MessageDecryptor Class
Properties Methods Events Configuration Settings Errors
The MessageDecryptor class decrypts data that is stored in the PKCS#7 format.
Syntax
class secureblackbox.MessageDecryptor
Remarks
PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| certificate_bytes | Returns raw certificate data in DER format. |
| certificate_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| certificate_issuer | The common name of the certificate issuer (CA), typically a company name. |
| certificate_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| certificate_serial_number | Returns the certificate's serial number. |
| certificate_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| certificate_subject_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| cert_count | The number of records in the Cert arrays. |
| cert_bytes | Returns raw certificate data in DER format. |
| cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encryption_algorithm | The symmetric cipher that was used to encrypt the data. |
| 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. |
| input_bytes | Use this property to pass the input to class in the byte array form. |
| input_file | Path to the file containing the encrypted message. |
| key | The symmetric key to use for decryption. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | Path to the file to save the decrypted data to. |
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 | Attempts to decrypt an encrypted PKCS#7 message. |
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 PKCS#7 message decryption. |
| on_external_decrypt | Handles remote or external decryption. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_recipient_found | Fires to report a message addressee parameters. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| NoOuterContentInfo | Whether the message has outer content. |
| OAEPHashAlgorithm | Hash algorithm to be used in RSA-OAEP. |
| TempPath | Path for storing temporary files. |
| 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. |