Interface: UnlockedAccount
account.UnlockedAccount
Hierarchy
-
↳
UnlockedAccount
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[]
Inherited from
Account._propertySerializationOptions
Defined in
created
• created: Date
When the account was created
Inherited from
Defined in
• email: string = ""
The users email address
Inherited from
Defined in
encryptedData
• Optional encryptedData: Uint8Array
Encrypted data
Inherited from
Defined in
encryptionParams
• encryptionParams:
AESEncryptionParams
Parameters used for encryption of content data
Inherited from
Defined in
favorites
• favorites: Set<string>
Inherited from
Defined in
id
• id: string = ""
Unique account ID
Inherited from
Defined in
keyParams
• keyParams: PBKDF2Params
Parameters used for key derivation
Inherited from
Defined in
mainVault
• mainVault: Object
ID of the accounts main or "private" Vault.
Type declaration
| Name | Type |
|---|---|
id |
string |
name? |
string |
revision? |
string |
Inherited from
Defined in
name
• name: string = ""
The users display name
Inherited from
Defined in
orgs
• orgs: OrgInfo[] = []
All organizations this account is a member of
Inherited from
Defined in
privateKey
• privateKey: Uint8Array
The accounts private key
Overrides
Defined in
publicKey
• publicKey: Uint8Array
The accounts public key
Inherited from
Defined in
revision
• revision: string = ""
Revision id used for ensuring continuity when synchronizing the account object between client and server
Inherited from
Defined in
signingKey
• signingKey: Uint8Array
HMAC key used for signing and verifying organization details
IMPORTANT: This property is considered secret and should never stored or transmitted in plain text
Overrides
Defined in
updated
• updated: Date
when the account was last updated
Inherited from
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
Inherited from
Account.kind
Defined in
locked
• get locked(): boolean
Whether or not this Account object is current "locked" or, in other words,
whether the privateKey and signingKey properties have been decrypted.
Returns
boolean
Inherited from
Account.locked
Defined in
masterKey
• get masterKey(): undefined | Uint8Array
Returns
undefined | Uint8Array
Inherited from
Account.masterKey
Defined in
• set masterKey(key): void
Parameters
| Name | Type |
|---|---|
key |
undefined | Uint8Array |
Returns
void
Inherited from
Account.masterKey
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
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
Inherited from
Defined in
clone
▸ clone(): UnlockedAccount
Creates a deep clone of the object
Returns
Inherited from
Defined in
copySecrets
▸ copySecrets(account): void
Parameters
| Name | Type |
|---|---|
account |
Account |
Returns
void
Inherited from
Defined in
fromBytes
▸ fromBytes(bytes): UnlockedAccount
Deserializes the object from a byte array
Parameters
| Name | Type |
|---|---|
bytes |
Uint8Array |
Returns
Inherited from
Defined in
fromJSON
▸ fromJSON(json): UnlockedAccount
Deserializes the object from a JSON string
Parameters
| Name | Type |
|---|---|
json |
string |
Returns
Inherited from
Defined in
fromRaw
▸ fromRaw(raw): UnlockedAccount
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
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
initialize
▸ initialize(password): Promise<void>
Generates the accounts privateKey, publicKey and signingKey and encrypts privateKey and [[singingKey]] using the master password.
Parameters
| Name | Type |
|---|---|
password |
string |
Returns
Promise<void>
Inherited from
Defined in
lock
▸ lock(): void
"Locks" the account by deleting all sensitive data from the object
Returns
void
Inherited from
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
setPassword
▸ setPassword(password): Promise<void>
Updates the master password by reencrypting the privateKey and signingKey properties
Parameters
| Name | Type |
|---|---|
password |
string |
Returns
Promise<void>
Inherited from
Defined in
signOrg
▸ signOrg(__namedParameters): Promise<Uint8Array>
Creates a signature that can be used later to verify an organizations id and public key
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
__namedParameters.id |
string |
__namedParameters.publicKey |
Uint8Array |
Returns
Promise<Uint8Array>
Inherited from
Defined in
toBytes
▸ toBytes(): Uint8Array
Returns a serialization of the object in form of a byte array
Returns
Uint8Array
Inherited from
Defined in
toJSON
▸ toJSON(): string
Returns a JSON serialization of the object
Returns
string
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
Inherited from
Defined in
toString
▸ toString(): string
Returns
string
Inherited from
Defined in
toggleFavorite
▸ toggleFavorite(id, favorite): Promise<void>
Parameters
| Name | Type |
|---|---|
id |
string |
favorite |
boolean |
Returns
Promise<void>
Inherited from
Defined in
unlock
▸ unlock(password): Promise<void>
"Unlocks" the account by decrypting and extracting privateKey and signingKey from encryptedData
Parameters
| Name | Type |
|---|---|
password |
string |
Returns
Promise<void>
Inherited from
Defined in
unlockWithMasterKey
▸ unlockWithMasterKey(key): Promise<void>
Unlocks the account by providing the encryption key directly rather than deriving it fro the master password
Parameters
| Name | Type |
|---|---|
key |
Uint8Array |
Returns
Promise<void>
Inherited from
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
Inherited from
Defined in
verifyOrg
▸ verifyOrg(org): Promise<void>
Verifies an organizations id an public key, using the signature stored in the Member object associated with the account.
Parameters
| Name | Type |
|---|---|
org |
Org |
Returns
Promise<void>