webcrypto.SubtleCrypto.importKey

method webcrypto.SubtleCrypto.importKey

Usage

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


        SubtleCrypto.importKey(format: "jwk"
keyData: JsonWebKey
algorithm:  | AlgorithmIdentifier
 | RsaHashedImportParams
 | EcKeyImportParams
 | HmacImportParams
 | AesKeyAlgorithm
extractable: boolean
keyUsages: readonly KeyUsage[]
): Promise<CryptoKey>

The subtle.importKey() method attempts to interpret the provided keyData as the given format to create a <CryptoKey> instance using the provided algorithm, extractable, and keyUsages arguments. If the import is successful, the returned promise will be resolved with the created <CryptoKey>.


        SubtleCrypto.importKey(format: Exclude<KeyFormat, "jwk">
keyData: BufferSource
algorithm:  | AlgorithmIdentifier
 | RsaHashedImportParams
 | EcKeyImportParams
 | HmacImportParams
 | AesKeyAlgorithm
extractable: boolean
keyUsages: KeyUsage[]
): Promise<CryptoKey>

If importing a 'PBKDF2' key, extractable must be false.

Parameters

format: "jwk"

Must be one of 'raw', 'pkcs8', 'spki', or 'jwk'.

keyData: JsonWebKey

algorithm:  | AlgorithmIdentifier
 | RsaHashedImportParams
 | EcKeyImportParams
 | HmacImportParams
 | AesKeyAlgorithm

extractable: boolean

keyUsages: readonly KeyUsage[]

See Key usages.

Return Type

Promise<CryptoKey>

Parameters

format: Exclude<KeyFormat, "jwk">

keyData: BufferSource

algorithm:  | AlgorithmIdentifier
 | RsaHashedImportParams
 | EcKeyImportParams
 | HmacImportParams
 | AesKeyAlgorithm

extractable: boolean

keyUsages: KeyUsage[]

Return Type

Promise<CryptoKey>