# AS2ProfileMgr Class

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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) Class as a convenient way to set communication parameters.

To use the **AS2ProfileMgr** you should first set [DataDir](#as2profilemgrdatadir-property) 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](#as2profilemgrsaveprofile-method), alternatively you could retrieve previously saved settings using [LoadProfile](#as2profilemgrloadprofile-method).

When a new trading partner profile is saved a sub-directory named after the trading partner is created within [DataDir](#as2profilemgrdatadir-property) and the file *partner.cfg* is saved in it. If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) 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.

|  |  |
| --- | --- |
| [DirDeleted](#as2profilemgrdirdeleted-property) | Deleted files. |
| [DirIncoming](#as2profilemgrdirincoming-property) | Received files. |
| [DirLogs](#as2profilemgrdirlogs-property) | Log files. |
| [DirOutgoing](#as2profilemgrdiroutgoing-property) | Files to be sent. |
| [DirPending](#as2profilemgrdirpending-property) | Files pending async MDN. |
| [DirPendingInfo](#as2profilemgrdirpendinginfo-property) | Files having data to verify async MSN. |
| [DirSent](#as2profilemgrdirsent-property) | Sent 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.*

|  |  |
| --- | --- |
| [AsyncMDNURL](#as2profilemgrasyncmdnurl-property) | The URL for posting Async MDNs. |
| [CreateDirStruct](#as2profilemgrcreatedirstruct-property) | Option to create file management directories. |
| [DataDir](#as2profilemgrdatadir-property) | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. |
| [DirDeleted](#as2profilemgrdirdeleted-property) | The directory used to store deleted files. |
| [DirIncoming](#as2profilemgrdirincoming-property) | The directory used to store incoming files. |
| [DirLogs](#as2profilemgrdirlogs-property) | The directory used to store log files. |
| [DirOutgoing](#as2profilemgrdiroutgoing-property) | The directory used to store outgoing files. |
| [DirPending](#as2profilemgrdirpending-property) | The directory used to store files waiting for Async MDN. |
| [DirPendingInfo](#as2profilemgrdirpendinginfo-property) | The directory used to store files containing data to verify Async MDN. |
| [DirSent](#as2profilemgrdirsent-property) | The directory used to store sent files. |
| [Email](#as2profilemgremail-property) | Your email address. |
| [EncryptionCert](#as2profilemgrencryptioncert-property) | Certificate used for encryption or decryption. |
| [OptionCompress](#as2profilemgroptioncompress-property) | Preference to compress outgoing data. |
| [OptionEncrypt](#as2profilemgroptionencrypt-property) | Preference to encrypt outgoing data. |
| [OptionSign](#as2profilemgroptionsign-property) | Preference to sign outgoing data. |
| [Organization](#as2profilemgrorganization-property) | The name of your, or your trading partner's organization. |
| [PartnerCount](#as2profilemgrpartnercount-property) | The number of partners found in DataDir . |
| [RequestMDN](#as2profilemgrrequestmdn-property) | Preference to receive MDNs from trading partner. |
| [RequestMDNSigned](#as2profilemgrrequestmdnsigned-property) | Preference to request for signed MDNs. |
| [RequestMDNSynchronous](#as2profilemgrrequestmdnsynchronous-property) | Preference to request for synchronous MDNs. |
| [RequireEncrypt](#as2profilemgrrequireencrypt-property) | Preference to receive encrypted messages. |
| [RequireSign](#as2profilemgrrequiresign-property) | Preference to receive signed messages. |
| [SigningCert](#as2profilemgrsigningcert-property) | Certificate used for signing or signature validation. |
| [SSLCert](#as2profilemgrsslcert-property) | Certificate used for secure communication over SSL. |
| [URL](#as2profilemgrurl-property) | The 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.*

|  |  |
| --- | --- |
| [Config](#as2profilemgrconfig-method) | Sets or retrieves a configuration setting. |
| [DeleteProfile](#as2profilemgrdeleteprofile-method) | Deletes the configuration of the specified partner. |
| [GetProperty](#as2profilemgrgetproperty-method) | Gets the property propName . |
| [GetTPInfo](#as2profilemgrgettpinfo-method) | Gets the profile of the specified partner as a XML TPInfo. |
| [ListPartners](#as2profilemgrlistpartners-method) | Lists trading partners known to the AS2ProfileMgr . |
| [ListProperties](#as2profilemgrlistproperties-method) | Lists the properties read from self or partner profile. |
| [LoadProfile](#as2profilemgrloadprofile-method) | Loads the profile of the trading partner identified by partnerOrganization . |
| [Reset](#as2profilemgrreset-method) | Resets the state of the control. |
| [SaveProfile](#as2profilemgrsaveprofile-method) | Saves the profile of the trading partner identified by partnerOrganization . |
| [SetProperty](#as2profilemgrsetproperty-method) | Sets 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.*

|  |  |
| --- | --- |
| [Error](#as2profilemgrerror-event) | Fired when information is available about errors during data delivery. |
| [Partner](#as2profilemgrpartner-event) | Fired when ListPartners is invoked. |
| [PartnerDirectory](#as2profilemgrpartnerdirectory-event) | Fired before accessing partner.cfg of a trading partner. |
| [Property](#as2profilemgrproperty-event) | Fired 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.*

|  |  |
| --- | --- |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [AS2ProfileMgr](#as2profilemgr-class).AsyncMDNURL Property

The URL for posting Async MDNs.

## Syntax

```text
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](#as2profilemgrrequestmdnsynchronous-property).

# [AS2ProfileMgr](#as2profilemgr-class).CreateDirStruct Property

Option to create file management directories.

## Syntax

```text
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](#as2profilemgrsaveprofile-method) is invoked.

# [AS2ProfileMgr](#as2profilemgr-class).DataDir Property

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

## Syntax

```text
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](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).DirDeleted Property

The directory used to store deleted files.

## Syntax

```text
getDirDeleted(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).DirIncoming Property

The directory used to store incoming files.

## Syntax

```text
getDirIncoming(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).DirLogs Property

The directory used to store log files.

## Syntax

```text
getDirLogs(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).DirOutgoing Property

The directory used to store outgoing files.

## Syntax

```text
getDirOutgoing(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).DirPending Property

The directory used to store files waiting for Async MDN.

## Syntax

```text
getDirPending(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).DirPendingInfo Property

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

## Syntax

```text
getDirPendingInfo(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).DirSent Property

The directory used to store sent files.

## Syntax

```text
getDirSent(): string;
```

## Default Value

""

## Remarks

If [CreateDirStruct](#as2profilemgrcreatedirstruct-property) was true when [SaveProfile](#as2profilemgrsaveprofile-method) 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](#as2profilemgrloadprofile-method).

This property is read-only.

# [AS2ProfileMgr](#as2profilemgr-class).Email Property

Your email address.

## Syntax

```text
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](AS2Sender.md#AS2Sender) for details.

After invoking [LoadProfile](#as2profilemgrloadprofile-method), the **Email** will contain your currently configured email address, alternatively **Email** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).EncryptionCert Property

Certificate used for encryption or decryption.

## Syntax

```text
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](AS2Sender.md#AS2Sender) to encrypt outgoing data. It is also used by [AS2Receiver](AS2Receiver.md#AS2Receiver) to verify signatures on incoming data if a separate [SigningCert](#as2profilemgrsigningcert-property) 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](AS2Receiver.md#AS2Receiver) to decrypt incoming data. It is also used by [AS2Sender](AS2Sender.md#AS2Sender) to sign outgoing data if a separate [SigningCert](#as2profilemgrsigningcert-property) is not specified.

After invoking [LoadProfile](#as2profilemgrloadprofile-method), the **EncryptionCert** will contain the currently saved encryption certificate, alternatively **EncryptionCert** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2ProfileMgr](#as2profilemgr-class).OptionCompress Property

Preference to compress outgoing data.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **OptionCompress** will contain your compression preference for your trading partner, alternatively **OptionCompress** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).OptionEncrypt Property

Preference to encrypt outgoing data.

## Syntax

```text
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](#as2profilemgrencryptioncert-property) must be specified. When a profile with **OptionEncrypt** set to true is loaded into [AS2Sender](AS2Sender.md#AS2Sender), the default encryption algorithm is *AESCBC256*.

After invoking [LoadProfile](#as2profilemgrloadprofile-method), the **OptionEncrypt** will contain your encryption preference for your trading partner, alternatively **OptionEncrypt** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).OptionSign Property

Preference to sign outgoing data.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **OptionSign** will contain your signing preference for your trading partner, alternatively **OptionSign** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).Organization Property

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

## Syntax

```text
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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

Invoking [LoadProfile](#as2profilemgrloadprofile-method) reads the AS2 identifier into **Organization**, alternatively you can save the AS2 identifier by setting **Organization** and invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).PartnerCount Property

The number of partners found in DataDir .

## Syntax

```text
getPartnerCount(): number;
```

## Default Value

0

## Remarks

This property returns the number of partners found in [DataDir](#as2profilemgrdatadir-property). This property is populated after calling [ListPartners](#as2profilemgrlistpartners-method).

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

# [AS2ProfileMgr](#as2profilemgr-class).RequestMDN Property

Preference to receive MDNs from trading partner.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **RequireMDN** will contain your preference of receiving MDNs, alternatively **RequireMDN** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).RequestMDNSigned Property

Preference to request for signed MDNs.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **MDNRequestSigned** will contain your preference of requesting signed MDNs, alternatively **MDNRequestSigned** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).RequestMDNSynchronous Property

Preference to request for synchronous MDNs.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **MDNRequestSynchronous** will contain your preference of requesting synchronous MDNs, alternatively **MDNRequestSynchronous** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).RequireEncrypt Property

Preference to receive encrypted messages.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **RequireEncrypt** will contain your preference of receiving encrypted messages, alternatively **RequireEncrypt** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).RequireSign Property

Preference to receive signed messages.

## Syntax

```text
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](#as2profilemgrloadprofile-method), the **RequireSign** will contain your preference of receiving signed messages, alternatively **RequireSign** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).SigningCert Property

Certificate used for signing or signature validation.

## Syntax

```text
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](AS2Receiver.md#AS2Receiver) to verify the signature on incoming data. If **SigningCert** is not specified [EncryptionCert](#as2profilemgrencryptioncert-property) 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](AS2Sender.md#AS2Sender) to sign outgoing data. If **SigningCert** is not specified the [EncryptionCert](#as2profilemgrencryptioncert-property) is used for signing as well.

After invoking [LoadProfile](#as2profilemgrloadprofile-method), the **SigningCert** will contain the currently saved signing certificate, alternatively **SigningCert** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2ProfileMgr](#as2profilemgr-class).SSLCert Property

Certificate used for secure communication over SSL.

## Syntax

```text
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](AS2Sender.md#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](AS2Sender.md#AS2Sender) for client side SSL authentication.

After invoking [LoadProfile](#as2profilemgrloadprofile-method), the **SSLCert** will contain the currently saved SSL certificate, alternatively **SSLCert** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2ProfileMgr](#as2profilemgr-class).URL Property

The URL for posting EDI data.

## Syntax

```text
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](AS2Sender.md#AS2Sender) for details.

In the case of "self" profile i.e. when the parameter *partnerIdentifier* is "self" in [LoadProfile](#as2profilemgrloadprofile-method) or [SaveProfile](#as2profilemgrsaveprofile-method), **URL** refers to the URL that your trading partners use to post data to you.

After invoking [LoadProfile](#as2profilemgrloadprofile-method), the **URL** will contain the URL of your trading partner, alternatively **URL** may be set and saved by invoking [SaveProfile](#as2profilemgrsaveprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
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](#config-settings-class-ipworksedias2profilemgr) 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](#config-settings-class-ipworksedias2profilemgr), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [AS2ProfileMgr](#as2profilemgr-class).deleteProfile Method

Deletes the configuration of the specified partner.

## Syntax

```text
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](#as2profilemgr-class).getProperty Method

Gets the property propName .

## Syntax

```text
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](AS2Sender.md#AS2Sender) [AS2Receiver](AS2Receiver.md#AS2Receiver) classes and thus not exposed as **AS2ProfileMgr** properties.

**GetProperty** returns *null* if property *propName* was not read by [LoadProfile](#as2profilemgrloadprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).getTPInfo Method

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

## Syntax

```text
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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) using the method *SetTPInfo*.

# [AS2ProfileMgr](#as2profilemgr-class).listPartners Method

Lists trading partners known to the AS2ProfileMgr .

## Syntax

```text
async as2profilemgr.listPartners(): Promise< void>
```

## Remarks

Invoking *ListPartners* causes the event [Partner](#as2profilemgrpartner-event) to be fired for each trading partner profile found by the **AS2ProfileMgr** class.

After this method returns [PartnerCount](#as2profilemgrpartnercount-property) is populated with the number of found partners.

# [AS2ProfileMgr](#as2profilemgr-class).listProperties Method

Lists the properties read from self or partner profile.

## Syntax

```text
async as2profilemgr.listProperties(): Promise< void>
```

## Remarks

Invoking *ListProperties* causes the event [Property](#as2profilemgrproperty-event) to be fired for each property read by [LoadProfile](#as2profilemgrloadprofile-method).

# [AS2ProfileMgr](#as2profilemgr-class).loadProfile Method

Loads the profile of the trading partner identified by partnerOrganization .

## Syntax

```text
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](#as2profilemgrdatadir-property). 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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**Partner Settings**

- [Organization](#as2profilemgrorganization-property)
- [URL](#as2profilemgrurl-property)
- [OptionSign](#as2profilemgroptionsign-property)
- [OptionEncrypt](#as2profilemgroptionencrypt-property)
- [OptionCompress](#as2profilemgroptioncompress-property)
- [RequireSign](#as2profilemgrrequiresign-property)
- [RequireEncrypt](#as2profilemgrrequireencrypt-property)
- [RequestMDN](#as2profilemgrrequestmdn-property)
- [RequestMDNSigned](#as2profilemgrrequestmdnsigned-property)
- [RequestMDNSynchronous](#as2profilemgrrequestmdnsynchronous-property)
- [EncryptionCert](#as2profilemgrencryptioncert-property)
- [SigningCert](#as2profilemgrsigningcert-property)
- [SSLCert](#as2profilemgrsslcert-property)

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](#as2profilemgrdatadir-property).

Although all properties are read from the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**My Settings**

- [Organization](#as2profilemgrorganization-property)
- [URL](#as2profilemgrurl-property)
- [Email](#as2profilemgremail-property)
- [EncryptionCert](#as2profilemgrencryptioncert-property)
- [SigningCert](#as2profilemgrsigningcert-property)
- [SSLCert](#as2profilemgrsslcert-property)
- [AsyncMDNURL](#as2profilemgrasyncmdnurl-property)

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

# [AS2ProfileMgr](#as2profilemgr-class).reset Method

Resets the state of the control.

## Syntax

```text
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](#as2profilemgr-class).saveProfile Method

Saves the profile of the trading partner identified by partnerOrganization .

## Syntax

```text
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](#as2profilemgrdatadir-property). 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](#as2profilemgrcreatedirstruct-property) is set to true.

|  |  |
| --- | --- |
| [DirDeleted](#as2profilemgrdirdeleted-property) | Deleted files. |
| [DirIncoming](#as2profilemgrdirincoming-property) | Received files. |
| [DirLogs](#as2profilemgrdirlogs-property) | Log files. |
| [DirOutgoing](#as2profilemgrdiroutgoing-property) | Files to be sent. |
| [DirPending](#as2profilemgrdirpending-property) | Files pending async MDN. |
| [DirPendingInfo](#as2profilemgrdirpendinginfo-property) | Files having data to verify async MSN. |
| [DirSent](#as2profilemgrdirsent-property) | Sent files. |

Although any number of properties may be saved to the partner profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**Partner Settings**

- [Organization](#as2profilemgrorganization-property)
- [URL](#as2profilemgrurl-property)
- [OptionSign](#as2profilemgroptionsign-property)
- [OptionEncrypt](#as2profilemgroptionencrypt-property)
- [OptionCompress](#as2profilemgroptioncompress-property)
- [RequireSign](#as2profilemgrrequiresign-property)
- [RequireEncrypt](#as2profilemgrrequireencrypt-property)
- [RequestMDN](#as2profilemgrrequestmdn-property)
- [RequestMDNSigned](#as2profilemgrrequestmdnsigned-property)
- [RequestMDNSynchronous](#as2profilemgrrequestmdnsynchronous-property)
- [EncryptionCert](#as2profilemgrencryptioncert-property)
- [SigningCert](#as2profilemgrsigningcert-property)
- [SSLCert](#as2profilemgrsslcert-property)

If the *partnerOrganization* specified is "self", the properties of **AS2ProfileMgr** are saved to the XML file *me.cfg* placed in [DataDir](#as2profilemgrdatadir-property).

Although any number of properties may be saved to the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**My Settings**

- [Organization](#as2profilemgrorganization-property)
- [URL](#as2profilemgrurl-property)
- [Email](#as2profilemgremail-property)
- [EncryptionCert](#as2profilemgrencryptioncert-property)
- [SigningCert](#as2profilemgrsigningcert-property)
- [SSLCert](#as2profilemgrsslcert-property)
- [AsyncMDNURL](#as2profilemgrasyncmdnurl-property)

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

# [AS2ProfileMgr](#as2profilemgr-class).setProperty Method

Sets the property propName to propValue .

## Syntax

```text
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](AS2Sender.md#AS2Sender) [AS2Receiver](AS2Receiver.md#AS2Receiver) classes and thus not exposed as **AS2ProfileMgr** properties.

# [AS2ProfileMgr](#as2profilemgr-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
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 .

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-ipworksedias2profilemgr) section.

# [AS2ProfileMgr](#as2profilemgr-class).Partner Event

Fired when ListPartners is invoked.

## Syntax

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

## Remarks

This event is fired when [ListPartners](#as2profilemgrlistpartners-method) is called. It fires for each partner found by the **AS2ProfileMgr** in [DataDir](#as2profilemgrdatadir-property). The parameter *partnerIdentifier* is same as provided to [SaveProfile](#as2profilemgrsaveprofile-method) to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from *partnerURL*.

# [AS2ProfileMgr](#as2profilemgr-class).PartnerDirectory Event

Fired before accessing partner.cfg of a trading partner.

## Syntax

```text
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](#as2profilemgrloadprofile-method) or [GetTPInfo](#as2profilemgrgettpinfo-method) 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](#as2profilemgrlistpartners-method) is invoked.

# [AS2ProfileMgr](#as2profilemgr-class).Property Event

Fired when ListProperties is invoked.

## Syntax

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

## Remarks

This event is fired when [ListProperties](#as2profilemgrlistproperties-method) is called. It fires for each property read by [LoadProfile](#as2profilemgrloadprofile-method). 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.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
*Default Value: ""*

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *string (read-only)*
*Default Value: ""*

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *string (read-only)*
*Default Value: ""*

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

 **Fingerprint** *string (read-only)*
*Default Value: ""*

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

 **FingerprintSHA1** *string (read-only)*
*Default Value: ""*

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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 (read-only)*
*Default Value: ""*

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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 (read-only)*
*Default Value: ""*

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

 **KeyPassword** *string*
*Default Value: ""*

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 property 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 (read-only)*
*Default Value: ""*

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 (read-only)*
*Default Value: False*

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 (read-only)*
*Default Value: ""*

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

 **PublicKey** *string (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *string (read-only)*
*Default Value: ""*

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 (read-only)*
*Default Value: 0*

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

 **SerialNumber** *string (read-only)*
*Default Value: ""*

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 (read-only)*
*Default Value: ""*

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** *string*
*Default Value: "MY"*

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 designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StoreB** *Uint8Array*
*Default Value: "MY"*

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 designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StorePassword** *string*
*Default Value: ""*

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*
*Default Value: 0*

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:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
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.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 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 (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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). |
| 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. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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. |

 **SubjectAltNames** *string (read-only)*
*Default Value: ""*

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *string (read-only)*
*Default Value: ""*

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA1** *string (read-only)*
*Default Value: ""*

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA256** *string (read-only)*
*Default Value: ""*

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **Usage** *string (read-only)*
*Default Value: ""*

The text description of .

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

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

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

 **UsageFlags** *number (read-only)*
*Default Value: 0*

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

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the  property for a text representation of .

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

 **Version** *string (read-only)*
*Default Value: ""*

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

 **Subject** *string*
*Default Value: ""*

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *string*
*Default Value: ""*

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** *Uint8Array*
*Default Value: ""*

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.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See 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 X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See 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 CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * 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 X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See 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 X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array 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 X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array 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 X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Config Settings (*class *ipworksedi.[as2profilemgr](#as2profilemgr-class))

 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](#as2profilemgrconfig-method) 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:

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

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

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**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.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

# Trappable Errors (*class *ipworksedi.[as2profilemgr](#as2profilemgr-class))

### 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. |