PasswordVault Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TsbxPasswordVault

Remarks

Use this component to keep passwords and other settings in secure manner.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

Description Property (PasswordVault Component)

The description of the vault.

Syntax

property Description: String read get_Description write set_Description;

Default Value

''

Remarks

Use this property to provide a textual description (comment) for the vault. This value is not encrypted even if the vault is.

EntryKey Property (PasswordVault Component)

Provides an encryption key for the current entry.

Syntax

property EntryKey: TBytes read get_EntryKey write set_EntryKey;

Remarks

Use this property to provide the encryption/decryption key for the current entry. This property is typically assigned from the EntryKeyNeeded event handler.

This property is automatically generated when a non-empty password is assigned to the EntryPassword property. This is because all entries, and the vault itself, are always encrypted with cryptographically strong keys, and if the user decides to use a password, it is converted to such key using a secure PBKDF function.

This property is not available at design time.

EntryPassword Property (PasswordVault Component)

Provides an encryption password for the current entry.

Syntax

property EntryPassword: String read get_EntryPassword write set_EntryPassword;

Default Value

''

Remarks

Use this property to provide the encryption/decryption password for the current entry. This property is typically assigned from the EntryKeyNeeded event handler.

See a comment in the EntryKey topic to find out how the passwords are used when encrypting entries.

FIPSMode Property (PasswordVault Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

Key Property (PasswordVault Component)

Provides an encryption key for the vault.

Syntax

property Key: TBytes read get_Key write set_Key;

Remarks

Use this property to provide the 'master' key for the vault file. This property can be assigned from the KeyNeeded event handler.

The content of this property is automatically generated when a non-empty password is assigned to the Password property. This is because the vault file are always encrypted with a cryptographically strong key, and if the user decides to use a password, it is converted to such key using a secure PBKDF function first.

This property is not available at design time.

Password Property (PasswordVault Component)

Provides an encryption password for the vault file.

Syntax

property Password: String read get_Password write set_Password;

Default Value

''

Remarks

Use this property to provide the master password for the vault file. This property can be assigned from the KeyNeeded event handler.

See a comment in the Key topic to learn how the passwords are used when encrypting the vault file.

PlatformProtection Property (PasswordVault Component)

Enables platform-based protection of the master key.

Syntax

property PlatformProtection: Boolean read get_PlatformProtection write set_PlatformProtection;

Default Value

false

Remarks

Use this property to enable the platform-based protection for the main encryption key. The platform protection is currently only available on Windows, in the form of DPAPI in unmanaged editions, or ProtectedData in .NET Framework.

Title Property (PasswordVault Component)

The title of the vault.

Syntax

property Title: String read get_Title write set_Title;

Default Value

''

Remarks

Use this property to provide a title for your vault storage. This value is not encrypted event if the vault itself is.

AddEntry Method (PasswordVault Component)

Adds an entry to the vault.

Syntax

procedure AddEntry(EntryName: String);

Remarks

Use this method to add a new entry to the vault. Use SetEntryValue or SetEntryValueStr to assign a value to the new entry.

ChangeEntryKey Method (PasswordVault Component)

Changes the entry's encryption key.

Syntax

procedure ChangeEntryKey(EntryName: String; NewKey: TBytes);

Remarks

Use this method to change the entry's encryption key. This method may invoke the EntryKeyNeeded event to request the existing key if the entry was previously encrypted.

ChangeEntryPassword Method (PasswordVault Component)

Changes the entry's encryption password.

Syntax

procedure ChangeEntryPassword(EntryName: String; NewPassword: String);

Remarks

Use this method to change the entry's encryption password. This method may invoke the EntryKeyNeeded event to request the existing key if the entry was previously encrypted.

Note that all entries, and the vault itself, are encrypted with cryptographic keys, rather than passwords. When you change an entry's encryption password, you are implicitly changing its encryption key, which is derived from the password using a cryptographically secure key derivation function.

Close Method (PasswordVault Component)

Closes the vault file.

Syntax

procedure Close();

Remarks

Use this method to close the vault file.

Config Method (PasswordVault Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (PasswordVault Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): String;

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetEntryValue Method (PasswordVault Component)

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

Syntax

function GetEntryValue(EntryName: String; FieldName: String): TBytes;

Remarks

Use this method to obtain the content stored in the FieldName field of the EntryName entry in the form of a byte array. Use GetEntryValueStr to retrieve the content as a string.

GetEntryValueStr Method (PasswordVault Component)

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

Syntax

function GetEntryValueStr(EntryName: String; FieldName: String): String;

Remarks

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

ListEntries Method (PasswordVault Component)

Returns a list of entries stored in the vault.

Syntax

function ListEntries(): String;

Remarks

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

ListFields Method (PasswordVault Component)

Returns a list of fields contained in the entry.

Syntax

function ListFields(EntryName: String; IncludeEncrypted: Boolean): String;

Remarks

Use this method to obtain a list of fields contained in the EntryName entry. The IncludeEncrypted parameter specifies whether to include encrypted entries in the list.

OpenBytes Method (PasswordVault Component)

Loads vault content from a byte array.

Syntax

procedure OpenBytes(VaultBytes: TBytes);

Remarks

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

OpenFile Method (PasswordVault Component)

Opens a vault file.

Syntax

procedure OpenFile(FileName: String);

Remarks

Use this method to open a vault file.

OpenStream Method (PasswordVault Component)

Loads vault data from a stream.

Syntax

procedure OpenStream(VaultStream: TStream);

Remarks

Use this method to load vault data from a stream.

RemoveAllEntries Method (PasswordVault Component)

Removes all entries from a vault.

Syntax

procedure RemoveAllEntries();

Remarks

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

RemoveEntry Method (PasswordVault Component)

Removes an entry from the vault.

Syntax

procedure RemoveEntry(EntryName: String);

Remarks

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

RemoveField Method (PasswordVault Component)

Removes an entry field.

Syntax

procedure RemoveField(EntryName: String; FieldName: String);

Remarks

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

SaveBytes Method (PasswordVault Component)

Saves the vault contents to a byte array.

Syntax

function SaveBytes(): TBytes;

Remarks

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

SaveFile Method (PasswordVault Component)

Saves the vault contents to a file.

Syntax

procedure SaveFile(Filename: String);

Remarks

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

SaveStream Method (PasswordVault Component)

Saves the vault contents to a stream.

Syntax

procedure SaveStream(VaultStream: TStream);

Remarks

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

SetEntryValue Method (PasswordVault Component)

Assigns a value to an entry field.

Syntax

procedure SetEntryValue(EntryName: String; FieldName: String; FieldValue: TBytes; Encrypted: Boolean);

Remarks

Use this method to assign a value to a field of a vault entry. Use EntryName to identify the entry, and provide the field's name and value via FieldName and FieldValue parameters respectively. Set Encrypted to true to indicate that the field should be encrypted.

SetEntryValueStr Method (PasswordVault Component)

Assigns a value to an entry field.

Syntax

procedure SetEntryValueStr(EntryName: String; FieldName: String; FieldValueStr: String; Encrypted: Boolean);

Remarks

Use this method to assign a string value to a field of a vault entry. Use EntryName to identify the entry, and provide the field's name and value via FieldName and FieldValueStr parameters respectively. Set Encrypted to true to indicate that the field should be encrypted.

EntryKeyNeeded Event (PasswordVault Component)

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

Syntax

type TEntryKeyNeededEvent = procedure (
  Sender: TObject;
  const EntryName: String;
  var Cancel: Boolean
) of Object;

property OnEntryKeyNeeded: TEntryKeyNeededEvent read FOnEntryKeyNeeded write FOnEntryKeyNeeded;

Remarks

The component fires this event when a key is needed to encrypt or decrypt an entry. The EntryName parameter provides the name of the entry.

The handler of this event should assign the password or key to be used to EntryPassword or EntryKey property respectively. Set Cancel to true to abort the operation.

Error Event (PasswordVault Component)

Informs about errors during cryptographic operations.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

Component fires this event if an error happens during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error that happened.

KeyNeeded Event (PasswordVault Component)

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

Syntax

type TKeyNeededEvent = procedure (
  Sender: TObject;
  var Cancel: Boolean
) of Object;

property OnKeyNeeded: TKeyNeededEvent read FOnKeyNeeded write FOnKeyNeeded;

Remarks

Component fires this event to request a vault encryption key from the application. Note that this is not the same as entry encryption key, which is requested by EntryKeyNeeded. The key requested by this event is used to encrypt or decrypt the whole vault.

The handler of this event should assign the password or key to be used to Password or Key property respectively. Set Cancel to true to abort the operation.

Notification Event (PasswordVault Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (PasswordVault Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PasswordVault Config Settings

Base Config Settings

Trappable Errors (PasswordVault Component)

PasswordVault Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component 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)