# MessageVerifier Module

The MessageVerifier module verifies digital signatures of data stored in the PKCS#7 format.

## Syntax

```text
SecureBlackbox.MessageVerifier
```

## Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

MessageVerifier can process signed data in PKCS#7 SignedData and AuthenticatedData subformats. RSA, ECDSA, and EdDSA algorithms are supported.

Setting up and using MessageVerifier is easy:

- Set up your source and destination via [InputFile](#inputfile-property-messageverifier-module) ([InputBytes](#inputbytes-property-messageverifier-module)) and [OutputFile](#outputfile-property-messageverifier-module) ([OutputBytes](#outputbytes-property-messageverifier-module)) properties. For detached signatures, provide the signed data separately via [DataFile](#datafile-property-messageverifier-module) ([DataBytes](#databytes-property-messageverifier-module)).
- For the SignedData-type signatures (most commonly used), add the public part of the signing certificate to the [KnownCertificates](#knowncertificates-property-messageverifier-module) collection. This step may be unnecessary, as it is typical for signers to include their certificates in the signature.
- For the AuthenticatedData-type signature, add the recipient's (i.e. your) certificate, with its private key, to [KnownCertificates](#knowncertificates-property-messageverifier-module) collection.
- Call [Verify](#verify-method-messageverifier-module) or [VerifyDetached](#verifydetached-method-messageverifier-module), as appropriate, to execute the validation operation.
- Post-validation, you can get access to signature properties, such as [ClaimedSigningTime](#claimedsigningtime-property-messageverifier-module), [SignedAttributes](#signedattributes-property-messageverifier-module), and [UnsignedAttributes](#unsignedattributes-property-messageverifier-module).

Note that MessageVerifier can only work with binary PKCS#7-compliant and PKCS#1-compliant signatures. To process S/MIME-signed emails, see [MailReader](MailReader.md#MailReader). To process PGP signatures, see [PGPReader](PGPReader.md#PGPReader).

MessageVerifier is a simplified form of [CAdESVerifier](CAdESVerifier.md#CAdESVerifier). Both classes work with PKCS#7 signed messages. [CAdESVerifier](CAdESVerifier.md#CAdESVerifier), however, provides support for advanced (CAdES) signatures, including long-term validity, archival, and full chain validation capabilities. These advanced capabilities are absent from MessageVerifier, which is only capable of processing basic PKCS#7 signatures without any chain of trust validation.

```text
MessageVerifier verifier = new MessageVerifier();

// Select the file which contains the signed message
verifier.setInputFile("signedMessage.bin");

if (verifier.checkSignatureType() == Constants.stPKCS7Detached)
{
    // To verify a detached signature, we need
    // to provide both the signature and the original data
    verifier.setDataFile("message.txt");

    verifier.verifyDetached();
}
else
{
    // To verify an enveloping signature, we need
    // to provide the location to extract the data
    verifier.setOutputFile("output.txt");

    verifier.verify();
}

System.out.println("Validation result: " + verifier.getSignatureValidationResult() + "\n" +
        "Signing time: " + verifier.getValidatedSigningTime() + "\n" +
        "TSA certificate: " + verifier.getSigningCertificate().getSubjectRDN());

// Output:
//
//   Validation result: 0 // 0 == svtValid
//   Signing time: 2024-05-16 15:18:35
//   TSA certificate: /CN=Test Certificate
```

## Property List

*The following is the full list of the properties of the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Certificates](#certificates-property-messageverifier-module) | A collection of certificates included in the electronic signature. |
| [ClaimedSigningTime](#claimedsigningtime-property-messageverifier-module) | Returns a signature's claimed signing time. |
| [ContentType](#contenttype-property-messageverifier-module) | A content type property of the signed message. |
| [DataBytes](#databytes-property-messageverifier-module) | Use this property to pass the original signed data to module in the byte array form. |
| [DataFile](#datafile-property-messageverifier-module) | The name of the file containing the original signed data. |
| [FIPSMode](#fipsmode-property-messageverifier-module) | Reserved. |
| [HashAlgorithm](#hashalgorithm-property-messageverifier-module) | Hash algorithm which was used to calculate the signature. |
| [InputBytes](#inputbytes-property-messageverifier-module) | Use this property to pass the input to module in byte array form. |
| [InputFile](#inputfile-property-messageverifier-module) | Path to the file containing the signed message. |
| [InputIsHash](#inputishash-property-messageverifier-module) | Specifies whether the input source contains the hash of the data or the actual data. |
| [KnownCertificates](#knowncertificates-property-messageverifier-module) | Additional certificates for chain validation. |
| [MACAlgorithm](#macalgorithm-property-messageverifier-module) | Specifies the hash algorithm to be used. |
| [OutputBytes](#outputbytes-property-messageverifier-module) | Use this property to read the output the module object has produced. |
| [OutputFile](#outputfile-property-messageverifier-module) | Path to the file to save the extracted data to. |
| [SignatureType](#signaturetype-property-messageverifier-module) | The type of the processed signature. |
| [SignatureValidationResult](#signaturevalidationresult-property-messageverifier-module) | The signature validation result. |
| [SignedAttributes](#signedattributes-property-messageverifier-module) | Custom signature attributes that are covered by the electronic signature. |
| [SigningCertificate](#signingcertificate-property-messageverifier-module) | The certificate that was used to create the signature. |
| [Timestamp](#timestamp-property-messageverifier-module) | Contains the timestamp which is being validated. |
| [Timestamped](#timestamped-property-messageverifier-module) | Indicates whether or not the signature is timestamped. |
| [TSACertificate](#tsacertificate-property-messageverifier-module) | The certificate of the Time Stamping Authority. |
| [UnsignedAttributes](#unsignedattributes-property-messageverifier-module) | Custom unsigned attributes included in the electronic signature. |
| [ValidatedSigningTime](#validatedsigningtime-property-messageverifier-module) | Contains the certified signing time. |

## Method List

*The following is the full list of the methods of the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [CheckSignatureType](#checksignaturetype-method-messageverifier-module) | Determines the signature kind. |
| [Config](#config-method-messageverifier-module) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-messageverifier-module) | Performs an additional action. |
| [Reset](#reset-method-messageverifier-module) | Resets the module settings. |
| [Verify](#verify-method-messageverifier-module) | Verifies digitally signed data. |
| [VerifyDetached](#verifydetached-method-messageverifier-module) | Verifies a detached signature. |

## 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.*

|  |  |
| --- | --- |
| [Error](#error-event-messageverifier-module) | Information about errors during PKCS#7 message verification. |
| [Notification](#notification-event-messageverifier-module) | This event notifies the application about an underlying control flow event. |
| [RecipientFound](#recipientfound-event-messageverifier-module) | Fires to report a message addressee parameters. |
| [SignatureFound](#signaturefound-event-messageverifier-module) | Signifies the start of signature validation. |
| [SignatureValidated](#signaturevalidated-event-messageverifier-module) | Marks the completion of the signature validation routine. |
| [TimestampFound](#timestampfound-event-messageverifier-module) | Signifies the start of a timestamp validation routine. |
| [TimestampValidated](#timestampvalidated-event-messageverifier-module) | Reports the completion of the timestamp validation routine. |

## Config Settings

*The following is a list of config settings for the module with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [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. |

# Certificates Property ([MessageVerifier](#messageverifier-module) Module)

A collection of certificates included in the electronic signature.

## Syntax

```text
public var certificates: Array<Certificate> {
  get {...}
}
```

## Default Value

""

## Remarks

This property includes a collection of certificates of the currently selected info.

This property is read-only.

# ClaimedSigningTime Property ([MessageVerifier](#messageverifier-module) Module)

Returns a signature's claimed signing time.

## Syntax

```text
public var claimedSigningTime: String {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use [ValidatedSigningTime](#validatedsigningtime-property-messageverifier-module) to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.

This property is read-only.

# ContentType Property ([MessageVerifier](#messageverifier-module) Module)

A content type property of the signed message.

## Syntax

```text
public var contentType: String {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to check the content type property of the processed signed message.

This property is read-only.

# DataBytes Property ([MessageVerifier](#messageverifier-module) Module)

Use this property to pass the original signed data to module in the byte array form.

## Syntax

```text
public var dataBytes: Data {
  get {...}
  set {...}
}
```

## Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

# DataFile Property ([MessageVerifier](#messageverifier-module) Module)

The name of the file containing the original signed data.

## Syntax

```text
public var dataFile: String {
  get {...}
  set {...}
}
```

## Default Value

""

## Remarks

Use this property to provide the original data when validating detached signatures with [VerifyDetached](#verifydetached-method-messageverifier-module).

# FIPSMode Property ([MessageVerifier](#messageverifier-module) Module)

Reserved.

## Syntax

```text
public var fipsMode: Bool {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

This property is reserved for future use.

# HashAlgorithm Property ([MessageVerifier](#messageverifier-module) Module)

Hash algorithm which was used to calculate the signature.

## Syntax

```text
public var hashAlgorithm: String {
  get {...}
  set {...}
}
```

## Default Value

""

## Remarks

Check this property after calling [Verify](#verify-method-messageverifier-module) or [VerifyDetached](#verifydetached-method-messageverifier-module) to get the hash algorithm that was used to calculate the signature message digest.

# InputBytes Property ([MessageVerifier](#messageverifier-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 ([MessageVerifier](#messageverifier-module) Module)

Path to the file containing the signed message.

## Syntax

```text
public var inputFile: String {
  get {...}
  set {...}
}
```

## Default Value

""

## Remarks

Use this property to provide a file containing the signed data, either enveloping or detached.

# InputIsHash Property ([MessageVerifier](#messageverifier-module) Module)

Specifies whether the input source contains the hash of the data or the actual data.

## Syntax

```text
public var inputIsHash: Bool {
  get {...}
  set {...}
}
```

## Default Value

False

## Remarks

Use this property to tell the component whether the input source contains the actual data or its hash.

# KnownCertificates Property ([MessageVerifier](#messageverifier-module) Module)

Additional certificates for chain validation.

## Syntax

```text
public var knownCertificates: Array<Certificate> {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is read-only.

# MACAlgorithm Property ([MessageVerifier](#messageverifier-module) Module)

Specifies the hash algorithm to be used.

## Syntax

```text
public var macAlgorithm: String {
  get {...}
}
```

## Default Value

"SHA256"

## Remarks

This property specifies the MAC algorithm that was used to calculate an authenticated signature.

|  |  |  |
| --- | --- | --- |
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 |  |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 |  |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |  |

This property is read-only.

# OutputBytes Property ([MessageVerifier](#messageverifier-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-messageverifier-module) and OutputStream properties had not been assigned.

This property is read-only.

# OutputFile Property ([MessageVerifier](#messageverifier-module) Module)

Path to the file to save the extracted data to.

## Syntax

```text
public var outputFile: String {
  get {...}
  set {...}
}
```

## Default Value

""

## Remarks

Use this property when validating enveloping signatures to specify the output file where the extracted message should be saved.

# SignatureType Property ([MessageVerifier](#messageverifier-module) Module)

The type of the processed signature.

## Syntax

```text
public var signatureType: MessageVerifierSignatureTypes {
  get {...}
}
public enum MessageVerifierSignatureTypes: Int32 {
  case stUnknown = 0
  case stPKCS1Detached = 1
  case stPKCS7Detached = 2
  case stPKCS7Enveloping = 3
  case stPKCS7MACDetached = 4
  case stPKCS7MACEnveloping = 5
}
```

## Default Value

0

## Remarks

Use this property to check the result of the most recent signature validation.

|  |  |  |
| --- | --- | --- |
| stUnknown | 0 | Unknown or unsupported signature types |
| stPKCS1Detached | 1 | Detached PKCS#1 signature |
| stPKCS7Detached | 2 | Detached PKCS#7 signature |
| stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature |
| stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature |
| stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature |

This property is read-only.

# SignatureValidationResult Property ([MessageVerifier](#messageverifier-module) Module)

The signature validation result.

## Syntax

```text
public var signatureValidationResult: MessageVerifierSignatureValidationResults {
  get {...}
}
public enum MessageVerifierSignatureValidationResults: Int32 {
  case svtValid = 0
  case svtUnknown = 1
  case svtCorrupted = 2
  case svtSignerNotFound = 3
  case svtFailure = 4
  case svtReferenceCorrupted = 5
}
```

## Default Value

0

## Remarks

Use this property to check the result of the most recent signature validation.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

This property is read-only.

# SignedAttributes Property ([MessageVerifier](#messageverifier-module) Module)

Custom signature attributes that are covered by the electronic signature.

## Syntax

```text
public var signedAttributes: Array<SignatureAttribute> {
  get {...}
}
```

## Default Value

""

## Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as signed attributes are covered by the signature.

This property is read-only.

# SigningCertificate Property ([MessageVerifier](#messageverifier-module) Module)

The certificate that was used to create the signature.

## Syntax

```text
public var signingCertificate: Certificate {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to access the certificate that was used to create the signature. This property might not be available if the signer chose not to include the certificate into the signature.

This property is read-only.

# Timestamp Property ([MessageVerifier](#messageverifier-module) Module)

Contains the timestamp which is being validated.

## Syntax

```text
public var timestamp: TimestampInfo {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to access the timestamp which is currently being validated.

This property is read-only.

# Timestamped Property ([MessageVerifier](#messageverifier-module) Module)

Indicates whether or not the signature is timestamped.

## Syntax

```text
public var timestamped: Bool {
  get {...}
}
```

## Default Value

False

## Remarks

This property returns True if the signature is timestamped, and False otherwise.

This property is read-only.

# TSACertificate Property ([MessageVerifier](#messageverifier-module) Module)

The certificate of the Time Stamping Authority.

## Syntax

```text
public var tsaCertificate: Certificate {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to access the certificate of the TSA that produced the timestamp.

Note that in some instances the TSA certificate might be unavailable, even for timestamped documents and signatures.

This property is read-only.

# UnsignedAttributes Property ([MessageVerifier](#messageverifier-module) Module)

Custom unsigned attributes included in the electronic signature.

## Syntax

```text
public var unsignedAttributes: Array<SignatureAttribute> {
  get {...}
}
```

## Default Value

""

## Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as unsigned attributes are not covered by the signature and can be changed or removed without affecting the signature.

This property is read-only.

# ValidatedSigningTime Property ([MessageVerifier](#messageverifier-module) Module)

Contains the certified signing time.

## Syntax

```text
public var validatedSigningTime: String {
  get {...}
}
```

## Default Value

""

## Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

This property is read-only.

# CheckSignatureType Method ([MessageVerifier](#messageverifier-module) Module)

Determines the signature kind.

## Syntax

```text
public func checkSignatureType() throws -> Int32
```

## Remarks

Use this method to determine the kind of the signature stored in [InputFile](#inputfile-property-messageverifier-module) (InputStream).

|  |  |  |
| --- | --- | --- |
| stUnknown | 0 | Unknown or unsupported signature types |
| stPKCS1Detached | 1 | Detached PKCS#1 signature |
| stPKCS7Detached | 2 | Detached PKCS#7 signature |
| stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature |
| stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature |
| stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature |

# Config Method ([MessageVerifier](#messageverifier-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-messageverifier-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-messageverifier-module), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DoAction Method ([MessageVerifier](#messageverifier-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 ([MessageVerifier](#messageverifier-module) Module)

Resets the component settings.

## Syntax

```text
public func reset() throws -> Void
```

## Remarks

Reset is a generic method available in every class.

# Verify Method ([MessageVerifier](#messageverifier-module) Module)

Verifies digitally signed data.

## Syntax

```text
public func verify() throws -> Void
```

## Remarks

PKCS#7 and its successor, CMS, support two types of signatures: (1) enveloping signatures, where the signed data and its signature are combined in the same message, and (2) detached signatures, where the signature is stored as a separate entity. This method verifies enveloped signatures and extracts data contained in them. Use [VerifyDetached](#verifydetached-method-messageverifier-module) to verify detached signatures.

This method expects the enveloping signature to be provided via [InputFile](#inputfile-property-messageverifier-module) or InputStream properties.

Note that this method only checks the integrity of the signature, i.e., that it is signed with the claimed certificate and has not been altered. It does not validate the signing certificate chain. To validate the certificate chain, either use [CertificateValidator](CertificateValidator.md#CertificateValidator) component together with MessageVerifier, or consider using [CAdESVerifier](CAdESVerifier.md#CAdESVerifier) component instead.

# VerifyDetached Method ([MessageVerifier](#messageverifier-module) Module)

Verifies a detached signature.

## Syntax

```text
public func verifyDetached() throws -> Void
```

## Remarks

Use this method to verify detached signatures. Pass the signature via [InputFile](#inputfile-property-messageverifier-module) (or InputStream) property, and the original data via [DataFile](#datafile-property-messageverifier-module) (DataStream).

# Error Event ([MessageVerifier](#messageverifier-module) Module)

Information about errors during PKCS#7 message verification.

## Syntax

```text
func onError(errorCode: Int32, description: String)
```

## Remarks

The event is fired in case of exceptional conditions during message processing.

*ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Messages](#trappable-errors-messageverifier-module) section.

# Notification Event ([MessageVerifier](#messageverifier-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.

This class can fire this event with the following *EventID* values:

|  |  |
| --- | --- |
| Progress | Fires periodically to report the progress of the current operation. The EventParam parameter contains a slash-separated pair of values (Current/Total). |

# RecipientFound Event ([MessageVerifier](#messageverifier-module) Module)

Fires to report a message addressee parameters.

## Syntax

```text
func onRecipientFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool)
```

## Remarks

This event is fired for each addressee the message is encrypted for. It may fire several times in a row if the message is encrypted for more than one recipient.

The *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters to identify the recipient's certificate. *CertFound* indicates if the specified certificate has been located in [Certificates](#certificates-property-messageverifier-module) collection. If it wasn't, you might want to look up the certificate manually, and add it to the collection inside the event handler.

# SignatureFound Event ([MessageVerifier](#messageverifier-module) Module)

Signifies the start of signature validation.

## Syntax

```text
func onSignatureFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateSignature: inout Bool, validateChain: inout Bool)
```

## Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters. It fires for every signature located in the verified document or message.

The *CertFound* parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the [KnownCertificates](#knowncertificates-property-messageverifier-module) property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the  and  properties respectively.

Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation.

# SignatureValidated Event ([MessageVerifier](#messageverifier-module) Module)

Marks the completion of the signature validation routine.

## Syntax

```text
func onSignatureValidated(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, validationResult: Int32)
```

## Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the *IssuerRDN*, *SerialNumber*, and/or *SubjectKeyID* parameters to identify the signing certificate.

*ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

# TimestampFound Event ([MessageVerifier](#messageverifier-module) Module)

Signifies the start of a timestamp validation routine.

## Syntax

```text
func onTimestampFound(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, certFound: Bool, validateTimestamp: inout Bool, validateChain: inout Bool)
```

## Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters.

The *CertFound* parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the [KnownCertificates](#knowncertificates-property-messageverifier-module) property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the  and  properties respectively.

Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation.

# TimestampValidated Event ([MessageVerifier](#messageverifier-module) Module)

Reports the completion of the timestamp validation routine.

## Syntax

```text
func onTimestampValidated(issuerRDN: String, serialNumber: Data, subjectKeyID: Data, time: String, validationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32)
```

## Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

*ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

# 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.

# SignatureAttribute Type

Represents an attribute of a digital PKCS#7/CMS signature.

## Remarks

Attributes store auxiliary information about the signed message, the signature, or the owner. Each attribute is a = pair.

Common attributes are signing time, a content type, a policy identifier, and a signature timestamp.

The following fields are available:

- [OID](#SignatureAttribute_f_OID)

- [Value](#SignatureAttribute_f_Value)

## Fields

 **oid** *String*
*Default Value: ""*

The object identifier of the attribute.

 **value** *Data*
*Default Value: ""*

The value of the attribute.

## Constructors

*Swift Syntax*

```text
public init()
```

 Creates a new, empty, signature attribute.

# TimestampInfo Type

A container for timestamp information.

## Remarks

The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.

The following fields are available:

- [Accuracy](#TimestampInfo_f_Accuracy)

- [Bytes](#TimestampInfo_f_Bytes)

- [CertificateIndex](#TimestampInfo_f_CertificateIndex)

- [ChainValidationDetails](#TimestampInfo_f_ChainValidationDetails)

- [ChainValidationResult](#TimestampInfo_f_ChainValidationResult)

- [ContainsLongTermInfo](#TimestampInfo_f_ContainsLongTermInfo)

- [EntityLabel](#TimestampInfo_f_EntityLabel)

- [HashAlgorithm](#TimestampInfo_f_HashAlgorithm)

- [ParentEntity](#TimestampInfo_f_ParentEntity)

- [SerialNumber](#TimestampInfo_f_SerialNumber)

- [Time](#TimestampInfo_f_Time)

- [TimestampType](#TimestampInfo_f_TimestampType)

- [TSAName](#TimestampInfo_f_TSAName)

- [ValidationLog](#TimestampInfo_f_ValidationLog)

- [ValidationResult](#TimestampInfo_f_ValidationResult)

## Fields

 **accuracy** *Int64 (read-only)*
*Default Value: 0*

This field indicates the accuracy of the included time mark, in microseconds.

 **bytes** *Data (read-only)*
*Default Value: ""*

Returns the raw timestamp data in DER format.

 **certificateIndex** *Int32 (read-only)*
*Default Value: -1*

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

 **chainValidationDetails** *Int32 (read-only)*
*Default Value: 0*

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

 **chainValidationResult** *ChainValidities (read-only)*
*Default Value: 0*

The outcome of a certificate chain validation routine.

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

 **containsLongTermInfo** *Bool (read-only)*
*Default Value: False*

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

 **entityLabel** *String (read-only)*
*Default Value: ""*

Use this property to get the timestamp entity label.

This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

 **hashAlgorithm** *String (read-only)*
*Default Value: ""*

Returns the timestamp's 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 |  |

 **parentEntity** *String (read-only)*
*Default Value: ""*

Use this property to get the label of the timestamp's parent entity.

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

 **serialNumber** *Data (read-only)*
*Default Value: ""*

Returns the timestamp's serial number.

 **time** *String (read-only)*
*Default Value: ""*

The time point incorporated into the timestamp.

 **timestampType** *Int32 (read-only)*
*Default Value: 0*

Returns the type of the timestamp.

Available options:

|  |  |  |
| --- | --- | --- |
| tstUnknown | 0 |  |
| tstLegacy | 1 | Supported by: Authenticode components |
| tstTrusted | 2 | Supported by: Authenticode components |
| tstGeneric | 3 | Supported by: CAdES components |
| tstESC | 4 | Supported by: CAdES components |
| tstContent | 5 | Supported by: CAdES components |
| tstCertsAndCRLs | 6 | Supported by: CAdES components |
| tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
| tstIndividualDataObjects | 10 | Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
| tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

 **tsaName** *String (read-only)*
*Default Value: ""*

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

 **validationLog** *String (read-only)*
*Default Value: ""*

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

 **validationResult** *SignatureValidities (read-only)*
*Default Value: 0*

Contains the timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

## Constructors

*Swift Syntax*

```text
public init()
```

 Creates a new TimestampInfo object with default field values.

# Config Settings ([MessageVerifier](#messageverifier-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-messageverifier-module) method.

### MessageVerifier Config Settings

**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.

### 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 ([MessageVerifier](#messageverifier-module) Module)

### MessageVerifier 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)) |