@panva/hkdf v1.2.1

hkdf

HKDF with no dependencies using runtime's native crypto

HKDF is a simple key derivation function defined in RFC 5869.

Documentation

▸ hkdf(digest, ikm, salt, info, keylen): Promise<Uint8Array>

The given ikm, salt and info are used with the digest to derive a key of keylen bytes.

Parameters

Returns

Promise<Uint8Array>

Example

example ESM import

import hkdf from '@panva/hkdf'

example CJS import

const { hkdf } = require('@panva/hkdf')

example Deno import

import hkdf from 'https://deno.land/x/hkdf/index.ts'

example Usage

const derivedKey = await hkdf(
  'sha256',
  'key',
  'salt',
  'info',
  64
)

Supported Runtimes

The supported JavaScript runtimes include ones that

• are reasonably up to date ECMAScript
• support the utilized Web API globals and standard built-in objects
• These are
  • (This is not an exhaustive list)
  • Browsers
  • Cloudflare Workers
  • Deno
  • Electron
  • Netlify Edge Functions
  • Next.js Middlewares
  • Node.js
  • Vercel Edge Functions