# AS2ProfileMgr Class The AS2ProfileMgr class is used to manage self and trading partner profiles used for AS2 communication. ## Syntax ```text class ipworksedi.AS2ProfileMgr ``` ## Remarks AS2 communication require management of several configuration settings such as encryption certificate, signing certificate and TLS/SSL certificates. Both for your self and your trading partners. The **AS2ProfileMgr** class allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) Class as a convenient way to set communication parameters. To use the **AS2ProfileMgr** you should first set [data_dir](#data_dir-property) to configure the directory that it will use to store the profiles. You can then set the properties to be retained and save them by invoking [save_profile](#save_profile-method), alternatively you could retrieve previously saved settings using [load_profile](#load_profile-method). When a new trading partner profile is saved a sub-directory named after the trading partner is created within [data_dir](#data_dir-property) and the file *partner.cfg* is saved in it. If [create_dir_struct](#create_dir_struct-property) is set to true, the following sub-directories are created within the partner directory. These can be helpful in managing other data for the trading partner. | | | | --- | --- | | [dir_deleted](#dir_deleted-property) | Deleted files. | | [dir_incoming](#dir_incoming-property) | Received files. | | [dir_logs](#dir_logs-property) | Log files. | | [dir_outgoing](#dir_outgoing-property) | Files to be sent. | | [dir_pending](#dir_pending-property) | Files pending async MDN. | | [dir_pending_info](#dir_pending_info-property) | Files having data to verify async MSN. | | [dir_sent](#dir_sent-property) | Sent files. | ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [async_mdnurl](#async_mdnurl-property) | The URL for posting Async MDNs. | | [create_dir_struct](#create_dir_struct-property) | Option to create file management directories. | | [data_dir](#data_dir-property) | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. | | [dir_deleted](#dir_deleted-property) | The directory used to store deleted files. | | [dir_incoming](#dir_incoming-property) | The directory used to store incoming files. | | [dir_logs](#dir_logs-property) | The directory used to store log files. | | [dir_outgoing](#dir_outgoing-property) | The directory used to store outgoing files. | | [dir_pending](#dir_pending-property) | The directory used to store files waiting for Async MDN. | | [dir_pending_info](#dir_pending_info-property) | The directory used to store files containing data to verify Async MDN. | | [dir_sent](#dir_sent-property) | The directory used to store sent files. | | [email](#email-property) | Your email address. | | [encryption_cert_effective_date](#encryption_cert_effective_date-property) | The date on which this certificate becomes valid. | | [encryption_cert_encoded](#encryption_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [encryption_cert_expiration_date](#encryption_cert_expiration_date-property) | The date on which the certificate expires. | | [encryption_cert_extended_key_usage](#encryption_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [encryption_cert_fingerprint](#encryption_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [encryption_cert_fingerprint_sha1](#encryption_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [encryption_cert_fingerprint_sha256](#encryption_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [encryption_cert_issuer](#encryption_cert_issuer-property) | The issuer of the certificate. | | [encryption_cert_private_key](#encryption_cert_private_key-property) | The private key of the certificate (if available). | | [encryption_cert_private_key_available](#encryption_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [encryption_cert_private_key_container](#encryption_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [encryption_cert_public_key](#encryption_cert_public_key-property) | The public key of the certificate. | | [encryption_cert_public_key_algorithm](#encryption_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [encryption_cert_public_key_length](#encryption_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [encryption_cert_serial_number](#encryption_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [encryption_cert_signature_algorithm](#encryption_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [encryption_cert_store](#encryption_cert_store-property) | The name of the certificate store for the client certificate. | | [encryption_cert_store_password](#encryption_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [encryption_cert_store_type](#encryption_cert_store_type-property) | The type of certificate store for this certificate. | | [encryption_cert_subject](#encryption_cert_subject-property) | The subject of the certificate used for client authentication. | | [encryption_cert_subject_alt_names](#encryption_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [encryption_cert_thumbprint_md5](#encryption_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [encryption_cert_thumbprint_sha1](#encryption_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [encryption_cert_thumbprint_sha256](#encryption_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [encryption_cert_usage](#encryption_cert_usage-property) | The text description of UsageFlags . | | [encryption_cert_usage_flags](#encryption_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [encryption_cert_version](#encryption_cert_version-property) | The certificate's version number. | | [option_compress](#option_compress-property) | Preference to compress outgoing data. | | [option_encrypt](#option_encrypt-property) | Preference to encrypt outgoing data. | | [option_sign](#option_sign-property) | Preference to sign outgoing data. | | [organization](#organization-property) | The name of your, or your trading partner's organization. | | [partner_count](#partner_count-property) | The number of partners found in DataDir . | | [request_mdn](#request_mdn-property) | Preference to receive MDNs from trading partner. | | [request_mdn_signed](#request_mdn_signed-property) | Preference to request for signed MDNs. | | [request_mdn_synchronous](#request_mdn_synchronous-property) | Preference to request for synchronous MDNs. | | [require_encrypt](#require_encrypt-property) | Preference to receive encrypted messages. | | [require_sign](#require_sign-property) | Preference to receive signed messages. | | [signing_cert_effective_date](#signing_cert_effective_date-property) | The date on which this certificate becomes valid. | | [signing_cert_encoded](#signing_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [signing_cert_expiration_date](#signing_cert_expiration_date-property) | The date on which the certificate expires. | | [signing_cert_extended_key_usage](#signing_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [signing_cert_fingerprint](#signing_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [signing_cert_fingerprint_sha1](#signing_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [signing_cert_fingerprint_sha256](#signing_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [signing_cert_issuer](#signing_cert_issuer-property) | The issuer of the certificate. | | [signing_cert_private_key](#signing_cert_private_key-property) | The private key of the certificate (if available). | | [signing_cert_private_key_available](#signing_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [signing_cert_private_key_container](#signing_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [signing_cert_public_key](#signing_cert_public_key-property) | The public key of the certificate. | | [signing_cert_public_key_algorithm](#signing_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [signing_cert_public_key_length](#signing_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [signing_cert_serial_number](#signing_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [signing_cert_signature_algorithm](#signing_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [signing_cert_store](#signing_cert_store-property) | The name of the certificate store for the client certificate. | | [signing_cert_store_password](#signing_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [signing_cert_store_type](#signing_cert_store_type-property) | The type of certificate store for this certificate. | | [signing_cert_subject](#signing_cert_subject-property) | The subject of the certificate used for client authentication. | | [signing_cert_subject_alt_names](#signing_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [signing_cert_thumbprint_md5](#signing_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [signing_cert_thumbprint_sha1](#signing_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [signing_cert_thumbprint_sha256](#signing_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [signing_cert_usage](#signing_cert_usage-property) | The text description of UsageFlags . | | [signing_cert_usage_flags](#signing_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [signing_cert_version](#signing_cert_version-property) | The certificate's version number. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_cert_store_type](#ssl_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. | | [url](#url-property) | The URL for posting EDI data. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [config](#config-method) | Sets or retrieves a configuration setting. | | [delete_profile](#delete_profile-method) | Deletes the configuration of the specified partner. | | [get_property](#get_property-method) | Gets the property propName . | | [get_tp_info](#get_tp_info-method) | Gets the profile of the specified partner as a XML TPInfo. | | [list_partners](#list_partners-method) | Lists trading partners known to the AS2ProfileMgr . | | [list_properties](#list_properties-method) | Lists the properties read from self or partner profile. | | [load_profile](#load_profile-method) | Loads the profile of the trading partner identified by partnerOrganization . | | [reset](#reset-method) | Resets the state of the control. | | [save_profile](#save_profile-method) | Saves the profile of the trading partner identified by partnerOrganization . | | [set_property](#set_property-method) | Sets the property propName to propValue . | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_partner](#on_partner-event) | Fired when ListPartners is invoked. | | [on_partner_directory](#on_partner_directory-event) | Fired before accessing partner.cfg of a trading partner. | | [on_property](#on_property-event) | Fired when ListProperties is invoked. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # async_mdnurl property The URL for posting Async MDNs. ## Syntax ```text def get_async_mdnurl() -> str: ... def set_async_mdnurl(value: str) -> None: ... async_mdnurl = property(get_async_mdnurl, set_async_mdnurl) ``` ## 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 [request_mdn_synchronous](#request_mdn_synchronous-property). # create_dir_struct property Option to create file management directories. ## Syntax ```text def get_create_dir_struct() -> bool: ... def set_create_dir_struct(value: bool) -> None: ... create_dir_struct = property(get_create_dir_struct, set_create_dir_struct) ``` ## 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 [save_profile](#save_profile-method) is invoked. # data_dir property The directory that the AS2ProfileMgr uses to store self and trading partner profiles. ## Syntax ```text def get_data_dir() -> str: ... def set_data_dir(value: str) -> None: ... data_dir = property(get_data_dir, set_data_dir) ``` ## 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 [save_profile](#save_profile-method). # dir_deleted property The directory used to store deleted files. ## Syntax ```text def get_dir_deleted() -> str: ... dir_deleted = property(get_dir_deleted, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing deleted files would have been created. The path to this directory can be read from **DirDeleted** after invoking [load_profile](#load_profile-method). This property is read-only. # dir_incoming property The directory used to store incoming files. ## Syntax ```text def get_dir_incoming() -> str: ... dir_incoming = property(get_dir_incoming, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing incoming files would have been created. The path to this directory can be read from **DirIncoming** after invoking [load_profile](#load_profile-method). This property is read-only. # dir_logs property The directory used to store log files. ## Syntax ```text def get_dir_logs() -> str: ... dir_logs = property(get_dir_logs, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing log files would have been created. The path to this directory can be read from **DirLogs** after invoking [load_profile](#load_profile-method). This property is read-only. # dir_outgoing property The directory used to store outgoing files. ## Syntax ```text def get_dir_outgoing() -> str: ... dir_outgoing = property(get_dir_outgoing, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing outgoing files would have been created. The path to this directory can be read from **DirOutgoing** after invoking [load_profile](#load_profile-method). This property is read-only. # dir_pending property The directory used to store files waiting for Async MDN. ## Syntax ```text def get_dir_pending() -> str: ... dir_pending = property(get_dir_pending, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing files waiting for Async MDN would have been created. The path to this directory can be read from **DirPending** after invoking [load_profile](#load_profile-method). This property is read-only. # dir_pending_info property The directory used to store files containing data to verify Async MDN. ## Syntax ```text def get_dir_pending_info() -> str: ... dir_pending_info = property(get_dir_pending_info, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing files containing data for Async MDN verification would have been created. The path to this directory can be read from **DirPendingInfo** after invoking [load_profile](#load_profile-method). This property is read-only. # dir_sent property The directory used to store sent files. ## Syntax ```text def get_dir_sent() -> str: ... dir_sent = property(get_dir_sent, None) ``` ## Default Value "" ## Remarks If [create_dir_struct](#create_dir_struct-property) was true when [save_profile](#save_profile-method) was invoked a directory for storing sent files would have been created. The path to this directory can be read from **DirSent** after invoking [load_profile](#load_profile-method). This property is read-only. # email property Your email address. ## Syntax ```text def get_email() -> str: ... def set_email(value: str) -> None: ... email = property(get_email, set_email) ``` ## 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 [load_profile](#load_profile-method), the **Email** will contain your currently configured email address, alternatively **Email** may be set and saved by invoking [save_profile](#save_profile-method). # encryption_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_encryption_cert_effective_date() -> str: ... encryption_cert_effective_date = property(get_encryption_cert_effective_date, None) ``` ## 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. # encryption_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_encryption_cert_encoded() -> bytes: ... def set_encryption_cert_encoded(value: bytes) -> None: ... encryption_cert_encoded = property(get_encryption_cert_encoded, set_encryption_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [encryption_cert_store](#encryption_cert_store-property) and [encryption_cert_subject](#encryption_cert_subject-property) properties also may be used to specify a certificate. When [encryption_cert_encoded](#encryption_cert_encoded-property) is set, a search is initiated in the current [encryption_cert_store](#encryption_cert_store-property) for the private key of the certificate. If the key is found, [encryption_cert_subject](#encryption_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [encryption_cert_subject](#encryption_cert_subject-property) is set to an empty string. # encryption_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_encryption_cert_expiration_date() -> str: ... encryption_cert_expiration_date = property(get_encryption_cert_expiration_date, None) ``` ## 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. # encryption_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_encryption_cert_extended_key_usage() -> str: ... encryption_cert_extended_key_usage = property(get_encryption_cert_extended_key_usage, None) ``` ## 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. # encryption_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_encryption_cert_fingerprint() -> str: ... encryption_cert_fingerprint = property(get_encryption_cert_fingerprint, None) ``` ## 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. # encryption_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_encryption_cert_fingerprint_sha1() -> str: ... encryption_cert_fingerprint_sha1 = property(get_encryption_cert_fingerprint_sha1, None) ``` ## 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. # encryption_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_encryption_cert_fingerprint_sha256() -> str: ... encryption_cert_fingerprint_sha256 = property(get_encryption_cert_fingerprint_sha256, None) ``` ## 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. # encryption_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_encryption_cert_issuer() -> str: ... encryption_cert_issuer = property(get_encryption_cert_issuer, None) ``` ## 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. # encryption_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_encryption_cert_private_key() -> str: ... encryption_cert_private_key = property(get_encryption_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [encryption_cert_private_key](#encryption_cert_private_key-property) may be available but not exportable. In this case, [encryption_cert_private_key](#encryption_cert_private_key-property) returns an empty string. This property is read-only. # encryption_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_encryption_cert_private_key_available() -> bool: ... encryption_cert_private_key_available = property(get_encryption_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [encryption_cert_private_key](#encryption_cert_private_key-property) is available for the selected certificate. If [encryption_cert_private_key_available](#encryption_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # encryption_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_encryption_cert_private_key_container() -> str: ... encryption_cert_private_key_container = property(get_encryption_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [encryption_cert_private_key](#encryption_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # encryption_cert_public_key property The public key of the certificate. ## Syntax ```text def get_encryption_cert_public_key() -> str: ... encryption_cert_public_key = property(get_encryption_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # encryption_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_encryption_cert_public_key_algorithm() -> str: ... encryption_cert_public_key_algorithm = property(get_encryption_cert_public_key_algorithm, None) ``` ## 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. # encryption_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_encryption_cert_public_key_length() -> int: ... encryption_cert_public_key_length = property(get_encryption_cert_public_key_length, None) ``` ## 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. # encryption_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_encryption_cert_serial_number() -> str: ... encryption_cert_serial_number = property(get_encryption_cert_serial_number, None) ``` ## 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. # encryption_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_encryption_cert_signature_algorithm() -> str: ... encryption_cert_signature_algorithm = property(get_encryption_cert_signature_algorithm, None) ``` ## 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. # encryption_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_encryption_cert_store() -> bytes: ... def set_encryption_cert_store(value: bytes) -> None: ... encryption_cert_store = property(get_encryption_cert_store, set_encryption_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [encryption_cert_store_type](#encryption_cert_store_type-property) property denotes the type of the certificate store specified by [encryption_cert_store](#encryption_cert_store-property). If the store is password-protected, specify the password in [encryption_cert_store_password](#encryption_cert_store_password-property). [encryption_cert_store](#encryption_cert_store-property) is used in conjunction with the [encryption_cert_subject](#encryption_cert_subject-property) property to specify client certificates. If [encryption_cert_store](#encryption_cert_store-property) has a value, and [encryption_cert_subject](#encryption_cert_subject-property) or [encryption_cert_encoded](#encryption_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [encryption_cert_subject](#encryption_cert_subject-property) 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). # encryption_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_encryption_cert_store_password() -> str: ... def set_encryption_cert_store_password(value: str) -> None: ... encryption_cert_store_password = property(get_encryption_cert_store_password, set_encryption_cert_store_password) ``` ## 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. # encryption_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_encryption_cert_store_type() -> int: ... def set_encryption_cert_store_type(value: int) -> None: ... encryption_cert_store_type = property(get_encryption_cert_store_type, set_encryption_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [encryption_cert_store_type](#encryption_cert_store_type-property), the full path of the PKCS#11 DLL as the [encryption_cert_store](#encryption_cert_store-property), and the PIN as the [encryption_cert_store_password](#encryption_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [encryption_cert_store](#encryption_cert_store-property) and set [encryption_cert_store_password](#encryption_cert_store_password-property) 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. | # encryption_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_encryption_cert_subject() -> str: ... def set_encryption_cert_subject(value: str) -> None: ... encryption_cert_subject = property(get_encryption_cert_subject, set_encryption_cert_subject) ``` ## 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. # encryption_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_encryption_cert_subject_alt_names() -> str: ... encryption_cert_subject_alt_names = property(get_encryption_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # encryption_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_encryption_cert_thumbprint_md5() -> str: ... encryption_cert_thumbprint_md5 = property(get_encryption_cert_thumbprint_md5, None) ``` ## 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. # encryption_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_encryption_cert_thumbprint_sha1() -> str: ... encryption_cert_thumbprint_sha1 = property(get_encryption_cert_thumbprint_sha1, None) ``` ## 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. # encryption_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_encryption_cert_thumbprint_sha256() -> str: ... encryption_cert_thumbprint_sha256 = property(get_encryption_cert_thumbprint_sha256, None) ``` ## 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. # encryption_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_encryption_cert_usage() -> str: ... encryption_cert_usage = property(get_encryption_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [encryption_cert_usage_flags](#encryption_cert_usage_flags-property). 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. # encryption_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_encryption_cert_usage_flags() -> int: ... encryption_cert_usage_flags = property(get_encryption_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [encryption_cert_usage_flags](#encryption_cert_usage_flags-property) 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 [encryption_cert_usage](#encryption_cert_usage-property) property for a text representation of [encryption_cert_usage_flags](#encryption_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # encryption_cert_version property The certificate's version number. ## Syntax ```text def get_encryption_cert_version() -> str: ... encryption_cert_version = property(get_encryption_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # option_compress property Preference to compress outgoing data. ## Syntax ```text def get_option_compress() -> bool: ... def set_option_compress(value: bool) -> None: ... option_compress = property(get_option_compress, set_option_compress) ``` ## Default Value FALSE ## Remarks **OptionCompress** is used to store your preference of compressing the data sent to your trading partner. After invoking [load_profile](#load_profile-method), the **OptionCompress** will contain your compression preference for your trading partner, alternatively **OptionCompress** may be set and saved by invoking [save_profile](#save_profile-method). # option_encrypt property Preference to encrypt outgoing data. ## Syntax ```text def get_option_encrypt() -> bool: ... def set_option_encrypt(value: bool) -> None: ... option_encrypt = property(get_option_encrypt, set_option_encrypt) ``` ## 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 encryption_cert 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 [load_profile](#load_profile-method), the **OptionEncrypt** will contain your encryption preference for your trading partner, alternatively **OptionEncrypt** may be set and saved by invoking [save_profile](#save_profile-method). # option_sign property Preference to sign outgoing data. ## Syntax ```text def get_option_sign() -> bool: ... def set_option_sign(value: bool) -> None: ... option_sign = property(get_option_sign, set_option_sign) ``` ## Default Value FALSE ## Remarks **OptionSign** is used to store your preference of signing the data sent to your trading partner. After invoking [load_profile](#load_profile-method), the **OptionSign** will contain your signing preference for your trading partner, alternatively **OptionSign** may be set and saved by invoking [save_profile](#save_profile-method). # organization property The name of your, or your trading partner's organization. ## Syntax ```text def get_organization() -> str: ... def set_organization(value: str) -> None: ... organization = property(get_organization, set_organization) ``` ## Default Value "" ## Remarks Generally, **Organization** is used to store your, or your trading partner's AS2 identifier. It is used to configure or verify **AS2From** and **AS2To** in [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes. Invoking [load_profile](#load_profile-method) reads the AS2 identifier into **Organization**, alternatively you can save the AS2 identifier by setting **Organization** and invoking [save_profile](#save_profile-method). # partner_count property The number of partners found in DataDir . ## Syntax ```text def get_partner_count() -> int: ... partner_count = property(get_partner_count, None) ``` ## Default Value 0 ## Remarks This property returns the number of partners found in [data_dir](#data_dir-property). This property is populated after calling [list_partners](#list_partners-method). This property is read-only. # request_mdn property Preference to receive MDNs from trading partner. ## Syntax ```text def get_request_mdn() -> bool: ... def set_request_mdn(value: bool) -> None: ... request_mdn = property(get_request_mdn, set_request_mdn) ``` ## 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 [load_profile](#load_profile-method), the **RequireMDN** will contain your preference of receiving MDNs, alternatively **RequireMDN** may be set and saved by invoking [save_profile](#save_profile-method). # request_mdn_signed property Preference to request for signed MDNs. ## Syntax ```text def get_request_mdn_signed() -> bool: ... def set_request_mdn_signed(value: bool) -> None: ... request_mdn_signed = property(get_request_mdn_signed, set_request_mdn_signed) ``` ## Default Value TRUE ## Remarks **MDNRequestSigned** is used to store your preference of requesting signed MDNs from your trading partner. After invoking [load_profile](#load_profile-method), the **MDNRequestSigned** will contain your preference of requesting signed MDNs, alternatively **MDNRequestSigned** may be set and saved by invoking [save_profile](#save_profile-method). # request_mdn_synchronous property Preference to request for synchronous MDNs. ## Syntax ```text def get_request_mdn_synchronous() -> bool: ... def set_request_mdn_synchronous(value: bool) -> None: ... request_mdn_synchronous = property(get_request_mdn_synchronous, set_request_mdn_synchronous) ``` ## Default Value TRUE ## Remarks **MDNRequestSynchronous** is used to store your preference of requesting synchronous MDNs from your trading partner. After invoking [load_profile](#load_profile-method), the **MDNRequestSynchronous** will contain your preference of requesting synchronous MDNs, alternatively **MDNRequestSynchronous** may be set and saved by invoking [save_profile](#save_profile-method). # require_encrypt property Preference to receive encrypted messages. ## Syntax ```text def get_require_encrypt() -> bool: ... def set_require_encrypt(value: bool) -> None: ... require_encrypt = property(get_require_encrypt, set_require_encrypt) ``` ## Default Value FALSE ## Remarks **RequireEncrypt** is used to store your preference of receiving encrypted messages from your trading partner. After invoking [load_profile](#load_profile-method), the **RequireEncrypt** will contain your preference of receiving encrypted messages, alternatively **RequireEncrypt** may be set and saved by invoking [save_profile](#save_profile-method). # require_sign property Preference to receive signed messages. ## Syntax ```text def get_require_sign() -> bool: ... def set_require_sign(value: bool) -> None: ... require_sign = property(get_require_sign, set_require_sign) ``` ## Default Value FALSE ## Remarks **RequireSign** is used to store your preference of receiving signed messages from your trading partner. After invoking [load_profile](#load_profile-method), the **RequireSign** will contain your preference of receiving signed messages, alternatively **RequireSign** may be set and saved by invoking [save_profile](#save_profile-method). # signing_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_signing_cert_effective_date() -> str: ... signing_cert_effective_date = property(get_signing_cert_effective_date, None) ``` ## 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. # signing_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_signing_cert_encoded() -> bytes: ... def set_signing_cert_encoded(value: bytes) -> None: ... signing_cert_encoded = property(get_signing_cert_encoded, set_signing_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [signing_cert_store](#signing_cert_store-property) and [signing_cert_subject](#signing_cert_subject-property) properties also may be used to specify a certificate. When [signing_cert_encoded](#signing_cert_encoded-property) is set, a search is initiated in the current [signing_cert_store](#signing_cert_store-property) for the private key of the certificate. If the key is found, [signing_cert_subject](#signing_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [signing_cert_subject](#signing_cert_subject-property) is set to an empty string. # signing_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_signing_cert_expiration_date() -> str: ... signing_cert_expiration_date = property(get_signing_cert_expiration_date, None) ``` ## 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. # signing_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_signing_cert_extended_key_usage() -> str: ... signing_cert_extended_key_usage = property(get_signing_cert_extended_key_usage, None) ``` ## 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. # signing_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_signing_cert_fingerprint() -> str: ... signing_cert_fingerprint = property(get_signing_cert_fingerprint, None) ``` ## 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. # signing_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_signing_cert_fingerprint_sha1() -> str: ... signing_cert_fingerprint_sha1 = property(get_signing_cert_fingerprint_sha1, None) ``` ## 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. # signing_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_signing_cert_fingerprint_sha256() -> str: ... signing_cert_fingerprint_sha256 = property(get_signing_cert_fingerprint_sha256, None) ``` ## 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. # signing_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_signing_cert_issuer() -> str: ... signing_cert_issuer = property(get_signing_cert_issuer, None) ``` ## 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. # signing_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_signing_cert_private_key() -> str: ... signing_cert_private_key = property(get_signing_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [signing_cert_private_key](#signing_cert_private_key-property) may be available but not exportable. In this case, [signing_cert_private_key](#signing_cert_private_key-property) returns an empty string. This property is read-only. # signing_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_signing_cert_private_key_available() -> bool: ... signing_cert_private_key_available = property(get_signing_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [signing_cert_private_key](#signing_cert_private_key-property) is available for the selected certificate. If [signing_cert_private_key_available](#signing_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # signing_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_signing_cert_private_key_container() -> str: ... signing_cert_private_key_container = property(get_signing_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [signing_cert_private_key](#signing_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # signing_cert_public_key property The public key of the certificate. ## Syntax ```text def get_signing_cert_public_key() -> str: ... signing_cert_public_key = property(get_signing_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # signing_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_signing_cert_public_key_algorithm() -> str: ... signing_cert_public_key_algorithm = property(get_signing_cert_public_key_algorithm, None) ``` ## 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. # signing_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_signing_cert_public_key_length() -> int: ... signing_cert_public_key_length = property(get_signing_cert_public_key_length, None) ``` ## 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. # signing_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_signing_cert_serial_number() -> str: ... signing_cert_serial_number = property(get_signing_cert_serial_number, None) ``` ## 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. # signing_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_signing_cert_signature_algorithm() -> str: ... signing_cert_signature_algorithm = property(get_signing_cert_signature_algorithm, None) ``` ## 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. # signing_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_signing_cert_store() -> bytes: ... def set_signing_cert_store(value: bytes) -> None: ... signing_cert_store = property(get_signing_cert_store, set_signing_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [signing_cert_store_type](#signing_cert_store_type-property) property denotes the type of the certificate store specified by [signing_cert_store](#signing_cert_store-property). If the store is password-protected, specify the password in [signing_cert_store_password](#signing_cert_store_password-property). [signing_cert_store](#signing_cert_store-property) is used in conjunction with the [signing_cert_subject](#signing_cert_subject-property) property to specify client certificates. If [signing_cert_store](#signing_cert_store-property) has a value, and [signing_cert_subject](#signing_cert_subject-property) or [signing_cert_encoded](#signing_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [signing_cert_subject](#signing_cert_subject-property) 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). # signing_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_signing_cert_store_password() -> str: ... def set_signing_cert_store_password(value: str) -> None: ... signing_cert_store_password = property(get_signing_cert_store_password, set_signing_cert_store_password) ``` ## 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. # signing_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_signing_cert_store_type() -> int: ... def set_signing_cert_store_type(value: int) -> None: ... signing_cert_store_type = property(get_signing_cert_store_type, set_signing_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [signing_cert_store_type](#signing_cert_store_type-property), the full path of the PKCS#11 DLL as the [signing_cert_store](#signing_cert_store-property), and the PIN as the [signing_cert_store_password](#signing_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [signing_cert_store](#signing_cert_store-property) and set [signing_cert_store_password](#signing_cert_store_password-property) 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. | # signing_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_signing_cert_subject() -> str: ... def set_signing_cert_subject(value: str) -> None: ... signing_cert_subject = property(get_signing_cert_subject, set_signing_cert_subject) ``` ## 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. # signing_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_signing_cert_subject_alt_names() -> str: ... signing_cert_subject_alt_names = property(get_signing_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # signing_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_signing_cert_thumbprint_md5() -> str: ... signing_cert_thumbprint_md5 = property(get_signing_cert_thumbprint_md5, None) ``` ## 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. # signing_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_signing_cert_thumbprint_sha1() -> str: ... signing_cert_thumbprint_sha1 = property(get_signing_cert_thumbprint_sha1, None) ``` ## 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. # signing_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_signing_cert_thumbprint_sha256() -> str: ... signing_cert_thumbprint_sha256 = property(get_signing_cert_thumbprint_sha256, None) ``` ## 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. # signing_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_signing_cert_usage() -> str: ... signing_cert_usage = property(get_signing_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [signing_cert_usage_flags](#signing_cert_usage_flags-property). 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. # signing_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_signing_cert_usage_flags() -> int: ... signing_cert_usage_flags = property(get_signing_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [signing_cert_usage_flags](#signing_cert_usage_flags-property) 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 [signing_cert_usage](#signing_cert_usage-property) property for a text representation of [signing_cert_usage_flags](#signing_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # signing_cert_version property The certificate's version number. ## Syntax ```text def get_signing_cert_version() -> str: ... signing_cert_version = property(get_signing_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_cert_effective_date() -> str: ... ssl_cert_effective_date = property(get_ssl_cert_effective_date, None) ``` ## 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. # ssl_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ... ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string. # ssl_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_cert_expiration_date() -> str: ... ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None) ``` ## 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. # ssl_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_cert_extended_key_usage() -> str: ... ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None) ``` ## 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. # ssl_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint() -> str: ... ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None) ``` ## 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. # ssl_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha1() -> str: ... ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None) ``` ## 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. # ssl_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha256() -> str: ... ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None) ``` ## 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. # ssl_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_cert_issuer() -> str: ... ssl_cert_issuer = property(get_ssl_cert_issuer, None) ``` ## 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. # ssl_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key() -> str: ... ssl_cert_private_key = property(get_ssl_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) returns an empty string. This property is read-only. # ssl_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_cert_private_key_available() -> bool: ... ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key_container() -> str: ... ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_cert_public_key() -> str: ... ssl_cert_public_key = property(get_ssl_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_cert_public_key_algorithm() -> str: ... ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None) ``` ## 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. # ssl_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_cert_public_key_length() -> int: ... ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None) ``` ## 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. # ssl_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_cert_serial_number() -> str: ... ssl_cert_serial_number = property(get_ssl_cert_serial_number, None) ``` ## 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. # ssl_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_cert_signature_algorithm() -> str: ... ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None) ``` ## 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. # ssl_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ... ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property). [ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property) 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). # ssl_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ... ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password) ``` ## 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. # ssl_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ... ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [ssl_cert_store](#ssl_cert_store-property) and set [ssl_cert_store_password](#ssl_cert_store_password-property) 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. | # ssl_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ... ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject) ``` ## 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. # ssl_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_cert_subject_alt_names() -> str: ... ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_md5() -> str: ... ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None) ``` ## 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. # ssl_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha1() -> str: ... ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None) ``` ## 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. # ssl_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha256() -> str: ... ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None) ``` ## 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. # ssl_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_cert_usage() -> str: ... ssl_cert_usage = property(get_ssl_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). 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. # ssl_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_cert_usage_flags() -> int: ... ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) 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 [ssl_cert_usage](#ssl_cert_usage-property) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_cert_version() -> str: ... ssl_cert_version = property(get_ssl_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # url property The URL for posting EDI data. ## Syntax ```text def get_url() -> str: ... def set_url(value: str) -> None: ... url = property(get_url, set_url) ``` ## 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 [load_profile](#load_profile-method) or [save_profile](#save_profile-method), **URL** refers to the URL that your trading partners use to post data to you. After invoking [load_profile](#load_profile-method), the **URL** will contain the URL of your trading partner, alternatively **URL** may be set and saved by invoking [save_profile](#save_profile-method). # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#as2profilemgr-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#as2profilemgr-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # delete_profile method Deletes the configuration of the specified partner. ## Syntax ```text def delete_profile(partner_organization: str) -> None: ... ``` ## 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. # get_property method Gets the property propName . ## Syntax ```text def get_property(prop_name: str) -> str: ... ``` ## Remarks **GetProperty** can be used to query any property from "self" or partner profile. It is specially useful in retrieving properties not interpreted by [AS2Sender](AS2Sender.md#AS2Sender) [AS2Receiver](AS2Receiver.md#AS2Receiver) classes and thus not exposed as **AS2ProfileMgr** properties. **GetProperty** returns *null* if property *propName* was not read by [load_profile](#load_profile-method). # get_tp_info method Gets the profile of the specified partner as a XML TPInfo. ## Syntax ```text def get_tp_info(partner_organization: str) -> str: ... ``` ## 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*. # list_partners method Lists trading partners known to the AS2ProfileMgr . ## Syntax ```text def list_partners() -> None: ... ``` ## Remarks Invoking *ListPartners* causes the event [on_partner](#on_partner-event) to be fired for each trading partner profile found by the **AS2ProfileMgr** class. After this method returns [partner_count](#partner_count-property) is populated with the number of found partners. # list_properties method Lists the properties read from self or partner profile. ## Syntax ```text def list_properties() -> None: ... ``` ## Remarks Invoking *ListProperties* causes the event [on_property](#on_property-event) to be fired for each property read by [load_profile](#load_profile-method). # load_profile method Loads the profile of the trading partner identified by partnerOrganization . ## Syntax ```text def load_profile(partner_organization: str) -> None: ... ``` ## 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 [data_dir](#data_dir-property). The name of the sub-directory is derived from *partnerOrganization*. Although all properties are read from the partner profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes. **Partner Settings** - [organization](#organization-property) - [url](#url-property) - [option_sign](#option_sign-property) - [option_encrypt](#option_encrypt-property) - [option_compress](#option_compress-property) - [require_sign](#require_sign-property) - [require_encrypt](#require_encrypt-property) - [request_mdn](#request_mdn-property) - [request_mdn_signed](#request_mdn_signed-property) - [request_mdn_synchronous](#request_mdn_synchronous-property) - encryption_cert - signing_cert - ssl_cert 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 [data_dir](#data_dir-property). Although all properties are read from the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes. **My Settings** - [organization](#organization-property) - [url](#url-property) - [email](#email-property) - encryption_cert - signing_cert - ssl_cert - [async_mdnurl](#async_mdnurl-property) Note: "self" cannot be the name of a trading partner organization. # reset method Resets the state of the control. ## Syntax ```text def reset() -> None: ... ``` ## Remarks Resets all properties. After invoking this method the class may be reused as if it were newly created. # save_profile method Saves the profile of the trading partner identified by partnerOrganization . ## Syntax ```text def save_profile(partner_organization: str) -> None: ... ``` ## 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 [data_dir](#data_dir-property). The name of the sub-directory is derived from *partnerOrganization*. In addition to saving the partner profile, **SaveProfile** also creates the following directories if [create_dir_struct](#create_dir_struct-property) is set to true. | | | | --- | --- | | [dir_deleted](#dir_deleted-property) | Deleted files. | | [dir_incoming](#dir_incoming-property) | Received files. | | [dir_logs](#dir_logs-property) | Log files. | | [dir_outgoing](#dir_outgoing-property) | Files to be sent. | | [dir_pending](#dir_pending-property) | Files pending async MDN. | | [dir_pending_info](#dir_pending_info-property) | Files having data to verify async MSN. | | [dir_sent](#dir_sent-property) | Sent files. | Although any number of properties may be saved to the partner profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes. **Partner Settings** - [organization](#organization-property) - [url](#url-property) - [option_sign](#option_sign-property) - [option_encrypt](#option_encrypt-property) - [option_compress](#option_compress-property) - [require_sign](#require_sign-property) - [require_encrypt](#require_encrypt-property) - [request_mdn](#request_mdn-property) - [request_mdn_signed](#request_mdn_signed-property) - [request_mdn_synchronous](#request_mdn_synchronous-property) - encryption_cert - signing_cert - ssl_cert If the *partnerOrganization* specified is "self", the properties of **AS2ProfileMgr** are saved to the XML file *me.cfg* placed in [data_dir](#data_dir-property). Although any number of properties may be saved to the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes. **My Settings** - [organization](#organization-property) - [url](#url-property) - [email](#email-property) - encryption_cert - signing_cert - ssl_cert - [async_mdnurl](#async_mdnurl-property) Note: "self" cannot be the name of a trading partner organization. # set_property method Sets the property propName to propValue . ## Syntax ```text def set_property(prop_name: str, prop_value: str) -> None: ... ``` ## Remarks **SetProperty** can be used to set any property in self or partner profile. It is specially useful in setting properties not interpreted by [AS2Sender](AS2Sender.md#AS2Sender) [AS2Receiver](AS2Receiver.md#AS2Receiver) classes and thus not exposed as **AS2ProfileMgr** properties. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class AS2ProfileMgrErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class AS2ProfileMgr: @property def on_error() -> Callable[[AS2ProfileMgrErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[AS2ProfileMgrErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *error_code* 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](#as2profilemgr-errors) section. # on_partner event Fired when ListPartners is invoked. ## Syntax ```text class AS2ProfileMgrPartnerEventParams(object): @property def partner_identifier() -> str: ... @property def partner_url() -> str: ... # In class AS2ProfileMgr: @property def on_partner() -> Callable[[AS2ProfileMgrPartnerEventParams], None]: ... @on_partner.setter def on_partner(event_hook: Callable[[AS2ProfileMgrPartnerEventParams], None]) -> None: ... ``` ## Remarks This event is fired when [list_partners](#list_partners-method) is called. It fires for each partner found by the **AS2ProfileMgr** in [data_dir](#data_dir-property). The parameter *partnerIdentifier* is same as provided to [save_profile](#save_profile-method) to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from *partnerURL*. # on_partner_directory event Fired before accessing partner.cfg of a trading partner. ## Syntax ```text class AS2ProfileMgrPartnerDirectoryEventParams(object): @property def name() -> str: ... @property def directory() -> str: ... @directory.setter def directory(value) -> None: ... # In class AS2ProfileMgr: @property def on_partner_directory() -> Callable[[AS2ProfileMgrPartnerDirectoryEventParams], None]: ... @on_partner_directory.setter def on_partner_directory(event_hook: Callable[[AS2ProfileMgrPartnerDirectoryEventParams], None]) -> None: ... ``` ## Remarks This event is fired every time *partner.cfg* needs to be accessed i.e when [load_profile](#load_profile-method) or [get_tp_info](#get_tp_info-method) are invoked with partner name not being "self". The *Name* provides the partner name and *Directory* indicates the directory in which partner profile is expected. Setting *Directory* to a different path will make the component look for *partner.cfg* in that directory. Note: PartnerDirectory event is not fired when [list_partners](#list_partners-method) is invoked. # on_property event Fired when ListProperties is invoked. ## Syntax ```text class AS2ProfileMgrPropertyEventParams(object): @property def prop_name() -> str: ... @property def prop_value() -> str: ... # In class AS2ProfileMgr: @property def on_property() -> Callable[[AS2ProfileMgrPropertyEventParams], None]: ... @on_property.setter def on_property(event_hook: Callable[[AS2ProfileMgrPropertyEventParams], None]) -> None: ... ``` ## Remarks This event is fired when [list_properties](#list_properties-method) is called. It fires for each property read by [load_profile](#load_profile-method). The parameters *propName* and *propValue* provide property name and value respectively. # AS2ProfileMgr Config Settings The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [config](#config-method) method. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *True*, the class 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 classes 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 class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *False* by default. On Linux/macOS, this setting is set to *True* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # AS2ProfileMgr Errors ### 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. |