PasswordVault Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_PasswordVault

Procedural Interface

 secureblackbox_passwordvault_open();
 secureblackbox_passwordvault_close($res);
 secureblackbox_passwordvault_register_callback($res, $id, $function);
 secureblackbox_passwordvault_get_last_error($res);
 secureblackbox_passwordvault_get_last_error_code($res);
 secureblackbox_passwordvault_set($res, $id, $index, $value);
 secureblackbox_passwordvault_get($res, $id, $index);
 secureblackbox_passwordvault_do_addentry($res, $entryname);
 secureblackbox_passwordvault_do_changeentrykey($res, $entryname, $newkey);
 secureblackbox_passwordvault_do_changeentrypassword($res, $entryname, $newpassword);
 secureblackbox_passwordvault_do_close($res);
 secureblackbox_passwordvault_do_config($res, $configurationstring);
 secureblackbox_passwordvault_do_createnew($res);
 secureblackbox_passwordvault_do_doaction($res, $actionid, $actionparams);
 secureblackbox_passwordvault_do_getentryvalue($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_getentryvaluestr($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_listentries($res);
 secureblackbox_passwordvault_do_listfields($res, $entryname, $includeencrypted);
 secureblackbox_passwordvault_do_openbytes($res, $vaultbytes);
 secureblackbox_passwordvault_do_openfile($res, $filename);
 secureblackbox_passwordvault_do_removeallentries($res);
 secureblackbox_passwordvault_do_removeentry($res, $entryname);
 secureblackbox_passwordvault_do_removefield($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_reset($res);
 secureblackbox_passwordvault_do_savebytes($res);
 secureblackbox_passwordvault_do_savefile($res, $filename);
 secureblackbox_passwordvault_do_setentryvalue($res, $entryname, $fieldname, $fieldvalue, $encrypted);
 secureblackbox_passwordvault_do_setentryvaluestr($res, $entryname, $fieldname, $fieldvaluestr, $encrypted);

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 (SecureBlackbox_PasswordVault Class)

The description of the vault.

Object Oriented Interface

public function getDescription();
public function setDescription($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 1 );
secureblackbox_passwordvault_set($res, 1, $value );

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 (SecureBlackbox_PasswordVault Class)

Provides an encryption key for the current entry.

Object Oriented Interface

public function getEntryKey();
public function setEntryKey($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 2 );
secureblackbox_passwordvault_set($res, 2, $value );

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 (SecureBlackbox_PasswordVault Class)

Provides an encryption password for the current entry.

Object Oriented Interface

public function getEntryPassword();
public function setEntryPassword($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 3 );
secureblackbox_passwordvault_set($res, 3, $value );

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 (SecureBlackbox_PasswordVault Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 4 );
secureblackbox_passwordvault_set($res, 4, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Key Property (SecureBlackbox_PasswordVault Class)

Provides an encryption key for the vault.

Object Oriented Interface

public function getKey();
public function setKey($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 5 );
secureblackbox_passwordvault_set($res, 5, $value );

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 (SecureBlackbox_PasswordVault Class)

Provides an encryption password for the vault file.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 6 );
secureblackbox_passwordvault_set($res, 6, $value );

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 (SecureBlackbox_PasswordVault Class)

Enables platform-based protection of the master key.

Object Oriented Interface

public function getPlatformProtection();
public function setPlatformProtection($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 7 );
secureblackbox_passwordvault_set($res, 7, $value );

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 (SecureBlackbox_PasswordVault Class)

The title of the vault.

Object Oriented Interface

public function getTitle();
public function setTitle($value);

Procedural Interface

secureblackbox_passwordvault_get($res, 8 );
secureblackbox_passwordvault_set($res, 8, $value );

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 (SecureBlackbox_PasswordVault Class)

Adds an entry to the vault.

Object Oriented Interface

public function doAddEntry($entryname);

Procedural Interface

secureblackbox_passwordvault_do_addentry($res, $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 (SecureBlackbox_PasswordVault Class)

Changes the entry's encryption key.

Object Oriented Interface

public function doChangeEntryKey($entryname, $newkey);

Procedural Interface

secureblackbox_passwordvault_do_changeentrykey($res, $entryname, $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 (SecureBlackbox_PasswordVault Class)

Changes the entry's encryption password.

Object Oriented Interface

public function doChangeEntryPassword($entryname, $newpassword);

Procedural Interface

secureblackbox_passwordvault_do_changeentrypassword($res, $entryname, $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 (SecureBlackbox_PasswordVault Class)

Closes the vault file.

Object Oriented Interface

public function doClose();

Procedural Interface

secureblackbox_passwordvault_do_close($res);

Remarks

Use this method to close the vault file.

Config Method (SecureBlackbox_PasswordVault Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_passwordvault_do_config($res, $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 (SecureBlackbox_PasswordVault Class)

Creates a new password vault.

Object Oriented Interface

public function doCreateNew();

Procedural Interface

secureblackbox_passwordvault_do_createnew($res);

Remarks

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

DoAction Method (SecureBlackbox_PasswordVault Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_passwordvault_do_doaction($res, $actionid, $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:

GetEntryValue Method (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function doGetEntryValue($entryname, $fieldname);

Procedural Interface

secureblackbox_passwordvault_do_getentryvalue($res, $entryname, $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 (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function doGetEntryValueStr($entryname, $fieldname);

Procedural Interface

secureblackbox_passwordvault_do_getentryvaluestr($res, $entryname, $fieldname);

Remarks

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

ListEntries Method (SecureBlackbox_PasswordVault Class)

Returns a list of entries stored in the vault.

Object Oriented Interface

public function doListEntries();

Procedural Interface

secureblackbox_passwordvault_do_listentries($res);

Remarks

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

ListFields Method (SecureBlackbox_PasswordVault Class)

Returns a list of fields contained in the entry.

Object Oriented Interface

public function doListFields($entryname, $includeencrypted);

Procedural Interface

secureblackbox_passwordvault_do_listfields($res, $entryname, $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 (SecureBlackbox_PasswordVault Class)

Loads vault content from a byte array.

Object Oriented Interface

public function doOpenBytes($vaultbytes);

Procedural Interface

secureblackbox_passwordvault_do_openbytes($res, $vaultbytes);

Remarks

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

OpenFile Method (SecureBlackbox_PasswordVault Class)

Opens a vault file.

Object Oriented Interface

public function doOpenFile($filename);

Procedural Interface

secureblackbox_passwordvault_do_openfile($res, $filename);

Remarks

Use this method to open a vault file.

RemoveAllEntries Method (SecureBlackbox_PasswordVault Class)

Removes all entries from a vault.

Object Oriented Interface

public function doRemoveAllEntries();

Procedural Interface

secureblackbox_passwordvault_do_removeallentries($res);

Remarks

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

RemoveEntry Method (SecureBlackbox_PasswordVault Class)

Removes an entry from the vault.

Object Oriented Interface

public function doRemoveEntry($entryname);

Procedural Interface

secureblackbox_passwordvault_do_removeentry($res, $entryname);

Remarks

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

RemoveField Method (SecureBlackbox_PasswordVault Class)

Removes an entry field.

Object Oriented Interface

public function doRemoveField($entryname, $fieldname);

Procedural Interface

secureblackbox_passwordvault_do_removefield($res, $entryname, $fieldname);

Remarks

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

Reset Method (SecureBlackbox_PasswordVault Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_passwordvault_do_reset($res);

Remarks

Reset is a generic method available in every class.

SaveBytes Method (SecureBlackbox_PasswordVault Class)

Saves the vault contents to a byte array.

Object Oriented Interface

public function doSaveBytes();

Procedural Interface

secureblackbox_passwordvault_do_savebytes($res);

Remarks

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

SaveFile Method (SecureBlackbox_PasswordVault Class)

Saves the vault contents to a file.

Object Oriented Interface

public function doSaveFile($filename);

Procedural Interface

secureblackbox_passwordvault_do_savefile($res, $filename);

Remarks

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

SetEntryValue Method (SecureBlackbox_PasswordVault Class)

Assigns a value to an entry field.

Object Oriented Interface

public function doSetEntryValue($entryname, $fieldname, $fieldvalue, $encrypted);

Procedural Interface

secureblackbox_passwordvault_do_setentryvalue($res, $entryname, $fieldname, $fieldvalue, $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 (SecureBlackbox_PasswordVault Class)

Assigns a value to an entry field.

Object Oriented Interface

public function doSetEntryValueStr($entryname, $fieldname, $fieldvaluestr, $encrypted);

Procedural Interface

secureblackbox_passwordvault_do_setentryvaluestr($res, $entryname, $fieldname, $fieldvaluestr, $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 (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function fireEntryKeyNeeded($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 1, array($this, 'fireEntryKeyNeeded'));

Parameter List

 'entryname'
 '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 (SecureBlackbox_PasswordVault Class)

Informs about errors during cryptographic operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 '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 (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function fireKeyNeeded($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 3, array($this, 'fireKeyNeeded'));

Parameter List

 '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 (SecureBlackbox_PasswordVault Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_passwordvault_register_callback($res, 4, array($this, 'fireNotification'));

Parameter List

 'eventid'
 '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 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 Config Settings

Base Config Settings

Trappable Errors (PasswordVault Class)

PasswordVault Errors