webcrypto.SubtleCrypto.deriveKey - crypto - Node

webcrypto.SubtleCrypto.deriveKey - crypto - Node documentation

method webcrypto.SubtleCrypto.deriveKey

Usage in Deno

import { type webcrypto } from "node:crypto";



SubtleCrypto.deriveKey(algorithm: AlgorithmIdentifier
 | EcdhKeyDeriveParams
 | HkdfParams
 | Pbkdf2Params,
baseKey: CryptoKey,
derivedKeyAlgorithm: AlgorithmIdentifier
 | AesDerivedKeyParams
 | HmacImportParams
 | HkdfParams
 | Pbkdf2Params,
extractable: boolean,
keyUsages: readonly KeyUsage[],
): Promise<CryptoKey>

Using the method and parameters specified in algorithm, and the keying material provided by baseKey, subtle.deriveKey() attempts to generate a new based on the method and parameters inderivedKeyAlgorithm`.

Calling subtle.deriveKey() is equivalent to calling subtle.deriveBits() to generate raw keying material, then passing the result into the subtle.importKey() method using the deriveKeyAlgorithm, extractable, and keyUsages parameters as input.

The algorithms currently supported include:

'ECDH'
'X25519'
'X448'
'HKDF'
'PBKDF2'

Parameters



algorithm: AlgorithmIdentifier
 | EcdhKeyDeriveParams
 | HkdfParams
 | Pbkdf2Params



baseKey: CryptoKey



derivedKeyAlgorithm: AlgorithmIdentifier
 | AesDerivedKeyParams
 | HmacImportParams
 | HkdfParams
 | Pbkdf2Params



extractable: boolean



keyUsages: readonly KeyUsage[]

See Key usages.

Return Type

Promise<CryptoKey>