PasswordVault Module

Properties Methods Events Config Settings Errors

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

Syntax

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 module 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 module 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.
CreateNew	Creates a new password vault.
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.
Reset	Resets the module settings.
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 module 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 module with short descriptions. Click on the links for further details.


EntrySalt	TBD.
NewEntrySalt	TBD.
Salt	TBD.
TempPath	Path for storing temporary files.
UseLocalMachineAccount	TBD.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
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 module.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client modules created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
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.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
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.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client modules should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

Description Property (PasswordVault Module)

The description of the vault.

public var description_: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=description,setter=setDescription:) NSString* description;

- (NSString*)description;
- (NSString*)description_;
- (void)setDescription :(NSString*)newDescription;
- (void)setDescription_ :(NSString*)newDescription;

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

Provides an encryption key for the current entry.

Syntax

Swift
Objective-C

public var entryKey: Data {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=entryKey,setter=setEntryKey:) NSData* entryKey;

- (NSData*)entryKey;
- (void)setEntryKey :(NSData*)newEntryKey;

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.

EntryPassword Property (PasswordVault Module)

Provides an encryption password for the current entry.

Syntax

Swift
Objective-C

public var entryPassword: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=entryPassword,setter=setEntryPassword:) NSString* entryPassword;

- (NSString*)entryPassword;
- (void)setEntryPassword :(NSString*)newEntryPassword;

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

Reserved.

Syntax

Swift
Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

Key Property (PasswordVault Module)

Provides an encryption key for the vault.

Syntax

Swift
Objective-C

public var key: Data {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=key,setter=setKey:) NSData* key;

- (NSData*)key;
- (void)setKey :(NSData*)newKey;

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.

Password Property (PasswordVault Module)

Provides an encryption password for the vault file.

Syntax

Swift
Objective-C

public var password: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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

Enables platform-based protection of the master key.

Syntax

Swift
Objective-C

public var platformProtection: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=platformProtection,setter=setPlatformProtection:) BOOL platformProtection;

- (BOOL)platformProtection;
- (void)setPlatformProtection :(BOOL)newPlatformProtection;

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

The title of the vault.

Syntax

Swift
Objective-C

public var title: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=title,setter=setTitle:) NSString* title;

- (NSString*)title;
- (void)setTitle :(NSString*)newTitle;

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

Adds an entry to the vault.

Syntax

Swift
Objective-C

public func addEntry(entryName: String) throws -> Void

- (void)addEntry:(NSString*)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 (PasswordVault Module)

Changes the entry's encryption key.

Syntax

Swift
Objective-C

public func changeEntryKey(entryName: String, newKey: Data) throws -> Void

- (void)changeEntryKey:(NSString*)entryName :(NSData*)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 (PasswordVault Module)

Changes the entry's encryption password.

Syntax

Swift
Objective-C

public func changeEntryPassword(entryName: String, newPassword: String) throws -> Void

- (void)changeEntryPassword:(NSString*)entryName :(NSString*)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 (PasswordVault Module)

Closes the vault file.

Syntax

Swift
Objective-C

public func close() throws -> Void

- (void)close;

Remarks

Use this method to close the vault file.

Config Method (PasswordVault Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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.

CreateNew Method (PasswordVault Module)

Creates a new password vault.

Syntax

Swift
Objective-C

public func createNew() throws -> Void

- (void)createNew;

Remarks

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

DoAction Method (PasswordVault Module)

Performs an additional action.

Syntax

Swift
Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)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;....

Common ActionIDs:


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

GetEntryValue Method (PasswordVault Module)

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

Syntax

Swift
Objective-C

public func getEntryValue(entryName: String, fieldName: String) throws -> Data

- (NSData*)getEntryValue:(NSString*)entryName :(NSString*)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 (PasswordVault Module)

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

Syntax

Swift
Objective-C

public func getEntryValueStr(entryName: String, fieldName: String) throws -> String

- (NSString*)getEntryValueStr:(NSString*)entryName :(NSString*)fieldName;

Remarks

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

ListEntries Method (PasswordVault Module)

Returns a list of entries stored in the vault.

Syntax

Swift
Objective-C

public func listEntries() throws -> String

- (NSString*)listEntries;

Remarks

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

ListFields Method (PasswordVault Module)

Returns a list of fields contained in the entry.

Syntax

Swift
Objective-C

public func listFields(entryName: String, includeEncrypted: Bool) throws -> String

- (NSString*)listFields:(NSString*)entryName :(BOOL)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 (PasswordVault Module)

Loads vault content from a byte array.

Syntax

Swift
Objective-C

public func openBytes(vaultBytes: Data) throws -> Void

- (void)openBytes:(NSData*)vaultBytes;

Remarks

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

OpenFile Method (PasswordVault Module)

Opens a vault file.

Syntax

Swift
Objective-C

public func openFile(fileName: String) throws -> Void

- (void)openFile:(NSString*)fileName;

Remarks

Use this method to open a vault file.

RemoveAllEntries Method (PasswordVault Module)

Removes all entries from a vault.

Syntax

Swift
Objective-C

public func removeAllEntries() throws -> Void

- (void)removeAllEntries;

Remarks

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

RemoveEntry Method (PasswordVault Module)

Removes an entry from the vault.

Syntax

Swift
Objective-C

public func removeEntry(entryName: String) throws -> Void

- (void)removeEntry:(NSString*)entryName;

Remarks

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

RemoveField Method (PasswordVault Module)

Removes an entry field.

Syntax

Swift
Objective-C

public func removeField(entryName: String, fieldName: String) throws -> Void

- (void)removeField:(NSString*)entryName :(NSString*)fieldName;

Remarks

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

Reset Method (PasswordVault Module)

Resets the component settings.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

SaveBytes Method (PasswordVault Module)

Saves the vault contents to a byte array.

Syntax

Swift
Objective-C

public func saveBytes() throws -> Data

- (NSData*)saveBytes;

Remarks

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

SaveFile Method (PasswordVault Module)

Saves the vault contents to a file.

Syntax

Swift
Objective-C

public func saveFile(fileName: String) throws -> Void

- (void)saveFile:(NSString*)fileName;

Remarks

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

SetEntryValue Method (PasswordVault Module)

Assigns a value to an entry field.

Syntax

Swift
Objective-C

public func setEntryValue(entryName: String, fieldName: String, fieldValue: Data, encrypted: Bool) throws -> Void

- (void)setEntryValue:(NSString*)entryName :(NSString*)fieldName :(NSData*)fieldValue :(BOOL)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 (PasswordVault Module)

Assigns a value to an entry field.

Syntax

Swift
Objective-C

public func setEntryValueStr(entryName: String, fieldName: String, fieldValueStr: String, encrypted: Bool) throws -> Void

- (void)setEntryValueStr:(NSString*)entryName :(NSString*)fieldName :(NSString*)fieldValueStr :(BOOL)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 (PasswordVault Module)

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

Syntax

Swift
Objective-C

func onEntryKeyNeeded(entryName: String, cancel: inout Bool)

- (void)onEntryKeyNeeded:(NSString*)entryName :(int*)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 (PasswordVault Module)

Informs about errors during cryptographic operations.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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 (PasswordVault Module)

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

Syntax

Swift
Objective-C

func onKeyNeeded(cancel: inout Bool)

- (void)onKeyNeeded:(int*)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 (PasswordVault Module)

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

Syntax

Swift
Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)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 Module)

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.

UseLocalMachineAccount: TBD.

TBD

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


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

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

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

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

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:


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

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


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

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


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

LogFlushMode: Specifies the log flush mode.

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


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

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


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

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

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


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

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

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

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

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

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

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

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

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

Supported Values:


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

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath: Specifies the file system path where cached PKI data is stored.

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

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

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

ProductVersion: Returns the version of the SecureBlackbox library.

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

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


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

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are 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).

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

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

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

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

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

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

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

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

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

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

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

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

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

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

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

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

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

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

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

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

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

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

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

Trappable Errors (PasswordVault Module)

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