jose/docs/functions/util_generate_key_pair.generatekeypair.md

Function: generateKeyPair

util/generate_key_pair.generateKeyPair

▸ generateKeyPair(alg: string, options?: GenerateKeyPairOptions): Promise<{ privateKey: KeyLike ; publicKey: KeyLike }>

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.

example ESM import

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

example CJS import

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

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<{ privateKey: KeyLike ; publicKey: KeyLike }>

Defined in: util/generate_key_pair.ts:44