PasswordVault Class
Properties Methods Events Configuration Settings Errors
The PasswordVault class implements a vault for keeping passwords and other sensitive properties.
Syntax
PasswordVault
Remarks
Use this component to keep passwords and other settings in secure manner.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Description | The description of the vault. |
EntryKey | Provides an encryption key for the current entry. |
EntryPassword | Provides an encryption password for the current entry. |
FIPSMode | Reserved. |
Key | Provides an encryption key for the vault. |
Password | Provides an encryption password for the vault file. |
PlatformProtection | Enables platform-based protection of the master key. |
Title | The title of the vault. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddEntry | Adds an entry to the vault. |
ChangeEntryKey | Changes the entry's encryption key. |
ChangeEntryPassword | Changes the entry's encryption password. |
Close | Closes the vault file. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetEntryValue | Returns the content stored in one of the entry fields as a byte array. |
GetEntryValueStr | Returns the content stored in a field of the entry as a string. |
ListEntries | Returns a list of entries stored in the vault. |
ListFields | Returns a list of fields contained in the entry. |
OpenBytes | Loads vault content from a byte array. |
OpenFile | Opens a vault file. |
RemoveAllEntries | Removes all entries from a vault. |
RemoveEntry | Removes an entry from the vault. |
RemoveField | Removes an entry field. |
SaveBytes | Saves the vault contents to a byte array. |
SaveFile | Saves the vault contents to a file. |
SetEntryValue | Assigns a value to an entry field. |
SetEntryValueStr | Assigns a value to an entry field. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
EntryKeyNeeded | This event is fired to request an entry encryption/decryption key from the application. |
Error | Informs about errors during cryptographic operations. |
KeyNeeded | This event is fired to request a vault encryption/decryption key from the application. |
Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
Tag | Allows to store any custom data. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Description Property (PasswordVault Class)
The description of the vault.
Syntax
QString GetDescription();
int SetDescription(QString qsDescription);
Default Value
""
Remarks
Use this property to provide a textual description (comment) for the vault. This value is not encrypted even if the vault is.
Data Type
String
EntryKey Property (PasswordVault Class)
Provides an encryption key for the current entry.
Syntax
QByteArray GetEntryKey();
int SetEntryKey(QByteArray qbaEntryKey);
Remarks
Use this property to provide the encryption/decryption key for the current entry. This property is typically assigned from the EntryKeyNeeded event handler.
This property is automatically generated when a non-empty password is assigned to the EntryPassword property. This is because all entries, and the vault itself, are always encrypted with cryptographically strong keys, and if the user decides to use a password, it is converted to such key using a secure PBKDF function.
This property is not available at design time.
Data Type
Byte Array
EntryPassword Property (PasswordVault Class)
Provides an encryption password for the current entry.
Syntax
QString GetEntryPassword();
int SetEntryPassword(QString qsEntryPassword);
Default Value
""
Remarks
Use this property to provide the encryption/decryption password for the current entry. This property is typically assigned from the EntryKeyNeeded event handler.
See a comment in the EntryKey topic to find out how the passwords are used when encrypting entries.
Data Type
String
FIPSMode Property (PasswordVault Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
Key Property (PasswordVault Class)
Provides an encryption key for the vault.
Syntax
QByteArray GetKey();
int SetKey(QByteArray qbaKey);
Remarks
Use this property to provide the 'master' key for the vault file. This property can be assigned from the KeyNeeded event handler.
The content of this property is automatically generated when a non-empty password is assigned to the Password property. This is because the vault file are always encrypted with a cryptographically strong key, and if the user decides to use a password, it is converted to such key using a secure PBKDF function first.
This property is not available at design time.
Data Type
Byte Array
Password Property (PasswordVault Class)
Provides an encryption password for the vault file.
Syntax
QString GetPassword();
int SetPassword(QString qsPassword);
Default Value
""
Remarks
Use this property to provide the master password for the vault file. This property can be assigned from the KeyNeeded event handler.
See a comment in the Key topic to learn how the passwords are used when encrypting the vault file.
Data Type
String
PlatformProtection Property (PasswordVault Class)
Enables platform-based protection of the master key.
Syntax
bool GetPlatformProtection();
int SetPlatformProtection(bool bPlatformProtection);
Default Value
false
Remarks
Use this property to enable the platform-based protection for the main encryption key. The platform protection is currently only available on Windows, in the form of DPAPI in unmanaged editions, or ProtectedData in .NET Framework.
Data Type
Boolean
Title Property (PasswordVault Class)
The title of the vault.
Syntax
QString GetTitle();
int SetTitle(QString qsTitle);
Default Value
""
Remarks
Use this property to provide a title for your vault storage. This value is not encrypted event if the vault itself is.
Data Type
String
AddEntry Method (PasswordVault Class)
Adds an entry to the vault.
Syntax
int AddEntry(const QString& qsEntryName);
Remarks
Use this method to add a new entry to the vault. Use SetEntryValue or SetEntryValueStr to assign a value to the new entry.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ChangeEntryKey Method (PasswordVault Class)
Changes the entry's encryption key.
Syntax
int ChangeEntryKey(const QString& qsEntryName, QByteArray qbaNewKey);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ChangeEntryPassword Method (PasswordVault Class)
Changes the entry's encryption password.
Syntax
int ChangeEntryPassword(const QString& qsEntryName, const QString& qsNewPassword);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Close Method (PasswordVault Class)
Closes the vault file.
Syntax
int Close();
Remarks
Use this method to close the vault file.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (PasswordVault Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (PasswordVault Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetEntryValue Method (PasswordVault Class)
Returns the content stored in one of the entry fields as a byte array.
Syntax
QByteArray GetEntryValue(const QString& qsEntryName, const QString& qsFieldName);
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.
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetEntryValueStr Method (PasswordVault Class)
Returns the content stored in a field of the entry as a string.
Syntax
QString GetEntryValueStr(const QString& qsEntryName, const QString& qsFieldName);
Remarks
Call this method to obtain the data associated with the FieldName field of the EntryName entry in the string form.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ListEntries Method (PasswordVault Class)
Returns a list of entries stored in the vault.
Syntax
QString ListEntries();
Remarks
Use this method to retrieve a list of entries stored in the currently opened vault file.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ListFields Method (PasswordVault Class)
Returns a list of fields contained in the entry.
Syntax
QString ListFields(const QString& qsEntryName, bool bIncludeEncrypted);
Remarks
Use this method to obtain a list of fields contained in the EntryName entry. The IncludeEncrypted parameter specifies whether to include encrypted entries in the list.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
OpenBytes Method (PasswordVault Class)
Loads vault content from a byte array.
Syntax
int OpenBytes(QByteArray qbaVaultBytes);
Remarks
Use this method to load the vault from a byte array.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
OpenFile Method (PasswordVault Class)
Opens a vault file.
Syntax
int OpenFile(const QString& qsFileName);
Remarks
Use this method to open a vault file.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemoveAllEntries Method (PasswordVault Class)
Removes all entries from a vault.
Syntax
int RemoveAllEntries();
Remarks
Use this method to remove all entries from the currently opened vault.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemoveEntry Method (PasswordVault Class)
Removes an entry from the vault.
Syntax
int RemoveEntry(const QString& qsEntryName);
Remarks
Use this method to remove (delete) the EntryName entry from the vault.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemoveField Method (PasswordVault Class)
Removes an entry field.
Syntax
int RemoveField(const QString& qsEntryName, const QString& qsFieldName);
Remarks
Use this method to remove an entry field FieldName from the entry EntryName.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SaveBytes Method (PasswordVault Class)
Saves the vault contents to a byte array.
Syntax
QByteArray SaveBytes();
Remarks
Use this method to save the vault contents to a byte array.
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SaveFile Method (PasswordVault Class)
Saves the vault contents to a file.
Syntax
int SaveFile(const QString& qsFilename);
Remarks
Use this method to save the contents of the password vault to a file.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetEntryValue Method (PasswordVault Class)
Assigns a value to an entry field.
Syntax
int SetEntryValue(const QString& qsEntryName, const QString& qsFieldName, QByteArray qbaFieldValue, bool bEncrypted);
Remarks
Use this method to assign a value to a field of a vault entry. Use EntryName to identify the entry, and provide the field's name and value via FieldName and FieldValue parameters respectively. Set Encrypted to true to indicate that the field should be encrypted.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetEntryValueStr Method (PasswordVault Class)
Assigns a value to an entry field.
Syntax
int SetEntryValueStr(const QString& qsEntryName, const QString& qsFieldName, const QString& qsFieldValueStr, bool bEncrypted);
Remarks
Use this method to assign a string value to a field of a vault entry. Use EntryName to identify the entry, and provide the field's name and value via FieldName and FieldValueStr parameters respectively. Set Encrypted to true to indicate that the field should be encrypted.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EntryKeyNeeded Event (PasswordVault Class)
This event is fired to request an entry encryption/decryption key from the application.
Syntax
class PasswordVaultEntryKeyNeededEventParams { public: const QString &EntryName(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EntryKeyNeeded(PasswordVaultEntryKeyNeededEventParams *e);
// Or, subclass PasswordVault and override this emitter function. virtual int FireEntryKeyNeeded(PasswordVaultEntryKeyNeededEventParams *e) {...}
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 Class)
Informs about errors during cryptographic operations.
Syntax
class PasswordVaultErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PasswordVaultErrorEventParams *e);
// Or, subclass PasswordVault and override this emitter function. virtual int FireError(PasswordVaultErrorEventParams *e) {...}
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 Class)
This event is fired to request a vault encryption/decryption key from the application.
Syntax
class PasswordVaultKeyNeededEventParams { public: bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeyNeeded(PasswordVaultKeyNeededEventParams *e);
// Or, subclass PasswordVault and override this emitter function. virtual int FireKeyNeeded(PasswordVaultKeyNeededEventParams *e) {...}
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 Class)
This event notifies the application about an underlying control flow event.
Syntax
class PasswordVaultNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(PasswordVaultNotificationEventParams *e);
// Or, subclass PasswordVault and override this emitter function. virtual int FireNotification(PasswordVaultNotificationEventParams *e) {...}
Remarks
The class 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 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.
Configuration Settings (PasswordVault Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.PasswordVault Configuration Settings | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (PasswordVault Class)
PasswordVault Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |