XMLDecryptor Component
Properties Methods Events Configuration Settings Errors
The XMLDecryptor component decrypts XML documents.
Syntax
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 component with short descriptions. Click on the links for further details.
DecryptionKey | The symmetric (session) key used to encrypt the data. |
Encoding | Specifies XML encoding. |
EncryptedDataType | Defines the type of data being encrypted. |
EncryptionMethod | The encryption method used to encrypt the document. |
EncryptKey | Specifies if the encryption key is encrypted. |
ExternalCrypto | Provides access to external signing and DC parameters. |
ExternalData | The data that should be encrypted. |
InputBytes | Use this property to pass the input to component in the byte array form. |
InputFile | The XML file to be decrypted. |
InputStream | Stream containing the XML document. |
KeyDecryptionCertificate | The certificate used to decrypt a session key. |
KeyDecryptionKey | The symmetric key used to decrypt a session key. |
KeyEncryptionType | Defines how the session key is encrypted. |
KeyInfo | A collection of KeyInfo items found in the KeyInfo element. |
KeyInfoCertificates | A collection of certificates found in the KeyInfo element. |
KeyTransportMethod | Defines how the session key is encrypted. |
KeyWrapMethod | The key wrap method used to encrypt the session key. |
OutputBytes | Use this property to read the output the component object has produced. |
OutputFile | Defines where to save the decrypted XML document. |
OutputStream | The stream where to write the decrypted XML document to. |
UseGCM | Indicates if GCM mode was enabled. |
XMLElement | Defines the XML element to decrypt. |
XPathNamespaces | Specifies namespaces for XPath expressions. |
Method List
The following is the full list of the methods of the component 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 component with short descriptions. Click on the links for further details.
DecryptionInfoNeeded | Requests decryption information from the application. |
Error | Information about errors during signing. |
ExternalDecrypt | Handles remote or external decryption. |
Notification | This event notifies the application about an underlying control flow event. |
SaveExternalData | Request to save decrypted external data. |
Configuration Settings
The following is a list of configuration settings for the component 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 component (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 components 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. |