XMLEncryptor Class
Properties Methods Events Configuration Settings Errors
The XMLEncryptor class encrypts XML documents.
Syntax
class secureblackbox.XMLEncryptor
Remarks
XMLEncryptor encrypts XML documents 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.
| encoding | Specifies XML encoding. |
| encrypted_data_type | Specifies the type of the data being encrypted. |
| encryption_key | The symmetric (session) key used to encrypt the data. |
| encryption_method | The encryption method used to encrypt the document. |
| encrypt_key | Specifies if the encryption key is encrypted. |
| 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 document to be encrypted. |
| key_encryption_cert_bytes | Returns raw certificate data in DER format. |
| key_encryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| key_encryption_key | The symmetric key used to encrypt a session key. |
| key_encryption_type | Specifies how the session key is encrypted. |
| key_transport_method | Specifies 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 encrypted XML document. |
| use_gcm | Specifies if GCM mode is enabled. |
| xml_node | Defines the XML element to encrypt. |
| 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. |
| encrypt | Encrypts 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_error | Information about errors during signing. |
| on_format_element | Reports the XML element that is currently being processed. |
| on_format_text | Reports XML text that is currently being processed. |
| on_notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| EncryptedDataID | Specifies the ID for EncryptedData element. |
| EncryptedKeyID | Specifies the ID for EncryptedKey element. |
| EncryptedKeyInfoCustomXML | The custom XML content for EncryptedKey\\KeyInfo element. |
| EncryptedKeyInfoID | Specifies the ID for EncryptedKey\\KeyInfo element. |
| EncryptedKeyOnly | Specifies whether to create only EncryptedKey element. |
| EncryptedKeyXMLElement | Specifies the XML element where to save the encrypted key element. |
| EncryptionPrefix | Specifies the encryption prefix. |
| KeyInfoCustomXML | The custom XML content for KeyInfo element. |
| KeyInfoID | Specifies the ID for KeyInfo element. |
| KeyName | Contains information about the key used for encryption. |
| MimeType | Specifies the mime type of the encrypted data. |
| SignaturePrefix | Specifies the signature prefix. |
| TempPath | Location where the temporary files are stored. |
| WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
| XMLFormatting | Specifies the signature XML formatting. |
| 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. |