Class LockedSeedCipherPwHash

Unlock a SeedCipher with a straightforward pwhashed passphrase.

Hierarchy (view full)

LockedSeedCipher
- LockedSeedCipherPwHash

Index

Constructors

Properties

cipher header memLimit opsLimit salt

Methods

finishUnlock unlock

Constructors

constructor

new LockedSeedCipherPwHash(finishUnlockCb, salt, memLimit, opsLimit, header, cipher): LockedSeedCipherPwHash
You won't use this directly, call UnlockedSeedBundle.fromLocked()
Parameters
- finishUnlockCb: ((secretSeed) => UnlockedSeedBundle)
  The callback to finish unlocking the seed.
  - - (secretSeed): UnlockedSeedBundle
    - Parameters
      secretSeed: PrivSecretBuf
      Returns UnlockedSeedBundle
- salt: Uint8Array
  The salt used for password hashing.
- memLimit: number
  The memory limit for password hashing.
- opsLimit: number
  The operation limit for password hashing.
- header: Uint8Array
  The header for the secret stream.
- cipher: Uint8Array
  The cipher text.
Returns LockedSeedCipherPwHash
Overrides LockedSeedCipher.constructor
- Defined in index.ts:400

Properties

`Private` cipher

cipher: Uint8Array

`Private` header

header: Uint8Array

`Private` memLimit

memLimit: number

`Private` opsLimit

opsLimit: number

`Private` salt

salt: Uint8Array

Methods

finishUnlock

finishUnlock(secretSeed): UnlockedSeedBundle
Once the secretSeed is decrypted, subclass instances will call this to generate the actual UnlockedSeedBundle instance.
Parameters
- secretSeed: PrivSecretBuf
  the secret seed to unlock.
Returns UnlockedSeedBundle
an instance of UnlockedSeedBundle.
Inherited from LockedSeedCipher.finishUnlock
- Defined in index.ts:233

unlock

unlock(passphrase): UnlockedSeedBundle
Unlock to an UnlockedSeedBundle.
Parameters
- passphrase: PrivSecretBuf
  The passphrase as a PrivSecretBuf.
Returns UnlockedSeedBundle
An instance of UnlockedSeedBundle.

Throws
Will throw an error if the passphrase is not an instance of PrivSecretBuf.
- Defined in index.ts:422