Class: Vault
vault.Vault
Container for securely storing a collection of VaultItems. Vaults can be owned by a single user ("private" vaults) or shared between multiple users ("shared" vaults). Shared vaults are provisioned and managed through Orgs.
Hierarchy
-
↳
Vault
Implements
Constructors
constructor
• new Vault()
Inherited from
Properties
_key
• Protected Optional _key: Uint8Array
The key used for encryption. Sub classes must set this property in the unlock method.
Inherited from
Defined in
_propertySerializationOptions
• _propertySerializationOptions:
SerializationOptions[]
Implementation of
Storable._propertySerializationOptions
Inherited from
SharedContainer._propertySerializationOptions
Defined in
accessors
• accessors: Accessor[] = []
The ids and encrypted keys of all accessors
Inherited from
Defined in
created
• created: Date
Time of creation
Defined in
encryptedData
• Optional encryptedData: Uint8Array
Encrypted data
Inherited from
Defined in
encryptionParams
• encryptionParams: AESEncryptionParams
Parameters used for encryption of content data
Inherited from
SharedContainer.encryptionParams
Defined in
error
• Optional error: Err
Defined in
id
• id: string = ""
unique identifier
Implementation of
Storable.id
Defined in
items
• items: VaultItemCollection
A collection VaultItems representing the senstive data store in this vault
secret
IMPORTANT: This property is considered secret and should never stored or transmitted in plain text
Defined in
keyParams
• keyParams: RSAEncryptionParams
Parameters used to wrap the shared encryption key
Inherited from
Defined in
name
• name: string = ""
Vault name
Defined in
org
• Optional org: OrgInfo = undefined
The Org this vault belongs to (if a shared vault)
Defined in
owner
• owner: string = ""
The vault owner (the Account that created this vault)
Defined in
revision
• revision: string = ""
Revision id used for ensuring continuity when synchronizing the vault object between client and server
Defined in
updated
• updated: Date
Time of last update
Defined in
Accessors
kind
• get kind(): string
A string representing the objects "type", useful for segmenting storage, among other things. Defaults to the lowercase class name, but can be overwritten by subclasses
Returns
string
Implementation of
Storable.kind
Inherited from
SharedContainer.kind
Defined in
label
• get label(): string
Convenience getter for getting a display label truncated to a certain maximum length
Returns
string
Defined in
Methods
_fromRaw
▸ Protected _fromRaw(raw): void
Restore values from a raw object. The default implementation simply copies over all iterable properties from the base object. Overwrite this method for properties that require special treatment
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
void
Implementation of
Storable._fromRaw
Inherited from
Defined in
_toRaw
▸ Protected _toRaw(version): any
Transform this object into a raw javascript object used for serialization. The default implementation simply copies all iterable properties not included in the [[exlude]] array and calls toRaw on any properties that are themselfes instances of Serializable. This method should be overwritten by subclasses if certain properties require special treatment.
Parameters
| Name | Type |
|---|---|
version |
undefined | string |
Returns
any
Implementation of
Storable._toRaw
Inherited from
Defined in
clone
▸ clone(): Vault
Creates a deep clone of the object
Returns
Implementation of
Storable.clone
Overrides
Defined in
commit
▸ commit(): Promise<void>
Commit changes to items by reencrypting the data.
Returns
Promise<void>
Defined in
fromBytes
▸ fromBytes(bytes): Vault
Deserializes the object from a byte array
Parameters
| Name | Type |
|---|---|
bytes |
Uint8Array |
Returns
Implementation of
Storable.fromBytes
Inherited from
Defined in
fromJSON
▸ fromJSON(json): Vault
Deserializes the object from a JSON string
Parameters
| Name | Type |
|---|---|
json |
string |
Returns
Implementation of
Storable.fromJSON
Inherited from
Defined in
fromRaw
▸ fromRaw(raw): Vault
Restores propertiers from a raw object of the same form generated by
toRaw. The base implementation blindly copies over
values from the raw object via Object.assign so subclasses should explictly
process any propertyies that need special treatment.
Also takes are of validation and "upgrading" in case the raw object has an old version. Use the protected _fromRaw method to implement subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
Implementation of
Storable.fromRaw
Inherited from
Defined in
getData
▸ getData(): Promise<Uint8Array>
Decrypts and extracts the plain text data from the container. This will usually require unlocking the container first.
Returns
Promise<Uint8Array>
Inherited from
Defined in
lock
▸ lock(): Promise<void>
Locks the container, removing the possibility to extract the plain text data via getData until the container is unlocked again. Subclasses extending this class must take care to delete any keys or other sensitive data that may have been stored temporarily after unlocking the container.
Returns
Promise<void>
Overrides
Defined in
merge
▸ merge(vault): void
Merges in changes from another vault. This requires both vaults to be
unlocked.
Parameters
| Name | Type |
|---|---|
vault |
Vault |
Returns
void
Defined in
setData
▸ setData(data): Promise<void>
Encrypts the provided data and stores it in the container
Parameters
| Name | Type |
|---|---|
data |
Uint8Array |
Returns
Promise<void>
Inherited from
Defined in
toBytes
▸ toBytes(): Uint8Array
Returns a serialization of the object in form of a byte array
Returns
Uint8Array
Implementation of
Storable.toBytes
Inherited from
Defined in
toJSON
▸ toJSON(): string
Returns a JSON serialization of the object
Returns
string
Implementation of
Storable.toJSON
Inherited from
Defined in
toRaw
▸ toRaw(version?): any
Creates a raw javascript object representation of the class, which can be used for storage or data transmission. Also handles "downgrading" to previous versions. Use _toRaw for subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
version? |
string |
Returns
any
Implementation of
Storable.toRaw
Inherited from
Defined in
toString
▸ toString(): string
Returns
string
Defined in
unlock
▸ unlock(account): Promise<void>
Unlocks the vault with the given account, decrypting the data stored in the
vault and populating the items property. For this to be
successful, the account object needs to be unlocked and the account must have
access to this vault.
Parameters
| Name | Type |
|---|---|
account |
UnlockedAccount |
Returns
Promise<void>
Overrides
Defined in
updateAccessors
▸ updateAccessors(subjects): Promise<void>
Updates the containers accessors, generating a new shared key and encrypting it with the public keys of the provided subjects. Non-empty containers need to be unlocked first.
Parameters
| Name | Type |
|---|---|
subjects |
{ id: string ; publicKey: Uint8Array }[] |
Returns
Promise<void>
Inherited from
SharedContainer.updateAccessors
Defined in
validate
▸ validate(): boolean
This is called during deserialization and should verify that all properties have been populated with values of the correct type. Subclasses should implement this method based on their class structure.
Returns
boolean
Implementation of
Storable.validate