# PublicKeyCrypto Module

The PublicKeyCrypto module supports encrypting, decrypting, signing and verifying messages.

## Syntax

```text
SecureBlackbox.PublicKeyCrypto
```

## Remarks

PublicKeyCrypto allows you to encrypt, decrypt, sign and verify uninterpreted data. It implements low-level, or "raw" cryptographic primitives, such as RSA-PKCS1. The cryptographic primitives are typically used internally in higher-level protocols, such as CMS or PGP.

Cryptographic primitives work on small quantities of data (up to a few kilobytes). If you are looking to encrypt or sign large blobs of data, it is very likely that you need to use higher-level classes, such as [MessageEncryptor](MessageEncryptor.md#MessageEncryptor), [CAdESSigner](CAdESSigner.md#CAdESSigner), or [PGPWriter](PGPWriter.md#PGPWriter).

A code snippet below illustrates the use of PublicKeyCrypto to encrypt (and decrypt) a data piece with OpenSSL-generated RSA keypair.

```text
procedure TForm1.HandleKeyPasswordNeeded(Sender: TObject; const NeededFor: String;
  var Password: String; var Cancel: Boolean);
begin
  Password := 'key-password';
end;

procedure TForm1.btnRSAEncryptClick(Sender: TObject);
var
  Crypto : TsbxPublicKeyCrypto;
  KeyMgr : TsbxCryptoKeyManager;
  Plaintext, Ciphertext, Decrypted : TBytes;
begin
  // prep
  Plaintext := TEncoding.UTF8.GetBytes('Hello, World!');

  // encryption
  KeyMgr := TsbxCryptoKeyManager.Create(nil);
  try
    KeyMgr.ImportFromFile('public.pem', kffPEM, '', '', '', ktPublic);

    Crypto := TsbxPublicKeyCrypto.Create(nil);
    try
      Crypto.Key := KeyMgr.Key;
      Ciphertext := Crypto.Encrypt(Plaintext);
    finally
      FreeAndNil(Crypto);
    end;
  finally
    FreeAndNil(KeyMgr);
  end;

  // decryption
  KeyMgr := TsbxCryptoKeyManager.Create(nil);
  try
    KeyMgr.OnPasswordNeeded := HandleKeyPasswordNeeded;
    KeyMgr.ImportFromFile('private.pem', kffPEM, '', '', '', ktSecret);

    Crypto := TsbxPublicKeyCrypto.Create(nil);
    try
      Crypto.Key := KeyMgr.Key;
      Decrypted := Crypto.Decrypt(Ciphertext);
    finally
      FreeAndNil(Crypto);
    end;
  finally
    FreeAndNil(KeyMgr);
  end;

  ShowMessage(TEncoding.UTF8.GetString(Decrypted));
end;
```

## Property List

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

|  |  |
| --- | --- |
| [CanEncrypt](#canencrypt-property-publickeycrypto-module) | Returns true if the crypto object can be used for encryption. |
| [CanSign](#cansign-property-publickeycrypto-module) | Returns true if the crypto object is capable of data signing. |
| [FIPSMode](#fipsmode-property-publickeycrypto-module) | Reserved. |
| [HashAlgorithm](#hashalgorithm-property-publickeycrypto-module) | The hash algorithm to be used during the crypto operation. |
| [InputEncoding](#inputencoding-property-publickeycrypto-module) | The encoding to apply to the input data. |
| [InputIsHash](#inputishash-property-publickeycrypto-module) | Indicates whether the input data contains the hash or the actual data. |
| [JsonDetails](#jsondetails-property-publickeycrypto-module) | Provides a container for JSON settings. |
| [Key](#key-property-publickeycrypto-module) | The key to employ for the crypto operation. |
| [OutputEncoding](#outputencoding-property-publickeycrypto-module) | The encoding type to apply to the output data. |
| [Scheme](#scheme-property-publickeycrypto-module) | The algorithm scheme to use. |
| [SchemeParams](#schemeparams-property-publickeycrypto-module) | The algorithm scheme parameters to employ. |
| [SignatureValidationResult](#signaturevalidationresult-property-publickeycrypto-module) | The signature validation result. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-publickeycrypto-module) | Sets or retrieves a configuration setting. |
| [Decrypt](#decrypt-method-publickeycrypto-module) | Decrypts a buffer. |
| [DecryptFile](#decryptfile-method-publickeycrypto-module) | Decrypts a file. |
| [DoAction](#doaction-method-publickeycrypto-module) | Performs an additional action. |
| [Encrypt](#encrypt-method-publickeycrypto-module) | Encrypts a buffer. |
| [EncryptFile](#encryptfile-method-publickeycrypto-module) | Encrypts a file. |
| [Reset](#reset-method-publickeycrypto-module) | Resets the module settings. |
| [Sign](#sign-method-publickeycrypto-module) | Signs a buffer. |
| [SignFile](#signfile-method-publickeycrypto-module) | Signs a file. |
| [Verify](#verify-method-publickeycrypto-module) | Verifies an enveloped or enveloping signature contained in a buffer. |
| [VerifyDetached](#verifydetached-method-publickeycrypto-module) | Verifies a detached signature. |
| [VerifyDetachedFile](#verifydetachedfile-method-publickeycrypto-module) | Verifies a detached signature. |
| [VerifyFile](#verifyfile-method-publickeycrypto-module) | Verifies an enveloped or enveloping signature contained in a file. |

## 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-publickeycrypto-module) | Reports error information during a crypto operation. |
| [Notification](#notification-event-publickeycrypto-module) | This event notifies the application about an underlying control flow event. |

## 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. |
| [UseAlgorithmPrefix](#UseAlgorithmPrefix) | Enables or disables the PKCS#1 ASN.1 algorithm prefix. |
| [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. |

# CanEncrypt Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

Returns true if the crypto object can be used for encryption.

## Syntax

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

## Default Value

False

## Remarks

This property returns true if the crypto object can be used for encryption and decryption. This capability depends on the cryptographic algorithm.

For ML-KEM keys, this property returns true, and the [Encrypt](#encrypt-method-publickeycrypto-module) and [Decrypt](#decrypt-method-publickeycrypto-module) methods perform key encapsulation and decapsulation rather than conventional message encryption.

This property is read-only.

# CanSign Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

Returns true if the crypto object is capable of data signing.

## Syntax

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

## Default Value

False

## Remarks

This property returns true if the crypto object can be used for signing data and validating signatures. This capability depends on the cryptographic algorithm.

This property is read-only.

# FIPSMode Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

Reserved.

## Syntax

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

## Default Value

False

## Remarks

This property is reserved for future use.

# HashAlgorithm Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The hash algorithm to be used during the crypto operation.

## Syntax

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

## Default Value

"SHA256"

## Remarks

Use this property to adjust the hash to be used during the cryptographic operation. This typically applies to signing and verification, but can also apply to more complex encryption primitives, such as RSA-OEAP.

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

# InputEncoding Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The encoding to apply to the input data.

## Syntax

```text
public var inputEncoding: PublicKeyCryptoInputEncodings {
  get {...}
  set {...}
}
public enum PublicKeyCryptoInputEncodings: Int32 {
  case cetDefault = 0
  case cetBinary = 1
  case cetBase64 = 2
  case cetCompact = 3
  case cetJSON = 4
}
```

## Default Value

0

## Remarks

Use this property to specify the encoding to apply to the input data.

|  |  |  |
| --- | --- | --- |
| cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
| cetBinary | 1 | Raw binary encoding (no encoding) |
| cetBase64 | 2 | Base64 encoding (armouring) |
| cetCompact | 3 | JSON compact encoding |
| cetJSON | 4 | JSON standard encoding |

# InputIsHash Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

Indicates whether the input data contains the hash or the actual data.

## Syntax

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

## Default Value

False

## Remarks

Set this property to true to tell the class that the data you are passing to it is the hash of the data, rather than the actual (unhashed) data. If this property is set to false, class will hash the provided data internally if it is assumed by the algorithm.

# JsonDetails Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

Provides a container for JSON settings.

## Syntax

```text
public var jsonDetails: JWSettings {
  get {...}
}
```

## Default Value

0

## Remarks

Use this property when using JSON Web Encryption/Signature to tune up the JSON parameters.

This property is read-only.

# Key Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The key to employ for the crypto operation.

## Syntax

```text
public var key: CryptoKey {
  get {...}
  set {...}
}
```

## Default Value

0

## Remarks

Use this property to specify the key to perform the crypto operation with.

Please note that the key assigned should be of a proper type (a public key, not a symmetric key), have a proper set of capabilities (signing and/or encryption), and include its private part for signing and decryption operations.

This property is read-only.

# OutputEncoding Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The encoding type to apply to the output data.

## Syntax

```text
public var outputEncoding: PublicKeyCryptoOutputEncodings {
  get {...}
  set {...}
}
public enum PublicKeyCryptoOutputEncodings: Int32 {
  case cetDefault = 0
  case cetBinary = 1
  case cetBase64 = 2
  case cetCompact = 3
  case cetJSON = 4
}
```

## Default Value

0

## Remarks

Use this property to specify the encoding type to apply to the protected data.

|  |  |  |
| --- | --- | --- |
| cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
| cetBinary | 1 | Raw binary encoding (no encoding) |
| cetBase64 | 2 | Base64 encoding (armouring) |
| cetCompact | 3 | JSON compact encoding |
| cetJSON | 4 | JSON standard encoding |

# Scheme Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The algorithm scheme to use.

## Syntax

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

## Default Value

""

## Remarks

Certain asymmetric algorithms are often accompanied with a specific algorithm scheme. Two typical examples are RSA's own OAEP and PSS schemes. Use this property to tune up the scheme to use. Leave it empty to proceed with the standard scheme (such as PKCS#1-v1.5 for RSA). Supported schemes:

RSA: PKCS#1, PSS, OAEP, SSL3

ECDSA: ed25519, ed448, ed25519ph, ed448ph

ML-DSA: ML-DSA-44, ML-DSA-65, ML-DSA-87

ML-KEM: ML-KEM-512, ML-KEM-768, ML-KEM-1024

# SchemeParams Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The algorithm scheme parameters to employ.

## Syntax

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

## Default Value

""

## Remarks

Use this property to specify the parameters of the algorithm scheme if needed.

# SignatureValidationResult Property ([PublicKeyCrypto](#publickeycrypto-module) Module)

The signature validation result.

## Syntax

```text
public var signatureValidationResult: PublicKeyCryptoSignatureValidationResults {
  get {...}
}
public enum PublicKeyCryptoSignatureValidationResults: 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.

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

# Decrypt Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Decrypts a buffer.

## Syntax

```text
public func decrypt(buffer: Data) throws -> Data
```

## Remarks

Use this method to decrypt a byte array and get the encrypted message in another byte array.

Specify the decryption key in [Key](#key-property-publickeycrypto-module) property before calling this method.

When used with an ML-KEM key, this method performs key decapsulation. Pass the encapsulated ciphertext in *Buffer*; the derived shared secret becomes available through the *Config("SharedSecret")* setting of the crypto object.

# DecryptFile Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Decrypts a file.

## Syntax

```text
public func decryptFile(sourceFile: String, destFile: String) throws -> Void
```

## Remarks

Use this method to decrypt an encrypted file and save the decrypted data to another file.

Specify the decryption key in [Key](#key-property-publickeycrypto-module) property before calling this method.

# DoAction Method ([PublicKeyCrypto](#publickeycrypto-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. |

# Encrypt Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Encrypts a buffer.

## Syntax

```text
public func encrypt(buffer: Data) throws -> Data
```

## Remarks

Use this method to encrypt a byte array and get the protected message in another byte array.

Specify the encryption key in the [Key](#key-property-publickeycrypto-module) property before commencing encryption.

When used with an ML-KEM key, this method performs key encapsulation. The returned byte array contains the encapsulated ciphertext, and the derived shared secret becomes available through the *Config("SharedSecret")* setting of the crypto object.

# EncryptFile Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Encrypts a file.

## Syntax

```text
public func encryptFile(sourceFile: String, destFile: String) throws -> Void
```

## Remarks

Use this method to encrypt a file and save the protected message to another file.

Specify the encryption key in [Key](#key-property-publickeycrypto-module) property before commencing encryption.

# Reset Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Resets the component settings.

## Syntax

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

## Remarks

Reset is a generic method available in every class.

# Sign Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Signs a buffer.

## Syntax

```text
public func sign(buffer: Data, detached: Bool) throws -> Data
```

## Remarks

Use this method to sign a byte array and get the protected message in another byte array. Set the *Detached* parameter to false to create an enveloped/enveloping, rather than detached signature. Please note that certain signature algorithms/kinds only support detached signing.

Specify the signing key in [Key](#key-property-publickeycrypto-module) property before commencing the signing.

Please note that the key assigned must have a private key part.

# SignFile Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Signs a file.

## Syntax

```text
public func signFile(sourceFile: String, destFile: String, detached: Bool) throws -> Void
```

## Remarks

Use this method to sign a file and save the protected message to another file.

Specify the signing key in [Key](#key-property-publickeycrypto-module) property before the signing. Please make sure the assigned key has a private key associated with it.

Set *Detached* parameter to false to create an enveloped/enveloping signature. This may not be supported by certain algorithms or encryption modes.

# Verify Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Verifies an enveloped or enveloping signature contained in a buffer.

## Syntax

```text
public func verify(buffer: Data) throws -> Data
```

## Remarks

Use this method to verify an enveloped or enveloping signature contained in a byte array. The method verifies the signature and extracts the original signed content into another byte array.

The validation result is stored in [SignatureValidationResult](#signaturevalidationresult-property-publickeycrypto-module) property.

Use [VerifyDetached](#verifydetached-method-publickeycrypto-module) to verify detached signatures.

Specify the verification key in the [Key](#key-property-publickeycrypto-module) property before commencing verification.

# VerifyDetached Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Verifies a detached signature.

## Syntax

```text
public func verifyDetached(signedData: Data, signature: Data) throws -> Void
```

## Remarks

Use this method to verify a detached signature. Pass the original message via the *SignedData* parameter, and the signature via the *Signature* parameter.

The validation result is stored in [SignatureValidationResult](#signaturevalidationresult-property-publickeycrypto-module) property.

Provide the verification key in [Key](#key-property-publickeycrypto-module) property before commencing verification.

# VerifyDetachedFile Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Verifies a detached signature.

## Syntax

```text
public func verifyDetachedFile(signedDataFile: String, signatureFile: String) throws -> Void
```

## Remarks

Use this method to verify a detached signature. Pass the original data via the *SignedDataFile* parameter, and the signature via the *SignatureFile* parameter.

The validation result is stored in [SignatureValidationResult](#signaturevalidationresult-property-publickeycrypto-module) property.

Provide the verification key in [Key](#key-property-publickeycrypto-module) property.

# VerifyFile Method ([PublicKeyCrypto](#publickeycrypto-module) Module)

Verifies an enveloped or enveloping signature contained in a file.

## Syntax

```text
public func verifyFile(sourceFile: String, destFile: String) throws -> Void
```

## Remarks

Use this method to verify an enveloped or enveloping signature and extract the original signed message to another file.

The validation result is stored in [SignatureValidationResult](#signaturevalidationresult-property-publickeycrypto-module) property.

Specify the public verification key in [Key](#key-property-publickeycrypto-module) property before commencing the validation.

# Error Event ([PublicKeyCrypto](#publickeycrypto-module) Module)

Reports error information during a crypto operation.

## Syntax

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

## Remarks

Class fires this event if an error is encountered during a cryptographic operation.

*ErrorCode* contains an error code and *Description* contains a textual description of the error that happened.

# Notification Event ([PublicKeyCrypto](#publickeycrypto-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.

# CryptoKey Type

This container represents a cryptographic key.

## Remarks

This type is a universal placeholder for cryptographic keys.

Version 2026 upgrade note: granular key parameter properties (RSAModulus, EdPublic, DSSP and others) have been removed from this type and are now available via the CryptoKeyManager.GetKeyParam method.

The following fields are available:

- [Algorithm](#CryptoKey_f_Algorithm)

- [Bits](#CryptoKey_f_Bits)

- [Curve](#CryptoKey_f_Curve)

- [Exportable](#CryptoKey_f_Exportable)

- [Fingerprint](#CryptoKey_f_Fingerprint)

- [Handle](#CryptoKey_f_Handle)

- [ID](#CryptoKey_f_ID)

- [IV](#CryptoKey_f_IV)

- [Nonce](#CryptoKey_f_Nonce)

- [Private](#CryptoKey_f_Private)

- [Public](#CryptoKey_f_Public)

- [Subject](#CryptoKey_f_Subject)

- [Symmetric](#CryptoKey_f_Symmetric)

- [Valid](#CryptoKey_f_Valid)

- [Value](#CryptoKey_f_Value)

## Fields

 **algorithm** *String*
*Default Value: ""*

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH, EdDSA, ML-DSA, ML-KEM.

|  |  |  |
| --- | --- | --- |
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 |  |
| SB_SYMMETRIC_ALGORITHM_DES | DES |  |
| SB_SYMMETRIC_ALGORITHM_3DES | 3DES |  |
| SB_SYMMETRIC_ALGORITHM_RC2 | RC2 |  |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 |  |
| SB_SYMMETRIC_ALGORITHM_AES192 | AES192 |  |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |  |
| SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity |  |
| SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish |  |
| SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 |  |
| SB_SYMMETRIC_ALGORITHM_IDEA | IDEA |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 |  |
| SB_SYMMETRIC_ALGORITHM_SEED | SEED |  |
| SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit |  |
| SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic |  |
| SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 |  |
| SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |  |

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

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

The length of the key in bits.

 **curve** *String*
*Default Value: ""*

This property specifies the name of the curve the EC key is built on.

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

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

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

Contains the fingerprint (a hash imprint) of this key.

 **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());
```

 **id** *Data*
*Default Value: ""*

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

 **iv** *Data*
*Default Value: ""*

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

 **nonce** *Data*
*Default Value: ""*

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

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

Returns True if the object hosts a private key, and False otherwise.

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

Returns True if the object hosts a public key, and False otherwise.

 **subject** *Data*
*Default Value: ""*

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

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

Returns True if the object contains a symmetric key, and False otherwise.

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

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

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

The byte array representation of the key value. This may not be available for non- keys.

This property used to be called *Key* in SecureBlackbox versions 2024 and older.

## Constructors

*Swift Syntax*

```text
public init()
```

 Creates an empty crypto key object.

# JWSettings Type

This container represents JSON web security settings.

## Remarks

This type contains properties specific to JSON Web Security.

The following fields are available:

- [KeyHeaderParams](#JWSettings_f_KeyHeaderParams)

- [ProtectedHeader](#JWSettings_f_ProtectedHeader)

- [UnprotectedHeader](#JWSettings_f_UnprotectedHeader)

- [UnprotectedHeaderParams](#JWSettings_f_UnprotectedHeaderParams)

## Fields

 **keyHeaderParams** *String*
*Default Value: "kid"*

Contains key header parameters.

 **protectedHeader** *String*
*Default Value: ""*

Provides access to the header being protected.

 **unprotectedHeader** *String*
*Default Value: ""*

Provides access to the unprotected part of the header.

 **unprotectedHeaderParams** *String*
*Default Value: ""*

Contains unprotected header parameters.

## Constructors

*Swift Syntax*

```text
public init()
```

 Creates an json settings object.

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

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

**UseAlgorithmPrefix**: Enables or disables the PKCS#1 ASN.1 algorithm prefix.Use this property to enable or disable the use of ASN.1 hash algorithm prefix. This may be useful if you work with an external signing service that adds this prefix itself.

### 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 ([PublicKeyCrypto](#publickeycrypto-module) Module)

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