Interface KdfInterface

The KDF interface.

interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(
        label: Uint8Array,
        info: Uint8Array,
        len: number,
    ): Uint8Array;
    expand(
        prk: ArrayBuffer,
        info: ArrayBuffer,
        len: number,
    ): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(
        salt: ArrayBuffer,
        ikm: ArrayBuffer,
        info: ArrayBuffer,
        len: number,
    ): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(
        prk: ArrayBuffer,
        label: Uint8Array,
        info: Uint8Array,
        len: number,
    ): Promise<ArrayBuffer>;
    labeledExtract(
        salt: ArrayBuffer,
        label: Uint8Array,
        ikm: Uint8Array,
    ): Promise<ArrayBuffer>;
}

Index

Properties

hashSize id

Methods

buildLabeledIkm buildLabeledInfo expand extract extractAndExpand init labeledExpand labeledExtract

Properties

`Readonly`hashSize

hashSize: number

The output size of the extract() function in bytes (Nh).

`Readonly`id

id: KdfId

The KDF identifier.

Methods

buildLabeledIkm

buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array
Builds a labeled input keying material.
Parameters
- label: Uint8Array
  A byte string indicating the cryptographic context/operation.
- ikm: Uint8Array
Returns Uint8Array
An input keying material as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:23

buildLabeledInfo

buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array
Builds a labeled info string.
Parameters
- label: Uint8Array
  A byte string indicating the cryptographic context/operation.
- info: Uint8Array
  An additional byte string.
- len: number
  The length of the output byte string.
Returns Uint8Array
An info string as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:32

expand

expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>
Expands a pseudorandom key prk.
Parameters
- prk: ArrayBuffer
  A pseudorandom key.
- info: ArrayBuffer
  An additional byte string.
- len: number
  The length in bytes of the output keying material.
Returns Promise<ArrayBuffer>
An output keying material as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:49

extract

extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>
Extracts a pseudorandom key of fixed length (Nh) bytes.
Parameters
- salt: ArrayBuffer
  An additional random byte string.
- ikm: ArrayBuffer
  An input keying material
Returns Promise<ArrayBuffer>
A pseudorandom key as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:40

extractAndExpand

extractAndExpand(
    salt: ArrayBuffer,
    ikm: ArrayBuffer,
    info: ArrayBuffer,
    len: number,
): Promise<ArrayBuffer>
Extracts a pseudorandom key and expand it to a specified length keying material.
Parameters
- salt: ArrayBuffer
  An additional random byte string.
- ikm: ArrayBuffer
  An input keying material
- info: ArrayBuffer
  An additional byte string.
- len: number
  The length in bytes of the output keying material.
Returns Promise<ArrayBuffer>
An output keying material as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:59

init

init(suiteId: Uint8Array): void
Initializes the instance by setting a suite_id defined in RFC9180.
Parameters
- suiteId: Uint8Array
  A suite_id defined in RFC9180.
Returns void
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:15

labeledExpand

labeledExpand(
    prk: ArrayBuffer,
    label: Uint8Array,
    info: Uint8Array,
    len: number,
): Promise<ArrayBuffer>
Extracts a pseudorandom key with label.
Parameters
- prk: ArrayBuffer
  A pseudorandom key.
- label: Uint8Array
  A byte string indicating the cryptographic context/operation.
- info: Uint8Array
  An additional byte string.
- len: number
  The length in bytes of the output keying material.
Returns Promise<ArrayBuffer>
An output keying material as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:78

labeledExtract

labeledExtract(
    salt: ArrayBuffer,
    label: Uint8Array,
    ikm: Uint8Array,
): Promise<ArrayBuffer>
Extracts a pseudorandom key with label.
Parameters
- salt: ArrayBuffer
  An additional random byte string.
- label: Uint8Array
  A byte string indicating the cryptographic context/operation.
- ikm: Uint8Array
  An input keying material
Returns Promise<ArrayBuffer>
A pseudorandom key as bytes.
- Defined in node_modules/@hpke/common/esm/src/interfaces/kdfInterface.d.ts:68

Interface KdfInterface

Index

Properties

Methods

Properties

`Readonly`hashSize

`Readonly`id

Methods

buildLabeledIkm

Parameters

Returns Uint8Array

buildLabeledInfo

Parameters

Returns Uint8Array

expand

Parameters

Returns Promise<ArrayBuffer>

extract

Parameters

Returns Promise<ArrayBuffer>

extractAndExpand

Parameters

Returns Promise<ArrayBuffer>

init

Parameters

Returns void

labeledExpand

Parameters

Returns Promise<ArrayBuffer>

labeledExtract

Parameters

Returns Promise<ArrayBuffer>

Settings

On This Page

Interface KdfInterface

Index

Properties

Methods

Properties

ReadonlyhashSize

Readonlyid

Methods

buildLabeledIkm

Parameters

Returns Uint8Array

buildLabeledInfo

Parameters

Returns Uint8Array

expand

Parameters

Returns Promise<ArrayBuffer>

extract

Parameters

Returns Promise<ArrayBuffer>

extractAndExpand

Parameters

Returns Promise<ArrayBuffer>

init

Parameters

Returns void

labeledExpand

Parameters

Returns Promise<ArrayBuffer>

labeledExtract

Parameters

Returns Promise<ArrayBuffer>

Settings

On This Page

`Readonly`hashSize

`Readonly`id