PasswordVault Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class secureblackbox.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.

descriptionThe description of the vault.
entry_keyProvides an encryption key for the current entry.
entry_passwordProvides an encryption password for the current entry.
fips_modeReserved.
keyProvides an encryption key for the vault.
passwordProvides an encryption password for the vault file.
platform_protectionEnables platform-based protection of the master key.
titleThe 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.

add_entryAdds an entry to the vault.
change_entry_keyChanges the entry's encryption key.
change_entry_passwordChanges the entry's encryption password.
closeCloses the vault file.
configSets or retrieves a configuration setting.
create_newCreates a new password vault.
do_actionPerforms an additional action.
get_entry_valueReturns the content stored in one of the entry fields as a byte array.
get_entry_value_strReturns the content stored in a field of the entry as a string.
list_entriesReturns a list of entries stored in the vault.
list_fieldsReturns a list of fields contained in the entry.
open_bytesLoads vault content from a byte array.
open_fileOpens a vault file.
remove_all_entriesRemoves all entries from a vault.
remove_entryRemoves an entry from the vault.
remove_fieldRemoves an entry field.
resetResets the class settings.
save_bytesSaves the vault contents to a byte array.
save_fileSaves the vault contents to a file.
set_entry_valueAssigns a value to an entry field.
set_entry_value_strAssigns 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.

on_entry_key_neededThis event is fired to request an entry encryption/decryption key from the application.
on_errorInforms about errors during cryptographic operations.
on_key_neededThis event is fired to request a vault encryption/decryption key from the application.
on_notificationThis 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.

EntrySaltTBD.
NewEntrySaltTBD.
SaltTBD.
TempPathPath for storing temporary files.
UseLocalMachineAccountTBD.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

description Property

The description of the vault.

Syntax

def get_description() -> str: ...
def set_description(value: str) -> None: ...

description = property(get_description, set_description)

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.

entry_key Property

Provides an encryption key for the current entry.

Syntax

def get_entry_key() -> bytes: ...
def set_entry_key(value: bytes) -> None: ...

entry_key = property(get_entry_key, set_entry_key)

Remarks

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

This property is automatically generated when a non-empty password is assigned to the entry_password 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.

entry_password Property

Provides an encryption password for the current entry.

Syntax

def get_entry_password() -> str: ...
def set_entry_password(value: str) -> None: ...

entry_password = property(get_entry_password, set_entry_password)

Default Value

""

Remarks

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

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

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

key Property

Provides an encryption key for the vault.

Syntax

def get_key() -> bytes: ...
def set_key(value: bytes) -> None: ...

key = property(get_key, set_key)

Remarks

Use this property to provide the 'master' key for the vault file. This property can be assigned from the on_key_needed 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.

password Property

Provides an encryption password for the vault file.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

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

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

platform_protection Property

Enables platform-based protection of the master key.

Syntax

def get_platform_protection() -> bool: ...
def set_platform_protection(value: bool) -> None: ...

platform_protection = property(get_platform_protection, set_platform_protection)

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.

title Property

The title of the vault.

Syntax

def get_title() -> str: ...
def set_title(value: str) -> None: ...

title = property(get_title, set_title)

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.

add_entry Method

Adds an entry to the vault.

Syntax

def add_entry(entry_name: str) -> None: ...

Remarks

Use this method to add a new entry to the vault. Use set_entry_value or set_entry_value_str to assign a value to the new entry.

change_entry_key Method

Changes the entry's encryption key.

Syntax

def change_entry_key(entry_name: str, new_key: bytes) -> None: ...

Remarks

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

change_entry_password Method

Changes the entry's encryption password.

Syntax

def change_entry_password(entry_name: str, new_password: str) -> None: ...

Remarks

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

Closes the vault file.

Syntax

def close() -> None: ...

Remarks

Use this method to close the vault file.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

create_new Method

Creates a new password vault.

Syntax

def create_new() -> None: ...

Remarks

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

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

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

get_entry_value Method

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

Syntax

def get_entry_value(entry_name: str, field_name: str) -> bytes: ...

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

get_entry_value_str Method

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

Syntax

def get_entry_value_str(entry_name: str, field_name: str) -> str: ...

Remarks

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

list_entries Method

Returns a list of entries stored in the vault.

Syntax

def list_entries() -> str: ...

Remarks

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

list_fields Method

Returns a list of fields contained in the entry.

Syntax

def list_fields(entry_name: str, include_encrypted: bool) -> str: ...

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.

open_bytes Method

Loads vault content from a byte array.

Syntax

def open_bytes(vault_bytes: bytes) -> None: ...

Remarks

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

open_file Method

Opens a vault file.

Syntax

def open_file(file_name: str) -> None: ...

Remarks

Use this method to open a vault file.

remove_all_entries Method

Removes all entries from a vault.

Syntax

def remove_all_entries() -> None: ...

Remarks

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

remove_entry Method

Removes an entry from the vault.

Syntax

def remove_entry(entry_name: str) -> None: ...

Remarks

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

remove_field Method

Removes an entry field.

Syntax

def remove_field(entry_name: str, field_name: str) -> None: ...

Remarks

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

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

save_bytes Method

Saves the vault contents to a byte array.

Syntax

def save_bytes() -> bytes: ...

Remarks

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

save_file Method

Saves the vault contents to a file.

Syntax

def save_file(file_name: str) -> None: ...

Remarks

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

set_entry_value Method

Assigns a value to an entry field.

Syntax

def set_entry_value(entry_name: str, field_name: str, field_value: bytes, encrypted: bool) -> None: ...

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.

set_entry_value_str Method

Assigns a value to an entry field.

Syntax

def set_entry_value_str(entry_name: str, field_name: str, field_value_str: str, encrypted: bool) -> None: ...

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.

on_entry_key_needed Event

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

Syntax

class PasswordVaultEntryKeyNeededEventParams(object):
  @property
  def entry_name() -> str: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PasswordVault:
@property
def on_entry_key_needed() -> Callable[[PasswordVaultEntryKeyNeededEventParams], None]: ...
@on_entry_key_needed.setter
def on_entry_key_needed(event_hook: Callable[[PasswordVaultEntryKeyNeededEventParams], None]) -> None: ...

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

on_error Event

Informs about errors during cryptographic operations.

Syntax

class PasswordVaultErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PasswordVault:
@property
def on_error() -> Callable[[PasswordVaultErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PasswordVaultErrorEventParams], None]) -> None: ...

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.

on_key_needed Event

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

Syntax

class PasswordVaultKeyNeededEventParams(object):
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PasswordVault:
@property
def on_key_needed() -> Callable[[PasswordVaultKeyNeededEventParams], None]: ...
@on_key_needed.setter
def on_key_needed(event_hook: Callable[[PasswordVaultKeyNeededEventParams], None]) -> None: ...

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

on_notification Event

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

Syntax

class PasswordVaultNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class PasswordVault:
@property
def on_notification() -> Callable[[PasswordVaultNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[PasswordVaultNotificationEventParams], None]) -> None: ...

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.

PasswordVault Config Settings

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

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.

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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: auto, enable, or disable.

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:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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).

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

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.

PasswordVault Errors

PasswordVault Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)