SecureBlackbox 2020 C++ Edition

Questions / Feedback?

XMLDecryptor Class

Properties   Methods   Events   Configuration Settings   Errors  

The XMLDecryptor class decrypts XML documents.

Syntax

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.

DecryptionKeyThe symmetric (session) key used to encrypt the data.
EncodingSpecifies XML encoding.
EncryptedDataTypeDefines the type of data being encrypted.
EncryptionMethodThe encryption method used to encrypt the document.
EncryptKeySpecifies if the encryption key is encrypted.
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.
ExternalDataThe data that should be encrypted.
InputBytesUse this property to pass the input to class in the byte array form.
InputFileThe XML file to be decrypted.
KeyDecryptionCertBytesReturns raw certificate data in DER format.
KeyDecryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyDecryptionKeyThe symmetric key used to decrypt a session key.
KeyEncryptionTypeDefines how the session key is encrypted.
KeyInfoItemCountThe number of records in the KeyInfoItem arrays.
KeyInfoItemIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
KeyInfoItemSerialNumberReturns the certificate's serial number.
KeyInfoItemSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
KeyInfoItemSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
KeyInfoCertificateCountThe number of records in the KeyInfoCertificate arrays.
KeyInfoCertificateBytesReturns raw certificate data in DER format.
KeyInfoCertificateHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyTransportMethodDefines how the session key is encrypted.
KeyWrapMethodThe key wrap method used to encrypt the session key.
OutputBytesUse this property to read the output the class object has produced.
OutputFileDefines where to save the decrypted XML document.
UseGCMIndicates if GCM mode was enabled.
XMLElementDefines the XML element to decrypt.
NamespaceCountThe number of records in the Namespace arrays.
NamespacePrefixA user-defined prefix value of a namespace.
NamespaceURIA 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.

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

DecryptionInfoNeededRequests decryption information from the application.
ErrorInformation about errors during signing.
ExternalDecryptHandles remote or external decryption.
NotificationThis event notifies the application about an underlying control flow event.
SaveExternalDataRequest 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.

KeyNameContains information about the key used for encryption.
MimeTypeContains the mime type of the encrypted data.
TempPathLocation where the temporary files are stored.
WriteBOMSpecifies whether byte-order mark should be written when saving the document.
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 C++ Edition - Version 20.0 [Build 8166]