util_generate_key_pair.generateKeyPair.md

Function: generateKeyPair

util/generate_key_pair.generateKeyPair

▸ generateKeyPair(alg, options?): Promise<GenerateKeyPairResult>

Generates a private and a public key for a given JWA algorithm identifier. This can only generate asymmetric key pairs. For symmetric secrets use the generateSecret function.

Note: Under Web Cryptography API runtime the privateKey is generated with extractable set to false by default.

example ESM import

import { generateKeyPair } from 'jose/util/generate_key_pair'

example CJS import

const { generateKeyPair } = require('jose/util/generate_key_pair')

example Deno import

import { generateKeyPair } from 'https://deno.land/x/jose@v3.20.2/util/generate_key_pair.ts'

example Usage

const { publicKey, privateKey } = await generateKeyPair('PS256')
console.log(publicKey)
console.log(privateKey)

Parameters

Name	Type	Description
alg	string	JWA Algorithm Identifier to be used with the generated key pair.
options?	GenerateKeyPairOptions	Additional options passed down to the key pair generation.

Returns

Promise<GenerateKeyPairResult>