IPWorks EDI 2022 JavaScript Edition
Version 22.0 [Build 8369]

AS2ProfileMgr Class

Properties   Methods   Events   Config Settings   Errors  

The AS2ProfileMgr class is used to manage self and trading partner profiles used for AS2 communication.

Syntax

ipworksedi.as2profilemgr()

Remarks

AS2 communication require management of several configuration settings such as encryption certificate, signing certificate and TLS/SSL certificates. Both for your self and your trading partners.

The AS2ProfileMgr class allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Class as a convenient way to set communication parameters.

To use the AS2ProfileMgr you should first set DataDir to configure the directory that it will use to store the profiles. You can then set the properties to be retained and save them by invoking SaveProfile, alternatively you could retrieve previously saved settings using LoadProfile.

When a new trading partner profile is saved a sub-directory named after the trading partner is created within DataDir and the file partner.cfg is saved in it. If CreateDirStruct is set to true, the following sub-directories are created within the partner directory. These can be helpful in managing other data for the trading partner.

DirDeletedDeleted files.
DirIncomingReceived files.
DirLogsLog files.
DirOutgoingFiles to be sent.
DirPendingFiles pending async MDN.
DirPendingInfoFiles having data to verify async MSN.
DirSentSent files.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AsyncMDNURLThe URL for posting Async MDNs.
CreateDirStructOption to create file management directories.
DataDirThe directory that the AS2ProfileMgr uses to store self and trading partner profiles.
DirDeletedThe directory used to store deleted files.
DirIncomingThe directory used to store incoming files.
DirLogsThe directory used to store log files.
DirOutgoingThe directory used to store outgoing files.
DirPendingThe directory used to store files waiting for Async MDN.
DirPendingInfoThe directory used to store files containing data to verify Async MDN.
DirSentThe directory used to store sent files.
EmailYour email address.
EncryptionCertCertificate used for encryption or decryption.
OptionCompressPreference to compress outgoing data.
OptionEncryptPreference to encrypt outgoing data.
OptionSignPreference to sign outgoing data.
OrganizationThe name of your, or your trading partner's organization.
PartnerCountThe number of partners found in DataDir .
RequestMDNPreference to receive MDNs from trading partner.
RequestMDNSignedPreference to request for signed MDNs.
RequestMDNSynchronousPreference to request for synchronous MDNs.
RequireEncryptPreference to receive encrypted messages.
RequireSignPreference to receive signed messages.
SigningCertCertificate used for signing or signature validation.
SSLCertCertificate used for secure communication over SSL.
URLThe URL for posting EDI data.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DeleteProfileDeletes the configuration of the specified partner.
GetPropertyGets the property propName .
GetTPInfoGets the profile of the specified partner as a XML TPInfo.
ListPartnersLists trading partners known to the AS2ProfileMgr .
ListPropertiesLists the properties read from self or partner profile.
LoadProfileLoads the profile of the trading partner identified by partnerOrganization .
ResetResets the state of the control.
SaveProfileSaves the profile of the trading partner identified by partnerOrganization .
SetPropertySets the property propName to propValue .

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
PartnerFired when ListPartners is invoked.
PartnerDirectoryFired before accessing partner.cfg of a trading partner.
PropertyFired when ListProperties is invoked.

Config Settings


The following is a list of config settings for the class with short descriptions. Click on the links for further details.

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AS2ProfileMgr.AsyncMDNURL Property

The URL for posting Async MDNs.

Syntax


 getAsyncMDNURL(): string;


 setAsyncMDNURL(asyncMDNURL: string): void;

Default Value

""

Remarks

This is the URL to which your trading partners would post Async MDNs, if you choose to get asynchronous notifications. The choice of receiving asynchronous notifications can be made on a per partner basis and is reflected in RequestMDNSynchronous.

AS2ProfileMgr.CreateDirStruct Property

Option to create file management directories.

Syntax


 isCreateDirStruct(): boolean;


 setCreateDirStruct(createDirStruct: boolean): void;

Default Value

TRUE

Remarks

Set CreateDirStruct to false if you would like AS2ProfileMgr not to create file management directories. These are created for a trading partner when SaveProfile is invoked.

AS2ProfileMgr.DataDir Property

The directory that the AS2ProfileMgr uses to store self and trading partner profiles.

Syntax


 getDataDir(): string;


 setDataDir(dataDir: string): void;

Default Value

""

Remarks

AS2ProfileMgr uses DataDir to store self and trading partner configuration. The self profile is stored in the XML file me.cfg and the trading partner profiles are stored in the XML file partner.cfg. The partner.cfg is stored in a separate sub-directory for each trading partner. The sub-directory name is derived from the parameter PartnerOrganization of SaveProfile.

AS2ProfileMgr.DirDeleted Property

The directory used to store deleted files.

Syntax


 getDirDeleted(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing deleted files would have been created. The path to this directory can be read from DirDeleted after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.DirIncoming Property

The directory used to store incoming files.

Syntax


 getDirIncoming(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing incoming files would have been created. The path to this directory can be read from DirIncoming after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.DirLogs Property

The directory used to store log files.

Syntax


 getDirLogs(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing log files would have been created. The path to this directory can be read from DirLogs after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.DirOutgoing Property

The directory used to store outgoing files.

Syntax


 getDirOutgoing(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing outgoing files would have been created. The path to this directory can be read from DirOutgoing after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.DirPending Property

The directory used to store files waiting for Async MDN.

Syntax


 getDirPending(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files waiting for Async MDN would have been created. The path to this directory can be read from DirPending after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.DirPendingInfo Property

The directory used to store files containing data to verify Async MDN.

Syntax


 getDirPendingInfo(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files containing data for Async MDN verification would have been created. The path to this directory can be read from DirPendingInfo after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.DirSent Property

The directory used to store sent files.

Syntax


 getDirSent(): string;




Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing sent files would have been created. The path to this directory can be read from DirSent after invoking LoadProfile.

This property is read-only.

AS2ProfileMgr.Email Property

Your email address.

Syntax


 getEmail(): string;


 setEmail(email: string): void;

Default Value

""

Remarks

Email is used to store your email address. The email address is used to request a MDN. It is simply used as a token to request a MDN, it does not imply that the MDN would be sent to this address. Please refer to the property MDNTo in AS2Sender for details.

After invoking LoadProfile, the Email will contain your currently configured email address, alternatively Email may be set and saved by invoking SaveProfile.

AS2ProfileMgr.EncryptionCert Property

Certificate used for encryption or decryption.

Syntax


 getEncryptionCert(): Certificate;


 setEncryptionCert(encryptionCert: Certificate): void;

Default Value

Remarks

EncryptionCert for a trading partner, can be set to the path of a file containing the base64 encoded encryption certificate or to the contents of the file itself. It is used by the AS2Sender to encrypt outgoing data. It is also used by AS2Receiver to verify signatures on incoming data if a separate SigningCert is not specified.

While specifying self profile, EncryptionCert should be a pfx file containing a single certificate, private key pair. In this case EncryptionCertPassword must also be specified. EncryptionCert from self profile is used by AS2Receiver to decrypt incoming data. It is also used by AS2Sender to sign outgoing data if a separate SigningCert is not specified.

After invoking LoadProfile, the EncryptionCert will contain the currently saved encryption certificate, alternatively EncryptionCert may be set and saved by invoking SaveProfile.

AS2ProfileMgr.OptionCompress Property

Preference to compress outgoing data.

Syntax


 isOptionCompress(): boolean;


 setOptionCompress(optionCompress: boolean): void;

Default Value

FALSE

Remarks

OptionCompress is used to store your preference of compressing the data sent to your trading partner.

After invoking LoadProfile, the OptionCompress will contain your compression preference for your trading partner, alternatively OptionCompress may be set and saved by invoking SaveProfile.

AS2ProfileMgr.OptionEncrypt Property

Preference to encrypt outgoing data.

Syntax


 isOptionEncrypt(): boolean;


 setOptionEncrypt(optionEncrypt: boolean): void;

Default Value

FALSE

Remarks

OptionEncrypt is used to store your preference of encrypting data sent to your trading partner. If OptionEncrypt is set to true EncryptionCert must be specified.

After invoking LoadProfile, the OptionEncrypt will contain your encryption preference for your trading partner, alternatively OptionEncrypt may be set and saved by invoking SaveProfile.

AS2ProfileMgr.OptionSign Property

Preference to sign outgoing data.

Syntax


 isOptionSign(): boolean;


 setOptionSign(optionSign: boolean): void;

Default Value

FALSE

Remarks

OptionSign is used to store your preference of signing the data sent to your trading partner.

After invoking LoadProfile, the OptionSign will contain your signing preference for your trading partner, alternatively OptionSign may be set and saved by invoking SaveProfile.

AS2ProfileMgr.Organization Property

The name of your, or your trading partner's organization.

Syntax


 getOrganization(): string;


 setOrganization(organization: string): void;

Default Value

""

Remarks

Generally, Organization is used to store your, or your trading partner's AS2 identifier. It is used to configure or verify AS2From and AS2To in AS2Sender and AS2Receiver classs.

Invoking LoadProfile reads the AS2 identifier into Organization, alternatively you can save the AS2 identifier by setting Organization and invoking SaveProfile.

AS2ProfileMgr.PartnerCount Property

The number of partners found in DataDir .

Syntax


 getPartnerCount(): number;




Default Value

0

Remarks

This property returns the number of partners found in DataDir. This proprety is populated after calling ListPartners.

This property is read-only and not available at design time.

AS2ProfileMgr.RequestMDN Property

Preference to receive MDNs from trading partner.

Syntax


 isRequestMDN(): boolean;


 setRequestMDN(requestMDN: boolean): void;

Default Value

FALSE

Remarks

RequireMDN is used to store your preference of receiving MDNs for the messages you send to your trading partner.

After invoking LoadProfile, the RequireMDN will contain your preference of receiving MDNs, alternatively RequireMDN may be set and saved by invoking SaveProfile.

AS2ProfileMgr.RequestMDNSigned Property

Preference to request for signed MDNs.

Syntax


 isRequestMDNSigned(): boolean;


 setRequestMDNSigned(requestMDNSigned: boolean): void;

Default Value

TRUE

Remarks

MDNRequestSigned is used to store your preference of requesting signed MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSigned will contain your preference of requesting signed MDNs, alternatively MDNRequestSigned may be set and saved by invoking SaveProfile.

AS2ProfileMgr.RequestMDNSynchronous Property

Preference to request for synchronous MDNs.

Syntax


 isRequestMDNSynchronous(): boolean;


 setRequestMDNSynchronous(requestMDNSynchronous: boolean): void;

Default Value

TRUE

Remarks

MDNRequestSynchronous is used to store your preference of requesting synchronous MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSynchronous will contain your preference of requesting synchronous MDNs, alternatively MDNRequestSynchronous may be set and saved by invoking SaveProfile.

AS2ProfileMgr.RequireEncrypt Property

Preference to receive encrypted messages.

Syntax


 isRequireEncrypt(): boolean;


 setRequireEncrypt(requireEncrypt: boolean): void;

Default Value

FALSE

Remarks

RequireEncrypt is used to store your preference of receiving encrypted messages from your trading partner.

After invoking LoadProfile, the RequireEncrypt will contain your preference of receiving encrypted messages, alternatively RequireEncrypt may be set and saved by invoking SaveProfile.

AS2ProfileMgr.RequireSign Property

Preference to receive signed messages.

Syntax


 isRequireSign(): boolean;


 setRequireSign(requireSign: boolean): void;

Default Value

FALSE

Remarks

RequireSign is used to store your preference of receiving signed messages from your trading partner.

After invoking LoadProfile, the RequireSign will contain your preference of receiving signed messages, alternatively RequireSign may be set and saved by invoking SaveProfile.

AS2ProfileMgr.SigningCert Property

Certificate used for signing or signature validation.

Syntax


 getSigningCert(): Certificate;


 setSigningCert(signingCert: Certificate): void;

Default Value

Remarks

SigningCert for a trading partner, can be set to a filename containing the Base64 encoded signing certificate or to the contents of such file. It is used by the AS2Receiver to verify the signature on incoming data. If SigningCert is not specified EncryptionCert is used for signature verification as well.

While specifying "self" profile, SigningCert should be a pfx file containing a single certificate - private key pair. In such case SigningCertPassword must also be specified. SigningCert from "self" profile is used by AS2Sender to sign outgoing data. If SigningCert is not specified the EncryptionCert is used for signing as well.

After invoking LoadProfile, the SigningCert will contain the currently saved signing certificate, alternatively SigningCert may be set and saved by invoking SaveProfile.

AS2ProfileMgr.SSLCert Property

Certificate used for secure communication over SSL.

Syntax


 getSSLCert(): Certificate;


 setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

SSLCert for a trading partner, can be set to a filename containing the Base64 encoded SSL certificate or to the contents of the file itself. It is used by the AS2Sender to authenticate the trading partner's server and to establish a secure communication channel.

While specifying self profile, SSLCert should be a pfx file containing a single certificate, private key pair. In this case SSLPassword must also be specified. SSLCert from self profile is used by AS2Sender for client side SSL authentication.

After invoking LoadProfile, the SSLCert will contain the currently saved SSL certificate, alternatively SSLCert may be set and saved by invoking SaveProfile.

AS2ProfileMgr.URL Property

The URL for posting EDI data.

Syntax


 getURL(): string;


 setURL(URL: string): void;

Default Value

""

Remarks

URL is the URL provided by your trading partner for posting EDI Data. Please refer to the URL property in AS2Sender for details.

In the case of "self" profile i.e. when the parameter partnerIdentifier is "self" in LoadProfile or SaveProfile, URL refers to the URL that your trading partners use to post data to you.

After invoking LoadProfile, the URL will contain the URL of your trading partner, alternatively URL may be set and saved by invoking SaveProfile.

AS2ProfileMgr.config Method

Sets or retrieves a configuration setting.

Syntax

async as2profilemgr.config(configurationString : string): Promise<string>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

AS2ProfileMgr.deleteProfile Method

Deletes the configuration of the specified partner.

Syntax

async as2profilemgr.deleteProfile(partnerOrganization : string): Promise<void>

Remarks

The profile of the partner identified by partnerIdentifier is deleted. This method also deletes the directory in which the partner profile is stored, consequently deleting file management directories of the partner.

If the partnerOrganization specified is "self", the self profile i.e. me.cfg, is cleared.

AS2ProfileMgr.getProperty Method

Gets the property propName .

Syntax

async as2profilemgr.getProperty(propName : string): Promise<string>

Remarks

GetProperty can be used to query any property from "self" or partner profile. It is specially useful in retrieving properties not interpreted by AS2Sender AS2Receiver classs and thus not exposed as AS2ProfileMgr properties.

GetProperty returns null if property propName was not read by LoadProfile.

AS2ProfileMgr.getTPInfo Method

Gets the profile of the specified partner as a XML TPInfo.

Syntax

async as2profilemgr.getTPInfo(partnerOrganization : string): Promise<string>

Remarks

If the parameter partnerOrganization is "self", GetTPInfo returns a XML string representing the "self" profile otherwise it returns a XML string of partner profile. These strings can be directly fed to AS2Sender and AS2Receiver using the method SetTPInfo.

AS2ProfileMgr.listPartners Method

Lists trading partners known to the AS2ProfileMgr .

Syntax

async as2profilemgr.listPartners(): Promise<void>

Remarks

Invoking ListPartners causes the event Partner to be fired for each trading partner profile found by the AS2ProfileMgr class.

After this method returns PartnerCount is populated with the number of found partners.

AS2ProfileMgr.listProperties Method

Lists the properties read from self or partner profile.

Syntax

async as2profilemgr.listProperties(): Promise<void>

Remarks

Invoking ListProperties causes the event Property to be fired for each property read by LoadProfile.

AS2ProfileMgr.loadProfile Method

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

async as2profilemgr.loadProfile(partnerOrganization : string): Promise<void>

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are read from the XML file partner.cfg. The file is expected to be in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization.

Although all properties are read from the partner profile, the following are interpreted by AS2Sender and AS2Receiver classs.

Partner Settings

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are read from the XML file me.cfg. The file is expected to be in DataDir.

Although all properties are read from the self profile, the following are interpreted by AS2Sender and AS2Receiver classs.

My Settings

Note: "self" cannot be the name of a trading partner organization.

AS2ProfileMgr.reset Method

Resets the state of the control.

Syntax

async as2profilemgr.reset(): Promise<void>

Remarks

Resets all properties. After invoking this method the class may be reused as if it were newly created.

AS2ProfileMgr.saveProfile Method

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

async as2profilemgr.saveProfile(partnerOrganization : string): Promise<void>

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are saved to the XML file partner.cfg placed in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization. In addition to saving the partner profile, SaveProfile also creates the following directories if CreateDirStruct is set to true.

DirDeletedDeleted files.
DirIncomingReceived files.
DirLogsLog files.
DirOutgoingFiles to be sent.
DirPendingFiles pending async MDN.
DirPendingInfoFiles having data to verify async MSN.
DirSentSent files.

Although any number of properties may be saved to the partner profile, the following are interpreted by AS2Sender and AS2Receiver classes.

Partner Settings

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are saved to the XML file me.cfg placed in DataDir.

Although any number of properties may be saved to the self profile, the following are interpreted by AS2Sender and AS2Receiver classes.

My Settings

Note: "self" cannot be the name of a trading partner organization.

AS2ProfileMgr.setProperty Method

Sets the property propName to propValue .

Syntax

async as2profilemgr.setProperty(propName : string, propValue : string): Promise<void>

Remarks

SetProperty can be used to set any property in self or partner profile. It is specially useful in setting properties not interpreted by AS2Sender AS2Receiverclasss and thus not exposed as AS2ProfileMgr properties.

AS2ProfileMgr.Error Event

Information about errors during data delivery.

Syntax

as2profilemgr.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

AS2ProfileMgr.Partner Event

Fired when ListPartners is invoked.

Syntax

as2profilemgr.on('Partner', listener: (e: {readonly partnerIdentifier: string, readonly partnerURL: string}) => void )

Remarks

This event is fired when ListPartners is called. It fires for each partner found by the AS2ProfileMgr in DataDir. The parameter partnerIdentifier is same as provided to SaveProfile to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from partnerURL.

AS2ProfileMgr.PartnerDirectory Event

Fired before accessing partner.cfg of a trading partner.

Syntax

as2profilemgr.on('PartnerDirectory', listener: (e: {readonly name: string, directory: string}) => void )

Remarks

This event is fired every time partner.cfg needs to be accessed i.e when LoadProfile or GetTPInfo are invoked with partner name not being "self". The Name provides the partner name and Directory indicates the directory in which partner profile is expected. Setting Directory to a different path will make the component look for partner.cfg in that directory. Note: PartnerDirectory event is not fired when ListPartners is invoked.

AS2ProfileMgr.Property Event

Fired when ListProperties is invoked.

Syntax

as2profilemgr.on('Property', listener: (e: {readonly propName: string, readonly propValue: string}) => void )

Remarks

This event is fired when ListProperties is called. It fires for each property read by LoadProfile. The parameters propName and propValue provide property name and value respectively.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate
string

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
Uint8Array

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.

When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.

EncodedB
byte[]

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.

When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.

ExpirationDate
string

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
string

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
string

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
string

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
string

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
string

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys.

Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

PrivateKey
string

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The may be available but not exportable. In this case, returns an empty string.

PrivateKeyAvailable
boolean

This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string

This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
string

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
string

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
number

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
string

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
string

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
Uint8Array

This is the name of the certificate store for the client certificate.

The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in .

is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

StoreB
byte[]

This is the name of the certificate store for the client certificate.

The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in .

is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

StorePassword
string

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

StoreType
CertStoreTypes

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the and set to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
string

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

SubjectAltNames
string

This property contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string

This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA1
string

This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA256
string

This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.

Usage
string

This property contains the text description of .

This value will be of one or more of the following strings and will be separated by commas:

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
number

This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the property for a text representation of .

This functionality currently is not available when the provider is OpenSSL.

Version
string

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Config Settings (class ipworksedi.as2profilemgr)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (class ipworksedi.as2profilemgr)

AS2ProfileMgr Errors

601   Cannot access data directory.
602   This operation requires data directory to be set.
603   Cannot save personal profile.
604   Cannot load personal profile.
605   Cannot save partner profile.
606   Cannot load partner profile.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2022 JavaScript Edition - Version 22.0 [Build 8369]