PasswordVault Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SecureBlackbox.PasswordVault

Remarks

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Description Property (PasswordVault Module)

The description of the vault.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

EntryKey Property (PasswordVault Module)

Provides an encryption key for the current entry.

Syntax

• Swift
• Objective-C

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

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

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

Remarks

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

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

EntryPassword Property (PasswordVault Module)

Provides an encryption password for the current entry.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

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

FIPSMode Property (PasswordVault Module)

Reserved.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

False

Remarks

This property is reserved for future use.

Key Property (PasswordVault Module)

Provides an encryption key for the vault.

Syntax

• Swift
• Objective-C

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

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

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

Remarks

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

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

Password Property (PasswordVault Module)

Provides an encryption password for the vault file.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

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

PlatformProtection Property (PasswordVault Module)

Enables platform-based protection of the master key.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

False

Remarks

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

Title Property (PasswordVault Module)

The title of the vault.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

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

AddEntry Method (PasswordVault Module)

Adds an entry to the vault.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

ChangeEntryKey Method (PasswordVault Module)

Changes the entry's encryption key.

Syntax

• Swift
• Objective-C

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

- (void)changeEntryKey:(NSString*)entryName :(NSData*)newKey;

Remarks

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

ChangeEntryPassword Method (PasswordVault Module)

Changes the entry's encryption password.

Syntax

• Swift
• Objective-C

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

- (void)changeEntryPassword:(NSString*)entryName :(NSString*)newPassword;

Remarks

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

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

Close Method (PasswordVault Module)

Closes the vault file.

Syntax

• Swift
• Objective-C

public func close() throws -> Void

- (void)close;

Remarks

Use this method to close the vault file.

Config Method (PasswordVault Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

CreateNew Method (PasswordVault Module)

Creates a new password vault.

Syntax

• Swift
• Objective-C

public func createNew() throws -> Void

- (void)createNew;

Remarks

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

DoAction Method (PasswordVault Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

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

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

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

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

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

GetEntryValue Method (PasswordVault Module)

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

Syntax

• Swift
• Objective-C

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

- (NSData*)getEntryValue:(NSString*)entryName :(NSString*)fieldName;

Remarks

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

GetEntryValueStr Method (PasswordVault Module)

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

Syntax

• Swift
• Objective-C

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

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

Remarks

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

ListEntries Method (PasswordVault Module)

Returns a list of entries stored in the vault.

Syntax

• Swift
• Objective-C

public func listEntries() throws -> String

- (NSString*)listEntries;

Remarks

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

ListFields Method (PasswordVault Module)

Returns a list of fields contained in the entry.

Syntax

• Swift
• Objective-C

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

- (NSString*)listFields:(NSString*)entryName :(BOOL)includeEncrypted;

Remarks

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

OpenBytes Method (PasswordVault Module)

Loads vault content from a byte array.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

OpenFile Method (PasswordVault Module)

Opens a vault file.

Syntax

• Swift
• Objective-C

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

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

Remarks

Use this method to open a vault file.

RemoveAllEntries Method (PasswordVault Module)

Removes all entries from a vault.

Syntax

• Swift
• Objective-C

public func removeAllEntries() throws -> Void

- (void)removeAllEntries;

Remarks

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

RemoveEntry Method (PasswordVault Module)

Removes an entry from the vault.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

RemoveField Method (PasswordVault Module)

Removes an entry field.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

Reset Method (PasswordVault Module)

Resets the component settings.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

SaveBytes Method (PasswordVault Module)

Saves the vault contents to a byte array.

Syntax

• Swift
• Objective-C

public func saveBytes() throws -> Data

- (NSData*)saveBytes;

Remarks

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

SaveFile Method (PasswordVault Module)

Saves the vault contents to a file.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

SetEntryValue Method (PasswordVault Module)

Assigns a value to an entry field.

Syntax

• Swift
• Objective-C

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

- (void)setEntryValue:(NSString*)entryName :(NSString*)fieldName :(NSData*)fieldValue :(BOOL)encrypted;

Remarks

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

SetEntryValueStr Method (PasswordVault Module)

Assigns a value to an entry field.

Syntax

• Swift
• Objective-C

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

- (void)setEntryValueStr:(NSString*)entryName :(NSString*)fieldName :(NSString*)fieldValueStr :(BOOL)encrypted;

Remarks

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

EntryKeyNeeded Event (PasswordVault Module)

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

Syntax

• Swift
• Objective-C

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

- (void)onEntryKeyNeeded:(NSString*)entryName :(int*)cancel;

Remarks

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

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

Error Event (PasswordVault Module)

Informs about errors during cryptographic operations.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

KeyNeeded Event (PasswordVault Module)

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

Syntax

• Swift
• Objective-C

func onKeyNeeded(cancel: inout Bool)

- (void)onKeyNeeded:(int*)cancel;

Remarks

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

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

Notification Event (PasswordVault Module)

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

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

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

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

Config Settings (PasswordVault Module)

PasswordVault Config Settings

Base Config Settings

Trappable Errors (PasswordVault Module)

PasswordVault Errors