importJWK | /key/import.ts | jose@v4.14.4

function importJWK

import { importJWK } from "https://deno.land/x/jose@v4.14.4/key/import.ts";

importJWK<T extends KeyLike = KeyLike>(

jwk: JWK,

alg?: string,

octAsKeyObject?: boolean,

): Promise<T | Uint8Array>

Imports a JWK to a runtime-specific key representation (KeyLike). Either JWK "alg" (Algorithm) Parameter must be present or the optional "alg" argument. When running on a runtime using Web Cryptography API the jwk parameters "use", "key_ops", and "ext" are also used in the resulting CryptoKey.

Type Parameters

optional

T extends KeyLike = KeyLike

Parameters

jwk: JWK

JSON Web Key.

optional

alg: string

(Only effective in Web Crypto API runtimes) JSON Web Algorithm identifier to be used with the imported key. Default is the "alg" property on the JWK, its presence is only enforced in Web Crypto API runtimes. See Algorithm Key Requirements.

optional

octAsKeyObject: boolean

Forces a symmetric key to be imported to a KeyObject or CryptoKey. Default is true unless JWK "ext" (Extractable) is true.

Returns

Promise<T | Uint8Array>