Interface: GenerateKeyPairOptions

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Asymmetric key pair generation function options.

Properties

crv?

• optional crv: string

The EC "crv" (Curve) or OKP "crv" (Subtype of Key Pair) value to generate. The curve must be both supported on the runtime as well as applicable for the given JWA algorithm identifier.

extractable?

• optional extractable: boolean

The value to use as SubtleCrypto.generateKey extractable argument. Default is false.

Example

const { publicKey, privateKey } = await jose.generateKeyPair('PS256', {
  extractable: true,
})
console.log(await jose.exportJWK(privateKey))
console.log(await jose.exportPKCS8(privateKey))

modulusLength?

• optional modulusLength: number

A hint for RSA algorithms to generate an RSA key of a given modulusLength (Key size in bits). JOSE requires 2048 bits or larger. Default is 2048.