# XMLDecryptor Class

The XMLDecryptor class decrypts XML documents.

## Syntax

```text
class secureblackbox.XMLDecryptor
```

## Remarks

XMlDecryptor decrypts XML documents encrypted with certificates or generic keys.

## Property List

*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [decryption_key](#decryption_key-property) | The symmetric (session) key used to encrypt the data. |
| [encoding](#encoding-property) | Specifies XML encoding. |
| [encrypted_data_type](#encrypted_data_type-property) | Defines the type of data being encrypted. |
| [encryption_method](#encryption_method-property) | The encryption method used to encrypt the document. |
| [encrypt_key](#encrypt_key-property) | Specifies if the encryption key is encrypted. |
| [external_crypto_async_document_id](#external_crypto_async_document_id-property) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| [external_crypto_custom_params](#external_crypto_custom_params-property) | Custom parameters to be passed to the signing service (uninterpreted). |
| [external_crypto_data](#external_crypto_data-property) | Additional data to be included in the async state and mirrored back by the requestor. |
| [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property) | Specifies whether the message hash is to be calculated at the external endpoint. |
| [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property) | Specifies the request's signature hash algorithm. |
| [external_crypto_key_id](#external_crypto_key_id-property) | The ID of the pre-shared key used for DC request authentication. |
| [external_crypto_key_secret](#external_crypto_key_secret-property) | The pre-shared key used for DC request authentication. |
| [external_crypto_method](#external_crypto_method-property) | Specifies the asynchronous signing method. |
| [external_crypto_mode](#external_crypto_mode-property) | Specifies the external cryptography mode. |
| [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| [external_data](#external_data-property) | The data that should be encrypted. |
| [fips_mode](#fips_mode-property) | Reserved. |
| [input_bytes](#input_bytes-property) | Use this property to pass the input to class in byte array form. |
| [input_file](#input_file-property) | The XML file to be decrypted. |
| [key_decryption_cert_bytes](#key_decryption_cert_bytes-property) | Returns the raw certificate data in DER format. |
| [key_decryption_cert_handle](#key_decryption_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [key_decryption_key](#key_decryption_key-property) | The symmetric key used to decrypt a session key. |
| [key_encryption_type](#key_encryption_type-property) | Defines how the session key is encrypted. |
| [key_info_certificate_count](#key_info_certificate_count-property) | The number of records in the KeyInfoCertificate arrays. |
| [key_info_certificate_bytes](#key_info_certificate_bytes-property) | Returns the raw certificate data in DER format. |
| [key_info_certificate_handle](#key_info_certificate_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [key_info_item_count](#key_info_item_count-property) | The number of records in the KeyInfoItem arrays. |
| [key_info_item_issuer_rdn](#key_info_item_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [key_info_item_serial_number](#key_info_item_serial_number-property) | Returns the certificate's serial number. |
| [key_info_item_subject_key_id](#key_info_item_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. |
| [key_info_item_subject_rdn](#key_info_item_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [key_transport_method](#key_transport_method-property) | Defines how the session key is encrypted. |
| [key_wrap_method](#key_wrap_method-property) | The key wrap method used to encrypt the session key. |
| [output_bytes](#output_bytes-property) | Use this property to read the output the class object has produced. |
| [output_file](#output_file-property) | Defines where to save the decrypted XML document. |
| [use_gcm](#use_gcm-property) | Indicates if GCM mode was enabled. |
| [xml_element](#xml_element-property) | Defines the XML element to decrypt. |

## Method List

*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [add_known_namespace](#add_known_namespace-method) | Adds known prefix and correspondent namespace URI. |
| [config](#config-method) | Sets or retrieves a configuration setting. |
| [decrypt](#decrypt-method) | Decrypts an XML document. |
| [do_action](#do_action-method) | Performs an additional action. |
| [reset](#reset-method) | Resets the class settings. |

## 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_decryption_info_needed](#on_decryption_info_needed-event) | Requests decryption information from the application. |
| [on_error](#on_error-event) | Information about errors during signing. |
| [on_external_decrypt](#on_external_decrypt-event) | Handles remote or external decryption. |
| [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. |
| [on_save_external_data](#on_save_external_data-event) | Request to save decrypted external data. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [EncryptedKeyXMLElement](#EncryptedKeyXMLElement) | Specifies the XML element where the encrypted key element is located. |
| [KeyName](#KeyName) | Contains information about the key used for encryption. |
| [MimeType](#MimeType) | Contains the mime type of the encrypted data. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [WriteBOM](#WriteBOM) | Specifies whether byte-order mark should be written when saving the document. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# decryption_key property

The symmetric (session) key used to encrypt the data.

## Syntax

```text
def get_decryption_key() -> bytes: ...
def set_decryption_key(value: bytes) -> None: ...
decryption_key = property(get_decryption_key, set_decryption_key)
```

## Remarks

Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data.

It is required when the [encrypt_key](#encrypt_key-property) property is disabled. If the [encrypt_key](#encrypt_key-property) property is enabled, and no value is set, the component will generate a random session key (recommended).

# encoding property

Specifies XML encoding.

## Syntax

```text
def get_encoding() -> str: ...
def set_encoding(value: str) -> None: ...
encoding = property(get_encoding, set_encoding)
```

## Default Value

""

## Remarks

Use this property to specify the encoding to apply to the XML documents.

# encrypted_data_type property

Defines the type of data being encrypted.

## Syntax

```text
def get_encrypted_data_type() -> int: ...
encrypted_data_type = property(get_encrypted_data_type, None)
```

## Possible Values

```text
0   # Element1   # Content2   # External
```

## Default Value

0

## Remarks

This property defines what data type is about to be encrypted.

Supported values:

|  |  |  |
| --- | --- | --- |
| cxedtElement | 0 | The XML element is encrypted. xml_node property specifies the XML element that should be encrypted. |
| cxedtContent | 1 | Element content is encrypted. xml_node property specifies the XML element which content should be encrypted. |
| cxedtExternal | 2 | External data is encrypted. Use [external_data](#external_data-property) property to set the data that should be encrypted. xml_node property specifies the location where xenc:EncryptedData element should be placed. |

 If the xml_node property is set to the empty string, and the input_stream and [input_file](#input_file-property) properties are not provided, then a new XML document will be created with the xenc:EncryptedData element as a document element.

This property is read-only.

# encryption_method property

The encryption method used to encrypt the document.

## Syntax

```text
def get_encryption_method() -> str: ...
encryption_method = property(get_encryption_method, None)
```

## Default Value

"AES256"

## Remarks

This property contains the encryption algorithm used to encrypt the XML document.

Supported values:

|  |  |  |
| --- | --- | --- |
| SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 |  |
| SB_XML_ENCRYPTION_ALGORITHM_DES | DES |  |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 |  |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |  |

If [use_gcm](#use_gcm-property) property is enabled, then supported values are:

|  |  |  |
| --- | --- | --- |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 |  |

This property is read-only.

# encrypt_key property

Specifies if the encryption key is encrypted.

## Syntax

```text
def get_encrypt_key() -> bool: ...
encrypt_key = property(get_encrypt_key, None)
```

## Default Value

TRUE

## Remarks

Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data.

This property is read-only.

# external_crypto_async_document_id property

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

## Syntax

```text
def get_external_crypto_async_document_id() -> str: ...
def set_external_crypto_async_document_id(value: str) -> None: ...
external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)
```

## Default Value

""

## Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

# external_crypto_custom_params property

Custom parameters to be passed to the signing service (uninterpreted).

## Syntax

```text
def get_external_crypto_custom_params() -> str: ...
def set_external_crypto_custom_params(value: str) -> None: ...
external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)
```

## Default Value

""

## Remarks

Custom parameters to be passed to the signing service (uninterpreted).

# external_crypto_data property

Additional data to be included in the async state and mirrored back by the requestor.

## Syntax

```text
def get_external_crypto_data() -> str: ...
def set_external_crypto_data(value: str) -> None: ...
external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)
```

## Default Value

""

## Remarks

Additional data to be included in the async state and mirrored back by the requestor.

# external_crypto_external_hash_calculation property

Specifies whether the message hash is to be calculated at the external endpoint.

## Syntax

```text
def get_external_crypto_external_hash_calculation() -> bool: ...
def set_external_crypto_external_hash_calculation(value: bool) -> None: ...
external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)
```

## Default Value

FALSE

## Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

# external_crypto_hash_algorithm property

Specifies the request's signature hash algorithm.

## Syntax

```text
def get_external_crypto_hash_algorithm() -> str: ...
def set_external_crypto_hash_algorithm(value: str) -> None: ...
external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)
```

## Default Value

"SHA256"

## Remarks

Specifies the request's signature hash algorithm.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

# external_crypto_key_id property

The ID of the pre-shared key used for DC request authentication.

## Syntax

```text
def get_external_crypto_key_id() -> str: ...
def set_external_crypto_key_id(value: str) -> None: ...
external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)
```

## Default Value

""

## Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [external_crypto_key_secret](#external_crypto_key_secret-property) to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

```text
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";
```

# external_crypto_key_secret property

The pre-shared key used for DC request authentication.

## Syntax

```text
def get_external_crypto_key_secret() -> str: ...
def set_external_crypto_key_secret(value: str) -> None: ...
external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)
```

## Default Value

""

## Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the [external_crypto_key_id](#external_crypto_key_id-property) topic.

# external_crypto_method property

Specifies the asynchronous signing method.

## Syntax

```text
def get_external_crypto_method() -> int: ...
def set_external_crypto_method(value: int) -> None: ...
external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)
```

## Possible Values

```text
0   # PKCS11   # PKCS7
```

## Default Value

0

## Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

# external_crypto_mode property

Specifies the external cryptography mode.

## Syntax

```text
def get_external_crypto_mode() -> int: ...
def set_external_crypto_mode(value: int) -> None: ...
external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)
```

## Possible Values

```text
0   # Default1   # Disabled2   # Generic3   # DCAuth4   # DCAuthJSON
```

## Default Value

0

## Remarks

Specifies the external cryptography mode.

Available options:

|  |  |
| --- | --- |
| ecmDefault | The default value (0) |
| ecmDisabled | Do not use DC or external signing (1) |
| ecmGeneric | Generic external signing with the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |

# external_crypto_public_key_algorithm property

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

## Syntax

```text
def get_external_crypto_public_key_algorithm() -> str: ...
def set_external_crypto_public_key_algorithm(value: str) -> None: ...
external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)
```

## Default Value

""

## Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

# external_data property

The data that should be encrypted.

## Syntax

```text
def get_external_data() -> bytes: ...
def set_external_data(value: bytes) -> None: ...
external_data = property(get_external_data, set_external_data)
```

## Remarks

Use this property to provide the data that should be encrypted if [encrypted_data_type](#encrypted_data_type-property) property is set to cxedtExternal value.

# fips_mode property

Reserved.

## Syntax

```text
def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

# input_bytes property

Use this property to pass the input to class in byte array form.

## Syntax

```text
def get_input_bytes() -> bytes: ...
def set_input_bytes(value: bytes) -> None: ...
input_bytes = property(get_input_bytes, set_input_bytes)
```

## Remarks

Assign a byte array containing the data to be processed to this property.

# input_file property

The XML file to be decrypted.

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

Provide the path to the XML document to be decrypted.

# key_decryption_cert_bytes property

Returns the raw certificate data in DER format.

## Syntax

```text
def get_key_decryption_cert_bytes() -> bytes: ...
key_decryption_cert_bytes = property(get_key_decryption_cert_bytes, None)
```

## Remarks

Returns the raw certificate data in DER format.

This property is read-only.

# key_decryption_cert_handle property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

## Syntax

```text
def get_key_decryption_cert_handle() -> int: ...
def set_key_decryption_cert_handle(value: int) -> None: ...
key_decryption_cert_handle = property(get_key_decryption_cert_handle, set_key_decryption_cert_handle)
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

# key_decryption_key property

The symmetric key used to decrypt a session key.

## Syntax

```text
def get_key_decryption_key() -> bytes: ...
def set_key_decryption_key(value: bytes) -> None: ...
key_decryption_key = property(get_key_decryption_key, set_key_decryption_key)
```

## Remarks

Use this property to provide the decryption symmetric key that will be used to decrypt a session key. It is required when [encrypt_key](#encrypt_key-property) property is enabled and [key_encryption_type](#key_encryption_type-property) set to cxetKeyWrap value.

# key_encryption_type property

Defines how the session key is encrypted.

## Syntax

```text
def get_key_encryption_type() -> int: ...
key_encryption_type = property(get_key_encryption_type, None)
```

## Possible Values

```text
0   # KeyTransport1   # KeyWrap
```

## Default Value

0

## Remarks

This property defines how the session key is encrypted.

Supported values:

|  |  |  |
| --- | --- | --- |
| cxetKeyTransport | 0 | The key is encrypted using public-key based algorithm |
| cxetKeyWrap | 1 | The key is encrypted using symmetric algorithm with pre-shared secret key |

This property is read-only.

# key_info_certificate_count property

The number of records in the KeyInfoCertificate arrays.

## Syntax

```text
def get_key_info_certificate_count() -> int: ...
key_info_certificate_count = property(get_key_info_certificate_count, None)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [key_info_certificate_bytes](#key_info_certificate_bytes-property)
- [key_info_certificate_handle](#key_info_certificate_handle-property)

The array indices start at *0* and end at *key_info_certificate_count - 1*.

This property is read-only.

# key_info_certificate_bytes property

Returns the raw certificate data in DER format.

## Syntax

```text
def get_key_info_certificate_bytes(key_info_certificate_index: int) -> bytes: ...
```

## Remarks

Returns the raw certificate data in DER format.

The *key_info_certificate_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_info_certificate_count](#key_info_certificate_count-property) property.

This property is read-only.

# key_info_certificate_handle property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

## Syntax

```text
def get_key_info_certificate_handle(key_info_certificate_index: int) -> int: ...
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

The *key_info_certificate_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_info_certificate_count](#key_info_certificate_count-property) property.

This property is read-only.

# key_info_item_count property

The number of records in the KeyInfoItem arrays.

## Syntax

```text
def get_key_info_item_count() -> int: ...
key_info_item_count = property(get_key_info_item_count, None)
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [key_info_item_issuer_rdn](#key_info_item_issuer_rdn-property)
- [key_info_item_serial_number](#key_info_item_serial_number-property)
- [key_info_item_subject_key_id](#key_info_item_subject_key_id-property)
- [key_info_item_subject_rdn](#key_info_item_subject_rdn-property)

The array indices start at *0* and end at *key_info_item_count - 1*.

This property is read-only.

# key_info_item_issuer_rdn property

A list of Property=Value pairs that uniquely identify the certificate issuer.

## Syntax

```text
def get_key_info_item_issuer_rdn(key_info_item_index: int) -> str: ...
```

## Default Value

""

## Remarks

A list of *Property=Value* pairs that uniquely identify the certificate issuer.

Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*

The *key_info_item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_info_item_count](#key_info_item_count-property) property.

This property is read-only.

# key_info_item_serial_number property

Returns the certificate's serial number.

## Syntax

```text
def get_key_info_item_serial_number(key_info_item_index: int) -> bytes: ...
```

## Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The *key_info_item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_info_item_count](#key_info_item_count-property) property.

This property is read-only.

# key_info_item_subject_key_id property

Contains a unique identifier of the certificate's cryptographic key.

## Syntax

```text
def get_key_info_item_subject_key_id(key_info_item_index: int) -> bytes: ...
```

## Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [key_info_item_subject_key_id](#key_info_item_subject_key_id-property) and [key_info_item_ca_key_id](#XMLDecryptor_p_KeyInfoItemCAKeyID) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The *key_info_item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_info_item_count](#key_info_item_count-property) property.

This property is read-only.

# key_info_item_subject_rdn property

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

## Syntax

```text
def get_key_info_item_subject_rdn(key_info_item_index: int) -> str: ...
```

## Default Value

""

## Remarks

A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.

The *key_info_item_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [key_info_item_count](#key_info_item_count-property) property.

This property is read-only.

# key_transport_method property

Defines how the session key is encrypted.

## Syntax

```text
def get_key_transport_method() -> int: ...
key_transport_method = property(get_key_transport_method, None)
```

## Possible Values

```text
0   # RSA151   # RSAOAEP
```

## Default Value

0

## Remarks

This property defines how the session key is encrypted.

Supported values:

|  |  |  |
| --- | --- | --- |
| cxktRSA15 | 0 | RSA 1.5 (RSAES-PKCS1-v1_5) encryption is used |
| cxktRSAOAEP | 1 | RSA-OAEP (RSAES-OAEP-ENCRYPT) encryption is used |

This property is read-only.

# key_wrap_method property

The key wrap method used to encrypt the session key.

## Syntax

```text
def get_key_wrap_method() -> str: ...
key_wrap_method = property(get_key_wrap_method, None)
```

## Default Value

"Camellia256"

## Remarks

This property specifies the key wrap algorithm used to encrypt the session key.

Supported values:

|  |  |  |
| --- | --- | --- |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 |  |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |  |

This property is read-only.

# output_bytes property

Use this property to read the output the class object has produced.

## Syntax

```text
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
```

## Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [output_file](#output_file-property) and output_stream properties had not been assigned.

This property is read-only.

# output_file property

Defines where to save the decrypted XML document.

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

A path where the decrypted XML document should be saved.

# use_gcm property

Indicates if GCM mode was enabled.

## Syntax

```text
def get_use_gcm() -> bool: ...
use_gcm = property(get_use_gcm, None)
```

## Default Value

TRUE

## Remarks

Use this property to check if GCM encryption mode was enabled.

This property is read-only.

# xml_element property

Defines the XML element to decrypt.

## Syntax

```text
def get_xml_element() -> str: ...
def set_xml_element(value: str) -> None: ...
xml_element = property(get_xml_element, set_xml_element)
```

## Default Value

""

## Remarks

Defines the XML element to decrypt.

Supported values are:

|  |  |
| --- | --- |
| "" | an empty string indicates that all xenc:EncryptedData elements will be decrypted. |
| "#id" | indicates an XML element with specified Id. |
| XPointer expression | indicates an XML element selected using XPointer expression. Use [add_known_namespace](#add_known_namespace-method) method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via [add_known_namespace](#add_known_namespace-method) method. |
| Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". |

# add_known_namespace method

Adds known prefix and correspondent namespace URI.

## Syntax

```text
def add_known_namespace(prefix: str, uri: str) -> None: ...
```

## Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

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

# decrypt method

Decrypts an XML document.

## Syntax

```text
def decrypt() -> None: ...
```

## Remarks

Call this method to decrypt an XML document.

# do_action method

Performs an additional action.

## Syntax

```text
def do_action(action_id: str, action_params: str) -> str: ...
```

## Remarks

do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter.

*ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*.

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# reset method

Resets the class settings.

## Syntax

```text
def reset() -> None: ...
```

## Remarks

reset is a generic method available in every class.

# on_decryption_info_needed event

Requests decryption information from the application.

## Syntax

```text
class XMLDecryptorDecryptionInfoNeededEventParams(object):
  @property
  def cancel_decryption() -> bool: ...
  @cancel_decryption.setter
  def cancel_decryption(value) -> None: ...

# In class XMLDecryptor:
@property
def on_decryption_info_needed() -> Callable[[XMLDecryptorDecryptionInfoNeededEventParams], None]: ...
@on_decryption_info_needed.setter
def on_decryption_info_needed(event_hook: Callable[[XMLDecryptorDecryptionInfoNeededEventParams], None]) -> None: ...
```

## Remarks

This event is fired when the component needs decryption information (the private key) from the user.

Use [encrypt_key](#encrypt_key-property), Config["KeyName"] and [key_encryption_type](#key_encryption_type-property) properties to identify the encryption type and then set [decryption_key](#decryption_key-property) or [key_decryption_key](#key_decryption_key-property) or key_decryption_certificate properties accordingly.

if *CancelDecryption* property is set to *true* value (default value) then decryption would fail if provided key/certificate is invalid. Otherwise this event would be fired again.

# on_error event

Information about errors during signing.

## Syntax

```text
class XMLDecryptorErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class XMLDecryptor:
@property
def on_error() -> Callable[[XMLDecryptorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[XMLDecryptorErrorEventParams], None]) -> None: ...
```

## Remarks

The event is fired in case of exceptional conditions during signing.

*ErrorCode* contains an error code and *Description* contains a textual description of the error.

# on_external_decrypt event

Handles remote or external decryption.

## Syntax

```text
class XMLDecryptorExternalDecryptEventParams(object):
  @property
  def operation_id() -> str: ...

  @property
  def algorithm() -> str: ...

  @property
  def pars() -> str: ...

  @property
  def encrypted_data() -> str: ...

  @property
  def data() -> str: ...
  @data.setter
  def data(value) -> None: ...

# In class XMLDecryptor:
@property
def on_external_decrypt() -> Callable[[XMLDecryptorExternalDecryptEventParams], None]: ...
@on_external_decrypt.setter
def on_external_decrypt(event_hook: Callable[[XMLDecryptorExternalDecryptEventParams], None]) -> None: ...
```

## Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the *EncryptedData* parameter, and is expected to decrypt it and place the decrypted value into the *Data* parameter.

*OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *Algorithm* specifies the encryption algorithm being used, and *Pars* contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the *EncryptedData*, *Data*, and *Pars* parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

# on_notification event

This event notifies the application about an underlying control flow event.

## Syntax

```text
class XMLDecryptorNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class XMLDecryptor:
@property
def on_notification() -> Callable[[XMLDecryptorNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[XMLDecryptorNotificationEventParams], None]) -> None: ...
```

## Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

# on_save_external_data event

Request to save decrypted external data.

## Syntax

```text
class XMLDecryptorSaveExternalDataEventParams(object):
  @property
  def external_data() -> bytes: ...

# In class XMLDecryptor:
@property
def on_save_external_data() -> Callable[[XMLDecryptorSaveExternalDataEventParams], None]: ...
@on_save_external_data.setter
def on_save_external_data(event_hook: Callable[[XMLDecryptorSaveExternalDataEventParams], None]) -> None: ...
```

## Remarks

This event is fired when the component successfully decrypted an external data and needs to save it. The same data could be read using [external_data](#external_data-property) property.

It makes sense to use this event when the XML document contains several xenc:EncryptedData elements and the component decrypts them all.

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

### XMLDecryptor Config Settings

**EncryptedKeyXMLElement**: Specifies the XML element where the encrypted key element is located.This property specifies the XML element where the xenc:EncryptedKey element is located. May be used to decrypt data in SOAP messages.

Supported values are:

|  |  |
| --- | --- |
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use [add_known_namespace](#add_known_namespace-method) method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via [add_known_namespace](#add_known_namespace-method) method. |
| Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". |

**KeyName**: Contains information about the key used for encryption.The KeyName element contains a string value (with significant whitespaces) which may be used by the encryptor to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.

**MimeType**: Contains the mime type of the encrypted data.MimeType is an optional (advisory) attribute which describes the media type of the data which is encrypted. The value of this attribute is a string with values defined by MIME specification (RFC 2045). For example, if the data that is encrypted is a base64 encoded PNG, the transfer Encoding may be specified as 'http://www.w3.org/2000/09/xmldsig#base64' and the MimeType as 'image/png'. This attribute is purely advisory; no validation of the MimeType information is required and it does not indicate the encryption application must do any additional processing.

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**WriteBOM**: Specifies whether byte-order mark should be written when saving the document.Set this property to False to disable writing byte-order mark (BOM) when saving the XML document in Unicode encoding.

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# XMLDecryptor Errors

### XMLDecryptor Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |
| 39845889 | The input file does not exist ([SB_ERROR_XML_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORXMLINPUTFILENOTEXISTS)) |
| 39845890 | Data file does not exist ([SB_ERROR_XML_DATAFILE_NOT_EXISTS](constants.md#const_SBERRORXMLDATAFILENOTEXISTS)) |
| 39845892 | Unsupported hash algorithm ([SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM](constants.md#const_SBERRORXMLUNSUPPORTEDHASHALGORITHM)) |
| 39845893 | Unsupported key type ([SB_ERROR_XML_UNSUPPORTED_KEY_TYPE](constants.md#const_SBERRORXMLUNSUPPORTEDKEYTYPE)) |
| 39845895 | Unsupported encryption algorithm ([SB_ERROR_XML_INVALID_ENCRYPTION_METHOD](constants.md#const_SBERRORXMLINVALIDENCRYPTIONMETHOD)) |
| 39845896 | XML element not found ([SB_ERROR_XML_NOT_FOUND](constants.md#const_SBERRORXMLNOTFOUND)) |
| 39845897 | XML element has no ID ([SB_ERROR_XML_NO_ELEMENT_ID](constants.md#const_SBERRORXMLNOELEMENTID)) |