SecureBlackbox 2020 iOS Edition

Questions / Feedback?

XMLEncryptor Class

Properties   Methods   Events   Configuration Settings   Errors  

The XMLEncryptor class encrypts XML documents.

Syntax

SecureBlackboxXMLEncryptor
SecureBlackboxXMLEncryptorSwift

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.

- encodingSpecifies XML encoding.
- encryptedDataTypeSpecifies the type of the data being encrypted.
- encryptionKeyThe symmetric (session) key used to encrypt the data.
- encryptionMethodThe encryption method used to encrypt the document.
- encryptKeySpecifies if the encryption key is encrypted.
- externalDataThe data that should be encrypted.
- inputBytesUse this property to pass the input to class in the byte array form.
- inputFileThe XML document to be encrypted.
- keyEncryptionCertBytesReturns raw certificate data in DER format.
- keyEncryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- keyEncryptionKeyThe symmetric key used to encrypt a session key.
- keyEncryptionTypeSpecifies how the session key is encrypted.
- keyTransportMethodSpecifies 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 encrypted XML document.
- useGCMSpecifies if GCM mode is enabled.
- XMLNodeDefines the XML element to encrypt.
- namespaceCountThe number of records in the Namespace arrays.
- namespacePrefix:(int)namespaceIndexA user-defined prefix value of a namespace.
- namespaceURI:(int)namespaceIndexA 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.
- encryptEncrypts 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.

- onErrorInformation about errors during signing.
- onFormatElementReports the XML element that is currently being processed.
- onFormatTextReports XML text that is currently being processed.
- onNotificationThis 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.

EncryptedDataIDSpecifies the ID for EncryptedData element.
EncryptedKeyIDSpecifies the ID for EncryptedKey element.
EncryptedKeyInfoCustomXMLThe custom XML content for EncryptedKey\\KeyInfo element.
EncryptedKeyInfoIDSpecifies the ID for EncryptedKey\\KeyInfo element.
EncryptedKeyOnlySpecifies whether to create only EncryptedKey element.
EncryptedKeyXMLElementSpecifies the XML element where to save the encrypted key element.
EncryptionPrefixSpecifies the encryption prefix.
KeyInfoCustomXMLThe custom XML content for KeyInfo element.
KeyInfoIDSpecifies the ID for KeyInfo element.
KeyNameContains information about the key used for encryption.
MimeTypeSpecifies the mime type of the encrypted data.
SignaturePrefixSpecifies the signature prefix.
TempPathLocation where the temporary files are stored.
WriteBOMSpecifies whether byte-order mark should be written when saving the document.
XMLFormattingSpecifies the signature XML formatting.
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 iOS Edition - Version 20.0 [Build 8166]