SecureBlackbox 2020 Qt Edition

Questions / Feedback?

MessageDecryptor Class

Properties   Methods   Events   Configuration Settings   Errors  

The MessageDecryptor class decrypts data that is stored in the PKCS#7 format.

Syntax

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.

CertificateBytesReturns raw certificate data in DER format.
CertificateHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CertificateIssuerThe common name of the certificate issuer (CA), typically a company name.
CertificateIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
CertificateSerialNumberReturns the certificate's serial number.
CertificateSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CertificateSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
CertCountThe number of records in the Cert arrays.
CertBytesReturns raw certificate data in DER format.
CertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
EncryptionAlgorithmThe symmetric cipher that was used to encrypt the data.
ExternalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
ExternalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecretThe pre-shared key used for DC request authentication.
ExternalCryptoMethodSpecifies the asynchronous signing method.
ExternalCryptoModeSpecifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
InputBytesUse this property to pass the input to class in the byte array form.
InputFilePath to the file containing the encrypted message.
KeyThe symmetric key to use for decryption.
OutputBytesUse this property to read the output the class object has produced.
OutputFilePath 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.

ConfigSets or retrieves a configuration setting.
DecryptAttempts 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.

ErrorInformation about errors during PKCS#7 message decryption.
ExternalDecryptHandles remote or external decryption.
NotificationThis event notifies the application about an underlying control flow event.
RecipientFoundFires 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.

NoOuterContentInfoWhether the message has outer content.
OAEPHashAlgorithmHash algorithm to be used in RSA-OAEP.
TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Qt Edition - Version 20.0 [Build 8154]