Skip to main content

hkdf

function hkdf
Jump to headinghkdf(
digest: string,
salt: BinaryLike,
info: BinaryLike,
keylen: number,
callback: (
err: Error | null,
derivedKey: ArrayBuffer,
) => void,
): void

HKDF is a simple key derivation function defined in RFC 5869. The given ikm, salt and info are used with the digest to derive a key of keylen bytes.

The supplied callback function is called with two arguments: err and derivedKey. If an errors occurs while deriving the key, err will be set; otherwise err will be null. The successfully generated derivedKey will be passed to the callback as an ArrayBuffer. An error will be thrown if any of the input arguments specify invalid values or types.

import { Buffer } from 'node:buffer';
const {
  hkdf,
} = await import('node:crypto');

hkdf('sha512', 'key', 'salt', 'info', 64, (err, derivedKey) => {
  if (err) throw err;
  console.log(Buffer.from(derivedKey).toString('hex'));  // '24156e2...5391653'
});

Parameters Jump to heading

Jump to headingdigest: string

The digest algorithm to use.

The salt value. Must be provided but can be zero-length.

Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes.

Jump to headingkeylen: number

The length of the key to generate. Must be greater than 0. The maximum allowable value is 255 times the number of bytes produced by the selected digest function (e.g. sha512 generates 64-byte hashes, making the maximum HKDF output 16320 bytes).

Jump to headingcallback: (
err: Error | null,
derivedKey: ArrayBuffer,
) => void

Return Type Jump to heading

void
Back to top