PasswordVault Class

Properties Methods Events Config Settings Errors

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

Class Name

SecureBlackbox_PasswordVault

Procedural Interface

 secureblackbox_passwordvault_open();
 secureblackbox_passwordvault_close($res);
 secureblackbox_passwordvault_register_callback($res, $id, $function);
 secureblackbox_passwordvault_get_last_error($res);
 secureblackbox_passwordvault_get_last_error_code($res);
 secureblackbox_passwordvault_set($res, $id, $index, $value);
 secureblackbox_passwordvault_get($res, $id, $index);
 secureblackbox_passwordvault_do_addentry($res, $entryname);
 secureblackbox_passwordvault_do_changeentrykey($res, $entryname, $newkey);
 secureblackbox_passwordvault_do_changeentrypassword($res, $entryname, $newpassword);
 secureblackbox_passwordvault_do_close($res);
 secureblackbox_passwordvault_do_config($res, $configurationstring);
 secureblackbox_passwordvault_do_doaction($res, $actionid, $actionparams);
 secureblackbox_passwordvault_do_getentryvalue($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_getentryvaluestr($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_listentries($res);
 secureblackbox_passwordvault_do_listfields($res, $entryname, $includeencrypted);
 secureblackbox_passwordvault_do_openbytes($res, $vaultbytes);
 secureblackbox_passwordvault_do_openfile($res, $filename);
 secureblackbox_passwordvault_do_removeallentries($res);
 secureblackbox_passwordvault_do_removeentry($res, $entryname);
 secureblackbox_passwordvault_do_removefield($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_savebytes($res);
 secureblackbox_passwordvault_do_savefile($res, $filename);
 secureblackbox_passwordvault_do_setentryvalue($res, $entryname, $fieldname, $fieldvalue, $encrypted);
 secureblackbox_passwordvault_do_setentryvaluestr($res, $entryname, $fieldname, $fieldvaluestr, $encrypted);

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	The description of the vault.
EntryKey	Provides an encryption key for the current entry.
EntryPassword	Provides an encryption password for the current entry.
FIPSMode	Reserved.
Key	Provides an encryption key for the vault.
Password	Provides an encryption password for the vault file.
PlatformProtection	Enables platform-based protection of the master key.
Title	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	Adds an entry to the vault.
ChangeEntryKey	Changes the entry's encryption key.
ChangeEntryPassword	Changes the entry's encryption password.
Close	Closes the vault file.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
GetEntryValue	Returns the content stored in one of the entry fields as a byte array.
GetEntryValueStr	Returns the content stored in a field of the entry as a string.
ListEntries	Returns a list of entries stored in the vault.
ListFields	Returns a list of fields contained in the entry.
OpenBytes	Loads vault content from a byte array.
OpenFile	Opens a vault file.
RemoveAllEntries	Removes all entries from a vault.
RemoveEntry	Removes an entry from the vault.
RemoveField	Removes an entry field.
SaveBytes	Saves the vault contents to a byte array.
SaveFile	Saves the vault contents to a file.
SetEntryValue	Assigns a value to an entry field.
SetEntryValueStr	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	This event is fired to request an entry encryption/decryption key from the application.
Error	Informs about errors during cryptographic operations.
KeyNeeded	This event is fired to request a vault encryption/decryption key from the application.
Notification	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.


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

Description Property (SecureBlackbox_PasswordVault Class)

The description of the vault.

Object Oriented Interface


public function getDescription();


public function setDescription($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 1 );


secureblackbox_passwordvault_set($res, 1, $value );

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 (SecureBlackbox_PasswordVault Class)

Provides an encryption key for the current entry.

Object Oriented Interface


public function getEntryKey();


public function setEntryKey($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 2 );


secureblackbox_passwordvault_set($res, 2, $value );

Remarks

Use this property to provide the encryption/decryption key for the current entry. This property is typically assigned from the EntryKeyNeeded event handler.

This property is automatically generated when a non-empty password is assigned to the EntryPassword 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 (SecureBlackbox_PasswordVault Class)

Provides an encryption password for the current entry.

Object Oriented Interface


public function getEntryPassword();


public function setEntryPassword($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 3 );


secureblackbox_passwordvault_set($res, 3, $value );

Default Value

Remarks

Use this property to provide the encryption/decryption password for the current entry. This property is typically assigned from the EntryKeyNeeded event handler.

See a comment in the EntryKey topic to find out how the passwords are used when encrypting entries.

Data Type

String

FIPSMode Property (SecureBlackbox_PasswordVault Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 4 );


secureblackbox_passwordvault_set($res, 4, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Key Property (SecureBlackbox_PasswordVault Class)

Provides an encryption key for the vault.

Object Oriented Interface


public function getKey();


public function setKey($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 5 );


secureblackbox_passwordvault_set($res, 5, $value );

Remarks

Use this property to provide the 'master' key for the vault file. This property can be assigned from the KeyNeeded event handler.

The content of this property is automatically generated when a non-empty password is assigned to the Password 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 (SecureBlackbox_PasswordVault Class)

Provides an encryption password for the vault file.

Object Oriented Interface


public function getPassword();


public function setPassword($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 6 );


secureblackbox_passwordvault_set($res, 6, $value );

Default Value

Remarks

Use this property to provide the master password for the vault file. This property can be assigned from the KeyNeeded event handler.

See a comment in the Key topic to learn how the passwords are used when encrypting the vault file.

Data Type

String

PlatformProtection Property (SecureBlackbox_PasswordVault Class)

Enables platform-based protection of the master key.

Object Oriented Interface


public function getPlatformProtection();


public function setPlatformProtection($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 7 );


secureblackbox_passwordvault_set($res, 7, $value );

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 (SecureBlackbox_PasswordVault Class)

The title of the vault.

Object Oriented Interface


public function getTitle();


public function setTitle($value);

Procedural Interface


secureblackbox_passwordvault_get($res, 8 );


secureblackbox_passwordvault_set($res, 8, $value );

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 (SecureBlackbox_PasswordVault Class)

Adds an entry to the vault.

Object Oriented Interface

public function doAddEntry($entryname);

Procedural Interface

secureblackbox_passwordvault_do_addentry($res, $entryname);

Remarks

Use this method to add a new entry to the vault. Use SetEntryValue or SetEntryValueStr to assign a value to the new entry.

ChangeEntryKey Method (SecureBlackbox_PasswordVault Class)

Changes the entry's encryption key.

Object Oriented Interface

public function doChangeEntryKey($entryname, $newkey);

Procedural Interface

secureblackbox_passwordvault_do_changeentrykey($res, $entryname, $newkey);

Remarks

Use this method to change the entry's encryption key. This method may invoke the EntryKeyNeeded event to request the existing key if the entry was previously encrypted.

ChangeEntryPassword Method (SecureBlackbox_PasswordVault Class)

Changes the entry's encryption password.

Object Oriented Interface

public function doChangeEntryPassword($entryname, $newpassword);

Procedural Interface

secureblackbox_passwordvault_do_changeentrypassword($res, $entryname, $newpassword);

Remarks

Use this method to change the entry's encryption password. This method may invoke the EntryKeyNeeded 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.

Close Method (SecureBlackbox_PasswordVault Class)

Closes the vault file.

Object Oriented Interface

public function doClose();

Procedural Interface

secureblackbox_passwordvault_do_close($res);

Remarks

Use this method to close the vault file.

Config Method (SecureBlackbox_PasswordVault Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_passwordvault_do_config($res, $configurationstring);

Remarks

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

DoAction Method (SecureBlackbox_PasswordVault Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_passwordvault_do_doaction($res, $actionid, $actionparams);

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

GetEntryValue Method (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function doGetEntryValue($entryname, $fieldname);

Procedural Interface

secureblackbox_passwordvault_do_getentryvalue($res, $entryname, $fieldname);

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 to retrieve the content as a string.

GetEntryValueStr Method (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function doGetEntryValueStr($entryname, $fieldname);

Procedural Interface

secureblackbox_passwordvault_do_getentryvaluestr($res, $entryname, $fieldname);

Remarks

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

ListEntries Method (SecureBlackbox_PasswordVault Class)

Returns a list of entries stored in the vault.

Object Oriented Interface

public function doListEntries();

Procedural Interface

secureblackbox_passwordvault_do_listentries($res);

Remarks

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

ListFields Method (SecureBlackbox_PasswordVault Class)

Returns a list of fields contained in the entry.

Object Oriented Interface

public function doListFields($entryname, $includeencrypted);

Procedural Interface

secureblackbox_passwordvault_do_listfields($res, $entryname, $includeencrypted);

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.

OpenBytes Method (SecureBlackbox_PasswordVault Class)

Loads vault content from a byte array.

Object Oriented Interface

public function doOpenBytes($vaultbytes);

Procedural Interface

secureblackbox_passwordvault_do_openbytes($res, $vaultbytes);

Remarks

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

OpenFile Method (SecureBlackbox_PasswordVault Class)

Opens a vault file.

Object Oriented Interface

public function doOpenFile($filename);

Procedural Interface

secureblackbox_passwordvault_do_openfile($res, $filename);

Remarks

Use this method to open a vault file.

RemoveAllEntries Method (SecureBlackbox_PasswordVault Class)

Removes all entries from a vault.

Object Oriented Interface

public function doRemoveAllEntries();

Procedural Interface

secureblackbox_passwordvault_do_removeallentries($res);

Remarks

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

RemoveEntry Method (SecureBlackbox_PasswordVault Class)

Removes an entry from the vault.

Object Oriented Interface

public function doRemoveEntry($entryname);

Procedural Interface

secureblackbox_passwordvault_do_removeentry($res, $entryname);

Remarks

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

RemoveField Method (SecureBlackbox_PasswordVault Class)

Removes an entry field.

Object Oriented Interface

public function doRemoveField($entryname, $fieldname);

Procedural Interface

secureblackbox_passwordvault_do_removefield($res, $entryname, $fieldname);

Remarks

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

SaveBytes Method (SecureBlackbox_PasswordVault Class)

Saves the vault contents to a byte array.

Object Oriented Interface

public function doSaveBytes();

Procedural Interface

secureblackbox_passwordvault_do_savebytes($res);

Remarks

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

SaveFile Method (SecureBlackbox_PasswordVault Class)

Saves the vault contents to a file.

Object Oriented Interface

public function doSaveFile($filename);

Procedural Interface

secureblackbox_passwordvault_do_savefile($res, $filename);

Remarks

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

SetEntryValue Method (SecureBlackbox_PasswordVault Class)

Assigns a value to an entry field.

Object Oriented Interface

public function doSetEntryValue($entryname, $fieldname, $fieldvalue, $encrypted);

Procedural Interface

secureblackbox_passwordvault_do_setentryvalue($res, $entryname, $fieldname, $fieldvalue, $encrypted);

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.

SetEntryValueStr Method (SecureBlackbox_PasswordVault Class)

Assigns a value to an entry field.

Object Oriented Interface

public function doSetEntryValueStr($entryname, $fieldname, $fieldvaluestr, $encrypted);

Procedural Interface

secureblackbox_passwordvault_do_setentryvaluestr($res, $entryname, $fieldname, $fieldvaluestr, $encrypted);

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.

EntryKeyNeeded Event (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function fireEntryKeyNeeded($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 1, array($this, 'fireEntryKeyNeeded'));

Parameter List

 'entryname'
 'cancel'

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 or EntryKey property respectively. Set Cancel to true to abort the operation.

Error Event (SecureBlackbox_PasswordVault Class)

Informs about errors during cryptographic operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function fireKeyNeeded($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 3, array($this, 'fireKeyNeeded'));

Parameter List

 'cancel'

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. 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 or Key property respectively. Set Cancel to true to abort the operation.

Notification Event (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 4, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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.

Config Settings (PasswordVault 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 method.

PasswordVault Config Settings

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

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.

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.

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

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.

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.

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 devided 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 chached 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).

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.

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.

Trappable Errors (PasswordVault Class)

PasswordVault Errors


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Class is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
	1048579 Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
	1048580 Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
	1048581 Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
	1048581 Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)