Class SeedCipherPwHash

SeedCipher locked by a password hash.

Hierarchy (view full)

SeedCipher
- SeedCipherPwHash

Index

Constructors

Properties

limitName? passphrase

Methods

encryptSeed zero

Constructors

constructor

new SeedCipherPwHash(passphrase, limitName?): SeedCipherPwHash
Build this with
Parameters
- passphrase: PrivSecretBuf
  the passphrase as a PrivSecretBuf.
- Optional limitName: string
  optional limit name (['interactive', 'moderate' default, 'sensitive']).
Returns SeedCipherPwHash
Throws
Will throw an error if the passphrase is not an instance of PrivSecretBuf.
Overrides SeedCipher.constructor
- Defined in index.ts:251

Properties

`Private` `Optional` limitName

limitName?: string

`Private` passphrase

passphrase: PrivSecretBuf

Methods

encryptSeed

encryptSeed(secretSeed): object
Encrypt a secretSeed SeedCipher with this instance.
Parameters
- secretSeed: PrivSecretBuf
  the secret seed to encrypt.
Returns object
the encrypted seed as an object.

Throws
Will throw an error if the secret seed is not an instance of PrivSecretBuf.
Overrides SeedCipher.encryptSeed
- Defined in index.ts:273

zero

zero(): void
Clear secret data.

Returns void
Overrides SeedCipher.zero
- Defined in index.ts:263