# XMLEncrypt Class The XMLEncrypt class is used to encrypt and decrypt XML. ## Syntax ```text class ipworksencrypt.XMLEncrypt ``` ## Remarks The XMLEncrypt class provides a simple API for encrypting and decrypting XML. The [encrypt](#encrypt-method) method will encrypt the XML document, or a specific element. Multiple elements may be encrypted at one time by setting encrypted_data_details. The [decrypt](#decrypt-method) method will decrypt the XML document. The class supports encrypting and decrypting with a shared [symmetric_key](#symmetric_key-property), and also using asymmetric encryption to encrypt the [symmetric_key](#symmetric_key-property) (session key) via the recipient_cert and certificate properties. **Encrypt** To begin first specify a XML document by setting [input_file](#input_file-property), or [input_xml](#input_xml-property). The encrypted_data_details property specify the XML element to encrypt. By default the entire XML document is encrypted. The [symmetric_key](#symmetric_key-property) property specifies the key which will be used to encrypt the data. If the recipient_cert property is set, then the [symmetric_key](#symmetric_key-property) will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key ([symmetric_key](#symmetric_key-property)) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, recipient_cert MUST have a RSA key, not a DSA key. If the recipient_cert property is not set, then the recipient must know the value of [symmetric_key](#symmetric_key-property) before decrypting the XML. The [KeyName](#KeyName) setting may be set to provide a key identifier to the recipient. Optionally set [encrypting_algorithm](#encrypting_algorithm-property), and then call [encrypt](#encrypt-method) to encrypt the XML. The following properties are applicable when calling this method: - [symmetric_key](#symmetric_key-property) (required) - [encrypting_algorithm](#encrypting_algorithm-property) - encrypted_data_details - recipient_cert - [KeyName](#KeyName) **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. **Decrypt** To begin first specify a XML document by setting [input_file](#input_file-property), or [input_xml](#input_xml-property). The [symmetric_key](#symmetric_key-property) property specifies the key used to decrypt the data. This may be set before calling [decrypt](#decrypt-method) or inside the [on_encrypted_data_info](#on_encrypted_data_info-event) event. The [on_encrypted_data_info](#on_encrypted_data_info-event) event fires once for each encrypted element when [decrypt](#decrypt-method) is called. If the data was encrypted using an session key, set the certificate property to the certificate with private key before calling [decrypt](#decrypt-method). The certificate will be used to decrypt the encrypted session key. In this case the [symmetric_key](#symmetric_key-property) property is ignored. The following properties are applicable when calling this method: - [symmetric_key](#symmetric_key-property) - certificate **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [cert_effective_date](#cert_effective_date-property) | The date on which this certificate becomes valid. | | [cert_encoded](#cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [cert_expiration_date](#cert_expiration_date-property) | The date on which the certificate expires. | | [cert_extended_key_usage](#cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [cert_fingerprint](#cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [cert_fingerprint_sha1](#cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [cert_fingerprint_sha256](#cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [cert_issuer](#cert_issuer-property) | The issuer of the certificate. | | [cert_private_key](#cert_private_key-property) | The private key of the certificate (if available). | | [cert_private_key_available](#cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [cert_private_key_container](#cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [cert_public_key](#cert_public_key-property) | The public key of the certificate. | | [cert_public_key_algorithm](#cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [cert_public_key_length](#cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [cert_serial_number](#cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [cert_signature_algorithm](#cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [cert_store](#cert_store-property) | The name of the certificate store for the client certificate. | | [cert_store_password](#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. | | [cert_store_type](#cert_store_type-property) | The type of certificate store for this certificate. | | [cert_subject](#cert_subject-property) | The subject of the certificate used for client authentication. | | [cert_subject_alt_names](#cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [cert_thumbprint_md5](#cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [cert_thumbprint_sha1](#cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [cert_thumbprint_sha256](#cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [cert_usage](#cert_usage-property) | The text description of UsageFlags . | | [cert_usage_flags](#cert_usage_flags-property) | The flags that show intended use for the certificate. | | [cert_version](#cert_version-property) | The certificate's version number. | | [encrypted_data_detail_count](#encrypted_data_detail_count-property) | The number of records in the EncryptedDataDetail arrays. | | [encrypted_data_detail_id](#encrypted_data_detail_id-property) | This property is an optional identifier for the encrypted data. | | [encrypted_data_detail_mime_type](#encrypted_data_detail_mime_type-property) | This property specifies the MIME type of the encrypted data. | | [encrypted_data_detail_scope](#encrypted_data_detail_scope-property) | This property specifies the scope of the encryption. | | [encrypted_data_detail_xml_element](#encrypted_data_detail_xml_element-property) | This property specifies the XPath to the element which will be encrypted. | | [encrypting_algorithm](#encrypting_algorithm-property) | Then encryption algorithm used when encrypting. | | [input_file](#input_file-property) | The XML file to process. | | [input_xml](#input_xml-property) | The XML to process. | | [output_file](#output_file-property) | The output file. | | [output_xml](#output_xml-property) | The output XML after processing. | | [overwrite](#overwrite-property) | Indicates whether or not the class should overwrite files. | | [recipient_cert_effective_date](#recipient_cert_effective_date-property) | The date on which this certificate becomes valid. | | [recipient_cert_encoded](#recipient_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [recipient_cert_expiration_date](#recipient_cert_expiration_date-property) | The date on which the certificate expires. | | [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [recipient_cert_fingerprint](#recipient_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [recipient_cert_issuer](#recipient_cert_issuer-property) | The issuer of the certificate. | | [recipient_cert_private_key](#recipient_cert_private_key-property) | The private key of the certificate (if available). | | [recipient_cert_private_key_available](#recipient_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [recipient_cert_private_key_container](#recipient_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [recipient_cert_public_key](#recipient_cert_public_key-property) | The public key of the certificate. | | [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [recipient_cert_public_key_length](#recipient_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [recipient_cert_serial_number](#recipient_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [recipient_cert_store](#recipient_cert_store-property) | The name of the certificate store for the client certificate. | | [recipient_cert_store_password](#recipient_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. | | [recipient_cert_store_type](#recipient_cert_store_type-property) | The type of certificate store for this certificate. | | [recipient_cert_subject](#recipient_cert_subject-property) | The subject of the certificate used for client authentication. | | [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [recipient_cert_usage](#recipient_cert_usage-property) | The text description of UsageFlags . | | [recipient_cert_usage_flags](#recipient_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [recipient_cert_version](#recipient_cert_version-property) | The certificate's version number. | | [symmetric_key](#symmetric_key-property) | The symmetric key used to encrypt and decrypt the XML. | | [use_oaep](#use_oaep-property) | Whether to use Optimal Asymmetric Encryption Padding (OAEP). | ## 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. | | [decrypt](#decrypt-method) | Decrypts the XML. | | [do_events](#do_events-method) | This method processes events from the internal message queue. | | [encrypt](#encrypt-method) | Encrypts the XML. | | [reset](#reset-method) | Resets the class. | ## 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_encrypted_data_info](#on_encrypted_data_info-event) | Fired once for each encrypted element when Decrypt is called. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_progress](#on_progress-event) | Fired as progress is made. | | [on_status](#on_status-event) | Provides information about the current operation. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DecryptWithCryptoAPI](#DecryptWithCryptoAPI) | Whether to use the Crypto API for decrypt operations. | | [EncryptedKeyXPath](#EncryptedKeyXPath) | The XPath of the EncryptedKey element. | | [KeyName](#KeyName) | The name of the key used to encrypt the XML. | | [LogLevel](#LogLevel) | Specifies the level of detail that is logged. | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used with OAEP. | | [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters. | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used with OAEP. | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used when encrypting a key. | | [ReadFromProgressEvent](#ReadFromProgressEvent) | Whether to read input data from inside the progress event. | | [WriteToProgressEvent](#WriteToProgressEvent) | Whether to write output data so it is accessible from inside the progress event. | | [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. | # cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_cert_effective_date() -> str: ... cert_effective_date = property(get_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. # cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_cert_encoded() -> bytes: ... def set_cert_encoded(value: bytes) -> None: ... cert_encoded = property(get_cert_encoded, set_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [cert_store](#cert_store-property) and [cert_subject](#cert_subject-property) properties also may be used to specify a certificate. When [cert_encoded](#cert_encoded-property) is set, a search is initiated in the current [cert_store](#cert_store-property) for the private key of the certificate. If the key is found, [cert_subject](#cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [cert_subject](#cert_subject-property) is set to an empty string. # cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_cert_expiration_date() -> str: ... cert_expiration_date = property(get_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. # cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_cert_extended_key_usage() -> str: ... cert_extended_key_usage = property(get_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. # cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint() -> str: ... cert_fingerprint = property(get_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. # cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint_sha1() -> str: ... cert_fingerprint_sha1 = property(get_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. # cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint_sha256() -> str: ... cert_fingerprint_sha256 = property(get_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. # cert_issuer property The issuer of the certificate. ## Syntax ```text def get_cert_issuer() -> str: ... cert_issuer = property(get_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. # cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_cert_private_key() -> str: ... cert_private_key = property(get_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 [cert_private_key](#cert_private_key-property) may be available but not exportable. In this case, [cert_private_key](#cert_private_key-property) returns an empty string. This property is read-only. # cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_cert_private_key_available() -> bool: ... cert_private_key_available = property(get_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [cert_private_key](#cert_private_key-property) is available for the selected certificate. If [cert_private_key_available](#cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_cert_private_key_container() -> str: ... cert_private_key_container = property(get_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [cert_private_key](#cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # cert_public_key property The public key of the certificate. ## Syntax ```text def get_cert_public_key() -> str: ... cert_public_key = property(get_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. # cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_cert_public_key_algorithm() -> str: ... cert_public_key_algorithm = property(get_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. # cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_cert_public_key_length() -> int: ... cert_public_key_length = property(get_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. # cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_cert_serial_number() -> str: ... cert_serial_number = property(get_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. # cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_cert_signature_algorithm() -> str: ... cert_signature_algorithm = property(get_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. # cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_cert_store() -> bytes: ... def set_cert_store(value: bytes) -> None: ... cert_store = property(get_cert_store, set_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [cert_store_type](#cert_store_type-property) property denotes the type of the certificate store specified by [cert_store](#cert_store-property). If the store is password-protected, specify the password in [cert_store_password](#cert_store_password-property). [cert_store](#cert_store-property) is used in conjunction with the [cert_subject](#cert_subject-property) property to specify client certificates. If [cert_store](#cert_store-property) has a value, and [cert_subject](#cert_subject-property) or [cert_encoded](#cert_encoded-property) is set, a search for a certificate is initiated. Please see the [cert_subject](#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). # 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_cert_store_password() -> str: ... def set_cert_store_password(value: str) -> None: ... cert_store_password = property(get_cert_store_password, set_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. # cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_cert_store_type() -> int: ... def set_cert_store_type(value: int) -> None: ... cert_store_type = property(get_cert_store_type, set_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 [cert_store_type](#cert_store_type-property), the full path of the PKCS#11 DLL as the [cert_store](#cert_store-property), and the PIN as the [cert_store_password](#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 [cert_store](#cert_store-property) and set [cert_store_password](#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. | # cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_cert_subject() -> str: ... def set_cert_subject(value: str) -> None: ... cert_subject = property(get_cert_subject, set_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. # cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_cert_subject_alt_names() -> str: ... cert_subject_alt_names = property(get_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_md5() -> str: ... cert_thumbprint_md5 = property(get_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. # cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_sha1() -> str: ... cert_thumbprint_sha1 = property(get_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. # cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_sha256() -> str: ... cert_thumbprint_sha256 = property(get_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. # cert_usage property The text description of UsageFlags . ## Syntax ```text def get_cert_usage() -> str: ... cert_usage = property(get_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [cert_usage_flags](#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. # cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_cert_usage_flags() -> int: ... cert_usage_flags = property(get_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [cert_usage_flags](#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 [cert_usage](#cert_usage-property) property for a text representation of [cert_usage_flags](#cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # cert_version property The certificate's version number. ## Syntax ```text def get_cert_version() -> str: ... cert_version = property(get_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. # encrypted_data_detail_count property The number of records in the EncryptedDataDetail arrays. ## Syntax ```text def get_encrypted_data_detail_count() -> int: ... def set_encrypted_data_detail_count(value: int) -> None: ... encrypted_data_detail_count = property(get_encrypted_data_detail_count, set_encrypted_data_detail_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [encrypted_data_detail_id](#encrypted_data_detail_id-property) - [encrypted_data_detail_mime_type](#encrypted_data_detail_mime_type-property) - [encrypted_data_detail_scope](#encrypted_data_detail_scope-property) - [encrypted_data_detail_xml_element](#encrypted_data_detail_xml_element-property) The array indices start at *0* and end at *encrypted_data_detail_count - 1*. # encrypted_data_detail_id property This property is an optional identifier for the encrypted data. ## Syntax ```text def get_encrypted_data_detail_id(encrypted_data_detail_index: int) -> str: ... def set_encrypted_data_detail_id(encrypted_data_detail_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks This property is an optional identifier for the encrypted data. The *encrypted_data_detail_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [encrypted_data_detail_count](#encrypted_data_detail_count-property) property. # encrypted_data_detail_mime_type property This property specifies the MIME type of the encrypted data. ## Syntax ```text def get_encrypted_data_detail_mime_type(encrypted_data_detail_index: int) -> str: ... def set_encrypted_data_detail_mime_type(encrypted_data_detail_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks This property specifies the MIME type of the encrypted data. For example: "image/png". This property is optional. The *encrypted_data_detail_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [encrypted_data_detail_count](#encrypted_data_detail_count-property) property. # encrypted_data_detail_scope property This property specifies the scope of the encryption. ## Syntax ```text def get_encrypted_data_detail_scope(encrypted_data_detail_index: int) -> int: ... def set_encrypted_data_detail_scope(encrypted_data_detail_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Element1 # Content ``` ## Default Value 0 ## Remarks This property specifies the scope of the encryption. When calling encrypt the entire XML element specified by [encrypted_data_detail_xml_element](#encrypted_data_detail_xml_element-property) may be encrypted, or only the content may be encrypted. This setting controls the scope of the encryption. Possible values are: | | | | --- | --- | | 0 (sElement - default) | The entire XML element is encrypted. | | 1 (sContent) | Only the content of the XML element is encrypted. | The *encrypted_data_detail_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [encrypted_data_detail_count](#encrypted_data_detail_count-property) property. # encrypted_data_detail_xml_element property This property specifies the XPath to the element which will be encrypted. ## Syntax ```text def get_encrypted_data_detail_xml_element(encrypted_data_detail_index: int) -> str: ... def set_encrypted_data_detail_xml_element(encrypted_data_detail_index: int, value: str) -> None: ... ``` ## Default Value "/" ## Remarks This property specifies the XPath to the element which will be encrypted. For instance: | | | | --- | --- | | /root/myElement | XPath syntax | | /root/[1] | XPath syntax using an index | | /root/ns:myElement | XPath syntax where the element has a namespace | | myElement | Just the element name | | @id=myid | Attribute selector: This will select an element with an attribute "id" whose value is "myid". | | /root/myElement[1]/ns:name2[@attr=attrValue] | XPath syntax using an index and attribute selector | The *encrypted_data_detail_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [encrypted_data_detail_count](#encrypted_data_detail_count-property) property. # encrypting_algorithm property Then encryption algorithm used when encrypting. ## Syntax ```text def get_encrypting_algorithm() -> str: ... def set_encrypting_algorithm(value: str) -> None: ... encrypting_algorithm = property(get_encrypting_algorithm, set_encrypting_algorithm) ``` ## Default Value "3DES" ## Remarks This property specifies the encryption algorithm to use when encrypting. Possible values are: - "3DES" (default) - "DES" - "AES128" - "AES192" - "AES256" # input_file property The XML file to process. ## Syntax ```text def get_input_file() -> str: ... def set_input_file(value: str) -> None: ... input_file = property(get_input_file, set_input_file) ``` ## Default Value "" ## Remarks This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - input_file - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. # input_xml property The XML to process. ## Syntax ```text def get_input_xml() -> str: ... def set_input_xml(value: str) -> None: ... input_xml = property(get_input_xml, set_input_xml) ``` ## Default Value "" ## Remarks This property specifies the XML to be processed. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - input_xml When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. # output_file property The output file. ## Syntax ```text def get_output_file() -> str: ... def set_output_file(value: str) -> None: ... output_file = property(get_output_file, set_output_file) ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written. This may be set to an absolute or relative path. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - output_file - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. # output_xml property The output XML after processing. ## Syntax ```text def get_output_xml() -> str: ... def set_output_xml(value: str) -> None: ... output_xml = property(get_output_xml, set_output_xml) ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [output_file](#output_file-property) is not set. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - output_xml: The output data is written to this property if no other destination is specified. # overwrite property Indicates whether or not the class should overwrite files. ## Syntax ```text def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ... overwrite = property(get_overwrite, set_overwrite) ``` ## Default Value FALSE ## Remarks This property indicates whether or not the class will overwrite [output_file](#output_file-property). If overwrite is False, an error will be thrown whenever [output_file](#output_file-property) exists before an operation. The default value is False. # recipient_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_recipient_cert_effective_date() -> str: ... recipient_cert_effective_date = property(get_recipient_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. # recipient_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_recipient_cert_encoded() -> bytes: ... def set_recipient_cert_encoded(value: bytes) -> None: ... recipient_cert_encoded = property(get_recipient_cert_encoded, set_recipient_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [recipient_cert_store](#recipient_cert_store-property) and [recipient_cert_subject](#recipient_cert_subject-property) properties also may be used to specify a certificate. When [recipient_cert_encoded](#recipient_cert_encoded-property) is set, a search is initiated in the current [recipient_cert_store](#recipient_cert_store-property) for the private key of the certificate. If the key is found, [recipient_cert_subject](#recipient_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [recipient_cert_subject](#recipient_cert_subject-property) is set to an empty string. # recipient_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_recipient_cert_expiration_date() -> str: ... recipient_cert_expiration_date = property(get_recipient_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. # recipient_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_recipient_cert_extended_key_usage() -> str: ... recipient_cert_extended_key_usage = property(get_recipient_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. # recipient_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint() -> str: ... recipient_cert_fingerprint = property(get_recipient_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. # recipient_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint_sha1() -> str: ... recipient_cert_fingerprint_sha1 = property(get_recipient_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. # recipient_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint_sha256() -> str: ... recipient_cert_fingerprint_sha256 = property(get_recipient_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. # recipient_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_recipient_cert_issuer() -> str: ... recipient_cert_issuer = property(get_recipient_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. # recipient_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_recipient_cert_private_key() -> str: ... recipient_cert_private_key = property(get_recipient_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 [recipient_cert_private_key](#recipient_cert_private_key-property) may be available but not exportable. In this case, [recipient_cert_private_key](#recipient_cert_private_key-property) returns an empty string. This property is read-only. # recipient_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_recipient_cert_private_key_available() -> bool: ... recipient_cert_private_key_available = property(get_recipient_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [recipient_cert_private_key](#recipient_cert_private_key-property) is available for the selected certificate. If [recipient_cert_private_key_available](#recipient_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # recipient_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_recipient_cert_private_key_container() -> str: ... recipient_cert_private_key_container = property(get_recipient_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [recipient_cert_private_key](#recipient_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # recipient_cert_public_key property The public key of the certificate. ## Syntax ```text def get_recipient_cert_public_key() -> str: ... recipient_cert_public_key = property(get_recipient_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. # recipient_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_recipient_cert_public_key_algorithm() -> str: ... recipient_cert_public_key_algorithm = property(get_recipient_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. # recipient_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_recipient_cert_public_key_length() -> int: ... recipient_cert_public_key_length = property(get_recipient_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. # recipient_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_recipient_cert_serial_number() -> str: ... recipient_cert_serial_number = property(get_recipient_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. # recipient_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_recipient_cert_signature_algorithm() -> str: ... recipient_cert_signature_algorithm = property(get_recipient_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. # recipient_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_recipient_cert_store() -> bytes: ... def set_recipient_cert_store(value: bytes) -> None: ... recipient_cert_store = property(get_recipient_cert_store, set_recipient_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [recipient_cert_store_type](#recipient_cert_store_type-property) property denotes the type of the certificate store specified by [recipient_cert_store](#recipient_cert_store-property). If the store is password-protected, specify the password in [recipient_cert_store_password](#recipient_cert_store_password-property). [recipient_cert_store](#recipient_cert_store-property) is used in conjunction with the [recipient_cert_subject](#recipient_cert_subject-property) property to specify client certificates. If [recipient_cert_store](#recipient_cert_store-property) has a value, and [recipient_cert_subject](#recipient_cert_subject-property) or [recipient_cert_encoded](#recipient_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [recipient_cert_subject](#recipient_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). # recipient_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_recipient_cert_store_password() -> str: ... def set_recipient_cert_store_password(value: str) -> None: ... recipient_cert_store_password = property(get_recipient_cert_store_password, set_recipient_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. # recipient_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_recipient_cert_store_type() -> int: ... def set_recipient_cert_store_type(value: int) -> None: ... recipient_cert_store_type = property(get_recipient_cert_store_type, set_recipient_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 [recipient_cert_store_type](#recipient_cert_store_type-property), the full path of the PKCS#11 DLL as the [recipient_cert_store](#recipient_cert_store-property), and the PIN as the [recipient_cert_store_password](#recipient_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 [recipient_cert_store](#recipient_cert_store-property) and set [recipient_cert_store_password](#recipient_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. | # recipient_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_recipient_cert_subject() -> str: ... def set_recipient_cert_subject(value: str) -> None: ... recipient_cert_subject = property(get_recipient_cert_subject, set_recipient_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. # recipient_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_recipient_cert_subject_alt_names() -> str: ... recipient_cert_subject_alt_names = property(get_recipient_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # recipient_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_md5() -> str: ... recipient_cert_thumbprint_md5 = property(get_recipient_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. # recipient_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_sha1() -> str: ... recipient_cert_thumbprint_sha1 = property(get_recipient_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. # recipient_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_sha256() -> str: ... recipient_cert_thumbprint_sha256 = property(get_recipient_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. # recipient_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_recipient_cert_usage() -> str: ... recipient_cert_usage = property(get_recipient_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [recipient_cert_usage_flags](#recipient_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. # recipient_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_recipient_cert_usage_flags() -> int: ... recipient_cert_usage_flags = property(get_recipient_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [recipient_cert_usage_flags](#recipient_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 [recipient_cert_usage](#recipient_cert_usage-property) property for a text representation of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # recipient_cert_version property The certificate's version number. ## Syntax ```text def get_recipient_cert_version() -> str: ... recipient_cert_version = property(get_recipient_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. # symmetric_key property The symmetric key used to encrypt and decrypt the XML. ## Syntax ```text def get_symmetric_key() -> bytes: ... def set_symmetric_key(value: bytes) -> None: ... symmetric_key = property(get_symmetric_key, set_symmetric_key) ``` ## Default Value "" ## Remarks This property specifies the symmetric key used to encrypt and decrypt the XML. **Encrypt Notes** When calling [encrypt](#encrypt-method) if the recipient_cert property is set, then the symmetric_key will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the symmetric_key allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the symmetric_key is required by the recipient. If the recipient_cert property is set and symmetric_key is left empty, then a symmetric_key value will automatically be generated by the class when [encrypt](#encrypt-method) is called. When calling [encrypt](#encrypt-method) if the recipient_cert property is are not set, then the symmetric_key value must be known by the recipient before the message can be decrypted. **Decrypt Notes** When calling [decrypt](#decrypt-method) if the data contains an encrypted key the class will attempt to use the certificate specified by the certificate property to decrypt the encrypted key and this property is ignored. When calling [decrypt](#decrypt-method) if the data does not contain an encrypted key then symmetric_key must be set either before calling [decrypt](#decrypt-method), or within the [on_encrypted_data_info](#on_encrypted_data_info-event) event. **Legal Key and Block Sizes (in bits)** | | | | | | --- | --- | --- | --- | | | AES | DES | 3DES | | Minimum Key Size | 128 | 64 | 128 | | Maximum Key Size | 256 | 64 | 192 | | Key Size Step | 64 | 0 | 64 | | Block Size | 128 | 64 | 64 | # use_oaep property Whether to use Optimal Asymmetric Encryption Padding (OAEP). ## Syntax ```text def get_use_oaep() -> bool: ... def set_use_oaep(value: bool) -> None: ... use_oaep = property(get_use_oaep, set_use_oaep) ``` ## Default Value FALSE ## Remarks This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the [symmetric_key](#symmetric_key-property) with the certificate specified by recipient_cert. It is only applicable when calling [encrypt](#encrypt-method) and recipient_cert is specified. By default this value is False and the class will use PKCS1. # 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](#xmlencrypt-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](#xmlencrypt-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # decrypt method Decrypts the XML. ## Syntax ```text def decrypt() -> None: ... ``` ## Remarks This method decrypts the specified XML. To begin first specify a XML document by setting [input_file](#input_file-property), or [input_xml](#input_xml-property). The [symmetric_key](#symmetric_key-property) property specifies the key used to decrypt the data. This may be set before calling decrypt or inside the [on_encrypted_data_info](#on_encrypted_data_info-event) event. The [on_encrypted_data_info](#on_encrypted_data_info-event) event fires once for each encrypted element when decrypt is called. If the data was encrypted using an session key, set the certificate property to the certificate with private key before calling decrypt. The certificate will be used to decrypt the encrypted session key. In this case the [symmetric_key](#symmetric_key-property) property is ignored. The following properties are applicable when calling this method: - [symmetric_key](#symmetric_key-property) - certificate **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. # do_events method This method processes events from the internal message queue. ## Syntax ```text def do_events() -> None: ... ``` ## Remarks When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # encrypt method Encrypts the XML. ## Syntax ```text def encrypt() -> None: ... ``` ## Remarks This method encrypts the specified XML. To begin first specify a XML document by setting [input_file](#input_file-property), or [input_xml](#input_xml-property). The encrypted_data_details property specify the XML element to encrypt. By default the entire XML document is encrypted. The [symmetric_key](#symmetric_key-property) property specifies the key which will be used to encrypt the data. If the recipient_cert property is set, then the [symmetric_key](#symmetric_key-property) will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key ([symmetric_key](#symmetric_key-property)) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, recipient_cert MUST have a RSA key, not a DSA key. If the recipient_cert property is not set, then the recipient must know the value of [symmetric_key](#symmetric_key-property) before decrypting the XML. The [KeyName](#KeyName) setting may be set to provide a key identifier to the recipient. Optionally set [encrypting_algorithm](#encrypting_algorithm-property), and then call encrypt to encrypt the XML. The following properties are applicable when calling this method: - [symmetric_key](#symmetric_key-property) (required) - [encrypting_algorithm](#encrypting_algorithm-property) - encrypted_data_details - recipient_cert - [KeyName](#KeyName) **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property) - [input_xml](#input_xml-property) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property) - [output_xml](#output_xml-property): The output data is written to this property if no other destination is specified. # reset method Resets the class. ## Syntax ```text def reset() -> None: ... ``` ## Remarks When called, the component will reset all of its properties to their default values. # on_encrypted_data_info event Fired once for each encrypted element when Decrypt is called. ## Syntax ```text class XMLEncryptEncryptedDataInfoEventParams(object): @property def encrypted_data_id() -> str: ... @property def scope() -> int: ... @property def mime_type() -> str: ... # In class XMLEncrypt: @property def on_encrypted_data_info() -> Callable[[XMLEncryptEncryptedDataInfoEventParams], None]: ... @on_encrypted_data_info.setter def on_encrypted_data_info(event_hook: Callable[[XMLEncryptEncryptedDataInfoEventParams], None]) -> None: ... ``` ## Remarks This event fires once for each encrypted element in the XML document when [decrypt](#decrypt-method) is called. The parameters of this event provide information about the encrypted data. Additionally, the [KeyName](#KeyName) setting may be queried to identify the encryption key. [symmetric_key](#symmetric_key-property) may be set from within this event. *EncryptedDataId* is the Id of the encrypted data (if any). *Scope* indicates the scope of the encrypted data. This defines whether the entire XML element was encrypted, or only the content. Possible values are: | | | | --- | --- | | 0 | Element | | 1 | Content | *MIMEType* holds the MIME type of the encrypted data (if any). For example: "image/png". # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class XMLEncryptErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class XMLEncrypt: @property def on_error() -> Callable[[XMLEncryptErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[XMLEncryptErrorEventParams], 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](#xmlencrypt-errors) section. # on_progress event Fired as progress is made. ## Syntax ```text class XMLEncryptProgressEventParams(object): @property def bytes_processed() -> int: ... @property def percent_processed() -> int: ... @property def operation() -> int: ... @property def is_eof() -> bool: ... @is_eof.setter def is_eof(value) -> None: ... # In class XMLEncrypt: @property def on_progress() -> Callable[[XMLEncryptProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[XMLEncryptProgressEventParams], None]) -> None: ... ``` ## Remarks This event is fired automatically as data is processed by the class. The *PercentProcessed* parameter indicates the current status of the operation. The *BytesProcessed* parameter holds the total number of bytes processed so far. The *Operation* parameter is only applicable when either [ReadFromProgressEvent](#ReadFromProgressEvent) or [WriteToProgressEvent](#WriteToProgressEvent) is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are: | | | | --- | --- | | 0 | None | | 1 | Read | | 2 | Write | The *IsEOF* parameter is only applicable when either [ReadFromProgressEvent](#ReadFromProgressEvent) or [WriteToProgressEvent](#WriteToProgressEvent) is set to True. This parameter defines whether the Read or Write operation is complete. When the *Operation* is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the *Operation* is Write (2) this value may be queried to determine when all data has been processed. # on_status event Provides information about the current operation. ## Syntax ```text class XMLEncryptStatusEventParams(object): @property def message() -> str: ... # In class XMLEncrypt: @property def on_status() -> Callable[[XMLEncryptStatusEventParams], None]: ... @on_status.setter def on_status(event_hook: Callable[[XMLEncryptStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. It may be used to track the progress of an operation. The level of detail is controlled by the [LogLevel](#LogLevel) setting. # XMLEncrypt 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. ### XMLEnc Config Settings **DecryptWithCryptoAPI**: Whether to use the Crypto API for decrypt operations.This setting determines whether to use the Microsoft Crypto API to decrypt. This is helpful in cases where the certificate is present in the Windows Certificate Store but the private key is not marked as exportable. For instance when using a USB security key. The default value is False. Note: This functionality is only available on Windows. **EncryptedKeyXPath**: The XPath of the EncryptedKey element.This setting specifies the XPath where the EncryptedKey element will be written. In most cases this does not need to be changed. By default it is included in the EncryptedData element. **KeyName**: The name of the key used to encrypt the XML.This setting optionally holds the key name which may be useful to the recipient to help identify the key used to encrypt the data. This may be set before calling [encrypt](#encrypt-method). When calling [decrypt](#decrypt-method) this may be queried inside the [on_encrypted_data_info](#on_encrypted_data_info-event) event. Note that this value is only informative, it does not affect processing. **LogLevel**: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the [on_status](#on_status-event) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This configuration setting specifies the MGF1 hash algorithm used when [use_oaep](#use_oaep-property) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" Note: This setting is not applicable when [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is set to *True* or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) and [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) values. In this case the [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is also used for MGF1. **OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [use_oaep](#use_oaep-property) is set to True. The specified value should be hex encoded. **OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This configuration setting specifies that RSA hash algorithm used when [use_oaep](#use_oaep-property) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the message content. Possible values are: - "SHA1" (default) - "SHA224" - "SHA256" - "SHA384" - "SHA512" **OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This configuration setting specifies that RSA hash algorithm used when [use_oaep](#use_oaep-property) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the message content. Possible values are: - "SHA1" (default) - "SHA224" - "SHA256" - "SHA384" - "SHA512" **ReadFromProgressEvent**: Whether to read input data from inside the progress event.When set to True this setting allows input data to be specified from within the [on_progress](#on_progress-event) event. The class will repeatedly fire the [on_progress](#on_progress-event) event to ask for data. Inside the event set [input_xml](#input_xml-property) when the *Operation* parameter of the event is 1 (Read). When all data has been provided set the *IsEOF* parameter of the event to True. This allows input data to be chunked and provided piece by piece. The default value is False. **WriteToProgressEvent**: Whether to write output data so it is accessible from inside the progress event.When set to True this setting allows output data to be obtained from within the [on_progress](#on_progress-event) event. The class will repeatedly fire the [on_progress](#on_progress-event) event to provide output data. Inside the event check [output_xml](#output_xml-property) when the *Operation* parameter of the event is 2 (Write). The *IsEOF* parameter should be checked inside the event to determine when all output data has been provided. This allows output data to be chunked and obtained piece by piece. The default value is False. ### 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](#do_events-method) 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. # XMLEncrypt Errors ### XMLEnc Errors | | | | --- | --- | | 607 | Failed to write output. | | 609 | Could not find encrypted data. | | 610 | Invalid encrypted data. | | 611 | Failed parsing certificate data. | | 612 | SymmetricKey or RecipientCert must be set. | ### XML Errors | | | | --- | --- | | 101 | Invalid attribute index. | | 102 | No attributes available. | | 103 | Invalid namespace index. | | 104 | No namespaces available. | | 105 | Invalid element index. | | 106 | No elements available. | | 107 | Attribute does not exist. | | 201 | Unbalanced element tag. | | 202 | Unknown element prefix (cannot find namespace). | | 203 | Unknown attribute prefix (cannot find namespace). | | 204 | Invalid XML markup. | | 205 | Invalid end state for parser. | | 206 | Document contains unbalanced elements. | | 207 | Invalid xpath. | | 208 | No such child. | | 209 | Top element does not match start of path. | | 210 | DOM tree unavailable (set build_dom to True and reparse). | | 302 | Cannot open file. | | 401 | Invalid XML would be generated. | | 402 | An invalid XML name has been specified. |