# Struct secureblackbox::XMLEncryptor The XMLEncryptor struct encrypts XML documents. ## Syntax ```text secureblackbox::XMLEncryptor ``` ## Remarks XMLEncryptor encrypts XML documents with certificates or generic keys. ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the XMLEncryptor struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of XMLEncryptor when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [encoding](#encoding-property-xmlencryptor-struct) | Specifies XML encoding. | | [encrypted_data_type](#encrypted_data_type-property-xmlencryptor-struct) | Specifies the type of the data being encrypted. | | [encryption_key](#encryption_key-property-xmlencryptor-struct) | The symmetric (session) key used to encrypt the data. | | [encryption_method](#encryption_method-property-xmlencryptor-struct) | The encryption method used to encrypt the document. | | [encrypt_key](#encrypt_key-property-xmlencryptor-struct) | Specifies if the encryption key is encrypted. | | [external_data](#external_data-property-xmlencryptor-struct) | The data that should be encrypted. | | [fips_mode](#fips_mode-property-xmlencryptor-struct) | Reserved. | | [input_bytes](#input_bytes-property-xmlencryptor-struct) | Use this property to pass the input to struct in byte array form. | | [input_file](#input_file-property-xmlencryptor-struct) | The XML document to be encrypted. | | [key_encryption_cert_bytes](#key_encryption_cert_bytes-property-xmlencryptor-struct) | Returns the raw certificate data in DER format. | | [key_encryption_cert_handle](#key_encryption_cert_handle-property-xmlencryptor-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [key_encryption_key](#key_encryption_key-property-xmlencryptor-struct) | The symmetric key used to encrypt a session key. | | [key_encryption_type](#key_encryption_type-property-xmlencryptor-struct) | Specifies how the session key is encrypted. | | [key_transport_method](#key_transport_method-property-xmlencryptor-struct) | Specifies how the session key is encrypted. | | [key_wrap_method](#key_wrap_method-property-xmlencryptor-struct) | The key wrap method used to encrypt the session key. | | [output_bytes](#output_bytes-property-xmlencryptor-struct) | Use this property to read the output the struct object has produced. | | [output_file](#output_file-property-xmlencryptor-struct) | Defines where to save the encrypted XML document. | | [use_gcm](#use_gcm-property-xmlencryptor-struct) | Specifies if GCM mode is enabled. | | [xml_node](#xml_node-property-xmlencryptor-struct) | Defines the XML element to encrypt. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_known_namespace](#add_known_namespace-method-xmlencryptor-struct) | Adds known prefix and correspondent namespace URI. | | [config](#config-method-xmlencryptor-struct) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method-xmlencryptor-struct) | Performs an additional action. | | [encrypt](#encrypt-method-xmlencryptor-struct) | Encrypts an XML document. | | [reset](#reset-method-xmlencryptor-struct) | Resets the struct settings. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_error](#on_error-event-xmlencryptor-struct) | Information about errors during signing. | | [on_format_element](#on_format_element-event-xmlencryptor-struct) | Reports the XML element that is currently being processed. | | [on_format_text](#on_format_text-event-xmlencryptor-struct) | Reports XML text that is currently being processed. | | [on_notification](#on_notification-event-xmlencryptor-struct) | This event notifies the application about an underlying control flow event. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [EncryptedDataID](#EncryptedDataID) | Specifies the ID for EncryptedData element. | | [EncryptedKeyID](#EncryptedKeyID) | Specifies the ID for EncryptedKey element. | | [EncryptedKeyInfoCustomXML](#EncryptedKeyInfoCustomXML) | The custom XML content for EncryptedKey\\KeyInfo element. | | [EncryptedKeyInfoID](#EncryptedKeyInfoID) | Specifies the ID for EncryptedKey\\KeyInfo element. | | [EncryptedKeyOnly](#EncryptedKeyOnly) | Specifies whether to create only EncryptedKey element. | | [EncryptedKeyXMLElement](#EncryptedKeyXMLElement) | Specifies the XML element where to save the encrypted key element. | | [EncryptionPrefix](#EncryptionPrefix) | Specifies the encryption prefix. | | [KeyInfoCustomXML](#KeyInfoCustomXML) | The custom XML content for KeyInfo element. | | [KeyInfoID](#KeyInfoID) | Specifies the ID for KeyInfo element. | | [KeyName](#KeyName) | Contains information about the key used for encryption. | | [MimeType](#MimeType) | Specifies the mime type of the encrypted data. | | [SignaturePrefix](#SignaturePrefix) | Specifies the signature prefix. | | [TempPath](#TempPath) | Path for storing temporary files. | | [WriteBOM](#WriteBOM) | Specifies whether byte-order mark should be written when saving the document. | | [XMLFormatting](#XMLFormatting) | Specifies the signature XML formatting. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the struct. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client structs created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client structs should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # encoding property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Specifies XML encoding. ## Syntax *Rust Syntax* ```text fn encoding(&self ) -> Result fn set_encoding(&self, value : &str) -> Option fn set_encoding_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to specify the encoding to apply to the XML documents. ## Data Type String # encrypted_data_type property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Specifies the type of the data being encrypted. ## Syntax *Rust Syntax* ```text fn encrypted_data_type(&self ) -> Result fn set_encrypted_data_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Element1 // Content2 // External ``` ## Default Value 0 ## Remarks This property specifies the data type to be encrypted. Supported values: | | | | | --- | --- | --- | | cxedtElement | 0 | The XML element is encrypted. [xml_node](#xml_node-property-xmlencryptor-struct) property specifies the XML element that should be encrypted. | | cxedtContent | 1 | Element content is encrypted. [xml_node](#xml_node-property-xmlencryptor-struct) property specifies the XML element which content should be encrypted. | | cxedtExternal | 2 | External data is encrypted. Use [external_data](#external_data-property-xmlencryptor-struct) property to set the data that should be encrypted. [xml_node](#xml_node-property-xmlencryptor-struct) property specifies the location where xenc:EncryptedData element should be placed. | If the [xml_node](#xml_node-property-xmlencryptor-struct) property is set to the empty string, and the input_stream and [input_file](#input_file-property-xmlencryptor-struct) properties are not provided, then a new XML document will be created with the xenc:EncryptedData element as a document element. ## Data Type i32 # encryption_key property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The symmetric (session) key used to encrypt the data. ## Syntax *Rust Syntax* ```text fn encryption_key(&self ) -> Result, SecureBlackboxError> fn set_encryption_key(&self, value : Vec) -> Option fn set_encryption_key_ref(&self, value : &[u8]) -> Option ``` ## Remarks Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data. It is required when the [encrypt_key](#encrypt_key-property-xmlencryptor-struct) property is disabled. If the [encrypt_key](#encrypt_key-property-xmlencryptor-struct) property is enabled, and no value is set, the component will generate a random session key (recommended). ## Data Type Vec # encryption_method property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The encryption method used to encrypt the document. ## Syntax *Rust Syntax* ```text fn encryption_method(&self ) -> Result fn set_encryption_method(&self, value : &str) -> Option fn set_encryption_method_ref(&self, value : &String) -> Option ``` ## Default Value "AES256" ## Remarks This property contains the encryption algorithm used to encrypt the XML document. Supported values: | | | | | --- | --- | --- | | SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | | | SB_XML_ENCRYPTION_ALGORITHM_DES | DES | | | SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | | | SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | | | SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | | | SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | | | SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED | | If [use_gcm](#use_gcm-property-xmlencryptor-struct) property is enabled, then supported values are: | | | | | --- | --- | --- | | SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | | | SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | | | SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | | ## Data Type String # encrypt_key property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Specifies if the encryption key is encrypted. ## Syntax *Rust Syntax* ```text fn encrypt_key(&self ) -> Result fn set_encrypt_key(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data. ## Data Type bool # external_data property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The data that should be encrypted. ## Syntax *Rust Syntax* ```text fn external_data(&self ) -> Result, SecureBlackboxError> fn set_external_data(&self, value : Vec) -> Option fn set_external_data_ref(&self, value : &[u8]) -> Option ``` ## Remarks Use this property to provide the data that should be encrypted if [encrypted_data_type](#encrypted_data_type-property-xmlencryptor-struct) property is set to cxedtExternal value. ## Data Type Vec # fips_mode property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Reserved. ## Syntax *Rust Syntax* ```text fn fips_mode(&self ) -> Result fn set_fips_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type bool # input_bytes property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Use this property to pass the input to struct in byte array form. ## Syntax *Rust Syntax* ```text fn input_bytes(&self ) -> Result, SecureBlackboxError> fn set_input_bytes(&self, value : Vec) -> Option fn set_input_bytes_ref(&self, value : &[u8]) -> Option ``` ## Remarks Assign a byte array containing the data to be processed to this property. ## Data Type Vec # input_file property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The XML document to be encrypted. ## Syntax *Rust Syntax* ```text fn input_file(&self ) -> Result fn set_input_file(&self, value : &str) -> Option fn set_input_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Provide the path to the XML document to be encrypted. ## Data Type String # key_encryption_cert_bytes property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn key_encryption_cert_bytes(&self ) -> Result, SecureBlackboxError> ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. ## Data Type Vec # key_encryption_cert_handle property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn key_encryption_cert_handle(&self ) -> Result fn set_key_encryption_cert_handle(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` ## Data Type i64 # key_encryption_key property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The symmetric key used to encrypt a session key. ## Syntax *Rust Syntax* ```text fn key_encryption_key(&self ) -> Result, SecureBlackboxError> fn set_key_encryption_key(&self, value : Vec) -> Option fn set_key_encryption_key_ref(&self, value : &[u8]) -> Option ``` ## Remarks Use this property to provide the encryption symmetric key that will be used to encrypt a session key. It is required when the [encrypt_key](#encrypt_key-property-xmlencryptor-struct) property is enabled and [key_encryption_type](#key_encryption_type-property-xmlencryptor-struct) is set to cxetKeyWrap value. ## Data Type Vec # key_encryption_type property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Specifies how the session key is encrypted. ## Syntax *Rust Syntax* ```text fn key_encryption_type(&self ) -> Result fn set_key_encryption_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // KeyTransport1 // KeyWrap ``` ## Default Value 0 ## Remarks This property specifies how the session key is encrypted. Supported values: | | | | | --- | --- | --- | | cxetKeyTransport | 0 | The key is encrypted using public-key based algorithm | | cxetKeyWrap | 1 | The key is encrypted using symmetric algorithm with pre-shared secret key | ## Data Type i32 # key_transport_method property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Specifies how the session key is encrypted. ## Syntax *Rust Syntax* ```text fn key_transport_method(&self ) -> Result fn set_key_transport_method(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // RSA151 // RSAOAEP ``` ## Default Value 0 ## Remarks This property specifies how the session key is encrypted. Supported values: | | | | | --- | --- | --- | | cxktRSA15 | 0 | RSA 1.5 (RSAES-PKCS1-v1_5) encryption is used | | cxktRSAOAEP | 1 | RSA-OAEP (RSAES-OAEP-ENCRYPT) encryption is used | ## Data Type i32 # key_wrap_method property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The key wrap method used to encrypt the session key. ## Syntax *Rust Syntax* ```text fn key_wrap_method(&self ) -> Result fn set_key_wrap_method(&self, value : &str) -> Option fn set_key_wrap_method_ref(&self, value : &String) -> Option ``` ## Default Value "Camellia256" ## Remarks This property specifies the key wrap algorithm used to encrypt the session key. Supported values: | | | | | --- | --- | --- | | SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | | | SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | | | SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | | | SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | | | SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | | | SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED | | ## Data Type String # output_bytes property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Use this property to read the output the struct object has produced. ## Syntax *Rust Syntax* ```text fn output_bytes(&self ) -> Result, SecureBlackboxError> ``` ## Remarks Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [output_file](#output_file-property-xmlencryptor-struct) and output_stream properties had not been assigned. This property is read-only. ## Data Type Vec # output_file property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Defines where to save the encrypted XML document. ## Syntax *Rust Syntax* ```text fn output_file(&self ) -> Result fn set_output_file(&self, value : &str) -> Option fn set_output_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Specifies the path where the encrypted XML document should be saved. ## Data Type String # use_gcm property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Specifies if GCM mode is enabled. ## Syntax *Rust Syntax* ```text fn use_gcm(&self ) -> Result fn set_use_gcm(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Use this property to enable Galois/Counter Mode (GCM) mode for AES encryption method. ## Data Type bool # xml_node property ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Defines the XML element to encrypt. ## Syntax *Rust Syntax* ```text fn xml_node(&self ) -> Result fn set_xml_node(&self, value : &str) -> Option fn set_xml_node_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Defines the XML element/node to encrypt or in case if cxedtExternal encryption data type is used where to save the encrypted data. Supported values are: | | | | --- | --- | | "" | an empty string indicates the Document element | | "#id" | indicates an XML element with specified Id | | XPath expression | indicates an XML element selected using XPath expression. Use [add_known_namespace](#add_known_namespace-method-xmlencryptor-struct) method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via [add_known_namespace](#add_known_namespace-method-xmlencryptor-struct) method. | | Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". | ## Data Type String # add_known_namespace method ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Adds known prefix and correspondent namespace URI. ## Syntax *Rust Syntax* ```text fn add_known_namespace(&self, prefix : &str, uri : &str) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references. # config method ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-xmlencryptor-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-xmlencryptor-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Performs an additional action. ## Syntax *Rust Syntax* ```text fn do_action(&self, action_id : &str, action_params : &str) -> Result ``` ## Remarks do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # encrypt method ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Encrypts an XML document. ## Syntax *Rust Syntax* ```text fn encrypt(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks Call this method to encrypt an XML document. The struct could be used to encrypt the SOAP message as well. **Example 1: Encrypting the SOAP message** ```text void EncryptSOAPMessage(string inputFilename, string outputFilename, string cert, string certPassword) { string encKeyId = "EK-" + Guid.NewGuid().ToString(); string encDataId = "ED-" + Guid.NewGuid().ToString(); using (Xmlencryptor encryptor = new Xmlencryptor()) { encryptor.InputFile = inputFilename; encryptor.OutputFile = outputFilename; string certB64; using (Certificatemanager certMgr = new Certificatemanager()) { certMgr.ImportFromFile(cert, certPassword); encryptor.KeyEncryptionCertificate = certMgr.Certificate; using (Utils utils = new Utils()) { var certBytes = certMgr.Certificate.Bytes; certB64 = utils.Base64Encode(certBytes, false); } } encryptor.XMLNode = "/soapv11:Envelope/soapv11:Body"; encryptor.EncryptedDataType = XmlencryptorEncryptedDataTypes.cxedtContent; encryptor.EncryptionMethod = "AES128"; encryptor.EncryptKey = true; encryptor.KeyEncryptionType = XmlencryptorKeyEncryptionTypes.cxetKeyTransport; encryptor.KeyTransportMethod = XmlencryptorKeyTransportMethods.cxktRSA15; encryptor.Config($"EncryptedDataID={encDataId}"); encryptor.Config($"EncryptedKeyID={encKeyId}"); encryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security"); encryptor.Config("KeyInfoCustomXML=" + $"" + ""); encryptor.Config("EncryptedKeyInfoCustomXML=" + $"{certB64}" + ""); encryptor.Encrypt(); } } EncryptSOAPMessage(@"soap_test.xml", @"soap_encrypted.xml", @"cert.pfx", "password"); ``` Note: The above code expects that the SOAP message has a WS Security header element. Sample SOAP message: ```text Sample message ``` Sample encrypted SOAP message produced by the above code: ```text ... ... ... ``` **Example 2: Decrypting the SOAP message** ```text void DecryptSOAPMessage(string inputFilename, string outputFilename, string cert, string certPassword) { using (Xmldecryptor decryptor = new Xmldecryptor()) { decryptor.InputFile = inputFilename; decryptor.OutputFile = outputFilename; using (Certificatemanager certMgr = new Certificatemanager()) { certMgr.ImportFromFile(cert, certPassword); decryptor.KeyDecryptionCertificate = certMgr.Certificate; } decryptor.XMLElement = "/soapv11:Envelope/soapv11:Body/xenc:EncryptedData"; decryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security"); decryptor.Decrypt(); } } DecryptSOAPMessage(@"soap_encrypted.xml", @"soap_decrypted.xml", @"cert.pfx", "password"); ``` **Example 3: Signing and encrypting the SOAP message** ```text void SignAndEncryptSOAPMessage(string inputFilename, string outputFilename, string signingCert, string signingCertPassword, string encryptionCert, string encryptionCertPassword) { byte[] data; string encKeyId = "EK-" + Guid.NewGuid().ToString(); string encDataId1 = "ED-" + Guid.NewGuid().ToString(); string encDataId2 = "ED-" + Guid.NewGuid().ToString(); // Step 1: Creating Web service security (WSS) signature using (Soapsigner signer = new Soapsigner()) { signer.InputFile = inputFilename; // loading the signing certificate using (Certificatemanager certMgr = new Certificatemanager()) { certMgr.ImportFromFile(encryptionCert, encryptionCertPassword); signer.SigningCertificate = certMgr.Certificate; } signer.NewSignature.SignatureType = SOAPSignatureTypes.sstWSSSignature; signer.NewSignature.HashAlgorithm = "SHA256"; signer.NewSignature.XAdES = false; signer.SecurityHeaderIndex = 0; signer.AddBodyReference("ID-" + Guid.NewGuid().ToString(), false); signer.Sign(); data = signer.OutputBytes; } using (Xmlencryptor encryptor = new Xmlencryptor()) { // Step 2: loading the encryption certificate string certB64; using (Certificatemanager certMgr = new Certificatemanager()) { certMgr.ImportFromFile(encryptionCert, encryptionCertPassword); encryptor.KeyEncryptionCertificate = certMgr.Certificate; using (Utils utils = new Utils()) { var certBytes = certMgr.Certificate.Bytes; certB64 = utils.Base64Encode(certBytes, false); } } // Step 3: generating random key encryption key (128-bit length) // this key will be used for both encryptions byte[] KEK; using (Rnd rnd = new Rnd()) { KEK = rnd.NextBytes(16); } encryptor.KeyEncryptionKey = KEK; // Step 4: encrypting Body element and placing encrypted key to the Security block in the SOAP Message Header encryptor.XMLNode = "/soapv11:Envelope/soapv11:Body"; encryptor.EncryptedDataType = XmlencryptorEncryptedDataTypes.cxedtContent; encryptor.EncryptionMethod = "AES128"; encryptor.EncryptKey = true; encryptor.KeyEncryptionType = XmlencryptorKeyEncryptionTypes.cxetKeyTransport; encryptor.KeyTransportMethod = XmlencryptorKeyTransportMethods.cxktRSA15; encryptor.Config($"EncryptedDataID={encDataId1}"); encryptor.Config($"EncryptedKeyID={encKeyId}"); encryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security"); encryptor.Config("KeyInfoCustomXML=" + $"" + ""); encryptor.Config("EncryptedKeyInfoCustomXML=" + $"{certB64}" + ""); encryptor.InputBytes = data; encryptor.Encrypt(); // Step 5: encrypting WSS Signature encryptor.InputBytes = encryptor.OutputBytes; // resetting settings encryptor.Config("EncryptedKeyXMLElement="); encryptor.Config("EncryptedKeyInfoCustomXML="); encryptor.XMLNode = "/soapv11:Envelope/soapv11:Header/wsse:Security/ds:Signature"; encryptor.EncryptedDataType = XmlencryptorEncryptedDataTypes.cxedtElement; encryptor.EncryptKey = false; encryptor.Config($"EncryptedDataID={encDataId2}"); encryptor.Config("KeyInfoCustomXML=" + $"" + ""); encryptor.Encrypt(); data = encryptor.OutputBytes; } // Step 6: miscellaneous XML DOM manipulations, not supported by XMLEncryptor, but may be required by SOAP standard using (Soapsigner signer = new Soapsigner()) { signer.InputBytes = data; signer.OutputFile = outputFilename; signer.Open(); // Adding xenc:ReferenceList element to xenc:EncryptedKey element signer.SetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security/xenc:EncryptedKey", signer.GetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security/xenc:EncryptedKey") + "" + $"" + $"" + ""); // swapping the order of elements in WSS Security header // SOAP requires that items in the header are placed in the order that they will be processed, not the order they were generated // because the decryption should be performed before veryfing SOAP message, the xenc:EncryptedKey element should be placed first var encKeyContent = signer.GetOuterXML("/soapv11:Envelope/soapv11:Header/wssev10:Security/xenc:EncryptedKey"); var secContent = signer.GetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security"); var k = secContent.IndexOf(encKeyContent, StringComparison.Ordinal); if (k != -1) signer.SetInnerXML("/soapv11:Envelope/soapv11:Header/wssev10:Security", encKeyContent + secContent.Substring(0, k)); signer.Close(true); } } SignAndEncryptSOAPMessage(@"soap_test.xml", @"soap_signed_encrypted.xml", @"cert.pfx", "password", @"cert2.pfx", "password2"); ``` Sample SOAP message: ```text Sample message ``` Sample signed and encrypted SOAP message produced by the above code: ```text ... ... ... ... ... ``` **Example 4: Decrypting and verifying the SOAP message** ```text void DecryptAndVerifySOAPMessage(string inputFilename, string outputFilename, string decryptionCert, string decryptionCertPassword) { byte[] data; using (Xmldecryptor decryptor = new Xmldecryptor()) { decryptor.InputFile = inputFilename; decryptor.OutputFile = outputFilename; using (Certificatemanager certMgr = new Certificatemanager()) { certMgr.ImportFromFile(decryptionCert, decryptionCertPassword); decryptor.KeyDecryptionCertificate = certMgr.Certificate; } decryptor.Config("EncryptedKeyXMLElement=/soapv11:Envelope/soapv11:Header/wssev10:Security"); decryptor.Decrypt(); } using (Soapverifier verifier = new Soapverifier()) { verifier.InputFile = outputFilename; verifier.Verify(); if ((verifier.Signatures.Count != 1) || (verifier.Signatures[0].SignatureValidationResult != SignatureValidities.svtValid)) throw new Exception("Signature not found or failed to verify a signature"); } } DecryptAndVerifySOAPMessage(@"soap_signed_encrypted.xml", @"soap_signed_decrypted.xml", @"cert2.pfx", "password2"); ``` # reset method ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Resets the struct settings. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks reset is a generic method available in every struct. # on_error event ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Information about errors during signing. ## Syntax *Rust Syntax* ```text // XMLEncryptorErrorEventArgs carries the XMLEncryptor Error event's parameters. pub struct XMLEncryptorErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // XMLEncryptorErrorEvent defines the signature of the XMLEncryptor Error event's handler function. pub trait XMLEncryptorErrorEvent { fn on_error(&self, sender : XMLEncryptor, e : &mut XMLEncryptorErrorEventArgs); } impl <'a> XMLEncryptor<'a> { pub fn on_error(&self) -> &'a dyn XMLEncryptorErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn XMLEncryptorErrorEvent); ... } ``` ## Remarks The event is fired in case of exceptional conditions during signing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # on_format_element event ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Reports the XML element that is currently being processed. ## Syntax *Rust Syntax* ```text // XMLEncryptorFormatElementEventArgs carries the XMLEncryptor FormatElement event's parameters. pub struct XMLEncryptorFormatElementEventArgs { fn start_tag_whitespace(&self) -> &String fn set_start_tag_whitespace(&self, value : &str) fn set_start_tag_whitespace_ref(&self, value : &String) fn end_tag_whitespace(&self) -> &String fn set_end_tag_whitespace(&self, value : &str) fn set_end_tag_whitespace_ref(&self, value : &String) fn level(&self) -> i32 fn path(&self) -> &String fn has_child_elements(&self) -> bool } // XMLEncryptorFormatElementEvent defines the signature of the XMLEncryptor FormatElement event's handler function. pub trait XMLEncryptorFormatElementEvent { fn on_format_element(&self, sender : XMLEncryptor, e : &mut XMLEncryptorFormatElementEventArgs); } impl <'a> XMLEncryptor<'a> { pub fn on_format_element(&self) -> &'a dyn XMLEncryptorFormatElementEvent; pub fn set_on_format_element(&mut self, value : &'a dyn XMLEncryptorFormatElementEvent); ... } ``` ## Remarks *Path* and *Level* specify the path to the XML element being processed and its nesting level, respectively. *HasChildElements* specify if processed XML element has child elements. Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature. # on_format_text event ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) Reports XML text that is currently being processed. ## Syntax *Rust Syntax* ```text // XMLEncryptorFormatTextEventArgs carries the XMLEncryptor FormatText event's parameters. pub struct XMLEncryptorFormatTextEventArgs { fn text(&self) -> &String fn set_text(&self, value : &str) fn set_text_ref(&self, value : &String) fn text_type(&self) -> i32 fn level(&self) -> i32 fn path(&self) -> &String } // XMLEncryptorFormatTextEvent defines the signature of the XMLEncryptor FormatText event's handler function. pub trait XMLEncryptorFormatTextEvent { fn on_format_text(&self, sender : XMLEncryptor, e : &mut XMLEncryptorFormatTextEventArgs); } impl <'a> XMLEncryptor<'a> { pub fn on_format_text(&self) -> &'a dyn XMLEncryptorFormatTextEvent; pub fn set_on_format_text(&mut self, value : &'a dyn XMLEncryptorFormatTextEvent); ... } ``` ## Remarks *TextType* parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; *Path* and *Level* specify the path to the XML element and its nesting level. Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature. # on_notification event ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) This event notifies the application about an underlying control flow event. ## Syntax *Rust Syntax* ```text // XMLEncryptorNotificationEventArgs carries the XMLEncryptor Notification event's parameters. pub struct XMLEncryptorNotificationEventArgs { fn event_id(&self) -> &String fn event_param(&self) -> &String } // XMLEncryptorNotificationEvent defines the signature of the XMLEncryptor Notification event's handler function. pub trait XMLEncryptorNotificationEvent { fn on_notification(&self, sender : XMLEncryptor, e : &mut XMLEncryptorNotificationEventArgs); } impl <'a> XMLEncryptor<'a> { pub fn on_notification(&self) -> &'a dyn XMLEncryptorNotificationEvent; pub fn set_on_notification(&mut self, value : &'a dyn XMLEncryptorNotificationEvent); ... } ``` ## Remarks The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted. # Config Settings ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-xmlencryptor-struct) method. ### XMLEncryptor Config Settings **EncryptedDataID**: Specifies the ID for EncryptedData element.This property contains the identifier (ID) attribute of the xenc:EncryptedData element. **EncryptedKeyID**: Specifies the ID for EncryptedKey element.This property contains the identifier (ID) attribute of the xenc:EncryptedKey element. **EncryptedKeyInfoCustomXML**: The custom XML content for EncryptedKey\KeyInfo element.Use this property to specify the custom XML content of the xenc:EncryptedKey\ds:KeyInfo element. The empty elements in the custom XML content act as a placeholder for auto-generated elements. For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "" **EncryptedKeyInfoID**: Specifies the ID for EncryptedKey\KeyInfo element.This property contains the identifier (ID) attribute of the xenc:EncryptedKey\ds:KeyInfo element. **EncryptedKeyOnly**: Specifies whether to create only EncryptedKey element.Set this property to True to create only xenc:EncryptedKey element. **EncryptedKeyXMLElement**: Specifies the XML element where to save the encrypted key element.This property specifies the XML element where to save the xenc:EncryptedKey element. Supported values are: | | | | --- | --- | | "" | an empty string indicates the Document element | | "#id" | indicates an XML element with specified Id | | XPath expression | indicates an XML element selected using XPath expression. Use [add_known_namespace](#add_known_namespace-method-xmlencryptor-struct) method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via [add_known_namespace](#add_known_namespace-method-xmlencryptor-struct) method. | | Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". | **EncryptionPrefix**: Specifies the encryption prefix.Specifies the prefix for the EncryptedData elements. Default value is "xenc". In this case "xenc:" prefix will be used. Special values: | | | | --- | --- | | "#default" or "" | indicates that the prefix will be omitted. | | "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. | **KeyInfoCustomXML**: The custom XML content for KeyInfo element.Use this property to specify the custom XML content of the ds:KeyInfo element. The empty elements in the custom XML content act as a placeholder for auto-generated elements. For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "" **KeyInfoID**: Specifies the ID for KeyInfo element.This property contains the identifier (ID) attribute of the ds:KeyInfo element. **KeyName**: Contains information about the key used for encryption.The KeyName element contains a string value (with significant whitespaces) which may be used by the encryptor to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc. **MimeType**: Specifies the mime type of the encrypted data.MimeType is an optional (advisory) attribute which describes the media type of the data which is encrypted. The value of this attribute is a string with values defined by MIME specification (RFC 2045). For example, if the data that is encrypted is a base64 encoded PNG, the transfer Encoding may be specified as 'http://www.w3.org/2000/09/xmldsig#base64' and the MimeType as 'image/png'. This attribute is purely advisory; no validation of the MimeType information is required and it does not indicate the encryption application must do any additional processing. **SignaturePrefix**: Specifies the signature prefix.Specifies the prefix for the Signature elements. Default value is "ds". In this case "ds:" prefix will be used. Special values: | | | | --- | --- | | "#default" or "" | indicates that the prefix will be omitted. | | "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. | **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **WriteBOM**: Specifies whether byte-order mark should be written when saving the document.Set this property to False to disable writing byte-order mark (BOM) when saving the XML document in Unicode encoding. **XMLFormatting**: Specifies the signature XML formatting.Use this property to specify how the signature should be formatted. Supported values: | | | | | --- | --- | --- | | "" or "none" | | no formatting (by default). | | "auto" | | enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node" | Custom values, contains a list of value pairs ("name:value") separated by comma or semicolon: | | | | | --- | --- | --- | | indent | | specifies indentation level (default is 1) | | indent-char | | specifies indentation character: "space" or "tab" (default) | | base64-max-length | | specifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64) | | starting-level | | specifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node"). | | indent-before-main | | specifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no" | For more precise formatting use OnFormatText and OnFormatElement events. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the struct. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the struct.Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the structs that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other structs. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the struct. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the struct) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the struct is set to "*local*", the property returns/restores the rules from/to the internal storage of the struct. If *StaticDNS* of the struct is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the structs. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([XMLEncryptor](#struct-secureblackboxxmlencryptor) Struct) ### XMLEncryptor Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 39845889 | The input file does not exist ([SB_ERROR_XML_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORXMLINPUTFILENOTEXISTS)) | | 39845890 | Data file does not exist ([SB_ERROR_XML_DATAFILE_NOT_EXISTS](constants.md#const_SBERRORXMLDATAFILENOTEXISTS)) | | 39845892 | Unsupported hash algorithm ([SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM](constants.md#const_SBERRORXMLUNSUPPORTEDHASHALGORITHM)) | | 39845893 | Unsupported key type ([SB_ERROR_XML_UNSUPPORTED_KEY_TYPE](constants.md#const_SBERRORXMLUNSUPPORTEDKEYTYPE)) | | 39845895 | Unsupported encryption algorithm ([SB_ERROR_XML_INVALID_ENCRYPTION_METHOD](constants.md#const_SBERRORXMLINVALIDENCRYPTIONMETHOD)) | | 39845896 | XML element not found ([SB_ERROR_XML_NOT_FOUND](constants.md#const_SBERRORXMLNOTFOUND)) | | 39845897 | XML element has no ID ([SB_ERROR_XML_NO_ELEMENT_ID](constants.md#const_SBERRORXMLNOELEMENTID)) |