# PasswordVault Class

The PasswordVault class implements a vault for keeping passwords and other sensitive properties.

## Syntax

```text
PasswordVault
```

## Remarks

Use this component to keep passwords and other settings in secure manner.

## Property List

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

|  |  |
| --- | --- |
| [Description](#description-property-passwordvault-class) | The description of the vault. |
| [EntryKey](#entrykey-property-passwordvault-class) | Provides an encryption key for the current entry. |
| [EntryPassword](#entrypassword-property-passwordvault-class) | Provides an encryption password for the current entry. |
| [FIPSMode](#fipsmode-property-passwordvault-class) | Reserved. |
| [Key](#key-property-passwordvault-class) | Provides an encryption key for the vault. |
| [Password](#password-property-passwordvault-class) | Provides an encryption password for the vault file. |
| [PlatformProtection](#platformprotection-property-passwordvault-class) | Enables platform-based protection of the master key. |
| [Title](#title-property-passwordvault-class) | The title of the vault. |

## Method List

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

|  |  |
| --- | --- |
| [AddEntry](#addentry-method-passwordvault-class) | Adds an entry to the vault. |
| [ChangeEntryKey](#changeentrykey-method-passwordvault-class) | Changes the entry's encryption key. |
| [ChangeEntryPassword](#changeentrypassword-method-passwordvault-class) | Changes the entry's encryption password. |
| [Close](#close-method-passwordvault-class) | Closes the vault file. |
| [Config](#config-method-passwordvault-class) | Sets or retrieves a configuration setting. |
| [CreateNew](#createnew-method-passwordvault-class) | Creates a new password vault. |
| [DoAction](#doaction-method-passwordvault-class) | Performs an additional action. |
| [GetEntryValue](#getentryvalue-method-passwordvault-class) | Returns the content stored in one of the entry fields as a byte array. |
| [GetEntryValueStr](#getentryvaluestr-method-passwordvault-class) | Returns the content stored in a field of the entry as a string. |
| [ListEntries](#listentries-method-passwordvault-class) | Returns a list of entries stored in the vault. |
| [ListFields](#listfields-method-passwordvault-class) | Returns a list of fields contained in the entry. |
| [OpenBytes](#openbytes-method-passwordvault-class) | Loads vault content from a byte array. |
| [OpenFile](#openfile-method-passwordvault-class) | Opens a vault file. |
| [OpenStream](#openstream-method-passwordvault-class) | Loads vault data from a stream. |
| [RemoveAllEntries](#removeallentries-method-passwordvault-class) | Removes all entries from a vault. |
| [RemoveEntry](#removeentry-method-passwordvault-class) | Removes an entry from the vault. |
| [RemoveField](#removefield-method-passwordvault-class) | Removes an entry field. |
| [Reset](#reset-method-passwordvault-class) | Resets the class settings. |
| [SaveBytes](#savebytes-method-passwordvault-class) | Saves the vault contents to a byte array. |
| [SaveFile](#savefile-method-passwordvault-class) | Saves the vault contents to a file. |
| [SaveStream](#savestream-method-passwordvault-class) | Saves the vault contents to a stream. |
| [SetEntryValue](#setentryvalue-method-passwordvault-class) | Assigns a value to an entry field. |
| [SetEntryValueStr](#setentryvaluestr-method-passwordvault-class) | Assigns a value to an entry field. |

## Event List

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

|  |  |
| --- | --- |
| [EntryKeyNeeded](#entrykeyneeded-event-passwordvault-class) | This event is fired to request an entry encryption/decryption key from the application. |
| [Error](#error-event-passwordvault-class) | Informs about errors during cryptographic operations. |
| [KeyNeeded](#keyneeded-event-passwordvault-class) | This event is fired to request a vault encryption/decryption key from the application. |
| [Notification](#notification-event-passwordvault-class) | This event notifies the application about an underlying control flow event. |

## Config Settings

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

|  |  |
| --- | --- |
| [EntrySalt](#EntrySalt) | TBD. |
| [NewEntrySalt](#NewEntrySalt) | TBD. |
| [Salt](#Salt) | TBD. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [UseLocalMachineAccount](#UseLocalMachineAccount) | TBD. |
| [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 class. |
| [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 classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [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 classes 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 classes 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. |

# Description Property ([PasswordVault](#passwordvault-class) Class)

The description of the vault.

## Syntax

```text
ANSI (Cross Platform)
char* GetDescription();int SetDescription(const char* lpszDescription);

Unicode (Windows)
LPWSTR GetDescription();INT SetDescription(LPCWSTR lpszDescription);
```

## Default Value

""

## Remarks

Use this property to provide a textual description (comment) for the vault. This value is not encrypted even if the vault is.

## Data Type

String

# EntryKey Property ([PasswordVault](#passwordvault-class) Class)

Provides an encryption key for the current entry.

## Syntax

```text
ANSI (Cross Platform)
int GetEntryKey(char* &lpEntryKey, int &lenEntryKey);int SetEntryKey(const char* lpEntryKey, int lenEntryKey);

Unicode (Windows)
INT GetEntryKey(LPSTR &lpEntryKey, INT &lenEntryKey);INT SetEntryKey(LPCSTR lpEntryKey, INT lenEntryKey);
```

## Remarks

Use this property to provide the encryption/decryption key for the current entry. This property is typically assigned from the [EntryKeyNeeded](#entrykeyneeded-event-passwordvault-class) event handler.

This property is automatically generated when a non-empty password is assigned to the [EntryPassword](#entrypassword-property-passwordvault-class) property. This is because all entries, and the vault itself, are always encrypted with cryptographically strong keys, and if the user decides to use a password, it is converted to such key using a secure PBKDF function.

This property is not available at design time.

## Data Type

Byte Array

# EntryPassword Property ([PasswordVault](#passwordvault-class) Class)

Provides an encryption password for the current entry.

## Syntax

```text
ANSI (Cross Platform)
char* GetEntryPassword();int SetEntryPassword(const char* lpszEntryPassword);

Unicode (Windows)
LPWSTR GetEntryPassword();INT SetEntryPassword(LPCWSTR lpszEntryPassword);
```

## Default Value

""

## Remarks

Use this property to provide the encryption/decryption password for the current entry. This property is typically assigned from the [EntryKeyNeeded](#entrykeyneeded-event-passwordvault-class) event handler.

See a comment in the [EntryKey](#entrykey-property-passwordvault-class) topic to find out how the passwords are used when encrypting entries.

## Data Type

String

# FIPSMode Property ([PasswordVault](#passwordvault-class) Class)

Reserved.

## Syntax

```text
ANSI (Cross Platform)
int GetFIPSMode();int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode);
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# Key Property ([PasswordVault](#passwordvault-class) Class)

Provides an encryption key for the vault.

## Syntax

```text
ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);INT SetKey(LPCSTR lpKey, INT lenKey);
```

## Remarks

Use this property to provide the 'master' key for the vault file. This property can be assigned from the [KeyNeeded](#keyneeded-event-passwordvault-class) event handler.

The content of this property is automatically generated when a non-empty password is assigned to the [Password](#password-property-passwordvault-class) property. This is because the vault file are always encrypted with a cryptographically strong key, and if the user decides to use a password, it is converted to such key using a secure PBKDF function first.

This property is not available at design time.

## Data Type

Byte Array

# Password Property ([PasswordVault](#passwordvault-class) Class)

Provides an encryption password for the vault file.

## Syntax

```text
ANSI (Cross Platform)
char* GetPassword();int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();INT SetPassword(LPCWSTR lpszPassword);
```

## Default Value

""

## Remarks

Use this property to provide the master password for the vault file. This property can be assigned from the [KeyNeeded](#keyneeded-event-passwordvault-class) event handler.

See a comment in the [Key](#key-property-passwordvault-class) topic to learn how the passwords are used when encrypting the vault file.

## Data Type

String

# PlatformProtection Property ([PasswordVault](#passwordvault-class) Class)

Enables platform-based protection of the master key.

## Syntax

```text
ANSI (Cross Platform)
int GetPlatformProtection();int SetPlatformProtection(int bPlatformProtection);

Unicode (Windows)
BOOL GetPlatformProtection();INT SetPlatformProtection(BOOL bPlatformProtection);
```

## Default Value

FALSE

## Remarks

Use this property to enable the platform-based protection for the main encryption key. The platform protection is currently only available on Windows, in the form of DPAPI in unmanaged editions, or ProtectedData in .NET Framework.

## Data Type

Boolean

# Title Property ([PasswordVault](#passwordvault-class) Class)

The title of the vault.

## Syntax

```text
ANSI (Cross Platform)
char* GetTitle();int SetTitle(const char* lpszTitle);

Unicode (Windows)
LPWSTR GetTitle();INT SetTitle(LPCWSTR lpszTitle);
```

## Default Value

""

## Remarks

Use this property to provide a title for your vault storage. This value is not encrypted event if the vault itself is.

## Data Type

String

# AddEntry Method ([PasswordVault](#passwordvault-class) Class)

Adds an entry to the vault.

## Syntax

```text
ANSI (Cross Platform)
int AddEntry(const char* lpszEntryName);

Unicode (Windows)
INT AddEntry(LPCWSTR lpszEntryName);
```

## Remarks

Use this method to add a new entry to the vault. Use [SetEntryValue](#setentryvalue-method-passwordvault-class) or [SetEntryValueStr](#setentryvaluestr-method-passwordvault-class) to assign a value to the new entry.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ChangeEntryKey Method ([PasswordVault](#passwordvault-class) Class)

Changes the entry's encryption key.

## Syntax

```text
ANSI (Cross Platform)
int ChangeEntryKey(const char* lpszEntryName, const char* lpNewKey, int lenNewKey);

Unicode (Windows)
INT ChangeEntryKey(LPCWSTR lpszEntryName, LPCSTR lpNewKey, INT lenNewKey);
```

## Remarks

Use this method to change the entry's encryption key. This method may invoke the [EntryKeyNeeded](#entrykeyneeded-event-passwordvault-class) event to request the existing key if the entry was previously encrypted.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ChangeEntryPassword Method ([PasswordVault](#passwordvault-class) Class)

Changes the entry's encryption password.

## Syntax

```text
ANSI (Cross Platform)
int ChangeEntryPassword(const char* lpszEntryName, const char* lpszNewPassword);

Unicode (Windows)
INT ChangeEntryPassword(LPCWSTR lpszEntryName, LPCWSTR lpszNewPassword);
```

## Remarks

Use this method to change the entry's encryption password. This method may invoke the [EntryKeyNeeded](#entrykeyneeded-event-passwordvault-class) event to request the existing key if the entry was previously encrypted.

Note that all entries, and the vault itself, are encrypted with cryptographic keys, rather than passwords. When you change an entry's encryption password, you are implicitly changing its encryption key, which is derived from the password using a cryptographically secure key derivation function.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Close Method ([PasswordVault](#passwordvault-class) Class)

Closes the vault file.

## Syntax

```text
ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();
```

## Remarks

Use this method to close the vault file.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Config Method ([PasswordVault](#passwordvault-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-passwordvault-class) 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-passwordvault-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# CreateNew Method ([PasswordVault](#passwordvault-class) Class)

Creates a new password vault.

## Syntax

```text
ANSI (Cross Platform)
int CreateNew();

Unicode (Windows)
INT CreateNew();
```

## Remarks

This method resets the component state and initializes a fresh password vault object.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DoAction Method ([PasswordVault](#passwordvault-class) Class)

Performs an additional action.

## Syntax

```text
ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
```

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

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# GetEntryValue Method ([PasswordVault](#passwordvault-class) Class)

Returns the content stored in one of the entry fields as a byte array.

## Syntax

```text
ANSI (Cross Platform)
char* GetEntryValue(const char* lpszEntryName, const char* lpszFieldName, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetEntryValue(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName, LPINT lpSize = NULL);
```

## Remarks

Use this method to obtain the content stored in the *FieldName* field of the *EntryName* entry in the form of a byte array. Use [GetEntryValueStr](#getentryvaluestr-method-passwordvault-class) to retrieve the content as a string.

## Error Handling (C++)

This method returns a Byte Array value (with length *lpSize*); after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# GetEntryValueStr Method ([PasswordVault](#passwordvault-class) Class)

Returns the content stored in a field of the entry as a string.

## Syntax

```text
ANSI (Cross Platform)
char* GetEntryValueStr(const char* lpszEntryName, const char* lpszFieldName);

Unicode (Windows)
LPWSTR GetEntryValueStr(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName);
```

## Remarks

Call this method to obtain the data associated with the *FieldName* field of the *EntryName* entry in the string form.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# ListEntries Method ([PasswordVault](#passwordvault-class) Class)

Returns a list of entries stored in the vault.

## Syntax

```text
ANSI (Cross Platform)
char* ListEntries();

Unicode (Windows)
LPWSTR ListEntries();
```

## Remarks

Use this method to retrieve a list of entries stored in the currently opened vault file.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# ListFields Method ([PasswordVault](#passwordvault-class) Class)

Returns a list of fields contained in the entry.

## Syntax

```text
ANSI (Cross Platform)
char* ListFields(const char* lpszEntryName, int bIncludeEncrypted);

Unicode (Windows)
LPWSTR ListFields(LPCWSTR lpszEntryName, BOOL bIncludeEncrypted);
```

## Remarks

Use this method to obtain a list of fields contained in the *EntryName* entry. The *IncludeEncrypted* parameter specifies whether to include encrypted entries in the list.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# OpenBytes Method ([PasswordVault](#passwordvault-class) Class)

Loads vault content from a byte array.

## Syntax

```text
ANSI (Cross Platform)
int OpenBytes(const char* lpVaultBytes, int lenVaultBytes);

Unicode (Windows)
INT OpenBytes(LPCSTR lpVaultBytes, INT lenVaultBytes);
```

## Remarks

Use this method to load the vault from a byte array.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# OpenFile Method ([PasswordVault](#passwordvault-class) Class)

Opens a vault file.

## Syntax

```text
ANSI (Cross Platform)
int OpenFile(const char* lpszFileName);

Unicode (Windows)
INT OpenFile(LPCWSTR lpszFileName);
```

## Remarks

Use this method to open a vault file.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# OpenStream Method ([PasswordVault](#passwordvault-class) Class)

Loads vault data from a stream.

## Syntax

```text
ANSI (Cross Platform)
int OpenStream(SecureBlackboxStream* sVaultStream);

Unicode (Windows)
INT OpenStream(SecureBlackboxStream* sVaultStream);
```

## Remarks

Use this method to load vault data from a stream.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RemoveAllEntries Method ([PasswordVault](#passwordvault-class) Class)

Removes all entries from a vault.

## Syntax

```text
ANSI (Cross Platform)
int RemoveAllEntries();

Unicode (Windows)
INT RemoveAllEntries();
```

## Remarks

Use this method to remove all entries from the currently opened vault.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RemoveEntry Method ([PasswordVault](#passwordvault-class) Class)

Removes an entry from the vault.

## Syntax

```text
ANSI (Cross Platform)
int RemoveEntry(const char* lpszEntryName);

Unicode (Windows)
INT RemoveEntry(LPCWSTR lpszEntryName);
```

## Remarks

Use this method to remove (delete) the *EntryName* entry from the vault.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RemoveField Method ([PasswordVault](#passwordvault-class) Class)

Removes an entry field.

## Syntax

```text
ANSI (Cross Platform)
int RemoveField(const char* lpszEntryName, const char* lpszFieldName);

Unicode (Windows)
INT RemoveField(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName);
```

## Remarks

Use this method to remove an entry field *FieldName* from the entry *EntryName*.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Reset Method ([PasswordVault](#passwordvault-class) Class)

Resets the class settings.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

Reset is a generic method available in every class.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SaveBytes Method ([PasswordVault](#passwordvault-class) Class)

Saves the vault contents to a byte array.

## Syntax

```text
ANSI (Cross Platform)
char* SaveBytes(int *lpSize = NULL);

Unicode (Windows)
LPSTR SaveBytes(LPINT lpSize = NULL);
```

## Remarks

Use this method to save the vault contents to a byte array.

## Error Handling (C++)

This method returns a Byte Array value (with length *lpSize*); after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# SaveFile Method ([PasswordVault](#passwordvault-class) Class)

Saves the vault contents to a file.

## Syntax

```text
ANSI (Cross Platform)
int SaveFile(const char* lpszFileName);

Unicode (Windows)
INT SaveFile(LPCWSTR lpszFileName);
```

## Remarks

Use this method to save the contents of the password vault to a file.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SaveStream Method ([PasswordVault](#passwordvault-class) Class)

Saves the vault contents to a stream.

## Syntax

```text
ANSI (Cross Platform)
int SaveStream(SecureBlackboxStream* sVaultStream);

Unicode (Windows)
INT SaveStream(SecureBlackboxStream* sVaultStream);
```

## Remarks

Use this method to save the contents of the password vault to a stream.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetEntryValue Method ([PasswordVault](#passwordvault-class) Class)

Assigns a value to an entry field.

## Syntax

```text
ANSI (Cross Platform)
int SetEntryValue(const char* lpszEntryName, const char* lpszFieldName, const char* lpFieldValue, int lenFieldValue, int bEncrypted);

Unicode (Windows)
INT SetEntryValue(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName, LPCSTR lpFieldValue, INT lenFieldValue, BOOL bEncrypted);
```

## Remarks

Use this method to assign a value to a field of a vault entry. Use *EntryName* to identify the entry, and provide the field's name and value via *FieldName* and *FieldValue* parameters respectively. Set *Encrypted* to true to indicate that the field should be encrypted.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetEntryValueStr Method ([PasswordVault](#passwordvault-class) Class)

Assigns a value to an entry field.

## Syntax

```text
ANSI (Cross Platform)
int SetEntryValueStr(const char* lpszEntryName, const char* lpszFieldName, const char* lpszFieldValueStr, int bEncrypted);

Unicode (Windows)
INT SetEntryValueStr(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName, LPCWSTR lpszFieldValueStr, BOOL bEncrypted);
```

## Remarks

Use this method to assign a string value to a field of a vault entry. Use *EntryName* to identify the entry, and provide the field's name and value via *FieldName* and *FieldValueStr* parameters respectively. Set *Encrypted* to true to indicate that the field should be encrypted.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# EntryKeyNeeded Event ([PasswordVault](#passwordvault-class) Class)

This event is fired to request an entry encryption/decryption key from the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireEntryKeyNeeded(PasswordVaultEntryKeyNeededEventParams *e);
typedef struct {  const char *EntryName;  int Cancel;
  int reserved;
} PasswordVaultEntryKeyNeededEventParams;

Unicode (Windows)
virtual INT FireEntryKeyNeeded(PasswordVaultEntryKeyNeededEventParams *e);
typedef struct {  LPCWSTR EntryName;  BOOL Cancel;
  INT reserved;
} PasswordVaultEntryKeyNeededEventParams;
```

## Remarks

The class fires this event when a key is needed to encrypt or decrypt an entry. The *EntryName* parameter provides the name of the entry.

The handler of this event should assign the password or key to be used to [EntryPassword](#entrypassword-property-passwordvault-class) or [EntryKey](#entrykey-property-passwordvault-class) property respectively. Set *Cancel* to true to abort the operation.

# Error Event ([PasswordVault](#passwordvault-class) Class)

Informs about errors during cryptographic operations.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(PasswordVaultErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} PasswordVaultErrorEventParams;

Unicode (Windows)
virtual INT FireError(PasswordVaultErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} PasswordVaultErrorEventParams;
```

## Remarks

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

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

# KeyNeeded Event ([PasswordVault](#passwordvault-class) Class)

This event is fired to request a vault encryption/decryption key from the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireKeyNeeded(PasswordVaultKeyNeededEventParams *e);
typedef struct {  int Cancel;
  int reserved;
} PasswordVaultKeyNeededEventParams;

Unicode (Windows)
virtual INT FireKeyNeeded(PasswordVaultKeyNeededEventParams *e);
typedef struct {  BOOL Cancel;
  INT reserved;
} PasswordVaultKeyNeededEventParams;
```

## Remarks

Class fires this event to request a vault encryption key from the application. Note that this is not the same as entry encryption key, which is requested by [EntryKeyNeeded](#entrykeyneeded-event-passwordvault-class). The key requested by this event is used to encrypt or decrypt the whole vault.

The handler of this event should assign the password or key to be used to [Password](#password-property-passwordvault-class) or [Key](#key-property-passwordvault-class) property respectively. Set *Cancel* to true to abort the operation.

# Notification Event ([PasswordVault](#passwordvault-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireNotification(PasswordVaultNotificationEventParams *e);
typedef struct {  const char *EventID;  const char *EventParam;
  int reserved;
} PasswordVaultNotificationEventParams;

Unicode (Windows)
virtual INT FireNotification(PasswordVaultNotificationEventParams *e);
typedef struct {  LPCWSTR EventID;  LPCWSTR EventParam;
  INT reserved;
} PasswordVaultNotificationEventParams;
```

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

# SecureBlackboxStream Type

## Syntax

 *SecureBlackboxStream* (declared in *secureblackbox.h*)

## Remarks

 The PasswordVault class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the PasswordVault class an instance of that concrete class.

 When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecureBlackboxStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([PasswordVault](#passwordvault-class) Class)

 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-passwordvault-class) method.

### PasswordVault Config Settings

**EntrySalt**: TBD.TBD

**NewEntrySalt**: TBD.TBD

**Salt**: TBD.TBD

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

**UseLocalMachineAccount**: TBD.TBD

### 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 ([PasswordVault](#passwordvault-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

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