Class: PBES2Container

container.PBES2Container

Password-based Container that uses the PBES2 encryption scheme, deriving the encryption key from a user-provided passphrase.

Hierarchy

• BaseContainer

  ↳ PBES2Container

  ↳↳ Account

Constructors

constructor

• new PBES2Container()

Inherited from

BaseContainer.constructor

Properties

_key

• Protected Optional _key: Uint8Array

The key used for encryption. Sub classes must set this property in the unlock method.

Inherited from

BaseContainer._key

Defined in

core/src/container.ts:33

_propertySerializationOptions

• _propertySerializationOptions: SerializationOptions[]

Inherited from

BaseContainer._propertySerializationOptions

Defined in

core/src/encoding.ts:163

encryptedData

• Optional encryptedData: Uint8Array

Encrypted data

Inherited from

BaseContainer.encryptedData

Defined in

core/src/container.ts:28

encryptionParams

• encryptionParams: AESEncryptionParams

Parameters used for encryption of content data

Inherited from

BaseContainer.encryptionParams

Defined in

core/src/container.ts:24

keyParams

• keyParams: PBKDF2Params

Parameters used for key derivation

Defined in

core/src/container.ts:110

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

BaseContainer.kind

Defined in

core/src/encoding.ts:159

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

Returns

void

Inherited from

BaseContainer._fromRaw

Defined in

core/src/encoding.ts:286

_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

Returns

any

Inherited from

BaseContainer._toRaw

Defined in

core/src/encoding.ts:257

clone

▸ clone(): PBES2Container

Creates a deep clone of the object

Returns

PBES2Container

Inherited from

BaseContainer.clone

Defined in

core/src/container.ts:85

fromBytes

▸ fromBytes(bytes): PBES2Container

Deserializes the object from a byte array

Parameters

Returns

PBES2Container

Inherited from

BaseContainer.fromBytes

Defined in

core/src/encoding.ts:237

fromJSON

▸ fromJSON(json): PBES2Container

Deserializes the object from a JSON string

Parameters

Returns

PBES2Container

Inherited from

BaseContainer.fromJSON

Defined in

core/src/encoding.ts:223

fromRaw

▸ fromRaw(raw): PBES2Container

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

Returns

PBES2Container

Inherited from

BaseContainer.fromRaw

Defined in

core/src/encoding.ts:196

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

BaseContainer.getData

Defined in

core/src/container.ts:61

lock

▸ lock(): 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

void

Inherited from

BaseContainer.lock

Defined in

core/src/container.ts:81

setData

▸ setData(data): Promise<void>

Encrypts the provided data and stores it in the container

Parameters

Returns

Promise<void>

Inherited from

BaseContainer.setData

Defined in

core/src/container.ts:38

toBytes

▸ toBytes(): Uint8Array

Returns a serialization of the object in form of a byte array

Returns

Uint8Array

Inherited from

BaseContainer.toBytes

Defined in

core/src/encoding.ts:230

toJSON

▸ toJSON(): string

Returns a JSON serialization of the object

Returns

string

Inherited from

BaseContainer.toJSON

Defined in

core/src/encoding.ts:216

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

Returns

any

Inherited from

BaseContainer.toRaw

Defined in

core/src/encoding.ts:179

unlock

▸ unlock(password): Promise<void>

Unlocks the container using the given password

Parameters

Returns

Promise<void>

Overrides

BaseContainer.unlock

Defined in

core/src/container.ts:115

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

BaseContainer.validate

Defined in

core/src/encoding.ts:170