Class HkdfSha512

The HKDF-SHA512 for HPKE KDF implementing KdfInterface.

When using @hpke/core, the instance of this class must be specified to the kem parameter of CipherSuiteParams instead of KdfId.HkdfSha512.

The KDF class can only derive keys of the same length as the hashSize. If you want to derive keys longer than the hashSize, please use hpke-js#CipherSuite.

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP521HkdfSha512,
  HkdfSha512,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP521HkdfSha512(),
  kdf: new HkdfSha512(),
  aead: new Aes256Gcm(),
});

Hierarchy

HkdfSha512Native
- HkdfSha512

Index

Constructors

constructor

new HkdfSha512(): HkdfSha512
Returns HkdfSha512
Inherited from HkdfSha512Native.constructor
- Defined in ../common/src/kdfs/hkdf.ts:21

Properties

`Protected`_api

_api: SubtleCrypto = undefined

`Protected`_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

hashSize

hashSize: number = 64

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

Methods

`Protected`_checkInit

_checkInit(): void
Returns void
Inherited from HkdfSha512Native._checkInit
- Defined in ../common/src/kdfs/hkdf.ts:183

`Protected`_setup

_setup(): Promise<void>
Returns Promise<void>
Inherited from HkdfSha512Native._setup
- Defined in ../common/src/algorithm.ts:23

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.
Inherited from HkdfSha512Native.buildLabeledIkm
- Defined in ../common/src/kdfs/hkdf.ts:29

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.
Inherited from HkdfSha512Native.buildLabeledInfo
- Defined in ../common/src/kdfs/hkdf.ts:41

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.
Inherited from HkdfSha512Native.expand
- Defined in ../common/src/kdfs/hkdf.ts:83

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.
Inherited from HkdfSha512Native.extract
- Defined in ../common/src/kdfs/hkdf.ts:58

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.
Inherited from HkdfSha512Native.extractAndExpand
- Defined in ../common/src/kdfs/hkdf.ts:133

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
Inherited from HkdfSha512Native.init
- Defined in ../common/src/kdfs/hkdf.ts:25

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.
Inherited from HkdfSha512Native.labeledExpand
- Defined in ../common/src/kdfs/hkdf.ts:170

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.
Inherited from HkdfSha512Native.labeledExtract
- Defined in ../common/src/kdfs/hkdf.ts:159

Class HkdfSha512

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HkdfSha512

Properties

Protected_api

Protected_suiteId

algHash

hashSize

id

Methods

Protected_checkInit

Returns void

Protected_setup

Returns Promise<void>

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

`Protected`_api

`Protected`_suiteId

`Protected`_checkInit

`Protected`_setup