PasswordVault Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.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 component with short descriptions. Click on the links for further details.

DescriptionThe description of the vault.
EntryKeyProvides an encryption key for the current entry.
EntryPasswordProvides an encryption password for the current entry.
FIPSModeReserved.
KeyProvides an encryption key for the vault.
PasswordProvides an encryption password for the vault file.
PlatformProtectionEnables 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 component with short descriptions. Click on the links for further details.

AddEntryAdds an entry to the vault.
ChangeEntryKeyChanges the entry's encryption key.
ChangeEntryPasswordChanges the entry's encryption password.
CloseCloses the vault file.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new password vault.
DoActionPerforms an additional action.
GetEntryValueReturns the content stored in one of the entry fields as a byte array.
GetEntryValueStrReturns the content stored in a field of the entry as a string.
ListEntriesReturns a list of entries stored in the vault.
ListFieldsReturns a list of fields contained in the entry.
OpenBytesLoads vault content from a byte array.
OpenFileOpens a vault file.
OpenStreamLoads vault data from a stream.
RemoveAllEntriesRemoves all entries from a vault.
RemoveEntryRemoves an entry from the vault.
RemoveFieldRemoves an entry field.
ResetResets the component settings.
SaveBytesSaves the vault contents to a byte array.
SaveFileSaves the vault contents to a file.
SaveStreamSaves the vault contents to a stream.
SetEntryValueAssigns a value to an entry field.
SetEntryValueStrAssigns a value to an entry field.

Event List

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

EntryKeyNeededThis event is fired to request an entry encryption/decryption key from the application.
ErrorInforms about errors during cryptographic operations.
KeyNeededThis event is fired to request a vault encryption/decryption key from the application.
NotificationThis event notifies the application about an underlying control flow event.

Config Settings

The following is a list of config settings for the component 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 component.
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 components 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 components 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 (PasswordVault Component)

The description of the vault.

Syntax

public string Description { get; set; }

Public Property Description As String

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.

EntryKey Property (PasswordVault Component)

Provides an encryption key for the current entry.

Syntax

public byte[] EntryKey { get; set; }

Public Property EntryKey As Byte()

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.

EntryPassword Property (PasswordVault Component)

Provides an encryption password for the current entry.

Syntax

public string EntryPassword { get; set; }

Public Property EntryPassword As String

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.

FIPSMode Property (PasswordVault Component)

Reserved.

Syntax

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Key Property (PasswordVault Component)

Provides an encryption key for the vault.

Syntax

public byte[] Key { get; set; }

Public Property Key As Byte()

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.

Password Property (PasswordVault Component)

Provides an encryption password for the vault file.

Syntax

public string Password { get; set; }

Public Property Password As String

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.

PlatformProtection Property (PasswordVault Component)

Enables platform-based protection of the master key.

Syntax

public bool PlatformProtection { get; set; }

Public Property PlatformProtection As Boolean

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 (PasswordVault Component)

The title of the vault.

Syntax

public string Title { get; set; }

Public Property Title As String

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.

AddEntry Method (PasswordVault Component)

Adds an entry to the vault.

Syntax

public void AddEntry(string entryName);

Public Sub AddEntry(ByVal EntryName As String)

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 (PasswordVault Component)

Changes the entry's encryption key.

Syntax

public void ChangeEntryKey(string entryName, byte[] newKey);

Public Sub ChangeEntryKey(ByVal EntryName As String, ByVal NewKey As Byte())

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 (PasswordVault Component)

Changes the entry's encryption password.

Syntax

public void ChangeEntryPassword(string entryName, string newPassword);

Public Sub ChangeEntryPassword(ByVal EntryName As String, ByVal NewPassword As String)

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 (PasswordVault Component)

Closes the vault file.

Syntax

public void Close();

Public Sub Close()

Remarks

Use this method to close the vault file.

Config Method (PasswordVault Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

CreateNew Method (PasswordVault Component)

Creates a new password vault.

Syntax

public void CreateNew();

Public Sub CreateNew()

Remarks

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

DoAction Method (PasswordVault Component)

Performs an additional action.

Syntax

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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 (PasswordVault Component)

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

Syntax

public byte[] GetEntryValue(string entryName, string fieldName);

Public Function GetEntryValue(ByVal EntryName As String, ByVal FieldName As String) As Byte()

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 (PasswordVault Component)

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

Syntax

public string GetEntryValueStr(string entryName, string fieldName);

Public Function GetEntryValueStr(ByVal EntryName As String, ByVal FieldName As String) As String

Remarks

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

ListEntries Method (PasswordVault Component)

Returns a list of entries stored in the vault.

Syntax

public string ListEntries();

Public Function ListEntries() As String

Remarks

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

ListFields Method (PasswordVault Component)

Returns a list of fields contained in the entry.

Syntax

public string ListFields(string entryName, bool includeEncrypted);

Public Function ListFields(ByVal EntryName As String, ByVal IncludeEncrypted As Boolean) As String

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 (PasswordVault Component)

Loads vault content from a byte array.

Syntax

public void OpenBytes(byte[] vaultBytes);

Public Sub OpenBytes(ByVal VaultBytes As Byte())

Remarks

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

OpenFile Method (PasswordVault Component)

Opens a vault file.

Syntax

public void OpenFile(string fileName);

Public Sub OpenFile(ByVal FileName As String)

Remarks

Use this method to open a vault file.

OpenStream Method (PasswordVault Component)

Loads vault data from a stream.

Syntax

public void OpenStream(System.IO.Stream vaultStream);

Public Sub OpenStream(ByVal VaultStream As System.IO.Stream)

Remarks

Use this method to load vault data from a stream.

RemoveAllEntries Method (PasswordVault Component)

Removes all entries from a vault.

Syntax

public void RemoveAllEntries();

Public Sub RemoveAllEntries()

Remarks

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

RemoveEntry Method (PasswordVault Component)

Removes an entry from the vault.

Syntax

public void RemoveEntry(string entryName);

Public Sub RemoveEntry(ByVal EntryName As String)

Remarks

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

RemoveField Method (PasswordVault Component)

Removes an entry field.

Syntax

public void RemoveField(string entryName, string fieldName);

Public Sub RemoveField(ByVal EntryName As String, ByVal FieldName As String)

Remarks

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

Reset Method (PasswordVault Component)

Resets the component settings.

Syntax

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

SaveBytes Method (PasswordVault Component)

Saves the vault contents to a byte array.

Syntax

public byte[] SaveBytes();

Public Function SaveBytes() As Byte()

Remarks

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

SaveFile Method (PasswordVault Component)

Saves the vault contents to a file.

Syntax

public void SaveFile(string fileName);

Public Sub SaveFile(ByVal FileName As String)

Remarks

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

SaveStream Method (PasswordVault Component)

Saves the vault contents to a stream.

Syntax

public void SaveStream(System.IO.Stream vaultStream);

Public Sub SaveStream(ByVal VaultStream As System.IO.Stream)

Remarks

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

SetEntryValue Method (PasswordVault Component)

Assigns a value to an entry field.

Syntax

public void SetEntryValue(string entryName, string fieldName, byte[] fieldValue, bool encrypted);

Public Sub SetEntryValue(ByVal EntryName As String, ByVal FieldName As String, ByVal FieldValue As Byte(), ByVal Encrypted As Boolean)

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 (PasswordVault Component)

Assigns a value to an entry field.

Syntax

public void SetEntryValueStr(string entryName, string fieldName, string fieldValueStr, bool encrypted);

Public Sub SetEntryValueStr(ByVal EntryName As String, ByVal FieldName As String, ByVal FieldValueStr As String, ByVal Encrypted As Boolean)

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 (PasswordVault Component)

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

Syntax

public event OnEntryKeyNeededHandler OnEntryKeyNeeded;

public delegate void OnEntryKeyNeededHandler(object sender, PasswordVaultEntryKeyNeededEventArgs e);

public class PasswordVaultEntryKeyNeededEventArgs : EventArgs {
  public string EntryName { get; }
  public bool Cancel { get; set; }
}

Public Event OnEntryKeyNeeded As OnEntryKeyNeededHandler

Public Delegate Sub OnEntryKeyNeededHandler(sender As Object, e As PasswordVaultEntryKeyNeededEventArgs)

Public Class PasswordVaultEntryKeyNeededEventArgs Inherits EventArgs
  Public ReadOnly Property EntryName As String
  Public Property Cancel As Boolean
End Class

Remarks

The component 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 (PasswordVault Component)

Informs about errors during cryptographic operations.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PasswordVaultErrorEventArgs e);

public class PasswordVaultErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PasswordVaultErrorEventArgs)

Public Class PasswordVaultErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

Syntax

public event OnKeyNeededHandler OnKeyNeeded;

public delegate void OnKeyNeededHandler(object sender, PasswordVaultKeyNeededEventArgs e);

public class PasswordVaultKeyNeededEventArgs : EventArgs {
  public bool Cancel { get; set; }
}

Public Event OnKeyNeeded As OnKeyNeededHandler

Public Delegate Sub OnKeyNeededHandler(sender As Object, e As PasswordVaultKeyNeededEventArgs)

Public Class PasswordVaultKeyNeededEventArgs Inherits EventArgs
  Public Property Cancel As Boolean
End Class

Remarks

Component 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 (PasswordVault Component)

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

Syntax

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, PasswordVaultNotificationEventArgs e);

public class PasswordVaultNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As PasswordVaultNotificationEventArgs)

Public Class PasswordVaultNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (PasswordVault Component)

The component 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 component, 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.

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

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the component.

Use this property to get cookies from the internal cookie storage of the component 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 components 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 components.

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 component. 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 component) 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 component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component 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 components.

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.

Trappable Errors (PasswordVault Component)

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)