jose/docs/functions/key_import.importSPKI.md
2021-10-15 09:14:45 +02:00

1.2 KiB

Function: importSPKI

importSPKI(spki, alg, options?): Promise<KeyLike>

Imports an PEM-encoded SPKI string as a runtime-specific public key representation (KeyObject or CryptoKey). See Algorithm Key Requirements to learn about key to algorithm requirements and mapping.

example Usage

const algorithm = 'ES256'
const spki = `-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEFlHHWfLk0gLBbsLTcuCrbCqoHqmM
YJepMC+Q+Dd6RBmBiA41evUsNMwLeN+PNFqib+xwi9JkJ8qhZkq8Y/IzGg==
-----END PUBLIC KEY-----`
const ecPublicKey = await importSPKI(spki, algorithm)

example ESM import

import { importSPKI } from 'jose'

example CJS import

const { importSPKI } = require('jose')

example Deno import

import { importSPKI } from 'https://deno.land/x/jose@v4.0.2/index.ts'

Parameters

Name Type Description
spki string -
alg string JSON Web Algorithm identifier to be used with the imported key.
options? PEMImportOptions -

Returns

Promise<KeyLike>