PasswordVault Class

Properties   Methods   Events   Config 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.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Description Property (PasswordVault Class)

The description of the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDescription();
int SetDescription(const char* lpszDescription);

Unicode (Windows)
LPWSTR GetDescription();
INT SetDescription(LPCWSTR lpszDescription);

char* secureblackbox_passwordvault_getdescription(void* lpObj);
int secureblackbox_passwordvault_setdescription(void* lpObj, const char* lpszDescription);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryKey(char* &lpEntryKey, int &lenEntryKey);
int SetEntryKey(const char* lpEntryKey, int lenEntryKey);

Unicode (Windows)
INT GetEntryKey(LPSTR &lpEntryKey, INT &lenEntryKey);
INT SetEntryKey(LPCSTR lpEntryKey, INT lenEntryKey);

int secureblackbox_passwordvault_getentrykey(void* lpObj, char** lpEntryKey, int* lenEntryKey);
int secureblackbox_passwordvault_setentrykey(void* lpObj, const char* lpEntryKey, int lenEntryKey);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryPassword();
int SetEntryPassword(const char* lpszEntryPassword);

Unicode (Windows)
LPWSTR GetEntryPassword();
INT SetEntryPassword(LPCWSTR lpszEntryPassword);

char* secureblackbox_passwordvault_getentrypassword(void* lpObj);
int secureblackbox_passwordvault_setentrypassword(void* lpObj, const char* lpszEntryPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_passwordvault_getfipsmode(void* lpObj);
int secureblackbox_passwordvault_setfipsmode(void* lpObj, int bFIPSMode);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);

int secureblackbox_passwordvault_getkey(void* lpObj, char** lpKey, int* lenKey);
int secureblackbox_passwordvault_setkey(void* lpObj, const char* lpKey, int lenKey);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* secureblackbox_passwordvault_getpassword(void* lpObj);
int secureblackbox_passwordvault_setpassword(void* lpObj, const char* lpszPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPlatformProtection();
int SetPlatformProtection(int bPlatformProtection);

Unicode (Windows)
BOOL GetPlatformProtection();
INT SetPlatformProtection(BOOL bPlatformProtection);

int secureblackbox_passwordvault_getplatformprotection(void* lpObj);
int secureblackbox_passwordvault_setplatformprotection(void* lpObj, int bPlatformProtection);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTitle();
int SetTitle(const char* lpszTitle);

Unicode (Windows)
LPWSTR GetTitle();
INT SetTitle(LPCWSTR lpszTitle);

char* secureblackbox_passwordvault_gettitle(void* lpObj);
int secureblackbox_passwordvault_settitle(void* lpObj, const char* lpszTitle);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int AddEntry(const char* lpszEntryName);

Unicode (Windows)
INT AddEntry(LPCWSTR lpszEntryName);

int secureblackbox_passwordvault_addentry(void* lpObj, const char* lpszEntryName);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeEntryKey(const char* lpszEntryName, const char* lpNewKey, int lenNewKey);

Unicode (Windows)
INT ChangeEntryKey(LPCWSTR lpszEntryName, LPCSTR lpNewKey, INT lenNewKey);

int secureblackbox_passwordvault_changeentrykey(void* lpObj, const char* lpszEntryName, const char* lpNewKey, int lenNewKey);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeEntryPassword(const char* lpszEntryName, const char* lpszNewPassword);

Unicode (Windows)
INT ChangeEntryPassword(LPCWSTR lpszEntryName, LPCWSTR lpszNewPassword);

int secureblackbox_passwordvault_changeentrypassword(void* lpObj, const char* lpszEntryName, const char* lpszNewPassword);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int secureblackbox_passwordvault_close(void* lpObj);

int Close();

Remarks

Use this method to close the vault file.

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_passwordvault_config(void* lpObj, const char* lpszConfigurationString);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_passwordvault_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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 (case insencitive) 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;....

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryValue(const char* lpszEntryName, const char* lpszFieldName, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetEntryValue(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName, LPINT lpSize = NULL);

char* secureblackbox_passwordvault_getentryvalue(void* lpObj, const char* lpszEntryName, const char* lpszFieldName, int *lpSize);

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 (C++)

This method returns a Byte Array value (with length lpSize); 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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryValueStr(const char* lpszEntryName, const char* lpszFieldName);

Unicode (Windows)
LPWSTR GetEntryValueStr(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName);

char* secureblackbox_passwordvault_getentryvaluestr(void* lpObj, const char* lpszEntryName, const char* lpszFieldName);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListEntries();

Unicode (Windows)
LPWSTR ListEntries();

char* secureblackbox_passwordvault_listentries(void* lpObj);

QString ListEntries();

Remarks

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

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListFields(const char* lpszEntryName, int bIncludeEncrypted);

Unicode (Windows)
LPWSTR ListFields(LPCWSTR lpszEntryName, BOOL bIncludeEncrypted);

char* secureblackbox_passwordvault_listfields(void* lpObj, const char* lpszEntryName, int bIncludeEncrypted);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenBytes(const char* lpVaultBytes, int lenVaultBytes);

Unicode (Windows)
INT OpenBytes(LPCSTR lpVaultBytes, INT lenVaultBytes);

int secureblackbox_passwordvault_openbytes(void* lpObj, const char* lpVaultBytes, int lenVaultBytes);

int OpenBytes(QByteArray qbaVaultBytes);

Remarks

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

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenFile(const char* lpszFileName);

Unicode (Windows)
INT OpenFile(LPCWSTR lpszFileName);

int secureblackbox_passwordvault_openfile(void* lpObj, const char* lpszFileName);

int OpenFile(const QString& qsFileName);

Remarks

Use this method to open a vault file.

Error Handling (C++)

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

OpenStream Method (PasswordVault Class)

Loads vault data from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenStream(SecureBlackboxStream* sVaultStream);

Unicode (Windows)
INT OpenStream(SecureBlackboxStream* sVaultStream);

int secureblackbox_passwordvault_openstream(void* lpObj, SecureBlackboxStream* sVaultStream);

int OpenStream(SecureBlackboxStream* sVaultStream);

Remarks

Use this method to load vault data from a stream.

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveAllEntries();

Unicode (Windows)
INT RemoveAllEntries();

int secureblackbox_passwordvault_removeallentries(void* lpObj);

int RemoveAllEntries();

Remarks

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

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveEntry(const char* lpszEntryName);

Unicode (Windows)
INT RemoveEntry(LPCWSTR lpszEntryName);

int secureblackbox_passwordvault_removeentry(void* lpObj, const char* lpszEntryName);

int RemoveEntry(const QString& qsEntryName);

Remarks

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

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveField(const char* lpszEntryName, const char* lpszFieldName);

Unicode (Windows)
INT RemoveField(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName);

int secureblackbox_passwordvault_removefield(void* lpObj, const char* lpszEntryName, const char* lpszFieldName);

int RemoveField(const QString& qsEntryName, const QString& qsFieldName);

Remarks

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

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* SaveBytes(int *lpSize = NULL);

Unicode (Windows)
LPSTR SaveBytes(LPINT lpSize = NULL);

char* secureblackbox_passwordvault_savebytes(void* lpObjint *lpSize);

QByteArray SaveBytes();

Remarks

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

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveFile(const char* lpszFilename);

Unicode (Windows)
INT SaveFile(LPCWSTR lpszFilename);

int secureblackbox_passwordvault_savefile(void* lpObj, const char* lpszFilename);

int SaveFile(const QString& qsFilename);

Remarks

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

Error Handling (C++)

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

SaveStream Method (PasswordVault Class)

Saves the vault contents to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveStream(SecureBlackboxStream* sVaultStream);

Unicode (Windows)
INT SaveStream(SecureBlackboxStream* sVaultStream);

int secureblackbox_passwordvault_savestream(void* lpObj, SecureBlackboxStream* sVaultStream);

int SaveStream(SecureBlackboxStream* sVaultStream);

Remarks

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

Error Handling (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int SetEntryValue(const char* lpszEntryName, const char* lpszFieldName, const char* lpFieldValue, int lenFieldValue, int bEncrypted);

Unicode (Windows)
INT SetEntryValue(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName, LPCSTR lpFieldValue, INT lenFieldValue, BOOL bEncrypted);

int secureblackbox_passwordvault_setentryvalue(void* lpObj, const char* lpszEntryName, const char* lpszFieldName, const char* lpFieldValue, int lenFieldValue, int bEncrypted);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int SetEntryValueStr(const char* lpszEntryName, const char* lpszFieldName, const char* lpszFieldValueStr, int bEncrypted);

Unicode (Windows)
INT SetEntryValueStr(LPCWSTR lpszEntryName, LPCWSTR lpszFieldName, LPCWSTR lpszFieldValueStr, BOOL bEncrypted);

int secureblackbox_passwordvault_setentryvaluestr(void* lpObj, const char* lpszEntryName, const char* lpszFieldName, const char* lpszFieldValueStr, int bEncrypted);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEntryKeyNeeded(PasswordVaultEntryKeyNeededEventParams *e);

typedef struct {
  const char *EntryName;
  int Cancel;
  int reserved;
} PasswordVaultEntryKeyNeededEventParams;


Unicode (Windows)
virtual INT FireEntryKeyNeeded(PasswordVaultEntryKeyNeededEventParams *e);

typedef struct {
  LPCWSTR EntryName;
  BOOL Cancel;
  INT reserved;
} PasswordVaultEntryKeyNeededEventParams;

#define EID_PASSWORDVAULT_ENTRYKEYNEEDED 1

virtual INT SECUREBLACKBOX_CALL FireEntryKeyNeeded(LPSTR &lpszEntryName, BOOL &bCancel);

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PasswordVaultErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PasswordVaultErrorEventParams;


Unicode (Windows)
virtual INT FireError(PasswordVaultErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PasswordVaultErrorEventParams;

#define EID_PASSWORDVAULT_ERROR 2

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireKeyNeeded(PasswordVaultKeyNeededEventParams *e);

typedef struct {
  int Cancel;
  int reserved;
} PasswordVaultKeyNeededEventParams;


Unicode (Windows)
virtual INT FireKeyNeeded(PasswordVaultKeyNeededEventParams *e);

typedef struct {
  BOOL Cancel;
  INT reserved;
} PasswordVaultKeyNeededEventParams;

#define EID_PASSWORDVAULT_KEYNEEDED 3

virtual INT SECUREBLACKBOX_CALL FireKeyNeeded(BOOL &bCancel);

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(PasswordVaultNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} PasswordVaultNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(PasswordVaultNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} PasswordVaultNotificationEventParams;

#define EID_PASSWORDVAULT_NOTIFICATION 4

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

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.

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The PasswordVault class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the PasswordVault class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (PasswordVault Class)

PasswordVault Config Settings

Base Config Settings

Trappable Errors (PasswordVault Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PasswordVault Errors