XMLDecryptor Class

Properties Methods Events Configuration Settings Errors

The XMLDecryptor class decrypts XML documents.

Syntax

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

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	Sets or retrieves a configuration setting.
decrypt	Decrypts an XML document.

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

Configuration Settings

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


KeyName	Contains information about the key used for encryption.
MimeType	Contains the mime type of the encrypted data.
TempPath	Location where the temporary files are stored.
WriteBOM	Specifies whether byte-order mark should be written when saving the document.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.