# Struct secureblackbox::SymmetricCrypto

The SymmetricCrypto struct provides capabilities of encrypting and decrypting binary data.

## Syntax

```text
secureblackbox::SymmetricCrypto
```

## Remarks

SymmetricCrypto allows you to encrypt and decrypt uninterpreted binary data with a symmetric block encryption cipher.

SymmetricCrypto is one of the low-level cryptography classes (alongside [PublicKeyCrypto](PublicKeyCrypto.md#PublicKeyCrypto) and [HashFunction](HashFunction.md#HashFunction)) offered by SecureBlackbox. It allows to encrypt pools of binary data with a chosen symmetric encryption cipher. It can be used as a standalone encryption mechanism (for example, for encrypting database data or setting files), or as part of a larger security system (such as PKCS#7 or PGP).

Encryption and decryption with SymmetricCrypto broadly consists of three steps: configuring the encryption parameters, setting up the key material, and actually encrypting or decrypting the data.

**Configuring encryption parameters**

When preparing SymmetricCrypto for action, you need to fine-tune several cryptographic encryption parameters. Normally these would be given to you by the party that expects you to encrypt or decrypt their data (for example: 'AES128-CBC, with the IV of all zeroes').

As a rule, the following parameters need to be selected/adjusted:

- [encryption_algorithm](#encryption_algorithm-property-symmetriccrypto-struct), such as AES128, 3DES, or Blowfish.
- Encryption [mode](#mode-property-symmetriccrypto-struct), such as CBC, CTR, GCM or CCM.
- Block [padding](#padding-property-symmetriccrypto-struct) for data lengths that are not multiples of the cipher's block size (none, PKCS5, or ANSI X9.23).
- [tag_size](#tag_size-property-symmetriccrypto-struct) (for AEAD algorithms only).
- [hash_algorithm](#hash_algorithm-property-symmetriccrypto-struct) and [mac_algorithm](#mac_algorithm-property-symmetriccrypto-struct) (for algorithms that require them).

**Setting up the key material**

Symmetric algorithms use short (typically, 16-32 bytes) encryption keys. The exact key length depends on the encryption algorithm used (for example, 16 bytes for AES128). You can use the [key_size](#key_size-property-symmetriccrypto-struct) property to learn the expected key length for the chosen [encryption_algorithm](#encryption_algorithm-property-symmetriccrypto-struct).

In addition to keys, many encryption modes require additional data. These are typically represented by an Initialization Vector (IV) and a [nonce](#nonce-property-symmetriccrypto-struct). The IV is a randomized public part of the encryption key, which is used to avoid re-use of the same encryption key for different data. Nonce is similar in meaning to the initialization vector, but applies to the algorithm and not the key.

Any key material that you assign to SymmetricCrypto should be first loaded into the [CryptoKeyManager](CryptoKeyManager.md#CryptoKeyManager) object. Once you have done that, simply assign the key object returned by the [CryptoKeyManager](CryptoKeyManager.md#CryptoKeyManager) to the key property. Note that while the IV needs to be provided to the [CryptoKeyManager](CryptoKeyManager.md#CryptoKeyManager), the Nonce needs to be assigned directly to [nonce](#nonce-property-symmetriccrypto-struct) property of the SymmetricCrypto object.

Note that [CryptoKeyManager](CryptoKeyManager.md#CryptoKeyManager) lets you to form the encryption key in a few ways: by loading it from memory or file, generating a new random key, or deriving it from a password. Use the method that is the most appropriate in your circumstances.

**Encrypting and decrypting data**

Now that the component has been set up, you can proceed to the actual encryption or decryption operation. There are a few options you can use here:

- Encrypt (or decrypt) a buffer to a buffer using [encrypt](#encrypt-method-symmetriccrypto-struct) ([decrypt](#decrypt-method-symmetriccrypto-struct)).
- Encrypt a file to a file using [encrypt_file](#encrypt_file-method-symmetriccrypto-struct).
- Encrypt a stream to a stream using encrypt_stream.
- Encrypt longer data chunk by chunk using a sequence of [encrypt_init](#encrypt_init-method-symmetriccrypto-struct), [encrypt_update](#encrypt_update-method-symmetriccrypto-struct), [encrypt_update](#encrypt_update-method-symmetriccrypto-struct), ..., [encrypt_update](#encrypt_update-method-symmetriccrypto-struct), [encrypt_final](#encrypt_final-method-symmetriccrypto-struct) calls.

If you are using an authenticated encryption algorithm that can take additional associated data (AEAD), you can provide that via the [associated_data](#associated_data-property-symmetriccrypto-struct) property.

Please find an example of using SymmetricCrypto to encrypt and decrypt a file below:

```text
//encrypting a file
SymmetricCrypto symmetricCrypto = new SymmetricCrypto();

symmetricCrypto.setEncryptionAlgorithm("RC4"); // default AES256

// generating a key from a password
CryptoKeyManager keyManager = new CryptoKeyManager();
keyManager.deriveKey(256, "MyPassword","");
keyManager.getKey().setIV(new byte[16]);
symmetricCrypto.setKey(keyManager.getKey());

// the encoding to apply to the output data, default cetDefault which depends on
// the operation and type of key being used
symmetricCrypto.setOutputEncoding(SymmetricCrypto.cetBinary);

// first parameter is the path of the file you want to encrypt and the second is the path
// of where the encrypted file will be saved
symmetricCrypto.encryptFile("./message.txt","encryptedFile.bin");

// decrypting a file
symmetricCrypto.reset();

symmetricCrypto.setKey(keyManager.getKey());

// first parameter is the path of the file you want to decrypt and the second is the path
// of where the decrypted file will be saved
symmetricCrypto.decryptFile("encryptedFile.bin","decryptedFile.bin");
```

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the SymmetricCrypto struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SymmetricCrypto when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [associated_data](#associated_data-property-symmetriccrypto-struct) | Provides Associated Data for AEAD algorithms. |
| [block_size](#block_size-property-symmetriccrypto-struct) | The block size of the chosen symmetric cipher. |
| [encryption_algorithm](#encryption_algorithm-property-symmetriccrypto-struct) | The encryption algorithm to use for encrypting the data. |
| [fips_mode](#fips_mode-property-symmetriccrypto-struct) | Reserved. |
| [hash_algorithm](#hash_algorithm-property-symmetriccrypto-struct) | The hash algorithm to use during encryption. |
| [input_encoding](#input_encoding-property-symmetriccrypto-struct) | The encoding to apply to the input data. |
| [key_handle](#key_handle-property-symmetriccrypto-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [key_size](#key_size-property-symmetriccrypto-struct) | Returns the cryptographic key size in bytes. |
| [mac_algorithm](#mac_algorithm-property-symmetriccrypto-struct) | The (H)MAC algorithm to use during encryption. |
| [mode](#mode-property-symmetriccrypto-struct) | Specifies the symmetric cipher mode of operation. |
| [nonce](#nonce-property-symmetriccrypto-struct) | Specifies the Nonce value to employ. |
| [output_encoding](#output_encoding-property-symmetriccrypto-struct) | The encoding to apply to the output data. |
| [padding](#padding-property-symmetriccrypto-struct) | The padding type to apply to the encrypted data. |
| [payload_size](#payload_size-property-symmetriccrypto-struct) | Specifies the payload size, in bytes. |
| [stream_cipher](#stream_cipher-property-symmetriccrypto-struct) | Returns true if the selected algorithms works as a stream cipher. |
| [tag_size](#tag_size-property-symmetriccrypto-struct) | Specifies the AEAD tag size, in bytes. |

## Method List

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

|  |  |
| --- | --- |
| [config](#config-method-symmetriccrypto-struct) | Sets or retrieves a configuration setting. |
| [decrypt](#decrypt-method-symmetriccrypto-struct) | Decrypts a buffer. |
| [decrypt_file](#decrypt_file-method-symmetriccrypto-struct) | Decrypts a file. |
| [decrypt_final](#decrypt_final-method-symmetriccrypto-struct) | Finalization of decryption by blocks. |
| [decrypt_init](#decrypt_init-method-symmetriccrypto-struct) | Initializes a per-block decryption process. |
| [decrypt_update](#decrypt_update-method-symmetriccrypto-struct) | Decrypts the next block of encrypted data. |
| [do_action](#do_action-method-symmetriccrypto-struct) | Performs an additional action. |
| [encrypt](#encrypt-method-symmetriccrypto-struct) | Encrypts a buffer. |
| [encrypt_file](#encrypt_file-method-symmetriccrypto-struct) | Encrypts a file. |
| [encrypt_final](#encrypt_final-method-symmetriccrypto-struct) | Finalization of encryption by blocks. |
| [encrypt_init](#encrypt_init-method-symmetriccrypto-struct) | Initializes a per-block encryption process. |
| [encrypt_update](#encrypt_update-method-symmetriccrypto-struct) | Encrypts the next block of data. |
| [reset](#reset-method-symmetriccrypto-struct) | Resets the struct settings. |

## Event List

*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_error](#on_error-event-symmetriccrypto-struct) | Reports errors during encryption or decryption. |
| [on_notification](#on_notification-event-symmetriccrypto-struct) | This event notifies the application about an underlying control flow event. |
| [on_progress](#on_progress-event-symmetriccrypto-struct) | Reports the data encryption/decryption progress. |

## Config Settings

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

|  |  |
| --- | --- |
| [Compress](#Compress) | Specifies whether the JSON output should be compressed. |
| [CTRLittleEndian](#CTRLittleEndian) | Specifies whether the little-endian representation should be employed in CTR mode. |
| [KeyAlgorithm](#KeyAlgorithm) | Gets or sets a JWE key algorithm. |
| [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 struct. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client structs created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client structs should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# associated_data property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Provides Associated Data for AEAD algorithms.

## Syntax

*Rust Syntax*

```text
fn associated_data(&self ) -> Result<Vec<u8>, SecureBlackboxError> fn set_associated_data(&self, value : Vec<u8>) ->  Option<SecureBlackboxError>
fn set_associated_data_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError>
```

## Remarks

Use this property to set up Associated Data for AEAD encryption algorithms.

## Data Type

Vec

# block_size property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The block size of the chosen symmetric cipher.

## Syntax

*Rust Syntax*

```text
fn block_size(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

This property returns the block size of the chosen symmetric cipher.

Modern symmetric algorithms typically use blocks of 16 bytes. Some older algorithms, such as DES or Blowfish, use 8-byte blocks.

This property is read-only.

## Data Type

i32

# encryption_algorithm property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The encryption algorithm to use for encrypting the data.

## Syntax

*Rust Syntax*

```text
fn encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> fn set_encryption_algorithm(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_encryption_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

"AES256"

## Remarks

This property specifies the base symmetric algorithm to use (e.g. AES128). Use it in conjunction with [mode](#mode-property-symmetriccrypto-struct) to set up the complete encryption scheme (such as AES128-CBC or AES128-GCM).

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

## Data Type

String

# fips_mode property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Reserved.

## Syntax

*Rust Syntax*

```text
fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

This property is reserved for future use.

## Data Type

bool

# hash_algorithm property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The hash algorithm to use during encryption.

## Syntax

*Rust Syntax*

```text
fn hash_algorithm(&self ) -> Result<String, SecureBlackboxError> fn set_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

"SHA256"

## Remarks

Use this property to provide the hash algorithm to be used with the encryption operation. This only applies to certain encryption algorithms/modes.

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

## Data Type

String

# input_encoding property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The encoding to apply to the input data.

## Syntax

*Rust Syntax*

```text
fn input_encoding(&self ) -> Result<i32, SecureBlackboxError> fn set_input_encoding(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Default1   // Binary2   // Base643   // Compact4   // JSON
```

## Default Value

0

## Remarks

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

## Data Type

i32

# key_handle property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

## Syntax

*Rust Syntax*

```text
fn key_handle(&self ) -> Result<i64, SecureBlackboxError> fn set_key_handle(&self, value : i64) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

## Data Type

i64

# key_size property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Returns the cryptographic key size in bytes.

## Syntax

*Rust Syntax*

```text
fn key_size(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Use this property to read the cryptographic key size. For the majority of the symmetric algorithms this is hard-coded in the algorithm itself (such as 16 bytes for AES128), but may be variable for certain exceptions, such as Blowfish or RC4.

This property is read-only.

## Data Type

i32

# mac_algorithm property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The (H)MAC algorithm to use during encryption.

## Syntax

*Rust Syntax*

```text
fn mac_algorithm(&self ) -> Result<String, SecureBlackboxError> fn set_mac_algorithm(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_mac_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Use this property to configure the HMAC algorithm to use with the encryption operation. This only applies to a small subset of algorithms/modes.

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

## Data Type

String

# mode property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Specifies the symmetric cipher mode of operation.

## Syntax

*Rust Syntax*

```text
fn mode(&self ) -> Result<i32, SecureBlackboxError> fn set_mode(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Default1   // ECB2   // CBC3   // CTR4   // CFB85   // GCM6   // CCM7   // Poly13058   // OCB
```

## Default Value

0

## Remarks

Use this property to specify the mode of operation as required by your environment. The default setting is CBC.

|  |  |  |
| --- | --- | --- |
| scmDefault | 0 | The default mode in current circumstances. |
| scmECB | 1 | ECB (electronic code book) mode. This is insecure, unless you know how to use it right. |
| scmCBC | 2 | CBC (cipher block chaining mode) |
| scmCTR | 3 | Counter mode |
| scmCFB8 | 4 | Cipher feedback mode |
| scmGCM | 5 | Galois counter mode |
| scmCCM | 6 | CCM mode |
| scmPoly1305 | 7 | Poly1305 mode (only to be used with ChaCha20 algorithm) |
| scmOCB | 8 | OCB mode |

## Data Type

i32

# nonce property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Specifies the Nonce value to employ.

## Syntax

*Rust Syntax*

```text
fn nonce(&self ) -> Result<Vec<u8>, SecureBlackboxError> fn set_nonce(&self, value : Vec<u8>) ->  Option<SecureBlackboxError>
fn set_nonce_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError>
```

## Remarks

Use this property to specify the Nonce value for the symmetric operation. Not every algorithm or mode uses nonce.

## Data Type

Vec

# output_encoding property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The encoding to apply to the output data.

## Syntax

*Rust Syntax*

```text
fn output_encoding(&self ) -> Result<i32, SecureBlackboxError> fn set_output_encoding(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Default1   // Binary2   // Base643   // Compact4   // JSON
```

## Default Value

0

## Remarks

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

## Data Type

i32

# padding property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

The padding type to apply to the encrypted data.

## Syntax

*Rust Syntax*

```text
fn padding(&self ) -> Result<i32, SecureBlackboxError> fn set_padding(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // None1   // PKCS52   // ANSIX923
```

## Default Value

1

## Remarks

Use this property to specify the padding type to use with the encrypted data. A padding type commonly used in modern security environments is PKCS#5.

|  |  |  |
| --- | --- | --- |
| scpNone | 0 | No padding. You might need to adjust the length of the input data to align it by the encryption block boundary. |
| scpPKCS5 | 1 | Standard PKCS5 (sometimes also referred to as PKCS7) padding |
| scpANSIX923 | 2 | ANSI X.923 padding |

## Data Type

i32

# payload_size property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Specifies the payload size, in bytes.

## Syntax

*Rust Syntax*

```text
fn payload_size(&self ) -> Result<i32, SecureBlackboxError> fn set_payload_size(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

Use this property to specify the size of the input data in bytes. This is only used by a subset of algorithms/modes, such as CCM.

## Data Type

i32

# stream_cipher property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Returns true if the selected algorithms works as a stream cipher.

## Syntax

*Rust Syntax*

```text
fn stream_cipher(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

This property returns true if the selected algorithm processes data as a stream (byte-by-byte), rather than block-by-block. This affects the need to use a proper padding settings.

This property is read-only.

## Data Type

bool

# tag_size property ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Specifies the AEAD tag size, in bytes.

## Syntax

*Rust Syntax*

```text
fn tag_size(&self ) -> Result<i32, SecureBlackboxError> fn set_tag_size(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

16

## Remarks

Use this property to specify/customize the tag size for AEAD encryption.

## Data Type

i32

# config method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-symmetriccrypto-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-symmetriccrypto-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# decrypt method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Decrypts a buffer.

## Syntax

*Rust Syntax*

```text
fn decrypt(&self, buffer : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

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

Specify the decryption key in key property.

# decrypt_file method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Decrypts a file.

## Syntax

*Rust Syntax*

```text
fn decrypt_file(&self, source_file : &str, dest_file : &str) -> Result<(), SecureBlackboxError>
```

## Remarks

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

Specify the decryption key in key property before calling this method.

# decrypt_final method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Finalization of decryption by blocks.

## Syntax

*Rust Syntax*

```text
fn decrypt_final(&self) ->  Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Use this method to finalize of decryption by blocks.

Specify decryption key in key property.

# decrypt_init method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Initializes a per-block decryption process.

## Syntax

*Rust Syntax*

```text
fn decrypt_init(&self) -> Result<(), SecureBlackboxError>
```

## Remarks

Use this method to start a block-by-block decryption process.

Specify the decryption key in key property before starting the decryption.

# decrypt_update method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Decrypts the next block of encrypted data.

## Syntax

*Rust Syntax*

```text
fn decrypt_update(&self, buffer : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

When using block-by-block decryption, pass every subsequent block of the encrypted message to this method until the entire message is processed. For each encrypted block the method returns a piece of decrypted data.

Please note that in general case there is no direct correspondence between the data actually contained in the encrypted block with the output of this method. The component may choose to cache a piece of the provided buffer internally if it doesn't constitute a full block of encrypted data.

Remember to call [decrypt_init](#decrypt_init-method-symmetriccrypto-struct) before calling this method to prepare the control for the decryption process.

# do_action method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Performs an additional action.

## Syntax

*Rust Syntax*

```text
fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>
```

## Remarks

do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter.

*ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*.

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# encrypt method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Encrypts a buffer.

## Syntax

*Rust Syntax*

```text
fn encrypt(&self, buffer : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

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

Specify the encryption key in key property before calling this method.

This is a one-off encryption method. Don't use it with granular per-block methods ([encrypt_init](#encrypt_init-method-symmetriccrypto-struct), [encrypt_update](#encrypt_update-method-symmetriccrypto-struct), [encrypt_final](#encrypt_final-method-symmetriccrypto-struct)).

# encrypt_file method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Encrypts a file.

## Syntax

*Rust Syntax*

```text
fn encrypt_file(&self, source_file : &str, dest_file : &str) -> Result<(), SecureBlackboxError>
```

## Remarks

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

Specify the encryption key in key property before commencing encryption.

# encrypt_final method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Finalization of encryption by blocks.

## Syntax

*Rust Syntax*

```text
fn encrypt_final(&self) ->  Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Use this method to finalize of encryption by blocks.

Specify encryption key in key property.

# encrypt_init method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Initializes a per-block encryption process.

## Syntax

*Rust Syntax*

```text
fn encrypt_init(&self) -> Result<(), SecureBlackboxError>
```

## Remarks

Use this method to initialize a block-by-block encryption process. Follow it with calls to [encrypt_update](#encrypt_update-method-symmetriccrypto-struct) (as many as needed), and complete the encryption with an [encrypt_final](#encrypt_final-method-symmetriccrypto-struct) call.

Specify the encryption key in key property before calling this method.

# encrypt_update method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Encrypts the next block of data.

## Syntax

*Rust Syntax*

```text
fn encrypt_update(&self, buffer : &[u8]) ->  Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Use this method to encrypt the next block of data contained in *Buffer*.

Call this method after calling [encrypt_init](#encrypt_init-method-symmetriccrypto-struct) for as many times as needed, until the whole volume of data is processed. Having done that, call [encrypt_final](#encrypt_final-method-symmetriccrypto-struct) to complete the encryption and get the terminating encrypted trailer.

# reset method ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Resets the struct settings.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), SecureBlackboxError>
```

## Remarks

reset is a generic method available in every struct.

# on_error event ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Reports errors during encryption or decryption.

## Syntax

*Rust Syntax*

```text
// SymmetricCryptoErrorEventArgs carries the SymmetricCrypto Error event's parameters.
pub struct SymmetricCryptoErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// SymmetricCryptoErrorEvent defines the signature of the SymmetricCrypto Error event's handler function.
pub trait SymmetricCryptoErrorEvent {
  fn on_error(&self, sender : SymmetricCrypto, e : &mut SymmetricCryptoErrorEventArgs);
}

impl <'a> SymmetricCrypto<'a> {
  pub fn on_error(&self) -> &'a dyn SymmetricCryptoErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn SymmetricCryptoErrorEvent);
  ...
}
```

## Remarks

struct fires this event in case of exceptional conditions during a cryptographic operation.

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

# on_notification event ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

This event notifies the application about an underlying control flow event.

## Syntax

*Rust Syntax*

```text
// SymmetricCryptoNotificationEventArgs carries the SymmetricCrypto Notification event's parameters.
pub struct SymmetricCryptoNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// SymmetricCryptoNotificationEvent defines the signature of the SymmetricCrypto Notification event's handler function.
pub trait SymmetricCryptoNotificationEvent {
  fn on_notification(&self, sender : SymmetricCrypto, e : &mut SymmetricCryptoNotificationEventArgs);
}

impl <'a> SymmetricCrypto<'a> {
  pub fn on_notification(&self) -> &'a dyn SymmetricCryptoNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn SymmetricCryptoNotificationEvent);
  ...
}
```

## Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.

# on_progress event ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

Reports the data encryption/decryption progress.

## Syntax

*Rust Syntax*

```text
// SymmetricCryptoProgressEventArgs carries the SymmetricCrypto Progress event's parameters.
pub struct SymmetricCryptoProgressEventArgs {
  fn total(&self) -> i64
  fn current(&self) -> i64
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// SymmetricCryptoProgressEvent defines the signature of the SymmetricCrypto Progress event's handler function.
pub trait SymmetricCryptoProgressEvent {
  fn on_progress(&self, sender : SymmetricCrypto, e : &mut SymmetricCryptoProgressEventArgs);
}

impl <'a> SymmetricCrypto<'a> {
  pub fn on_progress(&self) -> &'a dyn SymmetricCryptoProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn SymmetricCryptoProgressEvent);
  ...
}
```

## Remarks

This event fires periodically during a file encrypt/decrypt operation to report its progress.

Use the *Cancel* parameter to terminate the encryption/decryption if needed.

# Config Settings ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

 The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-symmetriccrypto-struct) method.

### SymmetricCrypto Config Settings

**Compress**: Specifies whether the JSON output should be compressed.Use this configuration setting to specify that the output should be presented in the compressed form.

**CTRLittleEndian**: Specifies whether the little-endian representation should be employed in CTR mode.Use this setting to enable the little-endian representation when encrypting/decrypting in counter mode.

**KeyAlgorithm**: Gets or sets a JWE key algorithm.Use this property to retrieve or set the key algorithm to be used with JWE. The following algorithms are supported:

- dir ("direct")
- RSA1_5
- RSA-OAEP
- RSA-OAEP-256
- A128KW
- A192KW
- A256KW
- ECDH-ES
- ECDH-ES+A128KW
- ECDH-ES+A192KW
- ECDH-ES+A256KW
- A128GCMKW
- A192GCMKW
- A256GCMKW
- PBES2-HS256+A128KW
- PBES2-HS384+A192KW
- PBES2-HS512+A256KW

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

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the struct.Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the structs that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other structs.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the struct. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the struct) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the struct is set to "*local*", the property returns/restores the rules from/to the internal storage of the struct. If *StaticDNS* of the struct is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the structs.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# Trappable Errors ([SymmetricCrypto](#struct-secureblackboxsymmetriccrypto) Struct)

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