Class ScryptParams

Static ReadonlyINDEX

salt

• get salt(): Salt

  Returns the salt.

  Returns Salt

logN

• get logN(): number

  Returns the log_n parameter.

  Returns number

r

• get r(): number

  Returns the r parameter (block size).

  Returns number

p

• get p(): number

  Returns the p parameter (parallelism).

  Returns number

Staticfrom

• from(
      __namedParameters?: {
          salt?: Salt;
          logN?: number;
          r?: number;
          p?: number;
      },
  ): ScryptParams

  Parameters with a fresh random salt unless one is given.

  Parameters

  • __namedParameters: { salt?: Salt; logN?: number; r?: number; p?: number } = {}

  Returns ScryptParams

index

• index(): number

  Returns the method index for CBOR encoding.

  Returns number

lock

• lock(contentKey: SymmetricKey, secret: Uint8Array): EncryptedMessage

  Derive a key from the secret and encrypt the content key.

  Parameters

  • contentKey: SymmetricKey
  • secret: Uint8Array

  Returns EncryptedMessage

unlock

• unlock(encryptedMessage: EncryptedMessage, secret: Uint8Array): SymmetricKey

  Derive a key from the secret and decrypt the content key.

  Parameters

  • encryptedMessage: EncryptedMessage
  • secret: Uint8Array

  Returns SymmetricKey

toString

• toString(): string

  Get string representation.

  Returns string

equals

• equals(other: ScryptParams): boolean

  Check equality with another ScryptParams.

  Parameters

  • other: ScryptParams

  Returns boolean

toCbor

• toCbor(): Cbor

  Convert to CBOR. Format: [2, Salt, log_n, r, p] (Salt is encoded as a tagged value — #6.40018(bytes))

  Returns Cbor

toCborData

• toCborData(): Uint8Array

  Convert to CBOR binary data.

  Returns Uint8Array

StaticfromCbor

• fromCbor(cborValue: Cbor): ScryptParams

  From the CBOR array, as the reference's TryFrom<CBOR> (a dcbor error): every failure is Cbor with the bare message. The index element is read as a usize (with dcbor's negative wrap) and its value ignored; the fixed-width fields wrap the same way.

  Parameters

  • cborValue: Cbor

  Returns ScryptParams