# XMLDecryptor Module The XMLDecryptor module decrypts XML documents. ## Syntax ```text 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 module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DecryptionKey](#decryptionkey-property-xmldecryptor-module) | The symmetric (session) key used to encrypt the data. | | [Encoding](#encoding-property-xmldecryptor-module) | Specifies XML encoding. | | [EncryptedDataType](#encrypteddatatype-property-xmldecryptor-module) | Defines the type of data being encrypted. | | [EncryptionMethod](#encryptionmethod-property-xmldecryptor-module) | The encryption method used to encrypt the document. | | [EncryptKey](#encryptkey-property-xmldecryptor-module) | Specifies if the encryption key is encrypted. | | [ExternalCrypto](#externalcrypto-property-xmldecryptor-module) | Provides access to external signing and DC parameters. | | [ExternalData](#externaldata-property-xmldecryptor-module) | The data that should be encrypted. | | [FIPSMode](#fipsmode-property-xmldecryptor-module) | Reserved. | | [InputBytes](#inputbytes-property-xmldecryptor-module) | Use this property to pass the input to module in byte array form. | | [InputFile](#inputfile-property-xmldecryptor-module) | The XML file to be decrypted. | | [KeyDecryptionCertificate](#keydecryptioncertificate-property-xmldecryptor-module) | The certificate used to decrypt a session key. | | [KeyDecryptionKey](#keydecryptionkey-property-xmldecryptor-module) | The symmetric key used to decrypt a session key. | | [KeyEncryptionType](#keyencryptiontype-property-xmldecryptor-module) | Defines how the session key is encrypted. | | [KeyInfo](#keyinfo-property-xmldecryptor-module) | A collection of KeyInfo items found in the KeyInfo element. | | [KeyInfoCertificates](#keyinfocertificates-property-xmldecryptor-module) | A collection of certificates found in the KeyInfo element. | | [KeyTransportMethod](#keytransportmethod-property-xmldecryptor-module) | Defines how the session key is encrypted. | | [KeyWrapMethod](#keywrapmethod-property-xmldecryptor-module) | The key wrap method used to encrypt the session key. | | [OutputBytes](#outputbytes-property-xmldecryptor-module) | Use this property to read the output the module object has produced. | | [OutputFile](#outputfile-property-xmldecryptor-module) | Defines where to save the decrypted XML document. | | [UseGCM](#usegcm-property-xmldecryptor-module) | Indicates if GCM mode was enabled. | | [XMLElement](#xmlelement-property-xmldecryptor-module) | Defines the XML element to decrypt. | ## Method List *The following is the full list of the methods of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddKnownNamespace](#addknownnamespace-method-xmldecryptor-module) | Adds known prefix and correspondent namespace URI. | | [Config](#config-method-xmldecryptor-module) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-xmldecryptor-module) | Decrypts an XML document. | | [DoAction](#doaction-method-xmldecryptor-module) | Performs an additional action. | | [Reset](#reset-method-xmldecryptor-module) | Resets the module settings. | ## Event List *The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DecryptionInfoNeeded](#decryptioninfoneeded-event-xmldecryptor-module) | Requests decryption information from the application. | | [Error](#error-event-xmldecryptor-module) | Information about errors during signing. | | [ExternalDecrypt](#externaldecrypt-event-xmldecryptor-module) | Handles remote or external decryption. | | [Notification](#notification-event-xmldecryptor-module) | This event notifies the application about an underlying control flow event. | | [SaveExternalData](#saveexternaldata-event-xmldecryptor-module) | Request to save decrypted external data. | ## Config Settings *The following is a list of config settings for the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [EncryptedKeyXMLElement](#EncryptedKeyXMLElement) | Specifies the XML element where the encrypted key element is located. | | [KeyName](#KeyName) | Contains information about the key used for encryption. | | [MimeType](#MimeType) | Contains the mime type of the encrypted data. | | [TempPath](#TempPath) | Path for storing temporary files. | | [WriteBOM](#WriteBOM) | Specifies whether byte-order mark should be written when saving the document. | | [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 module. | | [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 modules. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server modules. | | [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 modules 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 modules 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. | # DecryptionKey Property ([XMLDecryptor](#xmldecryptor-module) Module) The symmetric (session) key used to encrypt the data. ## Syntax ```text public var decryptionKey: Data { get {...} set {...} } ``` ## Remarks Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data. It is required when the [EncryptKey](#encryptkey-property-xmldecryptor-module) property is disabled. If the [EncryptKey](#encryptkey-property-xmldecryptor-module) property is enabled, and no value is set, the component will generate a random session key (recommended). # Encoding Property ([XMLDecryptor](#xmldecryptor-module) Module) Specifies XML encoding. ## Syntax ```text public var encoding: String { get {...} set {...} } ``` ## Default Value "" ## Remarks Use this property to specify the encoding to apply to the XML documents. # EncryptedDataType Property ([XMLDecryptor](#xmldecryptor-module) Module) Defines the type of data being encrypted. ## Syntax ```text public var encryptedDataType: XMLDecryptorEncryptedDataTypes { get {...} } public enum XMLDecryptorEncryptedDataTypes: Int32 { case cxedtElement = 0 case cxedtContent = 1 case cxedtExternal = 2 } ``` ## Default Value 0 ## Remarks This property defines what data type is about to be encrypted. Supported values: | | | | | --- | --- | --- | | cxedtElement | 0 | The XML element is encrypted. XMLNode property specifies the XML element that should be encrypted. | | cxedtContent | 1 | Element content is encrypted. XMLNode property specifies the XML element which content should be encrypted. | | cxedtExternal | 2 | External data is encrypted. Use [ExternalData](#externaldata-property-xmldecryptor-module) property to set the data that should be encrypted. XMLNode property specifies the location where xenc:EncryptedData element should be placed. | If the XMLNode property is set to the empty string, and the InputStream and [InputFile](#inputfile-property-xmldecryptor-module) properties are not provided, then a new XML document will be created with the xenc:EncryptedData element as a document element. This property is read-only. # EncryptionMethod Property ([XMLDecryptor](#xmldecryptor-module) Module) The encryption method used to encrypt the document. ## Syntax ```text public var encryptionMethod: String { get {...} } ``` ## 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 [UseGCM](#usegcm-property-xmldecryptor-module) 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 | | This property is read-only. # EncryptKey Property ([XMLDecryptor](#xmldecryptor-module) Module) Specifies if the encryption key is encrypted. ## Syntax ```text public var encryptKey: Bool { get {...} } ``` ## Default Value True ## Remarks Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data. This property is read-only. # ExternalCrypto Property ([XMLDecryptor](#xmldecryptor-module) Module) Provides access to external signing and DC parameters. ## Syntax ```text public var externalCrypto: ExternalCrypto { get {...} } ``` ## Default Value "" ## Remarks Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component). # ExternalData Property ([XMLDecryptor](#xmldecryptor-module) Module) The data that should be encrypted. ## Syntax ```text public var externalData: Data { get {...} set {...} } ``` ## Remarks Use this property to provide the data that should be encrypted if [EncryptedDataType](#encrypteddatatype-property-xmldecryptor-module) property is set to cxedtExternal value. # FIPSMode Property ([XMLDecryptor](#xmldecryptor-module) Module) Reserved. ## Syntax ```text public var fipsMode: Bool { get {...} set {...} } ``` ## Default Value False ## Remarks This property is reserved for future use. # InputBytes Property ([XMLDecryptor](#xmldecryptor-module) Module) Use this property to pass the input to module in byte array form. ## Syntax ```text public var inputBytes: Data { get {...} set {...} } ``` ## Remarks Assign a byte array containing the data to be processed to this property. # InputFile Property ([XMLDecryptor](#xmldecryptor-module) Module) The XML file to be decrypted. ## Syntax ```text public var inputFile: String { get {...} set {...} } ``` ## Default Value "" ## Remarks Provide the path to the XML document to be decrypted. # KeyDecryptionCertificate Property ([XMLDecryptor](#xmldecryptor-module) Module) The certificate used to decrypt a session key. ## Syntax ```text public var keyDecryptionCertificate: Certificate { get {...} set {...} } ``` ## Default Value "" ## Remarks Use this property to provide the decryption certificate that will be used to decrypt a session key. It is required when [EncryptKey](#encryptkey-property-xmldecryptor-module) property is enabled and [KeyEncryptionType](#keyencryptiontype-property-xmldecryptor-module) set to cxetKeyTransport value. # KeyDecryptionKey Property ([XMLDecryptor](#xmldecryptor-module) Module) The symmetric key used to decrypt a session key. ## Syntax ```text public var keyDecryptionKey: Data { get {...} set {...} } ``` ## Remarks Use this property to provide the decryption symmetric key that will be used to decrypt a session key. It is required when [EncryptKey](#encryptkey-property-xmldecryptor-module) property is enabled and [KeyEncryptionType](#keyencryptiontype-property-xmldecryptor-module) set to cxetKeyWrap value. # KeyEncryptionType Property ([XMLDecryptor](#xmldecryptor-module) Module) Defines how the session key is encrypted. ## Syntax ```text public var keyEncryptionType: XMLDecryptorKeyEncryptionTypes { get {...} } public enum XMLDecryptorKeyEncryptionTypes: Int32 { case cxetKeyTransport = 0 case cxetKeyWrap = 1 } ``` ## Default Value 0 ## Remarks This property defines 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 | This property is read-only. # KeyInfo Property ([XMLDecryptor](#xmldecryptor-module) Module) A collection of KeyInfo items found in the KeyInfo element. ## Syntax ```text public var keyInfo: Array { get {...} } ``` ## Default Value "" ## Remarks A collection of KeyInfo items that contains information about the public key that is used to perform encryption. # KeyInfoCertificates Property ([XMLDecryptor](#xmldecryptor-module) Module) A collection of certificates found in the KeyInfo element. ## Syntax ```text public var keyInfoCertificates: Array { get {...} } ``` ## Default Value "" ## Remarks A collection of certificates that contains information about the public key that is used to perform encryption. # KeyTransportMethod Property ([XMLDecryptor](#xmldecryptor-module) Module) Defines how the session key is encrypted. ## Syntax ```text public var keyTransportMethod: XMLDecryptorKeyTransportMethods { get {...} } public enum XMLDecryptorKeyTransportMethods: Int32 { case cxktRSA15 = 0 case cxktRSAOAEP = 1 } ``` ## Default Value 0 ## Remarks This property defines 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 | This property is read-only. # KeyWrapMethod Property ([XMLDecryptor](#xmldecryptor-module) Module) The key wrap method used to encrypt the session key. ## Syntax ```text public var keyWrapMethod: String { get {...} } ``` ## 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 | | This property is read-only. # OutputBytes Property ([XMLDecryptor](#xmldecryptor-module) Module) Use this property to read the output the module object has produced. ## Syntax ```text public var outputBytes: Data { get {...} } ``` ## 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 [OutputFile](#outputfile-property-xmldecryptor-module) and OutputStream properties had not been assigned. This property is read-only. # OutputFile Property ([XMLDecryptor](#xmldecryptor-module) Module) Defines where to save the decrypted XML document. ## Syntax ```text public var outputFile: String { get {...} set {...} } ``` ## Default Value "" ## Remarks A path where the decrypted XML document should be saved. # UseGCM Property ([XMLDecryptor](#xmldecryptor-module) Module) Indicates if GCM mode was enabled. ## Syntax ```text public var useGCM: Bool { get {...} } ``` ## Default Value True ## Remarks Use this property to check if GCM encryption mode was enabled. This property is read-only. # XMLElement Property ([XMLDecryptor](#xmldecryptor-module) Module) Defines the XML element to decrypt. ## Syntax ```text public var xmlElement: String { get {...} set {...} } ``` ## Default Value "" ## Remarks Defines the XML element to decrypt. Supported values are: | | | | --- | --- | | "" | an empty string indicates that all xenc:EncryptedData elements will be decrypted. | | "#id" | indicates an XML element with specified Id. | | XPointer expression | indicates an XML element selected using XPointer expression. Use [AddKnownNamespace](#addknownnamespace-method-xmldecryptor-module) 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 [AddKnownNamespace](#addknownnamespace-method-xmldecryptor-module) method. | | Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". | # AddKnownNamespace Method ([XMLDecryptor](#xmldecryptor-module) Module) Adds known prefix and correspondent namespace URI. ## Syntax ```text public func addKnownNamespace(prefix: String, uri: String) throws -> Void ``` ## 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 ([XMLDecryptor](#xmldecryptor-module) Module) Sets or retrieves a configuration setting. ## Syntax ```text public func config(configurationString: String) throws -> String ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-xmldecryptor-module) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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-xmldecryptor-module), you must call *Config("PROPERTY")*. The value will be returned as a string. # Decrypt Method ([XMLDecryptor](#xmldecryptor-module) Module) Decrypts an XML document. ## Syntax ```text public func decrypt() throws -> Void ``` ## Remarks Call this method to decrypt an XML document. # DoAction Method ([XMLDecryptor](#xmldecryptor-module) Module) Performs an additional action. ## Syntax ```text public func doAction(actionID: String, actionParams: String) throws -> String ``` ## Remarks DoAction is a generic method available in every class. 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. | # Reset Method ([XMLDecryptor](#xmldecryptor-module) Module) Resets the component settings. ## Syntax ```text public func reset() throws -> Void ``` ## Remarks Reset is a generic method available in every class. # DecryptionInfoNeeded Event ([XMLDecryptor](#xmldecryptor-module) Module) Requests decryption information from the application. ## Syntax ```text func onDecryptionInfoNeeded(cancelDecryption: inout Bool) ``` ## Remarks This event is fired when the component needs decryption information (the private key) from the user. Use [EncryptKey](#encryptkey-property-xmldecryptor-module), Config["KeyName"] and [KeyEncryptionType](#keyencryptiontype-property-xmldecryptor-module) properties to identify the encryption type and then set [DecryptionKey](#decryptionkey-property-xmldecryptor-module) or [KeyDecryptionKey](#keydecryptionkey-property-xmldecryptor-module) or [KeyDecryptionCertificate](#keydecryptioncertificate-property-xmldecryptor-module) properties accordingly. if *CancelDecryption* property is set to *true* value (default value) then decryption would fail if provided key/certificate is invalid. Otherwise this event would be fired again. # Error Event ([XMLDecryptor](#xmldecryptor-module) Module) Information about errors during signing. ## Syntax ```text func onError(errorCode: Int32, description: String) ``` ## 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. # ExternalDecrypt Event ([XMLDecryptor](#xmldecryptor-module) Module) Handles remote or external decryption. ## Syntax ```text func onExternalDecrypt(operationId: String, algorithm: String, pars: String, encryptedData: String, data: inout String) ``` ## Remarks Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the *EncryptedData* parameter, and is expected to decrypt it and place the decrypted value into the *Data* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *Algorithm* specifies the encryption algorithm being used, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *EncryptedData*, *Data*, and *Pars* parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption. Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 # Notification Event ([XMLDecryptor](#xmldecryptor-module) Module) This event notifies the application about an underlying control flow event. ## Syntax ```text func onNotification(eventID: String, eventParam: String) ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted. # SaveExternalData Event ([XMLDecryptor](#xmldecryptor-module) Module) Request to save decrypted external data. ## Syntax ```text func onSaveExternalData(externalData: Data) ``` ## Remarks This event is fired when the component successfully decrypted an external data and needs to save it. The same data could be read using [ExternalData](#externaldata-property-xmldecryptor-module) property. It makes sense to use this event when the XML document contains several xenc:EncryptedData elements and the component decrypts them all. # Certificate Type Encapsulates an individual X.509 certificate. ## Remarks This type keeps and provides access to X.509 certificate details. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [Handle](#Certificate_f_Handle) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **bytes** *Data (read-only)* *Default Value: ""* Returns the raw certificate data in DER format. **ca** *Bool* *Default Value: False* Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. **caKeyID** *Data (read-only)* *Default Value: ""* A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **certType** *CertTypes (read-only)* *Default Value: 0* Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects. **crlDistributionPoints** *String* *Default Value: ""* Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **curve** *String* *Default Value: ""* Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | **fingerprint** *String (read-only)* *Default Value: ""* Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. **friendlyName** *String (read-only)* *Default Value: ""* Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. **handle** *Int64* *Default Value: 0* 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()); ``` **hashAlgorithm** *String* *Default Value: ""* Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **issuer** *String (read-only)* *Default Value: ""* The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via . **issuerRDN** *String* *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **keyAlgorithm** *String* *Default Value: "0"* Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the , , and properties to get more details about the key the certificate contains. **keyBits** *Int32 (read-only)* *Default Value: 0* Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the or property would typically contain auxiliary values, and therefore be longer. **keyFingerprint** *String (read-only)* *Default Value: ""* Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **keyUsage** *Int32* *Default Value: 0* Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. **keyValid** *Bool (read-only)* *Default Value: False* Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. **ocspLocations** *String* *Default Value: ""* Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **ocspNoCheck** *Bool* *Default Value: False* Accessor to the value of the certificate's ocsp-no-check extension. **origin** *Int32 (read-only)* *Default Value: 0* Returns the location that the certificate was taken or loaded from. **policyIDs** *String* *Default Value: ""* Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. **privateKeyBytes** *Data (read-only)* *Default Value: ""* Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. **privateKeyExists** *Bool (read-only)* *Default Value: False* Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This property is independent from , and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. **privateKeyExtractable** *Bool (read-only)* *Default Value: False* Indicates whether the private key is extractable (exportable). **publicKeyBytes** *Data (read-only)* *Default Value: ""* Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. **qualified** *Bool (read-only)* *Default Value: False* Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. **qualifiedStatements** *QualifiedStatementsTypes* *Default Value: 0* Returns a simplified qualified status of the certificate. **qualifiers** *String (read-only)* *Default Value: ""* A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **selfSigned** *Bool (read-only)* *Default Value: False* Indicates whether the certificate is self-signed (root) or signed by an external CA. **serialNumber** *Data* *Default Value: ""* Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. **sigAlgorithm** *String (read-only)* *Default Value: ""* Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. **source** *PKISources (read-only)* *Default Value: 0* Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **subject** *String (read-only)* *Default Value: ""* The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via . **subjectAlternativeName** *String* *Default Value: ""* Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. **subjectKeyID** *Data* *Default Value: ""* Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The and properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **subjectRDN** *String* *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. **valid** *Bool (read-only)* *Default Value: False* Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. **validFrom** *String* *Default Value: ""* The time point at which the certificate becomes valid, in UTC. **validTo** *String* *Default Value: ""* The time point at which the certificate expires, in UTC. ## Constructors *Swift Syntax* ```text public init(stream: ) ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. *Swift Syntax* ```text public init() ``` Creates a new object with default field values. # ExternalCrypto Type Specifies the parameters of external cryptographic calls. ## Remarks External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally. The following fields are available: - [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID) - [CustomParams](#ExternalCrypto_f_CustomParams) - [Data](#ExternalCrypto_f_Data) - [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation) - [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm) - [KeyID](#ExternalCrypto_f_KeyID) - [KeySecret](#ExternalCrypto_f_KeySecret) - [Method](#ExternalCrypto_f_Method) - [Mode](#ExternalCrypto_f_Mode) - [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm) ## Fields **asyncDocumentID** *String* *Default Value: ""* Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. **customParams** *String* *Default Value: ""* Custom parameters to be passed to the signing service (uninterpreted). **data** *String* *Default Value: ""* Additional data to be included in the async state and mirrored back by the requestor. **externalHashCalculation** *Bool* *Default Value: False* Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. **hashAlgorithm** *String* *Default Value: "SHA256"* Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **keyID** *String* *Default Value: ""* The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` **keySecret** *String* *Default Value: ""* The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the topic. **method** *AsyncSignMethods* *Default Value: 0* Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | **mode** *ExternalCryptoModes* *Default Value: 0* Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | **publicKeyAlgorithm** *String* *Default Value: ""* Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Constructors *Swift Syntax* ```text public init() ``` Creates a new ExternalCrypto object with default field values. # XMLKeyInfoItem Type Represents an XML KeyInfo item. ## Remarks This object contains information about the public key that was used to perform encryption or signing. The following fields are available: - [IssuerRDN](#XMLKeyInfoItem_f_IssuerRDN) - [SerialNumber](#XMLKeyInfoItem_f_SerialNumber) - [SubjectKeyID](#XMLKeyInfoItem_f_SubjectKeyID) - [SubjectRDN](#XMLKeyInfoItem_f_SubjectRDN) ## Fields **issuerRDN** *String* *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **serialNumber** *Data* *Default Value: ""* Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. **subjectKeyID** *Data* *Default Value: ""* Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The and properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **subjectRDN** *String* *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. ## Constructors *Swift Syntax* ```text public init() ``` Creates a new XMLKeyInfo item object. # Config Settings ([XMLDecryptor](#xmldecryptor-module) Module) The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-xmldecryptor-module) method. ### XMLDecryptor Config Settings **EncryptedKeyXMLElement**: Specifies the XML element where the encrypted key element is located.This property specifies the XML element where the xenc:EncryptedKey element is located. May be used to decrypt data in SOAP messages. 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 [AddKnownNamespace](#addknownnamespace-method-xmldecryptor-module) 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 [AddKnownNamespace](#addknownnamespace-method-xmldecryptor-module) method. | | Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". | **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**: Contains 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. **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. ### 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 class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class 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 classes 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 classes. **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 class. 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 class) 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 class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class 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 classes. **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 ([XMLDecryptor](#xmldecryptor-module) Module) ### XMLDecryptor 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)) |