AS2ProfileMgr Component
Properties Methods Events Config Settings Errors
The AS2ProfileMgr component is used to manage self and trading partner profiles used for AS2 communication.
Syntax
nsoftware.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 component allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Component 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.
DirDeleted | Deleted files. |
DirIncoming | Received files. |
DirLogs | Log files. |
DirOutgoing | Files to be sent. |
DirPending | Files pending async MDN. |
DirPendingInfo | Files having data to verify async MSN. |
DirSent | Sent files. |
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AsyncMDNURL | The URL for posting Async MDNs. |
CreateDirStruct | Option to create file management directories. |
DataDir | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. |
DirDeleted | The directory used to store deleted files. |
DirIncoming | The directory used to store incoming files. |
DirLogs | The directory used to store log files. |
DirOutgoing | The directory used to store outgoing files. |
DirPending | The directory used to store files waiting for Async MDN. |
DirPendingInfo | The directory used to store files containing data to verify Async MDN. |
DirSent | The directory used to store sent files. |
Your email address. | |
EncryptionCert | Certificate used for encryption or decryption. |
OptionCompress | Preference to compress outgoing data. |
OptionEncrypt | Preference to encrypt outgoing data. |
OptionSign | Preference to sign outgoing data. |
Organization | The name of your, or your trading partner's organization. |
PartnerCount | The number of partners found in DataDir |
RequestMDN | Preference to receive MDNs from trading partner. |
RequestMDNSigned | Preference to request for signed MDNs. |
RequestMDNSynchronous | Preference to request for synchronous MDNs. |
RequireEncrypt | Preference to receive encrypted messages. |
RequireSign | Preference to receive signed messages. |
SigningCert | Certificate used for signing or signature validation. |
SSLCert | Certificate used for secure communication over SSL. |
URL | The URL for posting EDI data. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DeleteProfile | Deletes the configuration of the specified partner. |
GetProperty | Gets the property propName . |
GetTPInfo | Gets the profile of the specified partner as a XML TPInfo. |
ListPartners | Lists trading partners known to the AS2ProfileMgr . |
ListProperties | Lists the properties read from self or partner profile. |
LoadProfile | Loads the profile of the trading partner identified by partnerOrganization . |
Reset | Resets the state of the control. |
SaveProfile | Saves the profile of the trading partner identified by partnerOrganization . |
SetProperty | Sets the property propName to propValue . |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
Partner | Fired when ListPartners is invoked. |
PartnerDirectory | Fired before accessing partner.cfg of a trading partner. |
Property | Fired when ListProperties is invoked. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AsyncMDNURL Property (AS2ProfileMgr Component)
The URL for posting Async MDNs.
Syntax
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.
CreateDirStruct Property (AS2ProfileMgr Component)
Option to create file management directories.
Syntax
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.
DataDir Property (AS2ProfileMgr Component)
The directory that the AS2ProfileMgr uses to store self and trading partner profiles.
Syntax
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.
DirDeleted Property (AS2ProfileMgr Component)
The directory used to store deleted files.
Syntax
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.
DirIncoming Property (AS2ProfileMgr Component)
The directory used to store incoming files.
Syntax
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.
DirLogs Property (AS2ProfileMgr Component)
The directory used to store log files.
Syntax
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.
DirOutgoing Property (AS2ProfileMgr Component)
The directory used to store outgoing files.
Syntax
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.
DirPending Property (AS2ProfileMgr Component)
The directory used to store files waiting for Async MDN.
Syntax
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.
DirPendingInfo Property (AS2ProfileMgr Component)
The directory used to store files containing data to verify Async MDN.
Syntax
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.
DirSent Property (AS2ProfileMgr Component)
The directory used to store sent files.
Syntax
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.
Email Property (AS2ProfileMgr Component)
Your email address.
Syntax
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.
EncryptionCert Property (AS2ProfileMgr Component)
Certificate used for encryption or decryption.
Syntax
public Certificate EncryptionCert { get; set; }
Public Property EncryptionCert As Certificate
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.
Please refer to the Certificate type for a complete list of fields.OptionCompress Property (AS2ProfileMgr Component)
Preference to compress outgoing data.
Syntax
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.
OptionEncrypt Property (AS2ProfileMgr Component)
Preference to encrypt outgoing data.
Syntax
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.
OptionSign Property (AS2ProfileMgr Component)
Preference to sign outgoing data.
Syntax
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.
Organization Property (AS2ProfileMgr Component)
The name of your, or your trading partner's organization.
Syntax
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 components.
Invoking LoadProfile reads the AS2 identifier into Organization, alternatively you can save the AS2 identifier by setting Organization and invoking SaveProfile.
PartnerCount Property (AS2ProfileMgr Component)
The number of partners found in DataDir
Syntax
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.
RequestMDN Property (AS2ProfileMgr Component)
Preference to receive MDNs from trading partner.
Syntax
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.
RequestMDNSigned Property (AS2ProfileMgr Component)
Preference to request for signed MDNs.
Syntax
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.
RequestMDNSynchronous Property (AS2ProfileMgr Component)
Preference to request for synchronous MDNs.
Syntax
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.
RequireEncrypt Property (AS2ProfileMgr Component)
Preference to receive encrypted messages.
Syntax
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.
RequireSign Property (AS2ProfileMgr Component)
Preference to receive signed messages.
Syntax
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.
SigningCert Property (AS2ProfileMgr Component)
Certificate used for signing or signature validation.
Syntax
public Certificate SigningCert { get; set; }
Public Property SigningCert As Certificate
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.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (AS2ProfileMgr Component)
Certificate used for secure communication over SSL.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
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.
Please refer to the Certificate type for a complete list of fields.URL Property (AS2ProfileMgr Component)
The URL for posting EDI data.
Syntax
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.
Config Method (AS2ProfileMgr Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
DeleteProfile Method (AS2ProfileMgr Component)
Deletes the configuration of the specified partner.
Syntax
public void DeleteProfile(string partnerOrganization); Async Version public async Task DeleteProfile(string partnerOrganization); public async Task DeleteProfile(string partnerOrganization, CancellationToken cancellationToken);
Public Sub DeleteProfile(ByVal partnerOrganization As String) Async Version Public Sub DeleteProfile(ByVal partnerOrganization As String) As Task Public Sub DeleteProfile(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task
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.
GetProperty Method (AS2ProfileMgr Component)
Gets the property propName .
Syntax
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 components and thus not exposed as AS2ProfileMgr properties.
GetProperty returns null if property propName was not read by LoadProfile.
GetTPInfo Method (AS2ProfileMgr Component)
Gets the profile of the specified partner as a XML TPInfo.
Syntax
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.
ListPartners Method (AS2ProfileMgr Component)
Lists trading partners known to the AS2ProfileMgr .
Syntax
public void ListPartners(); Async Version public async Task ListPartners(); public async Task ListPartners(CancellationToken cancellationToken);
Public Sub ListPartners() Async Version Public Sub ListPartners() As Task Public Sub ListPartners(cancellationToken As CancellationToken) As Task
Remarks
Invoking ListPartners causes the event Partner to be fired for each trading partner profile found by the AS2ProfileMgr component.
After this method returns PartnerCount is populated with the number of found partners.
ListProperties Method (AS2ProfileMgr Component)
Lists the properties read from self or partner profile.
Syntax
public void ListProperties(); Async Version public async Task ListProperties(); public async Task ListProperties(CancellationToken cancellationToken);
Public Sub ListProperties() Async Version Public Sub ListProperties() As Task Public Sub ListProperties(cancellationToken As CancellationToken) As Task
Remarks
Invoking ListProperties causes the event Property to be fired for each property read by LoadProfile.
LoadProfile Method (AS2ProfileMgr Component)
Loads the profile of the trading partner identified by partnerOrganization .
Syntax
public void LoadProfile(string partnerOrganization); Async Version public async Task LoadProfile(string partnerOrganization); public async Task LoadProfile(string partnerOrganization, CancellationToken cancellationToken);
Public Sub LoadProfile(ByVal partnerOrganization As String) Async Version Public Sub LoadProfile(ByVal partnerOrganization As String) As Task Public Sub LoadProfile(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task
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 components.
Partner Settings
- Organization
- URL
- OptionSign
- OptionEncrypt
- OptionCompress
- RequireSign
- RequireEncrypt
- RequestMDN
- RequestMDNSigned
- RequestMDNSynchronous
- EncryptionCert
- SigningCert
- SSLCert
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 components.
My Settings
Note: "self" cannot be the name of a trading partner organization.
Reset Method (AS2ProfileMgr Component)
Resets the state of the control.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
Resets all properties. After invoking this method the component may be reused as if it were newly created.
SaveProfile Method (AS2ProfileMgr Component)
Saves the profile of the trading partner identified by partnerOrganization .
Syntax
public void SaveProfile(string partnerOrganization); Async Version public async Task SaveProfile(string partnerOrganization); public async Task SaveProfile(string partnerOrganization, CancellationToken cancellationToken);
Public Sub SaveProfile(ByVal partnerOrganization As String) Async Version Public Sub SaveProfile(ByVal partnerOrganization As String) As Task Public Sub SaveProfile(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task
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.
DirDeleted | Deleted files. |
DirIncoming | Received files. |
DirLogs | Log files. |
DirOutgoing | Files to be sent. |
DirPending | Files pending async MDN. |
DirPendingInfo | Files having data to verify async MSN. |
DirSent | Sent files. |
Although any number of properties may be saved to the partner profile, the following are interpreted by AS2Sender and AS2Receiver components.
Partner Settings
- Organization
- URL
- OptionSign
- OptionEncrypt
- OptionCompress
- RequireSign
- RequireEncrypt
- RequestMDN
- RequestMDNSigned
- RequestMDNSynchronous
- EncryptionCert
- SigningCert
- SSLCert
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 components.
My Settings
Note: "self" cannot be the name of a trading partner organization.
SetProperty Method (AS2ProfileMgr Component)
Sets the property propName to propValue .
Syntax
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 AS2Receivercomponents and thus not exposed as AS2ProfileMgr properties.
Error Event (AS2ProfileMgr Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, AS2ProfileMgrErrorEventArgs e); public class AS2ProfileMgrErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As AS2ProfileMgrErrorEventArgs) Public Class AS2ProfileMgrErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.
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 section.
Partner Event (AS2ProfileMgr Component)
Fired when ListPartners is invoked.
Syntax
public event OnPartnerHandler OnPartner; public delegate void OnPartnerHandler(object sender, AS2ProfileMgrPartnerEventArgs e); public class AS2ProfileMgrPartnerEventArgs : EventArgs { public string partnerIdentifier { get; } public string partnerURL { get; } }
Public Event OnPartner As OnPartnerHandler Public Delegate Sub OnPartnerHandler(sender As Object, e As AS2ProfileMgrPartnerEventArgs) Public Class AS2ProfileMgrPartnerEventArgs Inherits EventArgs Public ReadOnly Property partnerIdentifier As String Public ReadOnly Property partnerURL As String End Class
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.
PartnerDirectory Event (AS2ProfileMgr Component)
Fired before accessing partner.cfg of a trading partner.
Syntax
public event OnPartnerDirectoryHandler OnPartnerDirectory; public delegate void OnPartnerDirectoryHandler(object sender, AS2ProfileMgrPartnerDirectoryEventArgs e); public class AS2ProfileMgrPartnerDirectoryEventArgs : EventArgs { public string Name { get; } public string Directory { get; set; } }
Public Event OnPartnerDirectory As OnPartnerDirectoryHandler Public Delegate Sub OnPartnerDirectoryHandler(sender As Object, e As AS2ProfileMgrPartnerDirectoryEventArgs) Public Class AS2ProfileMgrPartnerDirectoryEventArgs Inherits EventArgs Public ReadOnly Property Name As String Public Property Directory As String End Class
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.
Property Event (AS2ProfileMgr Component)
Fired when ListProperties is invoked.
Syntax
public event OnPropertyHandler OnProperty; public delegate void OnPropertyHandler(object sender, AS2ProfileMgrPropertyEventArgs e); public class AS2ProfileMgrPropertyEventArgs : EventArgs { public string propName { get; } public string propValue { get; } }
Public Event OnProperty As OnPropertyHandler Public Delegate Sub OnPropertyHandler(sender As Object, e As AS2ProfileMgrPropertyEventArgs) Public Class AS2ProfileMgrPropertyEventArgs Inherits EventArgs Public ReadOnly Property propName As String Public ReadOnly Property propValue As String End Class
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 (read-only)
Default: ""
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: ""
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: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
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: ""
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: ""
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: ""
The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
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
int (read-only)
Default: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
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: ""
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: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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
byte []
Default: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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: ""
If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
The type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field 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 (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, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 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 Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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: ""
Comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
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: ""
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: ""
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: ""
The text description of UsageFlags.
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
int (read-only)
Default: 0
The flags that show intended use for the certificate. The value of UsageFlags 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 Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
The subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
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 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: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
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 component 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.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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 component 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.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
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 component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
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 component 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.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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 component 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.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
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 component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Config Settings (AS2ProfileMgr Component)
The component 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 component, access to these internal properties is provided through the Config method.Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (AS2ProfileMgr Component)
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. |