Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.35 KB

key_import.importPKCS8.md

File metadata and controls

45 lines (35 loc) · 1.35 KB
Raw

Function: importPKCS8

▸ importPKCS8(pkcs8, alg, options?): Promise<KeyLike>

Imports an PEM-encoded PKCS8 string as a runtime-specific private key representation (KeyObject or CryptoKey). See Algorithm Key Requirements to learn about key to algorithm requirements and mapping. Encrypted keys are not supported.

example Usage

const algorithm = 'ES256'
const pkcs8 = `-----BEGIN PRIVATE KEY-----
MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgiyvo0X+VQ0yIrOaN
nlrnUclopnvuuMfoc8HHly3505OhRANCAAQWUcdZ8uTSAsFuwtNy4KtsKqgeqYxg
l6kwL5D4N3pEGYGIDjV69Sw0zAt43480WqJv7HCL0mQnyqFmSrxj8jMa
-----END PRIVATE KEY-----`
const ecPrivateKey = await importPKCS8(pkcs8, algorithm)

example ESM import

import { importPKCS8 } from 'jose'

example CJS import

const { importPKCS8 } = require('jose')

example Deno import

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

Parameters

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

Returns

Promise<KeyLike>