# AS2ProfileMgr Component The AS2ProfileMgr component is used to manage self and trading partner profiles used for AS2 communication. ## Syntax ```text TibeAS2ProfileMgr ``` ## 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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) Component as a convenient way to set communication parameters. To use the **AS2ProfileMgr** you should first set [DataDir](#datadir-property-as2profilemgr-component) 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](#saveprofile-method-as2profilemgr-component), alternatively you could retrieve previously saved settings using [LoadProfile](#loadprofile-method-as2profilemgr-component). When a new trading partner profile is saved a sub-directory named after the trading partner is created within [DataDir](#datadir-property-as2profilemgr-component) and the file *partner.cfg* is saved in it. If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) 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](#dirdeleted-property-as2profilemgr-component) | Deleted files. | | [DirIncoming](#dirincoming-property-as2profilemgr-component) | Received files. | | [DirLogs](#dirlogs-property-as2profilemgr-component) | Log files. | | [DirOutgoing](#diroutgoing-property-as2profilemgr-component) | Files to be sent. | | [DirPending](#dirpending-property-as2profilemgr-component) | Files pending async MDN. | | [DirPendingInfo](#dirpendinginfo-property-as2profilemgr-component) | Files having data to verify async MSN. | | [DirSent](#dirsent-property-as2profilemgr-component) | 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](#asyncmdnurl-property-as2profilemgr-component) | The URL for posting Async MDNs. | | [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) | Option to create file management directories. | | [DataDir](#datadir-property-as2profilemgr-component) | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. | | [DirDeleted](#dirdeleted-property-as2profilemgr-component) | The directory used to store deleted files. | | [DirIncoming](#dirincoming-property-as2profilemgr-component) | The directory used to store incoming files. | | [DirLogs](#dirlogs-property-as2profilemgr-component) | The directory used to store log files. | | [DirOutgoing](#diroutgoing-property-as2profilemgr-component) | The directory used to store outgoing files. | | [DirPending](#dirpending-property-as2profilemgr-component) | The directory used to store files waiting for Async MDN. | | [DirPendingInfo](#dirpendinginfo-property-as2profilemgr-component) | The directory used to store files containing data to verify Async MDN. | | [DirSent](#dirsent-property-as2profilemgr-component) | The directory used to store sent files. | | [Email](#email-property-as2profilemgr-component) | Your email address. | | [EncryptionCertEffectiveDate](#encryptioncerteffectivedate-property-as2profilemgr-component) | The date on which this certificate becomes valid. | | [EncryptionCertExpirationDate](#encryptioncertexpirationdate-property-as2profilemgr-component) | The date on which the certificate expires. | | [EncryptionCertExtendedKeyUsage](#encryptioncertextendedkeyusage-property-as2profilemgr-component) | A comma-delimited list of extended key usage identifiers. | | [EncryptionCertFingerprint](#encryptioncertfingerprint-property-as2profilemgr-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [EncryptionCertFingerprintSHA1](#encryptioncertfingerprintsha1-property-as2profilemgr-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [EncryptionCertFingerprintSHA256](#encryptioncertfingerprintsha256-property-as2profilemgr-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [EncryptionCertIssuer](#encryptioncertissuer-property-as2profilemgr-component) | The issuer of the certificate. | | [EncryptionCertPrivateKey](#encryptioncertprivatekey-property-as2profilemgr-component) | The private key of the certificate (if available). | | [EncryptionCertPrivateKeyAvailable](#encryptioncertprivatekeyavailable-property-as2profilemgr-component) | Whether a PrivateKey is available for the selected certificate. | | [EncryptionCertPrivateKeyContainer](#encryptioncertprivatekeycontainer-property-as2profilemgr-component) | The name of the PrivateKey container for the certificate (if available). | | [EncryptionCertPublicKey](#encryptioncertpublickey-property-as2profilemgr-component) | The public key of the certificate. | | [EncryptionCertPublicKeyAlgorithm](#encryptioncertpublickeyalgorithm-property-as2profilemgr-component) | The textual description of the certificate's public key algorithm. | | [EncryptionCertPublicKeyLength](#encryptioncertpublickeylength-property-as2profilemgr-component) | The length of the certificate's public key (in bits). | | [EncryptionCertSerialNumber](#encryptioncertserialnumber-property-as2profilemgr-component) | The serial number of the certificate encoded as a string. | | [EncryptionCertSignatureAlgorithm](#encryptioncertsignaturealgorithm-property-as2profilemgr-component) | The text description of the certificate's signature algorithm. | | [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component) | The name of the certificate store for the client certificate. | | [EncryptionCertStorePassword](#encryptioncertstorepassword-property-as2profilemgr-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [EncryptionCertStoreType](#encryptioncertstoretype-property-as2profilemgr-component) | The type of certificate store for this certificate. | | [EncryptionCertSubjectAltNames](#encryptioncertsubjectaltnames-property-as2profilemgr-component) | Comma-separated lists of alternative subject names for the certificate. | | [EncryptionCertThumbprintMD5](#encryptioncertthumbprintmd5-property-as2profilemgr-component) | The MD5 hash of the certificate. | | [EncryptionCertThumbprintSHA1](#encryptioncertthumbprintsha1-property-as2profilemgr-component) | The SHA-1 hash of the certificate. | | [EncryptionCertThumbprintSHA256](#encryptioncertthumbprintsha256-property-as2profilemgr-component) | The SHA-256 hash of the certificate. | | [EncryptionCertUsage](#encryptioncertusage-property-as2profilemgr-component) | The text description of UsageFlags . | | [EncryptionCertUsageFlags](#encryptioncertusageflags-property-as2profilemgr-component) | The flags that show intended use for the certificate. | | [EncryptionCertVersion](#encryptioncertversion-property-as2profilemgr-component) | The certificate's version number. | | [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) | The subject of the certificate used for client authentication. | | [EncryptionCertEncoded](#encryptioncertencoded-property-as2profilemgr-component) | The certificate (PEM/Base64 encoded). | | [OptionCompress](#optioncompress-property-as2profilemgr-component) | Preference to compress outgoing data. | | [OptionEncrypt](#optionencrypt-property-as2profilemgr-component) | Preference to encrypt outgoing data. | | [OptionSign](#optionsign-property-as2profilemgr-component) | Preference to sign outgoing data. | | [Organization](#organization-property-as2profilemgr-component) | The name of your, or your trading partner's organization. | | [PartnerCount](#partnercount-property-as2profilemgr-component) | The number of partners found in DataDir . | | [RequestMDN](#requestmdn-property-as2profilemgr-component) | Preference to receive MDNs from trading partner. | | [RequestMDNSigned](#requestmdnsigned-property-as2profilemgr-component) | Preference to request for signed MDNs. | | [RequestMDNSynchronous](#requestmdnsynchronous-property-as2profilemgr-component) | Preference to request for synchronous MDNs. | | [RequireEncrypt](#requireencrypt-property-as2profilemgr-component) | Preference to receive encrypted messages. | | [RequireSign](#requiresign-property-as2profilemgr-component) | Preference to receive signed messages. | | [SigningCertEffectiveDate](#signingcerteffectivedate-property-as2profilemgr-component) | The date on which this certificate becomes valid. | | [SigningCertExpirationDate](#signingcertexpirationdate-property-as2profilemgr-component) | The date on which the certificate expires. | | [SigningCertExtendedKeyUsage](#signingcertextendedkeyusage-property-as2profilemgr-component) | A comma-delimited list of extended key usage identifiers. | | [SigningCertFingerprint](#signingcertfingerprint-property-as2profilemgr-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SigningCertFingerprintSHA1](#signingcertfingerprintsha1-property-as2profilemgr-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SigningCertFingerprintSHA256](#signingcertfingerprintsha256-property-as2profilemgr-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SigningCertIssuer](#signingcertissuer-property-as2profilemgr-component) | The issuer of the certificate. | | [SigningCertPrivateKey](#signingcertprivatekey-property-as2profilemgr-component) | The private key of the certificate (if available). | | [SigningCertPrivateKeyAvailable](#signingcertprivatekeyavailable-property-as2profilemgr-component) | Whether a PrivateKey is available for the selected certificate. | | [SigningCertPrivateKeyContainer](#signingcertprivatekeycontainer-property-as2profilemgr-component) | The name of the PrivateKey container for the certificate (if available). | | [SigningCertPublicKey](#signingcertpublickey-property-as2profilemgr-component) | The public key of the certificate. | | [SigningCertPublicKeyAlgorithm](#signingcertpublickeyalgorithm-property-as2profilemgr-component) | The textual description of the certificate's public key algorithm. | | [SigningCertPublicKeyLength](#signingcertpublickeylength-property-as2profilemgr-component) | The length of the certificate's public key (in bits). | | [SigningCertSerialNumber](#signingcertserialnumber-property-as2profilemgr-component) | The serial number of the certificate encoded as a string. | | [SigningCertSignatureAlgorithm](#signingcertsignaturealgorithm-property-as2profilemgr-component) | The text description of the certificate's signature algorithm. | | [SigningCertStore](#signingcertstore-property-as2profilemgr-component) | The name of the certificate store for the client certificate. | | [SigningCertStorePassword](#signingcertstorepassword-property-as2profilemgr-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SigningCertStoreType](#signingcertstoretype-property-as2profilemgr-component) | The type of certificate store for this certificate. | | [SigningCertSubjectAltNames](#signingcertsubjectaltnames-property-as2profilemgr-component) | Comma-separated lists of alternative subject names for the certificate. | | [SigningCertThumbprintMD5](#signingcertthumbprintmd5-property-as2profilemgr-component) | The MD5 hash of the certificate. | | [SigningCertThumbprintSHA1](#signingcertthumbprintsha1-property-as2profilemgr-component) | The SHA-1 hash of the certificate. | | [SigningCertThumbprintSHA256](#signingcertthumbprintsha256-property-as2profilemgr-component) | The SHA-256 hash of the certificate. | | [SigningCertUsage](#signingcertusage-property-as2profilemgr-component) | The text description of UsageFlags . | | [SigningCertUsageFlags](#signingcertusageflags-property-as2profilemgr-component) | The flags that show intended use for the certificate. | | [SigningCertVersion](#signingcertversion-property-as2profilemgr-component) | The certificate's version number. | | [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) | The subject of the certificate used for client authentication. | | [SigningCertEncoded](#signingcertencoded-property-as2profilemgr-component) | The certificate (PEM/Base64 encoded). | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-as2profilemgr-component) | The date on which this certificate becomes valid. | | [SSLCertExpirationDate](#sslcertexpirationdate-property-as2profilemgr-component) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-as2profilemgr-component) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-as2profilemgr-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-as2profilemgr-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-as2profilemgr-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-as2profilemgr-component) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-as2profilemgr-component) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-as2profilemgr-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-as2profilemgr-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-as2profilemgr-component) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-as2profilemgr-component) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-as2profilemgr-component) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-as2profilemgr-component) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-as2profilemgr-component) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-as2profilemgr-component) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-as2profilemgr-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-as2profilemgr-component) | The type of certificate store for this certificate. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-as2profilemgr-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-as2profilemgr-component) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-as2profilemgr-component) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-as2profilemgr-component) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-as2profilemgr-component) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-as2profilemgr-component) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-as2profilemgr-component) | The certificate's version number. | | [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) | The subject of the certificate used for client authentication. | | [SSLCertEncoded](#sslcertencoded-property-as2profilemgr-component) | The certificate (PEM/Base64 encoded). | | [URL](#url-property-as2profilemgr-component) | 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](#config-method-as2profilemgr-component) | Sets or retrieves a configuration setting. | | [DeleteProfile](#deleteprofile-method-as2profilemgr-component) | Deletes the configuration of the specified partner. | | [GetProperty](#getproperty-method-as2profilemgr-component) | Gets the property propName . | | [GetTPInfo](#gettpinfo-method-as2profilemgr-component) | Gets the profile of the specified partner as a XML TPInfo. | | [ListPartners](#listpartners-method-as2profilemgr-component) | Lists trading partners known to the AS2ProfileMgr . | | [ListProperties](#listproperties-method-as2profilemgr-component) | Lists the properties read from self or partner profile. | | [LoadProfile](#loadprofile-method-as2profilemgr-component) | Loads the profile of the trading partner identified by partnerOrganization . | | [Reset](#reset-method-as2profilemgr-component) | Resets the state of the control. | | [SaveProfile](#saveprofile-method-as2profilemgr-component) | Saves the profile of the trading partner identified by partnerOrganization . | | [SetProperty](#setproperty-method-as2profilemgr-component) | 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](#error-event-as2profilemgr-component) | Fired when information is available about errors during data delivery. | | [Partner](#partner-event-as2profilemgr-component) | Fired when ListPartners is invoked. | | [PartnerDirectory](#partnerdirectory-event-as2profilemgr-component) | Fired before accessing partner.cfg of a trading partner. | | [Property](#property-event-as2profilemgr-component) | 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](#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. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AsyncMDNURL Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The URL for posting Async MDNs. ## Syntax *C++ Builder Syntax* ```text __property String AsyncMDNURL = { read=FAsyncMDNURL, write=FSetAsyncMDNURL }; ``` ## 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](#requestmdnsynchronous-property-as2profilemgr-component). ## Data Type String # CreateDirStruct Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Option to create file management directories. ## Syntax *C++ Builder Syntax* ```text __property bool CreateDirStruct = { read=FCreateDirStruct, write=FSetCreateDirStruct }; ``` ## 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](#saveprofile-method-as2profilemgr-component) is invoked. ## Data Type Boolean # DataDir Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory that the AS2ProfileMgr uses to store self and trading partner profiles. ## Syntax *C++ Builder Syntax* ```text __property String DataDir = { read=FDataDir, write=FSetDataDir }; ``` ## 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](#saveprofile-method-as2profilemgr-component). ## Data Type String # DirDeleted Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store deleted files. ## Syntax *C++ Builder Syntax* ```text __property String DirDeleted = { read=FDirDeleted }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # DirIncoming Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store incoming files. ## Syntax *C++ Builder Syntax* ```text __property String DirIncoming = { read=FDirIncoming }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # DirLogs Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store log files. ## Syntax *C++ Builder Syntax* ```text __property String DirLogs = { read=FDirLogs }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # DirOutgoing Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store outgoing files. ## Syntax *C++ Builder Syntax* ```text __property String DirOutgoing = { read=FDirOutgoing }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # DirPending Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store files waiting for Async MDN. ## Syntax *C++ Builder Syntax* ```text __property String DirPending = { read=FDirPending }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # DirPendingInfo Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store files containing data to verify Async MDN. ## Syntax *C++ Builder Syntax* ```text __property String DirPendingInfo = { read=FDirPendingInfo }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # DirSent Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The directory used to store sent files. ## Syntax *C++ Builder Syntax* ```text __property String DirSent = { read=FDirSent }; ``` ## Default Value "" ## Remarks If [CreateDirStruct](#createdirstruct-property-as2profilemgr-component) was true when [SaveProfile](#saveprofile-method-as2profilemgr-component) 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](#loadprofile-method-as2profilemgr-component). This property is read-only. ## Data Type String # Email Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Your email address. ## Syntax *C++ Builder Syntax* ```text __property String Email = { read=FEmail, write=FSetEmail }; ``` ## 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](#loadprofile-method-as2profilemgr-component), the **Email** will contain your currently configured email address, alternatively **Email** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type String # EncryptionCertEffectiveDate Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertEffectiveDate = { read=FEncryptionCertEffectiveDate }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertExpirationDate Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertExpirationDate = { read=FEncryptionCertExpirationDate }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertExtendedKeyUsage Property ([AS2ProfileMgr](#as2profilemgr-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertExtendedKeyUsage = { read=FEncryptionCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # EncryptionCertFingerprint Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertFingerprint = { read=FEncryptionCertFingerprint }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # EncryptionCertFingerprintSHA1 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertFingerprintSHA1 = { read=FEncryptionCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # EncryptionCertFingerprintSHA256 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertFingerprintSHA256 = { read=FEncryptionCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # EncryptionCertIssuer Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertIssuer = { read=FEncryptionCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # EncryptionCertPrivateKey Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertPrivateKey = { read=FEncryptionCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [EncryptionCertPrivateKey](#encryptioncertprivatekey-property-as2profilemgr-component) may be available but not exportable. In this case, [EncryptionCertPrivateKey](#encryptioncertprivatekey-property-as2profilemgr-component) returns an empty string. This property is read-only. ## Data Type String # EncryptionCertPrivateKeyAvailable Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool EncryptionCertPrivateKeyAvailable = { read=FEncryptionCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [EncryptionCertPrivateKey](#encryptioncertprivatekey-property-as2profilemgr-component) is available for the selected certificate. If [EncryptionCertPrivateKeyAvailable](#encryptioncertprivatekeyavailable-property-as2profilemgr-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # EncryptionCertPrivateKeyContainer Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertPrivateKeyContainer = { read=FEncryptionCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [EncryptionCertPrivateKey](#encryptioncertprivatekey-property-as2profilemgr-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # EncryptionCertPublicKey Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertPublicKey = { read=FEncryptionCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # EncryptionCertPublicKeyAlgorithm Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertPublicKeyAlgorithm = { read=FEncryptionCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertPublicKeyLength Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int EncryptionCertPublicKeyLength = { read=FEncryptionCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # EncryptionCertSerialNumber Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertSerialNumber = { read=FEncryptionCertSerialNumber }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertSignatureAlgorithm Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertSignatureAlgorithm = { read=FEncryptionCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertStore Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertStore = { read=FEncryptionCertStore, write=FSetEncryptionCertStore }; __property DynamicArray EncryptionCertStoreB = { read=FEncryptionCertStoreB, write=FSetEncryptionCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [EncryptionCertStoreType](#encryptioncertstoretype-property-as2profilemgr-component) property denotes the type of the certificate store specified by [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component). If the store is password-protected, specify the password in [EncryptionCertStorePassword](#encryptioncertstorepassword-property-as2profilemgr-component). [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component) is used in conjunction with the [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) property to specify client certificates. If [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component) has a value, and [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) or [EncryptionCertEncoded](#encryptioncertencoded-property-as2profilemgr-component) is set, a search for a certificate is initiated. Please see the [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) 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). ## Data Type Byte Array # EncryptionCertStorePassword Property ([AS2ProfileMgr](#as2profilemgr-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertStorePassword = { read=FEncryptionCertStorePassword, write=FSetEncryptionCertStorePassword }; ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # EncryptionCertStoreType Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __property TibeAS2ProfileMgrEncryptionCertStoreTypes EncryptionCertStoreType = { read=FEncryptionCertStoreType, write=FSetEncryptionCertStoreType }; enum TibeAS2ProfileMgrEncryptionCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 }; ``` ## Default Value cstUser ## Remarks 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 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](#Type_Certificate) object and pass cstPKCS11 as the [EncryptionCertStoreType](#encryptioncertstoretype-property-as2profilemgr-component), the full path of the PKCS#11 DLL as the [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component), and the PIN as the [EncryptionCertStorePassword](#encryptioncertstorepassword-property-as2profilemgr-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component) and set [EncryptionCertStorePassword](#encryptioncertstorepassword-property-as2profilemgr-component) 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. | ## Data Type Integer # EncryptionCertSubjectAltNames Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertSubjectAltNames = { read=FEncryptionCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # EncryptionCertThumbprintMD5 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertThumbprintMD5 = { read=FEncryptionCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertThumbprintSHA1 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertThumbprintSHA1 = { read=FEncryptionCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertThumbprintSHA256 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertThumbprintSHA256 = { read=FEncryptionCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # EncryptionCertUsage Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertUsage = { read=FEncryptionCertUsage }; ``` ## Default Value "" ## Remarks The text description of [EncryptionCertUsageFlags](#encryptioncertusageflags-property-as2profilemgr-component). 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. This property is read-only. ## Data Type String # EncryptionCertUsageFlags Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int EncryptionCertUsageFlags = { read=FEncryptionCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [EncryptionCertUsageFlags](#encryptioncertusageflags-property-as2profilemgr-component) 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 [EncryptionCertUsage](#encryptioncertusage-property-as2profilemgr-component) property for a text representation of [EncryptionCertUsageFlags](#encryptioncertusageflags-property-as2profilemgr-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # EncryptionCertVersion Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertVersion = { read=FEncryptionCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # EncryptionCertSubject Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertSubject = { read=FEncryptionCertSubject, write=FSetEncryptionCertSubject }; ``` ## Default Value "" ## Remarks 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. ## Data Type String # EncryptionCertEncoded Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String EncryptionCertEncoded = { read=FEncryptionCertEncoded, write=FSetEncryptionCertEncoded }; __property DynamicArray EncryptionCertEncodedB = { read=FEncryptionCertEncodedB, write=FSetEncryptionCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component) and [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) properties also may be used to specify a certificate. When [EncryptionCertEncoded](#encryptioncertencoded-property-as2profilemgr-component) is set, a search is initiated in the current [EncryptionCertStore](#encryptioncertstore-property-as2profilemgr-component) for the private key of the certificate. If the key is found, [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) is updated to reflect the full subject of the selected certificate; otherwise, [EncryptionCertSubject](#encryptioncertsubject-property-as2profilemgr-component) is set to an empty string. This property is not available at design time. ## Data Type Byte Array # OptionCompress Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to compress outgoing data. ## Syntax *C++ Builder Syntax* ```text __property bool OptionCompress = { read=FOptionCompress, write=FSetOptionCompress }; ``` ## Default Value false ## Remarks **OptionCompress** is used to store your preference of compressing the data sent to your trading partner. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **OptionCompress** will contain your compression preference for your trading partner, alternatively **OptionCompress** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # OptionEncrypt Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to encrypt outgoing data. ## Syntax *C++ Builder Syntax* ```text __property bool OptionEncrypt = { read=FOptionEncrypt, write=FSetOptionEncrypt }; ``` ## 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. When a profile with **OptionEncrypt** set to true is loaded into [AS2Sender](AS2Sender.md#AS2Sender), the default encryption algorithm is *AESCBC256*. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **OptionEncrypt** will contain your encryption preference for your trading partner, alternatively **OptionEncrypt** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # OptionSign Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to sign outgoing data. ## Syntax *C++ Builder Syntax* ```text __property bool OptionSign = { read=FOptionSign, write=FSetOptionSign }; ``` ## Default Value false ## Remarks **OptionSign** is used to store your preference of signing the data sent to your trading partner. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **OptionSign** will contain your signing preference for your trading partner, alternatively **OptionSign** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # Organization Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of your, or your trading partner's organization. ## Syntax *C++ Builder Syntax* ```text __property String Organization = { read=FOrganization, write=FSetOrganization }; ``` ## 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) components. Invoking [LoadProfile](#loadprofile-method-as2profilemgr-component) reads the AS2 identifier into **Organization**, alternatively you can save the AS2 identifier by setting **Organization** and invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type String # PartnerCount Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The number of partners found in DataDir . ## Syntax *C++ Builder Syntax* ```text __property int PartnerCount = { read=FPartnerCount }; ``` ## Default Value 0 ## Remarks This property returns the number of partners found in [DataDir](#datadir-property-as2profilemgr-component). This property is populated after calling [ListPartners](#listpartners-method-as2profilemgr-component). This property is read-only and not available at design time. ## Data Type Integer # RequestMDN Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to receive MDNs from trading partner. ## Syntax *C++ Builder Syntax* ```text __property bool RequestMDN = { read=FRequestMDN, write=FSetRequestMDN }; ``` ## 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](#loadprofile-method-as2profilemgr-component), the **RequireMDN** will contain your preference of receiving MDNs, alternatively **RequireMDN** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # RequestMDNSigned Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to request for signed MDNs. ## Syntax *C++ Builder Syntax* ```text __property bool RequestMDNSigned = { read=FRequestMDNSigned, write=FSetRequestMDNSigned }; ``` ## Default Value true ## Remarks **MDNRequestSigned** is used to store your preference of requesting signed MDNs from your trading partner. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **MDNRequestSigned** will contain your preference of requesting signed MDNs, alternatively **MDNRequestSigned** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # RequestMDNSynchronous Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to request for synchronous MDNs. ## Syntax *C++ Builder Syntax* ```text __property bool RequestMDNSynchronous = { read=FRequestMDNSynchronous, write=FSetRequestMDNSynchronous }; ``` ## Default Value true ## Remarks **MDNRequestSynchronous** is used to store your preference of requesting synchronous MDNs from your trading partner. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **MDNRequestSynchronous** will contain your preference of requesting synchronous MDNs, alternatively **MDNRequestSynchronous** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # RequireEncrypt Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to receive encrypted messages. ## Syntax *C++ Builder Syntax* ```text __property bool RequireEncrypt = { read=FRequireEncrypt, write=FSetRequireEncrypt }; ``` ## Default Value false ## Remarks **RequireEncrypt** is used to store your preference of receiving encrypted messages from your trading partner. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **RequireEncrypt** will contain your preference of receiving encrypted messages, alternatively **RequireEncrypt** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # RequireSign Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Preference to receive signed messages. ## Syntax *C++ Builder Syntax* ```text __property bool RequireSign = { read=FRequireSign, write=FSetRequireSign }; ``` ## Default Value false ## Remarks **RequireSign** is used to store your preference of receiving signed messages from your trading partner. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **RequireSign** will contain your preference of receiving signed messages, alternatively **RequireSign** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type Boolean # SigningCertEffectiveDate Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertEffectiveDate = { read=FSigningCertEffectiveDate }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertExpirationDate Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertExpirationDate = { read=FSigningCertExpirationDate }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertExtendedKeyUsage Property ([AS2ProfileMgr](#as2profilemgr-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertExtendedKeyUsage = { read=FSigningCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SigningCertFingerprint Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertFingerprint = { read=FSigningCertFingerprint }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # SigningCertFingerprintSHA1 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertFingerprintSHA1 = { read=FSigningCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # SigningCertFingerprintSHA256 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertFingerprintSHA256 = { read=FSigningCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # SigningCertIssuer Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertIssuer = { read=FSigningCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SigningCertPrivateKey Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SigningCertPrivateKey = { read=FSigningCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SigningCertPrivateKey](#signingcertprivatekey-property-as2profilemgr-component) may be available but not exportable. In this case, [SigningCertPrivateKey](#signingcertprivatekey-property-as2profilemgr-component) returns an empty string. This property is read-only. ## Data Type String # SigningCertPrivateKeyAvailable Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool SigningCertPrivateKeyAvailable = { read=FSigningCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [SigningCertPrivateKey](#signingcertprivatekey-property-as2profilemgr-component) is available for the selected certificate. If [SigningCertPrivateKeyAvailable](#signingcertprivatekeyavailable-property-as2profilemgr-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SigningCertPrivateKeyContainer Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SigningCertPrivateKeyContainer = { read=FSigningCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [SigningCertPrivateKey](#signingcertprivatekey-property-as2profilemgr-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SigningCertPublicKey Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertPublicKey = { read=FSigningCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SigningCertPublicKeyAlgorithm Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertPublicKeyAlgorithm = { read=FSigningCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertPublicKeyLength Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int SigningCertPublicKeyLength = { read=FSigningCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SigningCertSerialNumber Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertSerialNumber = { read=FSigningCertSerialNumber }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertSignatureAlgorithm Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertSignatureAlgorithm = { read=FSigningCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertStore Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertStore = { read=FSigningCertStore, write=FSetSigningCertStore }; __property DynamicArray SigningCertStoreB = { read=FSigningCertStoreB, write=FSetSigningCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SigningCertStoreType](#signingcertstoretype-property-as2profilemgr-component) property denotes the type of the certificate store specified by [SigningCertStore](#signingcertstore-property-as2profilemgr-component). If the store is password-protected, specify the password in [SigningCertStorePassword](#signingcertstorepassword-property-as2profilemgr-component). [SigningCertStore](#signingcertstore-property-as2profilemgr-component) is used in conjunction with the [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) property to specify client certificates. If [SigningCertStore](#signingcertstore-property-as2profilemgr-component) has a value, and [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) or [SigningCertEncoded](#signingcertencoded-property-as2profilemgr-component) is set, a search for a certificate is initiated. Please see the [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) 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). ## Data Type Byte Array # SigningCertStorePassword Property ([AS2ProfileMgr](#as2profilemgr-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertStorePassword = { read=FSigningCertStorePassword, write=FSetSigningCertStorePassword }; ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # SigningCertStoreType Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __property TibeAS2ProfileMgrSigningCertStoreTypes SigningCertStoreType = { read=FSigningCertStoreType, write=FSetSigningCertStoreType }; enum TibeAS2ProfileMgrSigningCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 }; ``` ## Default Value cstUser ## Remarks 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 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](#Type_Certificate) object and pass cstPKCS11 as the [SigningCertStoreType](#signingcertstoretype-property-as2profilemgr-component), the full path of the PKCS#11 DLL as the [SigningCertStore](#signingcertstore-property-as2profilemgr-component), and the PIN as the [SigningCertStorePassword](#signingcertstorepassword-property-as2profilemgr-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [SigningCertStore](#signingcertstore-property-as2profilemgr-component) and set [SigningCertStorePassword](#signingcertstorepassword-property-as2profilemgr-component) 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. | ## Data Type Integer # SigningCertSubjectAltNames Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertSubjectAltNames = { read=FSigningCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SigningCertThumbprintMD5 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertThumbprintMD5 = { read=FSigningCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertThumbprintSHA1 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertThumbprintSHA1 = { read=FSigningCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertThumbprintSHA256 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertThumbprintSHA256 = { read=FSigningCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SigningCertUsage Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String SigningCertUsage = { read=FSigningCertUsage }; ``` ## Default Value "" ## Remarks The text description of [SigningCertUsageFlags](#signingcertusageflags-property-as2profilemgr-component). 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. This property is read-only. ## Data Type String # SigningCertUsageFlags Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int SigningCertUsageFlags = { read=FSigningCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SigningCertUsageFlags](#signingcertusageflags-property-as2profilemgr-component) 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 [SigningCertUsage](#signingcertusage-property-as2profilemgr-component) property for a text representation of [SigningCertUsageFlags](#signingcertusageflags-property-as2profilemgr-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SigningCertVersion Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertVersion = { read=FSigningCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SigningCertSubject Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String SigningCertSubject = { read=FSigningCertSubject, write=FSetSigningCertSubject }; ``` ## Default Value "" ## Remarks 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. ## Data Type String # SigningCertEncoded Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String SigningCertEncoded = { read=FSigningCertEncoded, write=FSetSigningCertEncoded }; __property DynamicArray SigningCertEncodedB = { read=FSigningCertEncodedB, write=FSetSigningCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SigningCertStore](#signingcertstore-property-as2profilemgr-component) and [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) properties also may be used to specify a certificate. When [SigningCertEncoded](#signingcertencoded-property-as2profilemgr-component) is set, a search is initiated in the current [SigningCertStore](#signingcertstore-property-as2profilemgr-component) for the private key of the certificate. If the key is found, [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) is updated to reflect the full subject of the selected certificate; otherwise, [SigningCertSubject](#signingcertsubject-property-as2profilemgr-component) is set to an empty string. This property is not available at design time. ## Data Type Byte Array # SSLCertEffectiveDate Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertExpirationDate Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertExpirationDate = { read=FSSLCertExpirationDate }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertExtendedKeyUsage Property ([AS2ProfileMgr](#as2profilemgr-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SSLCertFingerprint Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertFingerprint = { read=FSSLCertFingerprint }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # SSLCertFingerprintSHA1 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # SSLCertFingerprintSHA256 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks 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* This property is read-only. ## Data Type String # SSLCertIssuer Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertIssuer = { read=FSSLCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SSLCertPrivateKey Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SSLCertPrivateKey = { read=FSSLCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-as2profilemgr-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-as2profilemgr-component) returns an empty string. This property is read-only. ## Data Type String # SSLCertPrivateKeyAvailable Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-as2profilemgr-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-as2profilemgr-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLCertPrivateKeyContainer Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-as2profilemgr-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLCertPublicKey Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertPublicKey = { read=FSSLCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SSLCertPublicKeyAlgorithm Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertPublicKeyLength Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SSLCertSerialNumber Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertSerialNumber = { read=FSSLCertSerialNumber }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertSignatureAlgorithm Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertStore Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore }; __property DynamicArray SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-as2profilemgr-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-as2profilemgr-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-as2profilemgr-component). [SSLCertStore](#sslcertstore-property-as2profilemgr-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-as2profilemgr-component) has a value, and [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) or [SSLCertEncoded](#sslcertencoded-property-as2profilemgr-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) 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). ## Data Type Byte Array # SSLCertStorePassword Property ([AS2ProfileMgr](#as2profilemgr-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword }; ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # SSLCertStoreType Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __property TibeAS2ProfileMgrSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType }; enum TibeAS2ProfileMgrSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 }; ``` ## Default Value cstUser ## Remarks 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 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](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-as2profilemgr-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-as2profilemgr-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-as2profilemgr-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [SSLCertStore](#sslcertstore-property-as2profilemgr-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-as2profilemgr-component) 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. | ## Data Type Integer # SSLCertSubjectAltNames Property ([AS2ProfileMgr](#as2profilemgr-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLCertThumbprintMD5 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertThumbprintSHA1 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertThumbprintSHA256 Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks 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. This property is read-only. ## Data Type String # SSLCertUsage Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String SSLCertUsage = { read=FSSLCertUsage }; ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-as2profilemgr-component). 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. This property is read-only. ## Data Type String # SSLCertUsageFlags Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int SSLCertUsageFlags = { read=FSSLCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-as2profilemgr-component) 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 [SSLCertUsage](#sslcertusage-property-as2profilemgr-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-as2profilemgr-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLCertVersion Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertVersion = { read=FSSLCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SSLCertSubject Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject }; ``` ## Default Value "" ## Remarks 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. ## Data Type String # SSLCertEncoded Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded }; __property DynamicArray SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-as2profilemgr-component) and [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-as2profilemgr-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-as2profilemgr-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-as2profilemgr-component) is set to an empty string. This property is not available at design time. ## Data Type Byte Array # URL Property ([AS2ProfileMgr](#as2profilemgr-component) Component) The URL for posting EDI data. ## Syntax *C++ Builder Syntax* ```text __property String URL = { read=FURL, write=FSetURL }; ``` ## 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](#loadprofile-method-as2profilemgr-component) or [SaveProfile](#saveprofile-method-as2profilemgr-component), **URL** refers to the URL that your trading partners use to post data to you. After invoking [LoadProfile](#loadprofile-method-as2profilemgr-component), the **URL** will contain the URL of your trading partner, alternatively **URL** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-component). ## Data Type String # Config Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-as2profilemgr-component) 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](#config-settings-as2profilemgr-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DeleteProfile Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Deletes the configuration of the specified partner. ## Syntax *C++ Builder Syntax* ```text void __fastcall DeleteProfile(String partnerOrganization); ``` ## 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](#as2profilemgr-component) Component) Gets the property propName . ## Syntax *C++ Builder Syntax* ```text String __fastcall GetProperty(String propName); ``` ## 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) components and thus not exposed as **AS2ProfileMgr** properties. **GetProperty** returns *null* if property *propName* was not read by [LoadProfile](#loadprofile-method-as2profilemgr-component). # GetTPInfo Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Gets the profile of the specified partner as a XML TPInfo. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetTPInfo(String partnerOrganization); ``` ## 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*. # ListPartners Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Lists trading partners known to the AS2ProfileMgr . ## Syntax *C++ Builder Syntax* ```text void __fastcall ListPartners(); ``` ## Remarks Invoking *ListPartners* causes the event [Partner](#partner-event-as2profilemgr-component) to be fired for each trading partner profile found by the **AS2ProfileMgr** component. After this method returns [PartnerCount](#partnercount-property-as2profilemgr-component) is populated with the number of found partners. # ListProperties Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Lists the properties read from self or partner profile. ## Syntax *C++ Builder Syntax* ```text void __fastcall ListProperties(); ``` ## Remarks Invoking *ListProperties* causes the event [Property](#property-event-as2profilemgr-component) to be fired for each property read by [LoadProfile](#loadprofile-method-as2profilemgr-component). # LoadProfile Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Loads the profile of the trading partner identified by partnerOrganization . ## Syntax *C++ Builder Syntax* ```text void __fastcall LoadProfile(String partnerOrganization); ``` ## 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](#datadir-property-as2profilemgr-component). 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) components. **Partner Settings** - [Organization](#organization-property-as2profilemgr-component) - [URL](#url-property-as2profilemgr-component) - [OptionSign](#optionsign-property-as2profilemgr-component) - [OptionEncrypt](#optionencrypt-property-as2profilemgr-component) - [OptionCompress](#optioncompress-property-as2profilemgr-component) - [RequireSign](#requiresign-property-as2profilemgr-component) - [RequireEncrypt](#requireencrypt-property-as2profilemgr-component) - [RequestMDN](#requestmdn-property-as2profilemgr-component) - [RequestMDNSigned](#requestmdnsigned-property-as2profilemgr-component) - [RequestMDNSynchronous](#requestmdnsynchronous-property-as2profilemgr-component) - 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](#datadir-property-as2profilemgr-component). Although all properties are read from the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) components. **My Settings** - [Organization](#organization-property-as2profilemgr-component) - [URL](#url-property-as2profilemgr-component) - [Email](#email-property-as2profilemgr-component) - EncryptionCert - SigningCert - SSLCert - [AsyncMDNURL](#asyncmdnurl-property-as2profilemgr-component) Note: "self" cannot be the name of a trading partner organization. # Reset Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Resets the state of the control. ## Syntax *C++ Builder Syntax* ```text void __fastcall Reset(); ``` ## Remarks Resets all properties. After invoking this method the component may be reused as if it were newly created. # SaveProfile Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Saves the profile of the trading partner identified by partnerOrganization . ## Syntax *C++ Builder Syntax* ```text void __fastcall SaveProfile(String partnerOrganization); ``` ## 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](#datadir-property-as2profilemgr-component). 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](#createdirstruct-property-as2profilemgr-component) is set to true. | | | | --- | --- | | [DirDeleted](#dirdeleted-property-as2profilemgr-component) | Deleted files. | | [DirIncoming](#dirincoming-property-as2profilemgr-component) | Received files. | | [DirLogs](#dirlogs-property-as2profilemgr-component) | Log files. | | [DirOutgoing](#diroutgoing-property-as2profilemgr-component) | Files to be sent. | | [DirPending](#dirpending-property-as2profilemgr-component) | Files pending async MDN. | | [DirPendingInfo](#dirpendinginfo-property-as2profilemgr-component) | Files having data to verify async MSN. | | [DirSent](#dirsent-property-as2profilemgr-component) | 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) components. **Partner Settings** - [Organization](#organization-property-as2profilemgr-component) - [URL](#url-property-as2profilemgr-component) - [OptionSign](#optionsign-property-as2profilemgr-component) - [OptionEncrypt](#optionencrypt-property-as2profilemgr-component) - [OptionCompress](#optioncompress-property-as2profilemgr-component) - [RequireSign](#requiresign-property-as2profilemgr-component) - [RequireEncrypt](#requireencrypt-property-as2profilemgr-component) - [RequestMDN](#requestmdn-property-as2profilemgr-component) - [RequestMDNSigned](#requestmdnsigned-property-as2profilemgr-component) - [RequestMDNSynchronous](#requestmdnsynchronous-property-as2profilemgr-component) - EncryptionCert - SigningCert - SSLCert If the *partnerOrganization* specified is "self", the properties of **AS2ProfileMgr** are saved to the XML file *me.cfg* placed in [DataDir](#datadir-property-as2profilemgr-component). 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) components. **My Settings** - [Organization](#organization-property-as2profilemgr-component) - [URL](#url-property-as2profilemgr-component) - [Email](#email-property-as2profilemgr-component) - EncryptionCert - SigningCert - SSLCert - [AsyncMDNURL](#asyncmdnurl-property-as2profilemgr-component) Note: "self" cannot be the name of a trading partner organization. # SetProperty Method ([AS2ProfileMgr](#as2profilemgr-component) Component) Sets the property propName to propValue . ## Syntax *C++ Builder Syntax* ```text void __fastcall SetProperty(String propName, String propValue); ``` ## 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) components and thus not exposed as **AS2ProfileMgr** properties. # Error Event ([AS2ProfileMgr](#as2profilemgr-component) Component) Fired when information is available about errors during data delivery. ## Syntax *C++ Builder Syntax* ```text typedef struct { int ErrorCode; String Description; } TibeAS2ProfileMgrErrorEventParams; typedef void __fastcall (__closure *TibeAS2ProfileMgrErrorEvent)(System::TObject* Sender, TibeAS2ProfileMgrErrorEventParams *e); __property TibeAS2ProfileMgrErrorEvent OnError = { read=FOnError, write=FOnError }; ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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](#trappable-errors-as2profilemgr-component) section. # Partner Event ([AS2ProfileMgr](#as2profilemgr-component) Component) Fired when ListPartners is invoked. ## Syntax *C++ Builder Syntax* ```text typedef struct { String partnerIdentifier; String partnerURL; } TibeAS2ProfileMgrPartnerEventParams; typedef void __fastcall (__closure *TibeAS2ProfileMgrPartnerEvent)(System::TObject* Sender, TibeAS2ProfileMgrPartnerEventParams *e); __property TibeAS2ProfileMgrPartnerEvent OnPartner = { read=FOnPartner, write=FOnPartner }; ``` ## Remarks This event is fired when [ListPartners](#listpartners-method-as2profilemgr-component) is called. It fires for each partner found by the **AS2ProfileMgr** in [DataDir](#datadir-property-as2profilemgr-component). The parameter *partnerIdentifier* is same as provided to [SaveProfile](#saveprofile-method-as2profilemgr-component) to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from *partnerURL*. # PartnerDirectory Event ([AS2ProfileMgr](#as2profilemgr-component) Component) Fired before accessing partner.cfg of a trading partner. ## Syntax *C++ Builder Syntax* ```text typedef struct { String Name; String Directory; } TibeAS2ProfileMgrPartnerDirectoryEventParams; typedef void __fastcall (__closure *TibeAS2ProfileMgrPartnerDirectoryEvent)(System::TObject* Sender, TibeAS2ProfileMgrPartnerDirectoryEventParams *e); __property TibeAS2ProfileMgrPartnerDirectoryEvent OnPartnerDirectory = { read=FOnPartnerDirectory, write=FOnPartnerDirectory }; ``` ## Remarks This event is fired every time *partner.cfg* needs to be accessed i.e when [LoadProfile](#loadprofile-method-as2profilemgr-component) or [GetTPInfo](#gettpinfo-method-as2profilemgr-component) 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](#listpartners-method-as2profilemgr-component) is invoked. # Property Event ([AS2ProfileMgr](#as2profilemgr-component) Component) Fired when ListProperties is invoked. ## Syntax *C++ Builder Syntax* ```text typedef struct { String propName; String propValue; } TibeAS2ProfileMgrPropertyEventParams; typedef void __fastcall (__closure *TibeAS2ProfileMgrPropertyEvent)(System::TObject* Sender, TibeAS2ProfileMgrPropertyEventParams *e); __property TibeAS2ProfileMgrPropertyEvent OnProperty = { read=FOnProperty, write=FOnProperty }; ``` ## Remarks This event is fired when [ListProperties](#listproperties-method-as2profilemgr-component) is called. It fires for each property read by [LoadProfile](#loadprofile-method-as2profilemgr-component). The parameters *propName* and *propValue* provide property name and value respectively. # Config Settings ([AS2ProfileMgr](#as2profilemgr-component) 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](#config-method-as2profilemgr-component) 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 component 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*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. 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](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the component 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 ([AS2ProfileMgr](#as2profilemgr-component) 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. |