jose/docs/interfaces/util_generate_key_pair.GenerateKeyPairOptions.md
2021-08-20 22:40:04 +02:00

1.5 KiB

Interface: GenerateKeyPairOptions

util/generate_key_pair.GenerateKeyPairOptions

Table of contents

Properties

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.

Defined in

util/generate_key_pair.ts:22


extractable

Optional extractable: boolean

(Web Cryptography API specific) The value to use as SubtleCrypto.generateKey() extractable argument. Default is false.

Defined in

util/generate_key_pair.ts:35


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.

Defined in

util/generate_key_pair.ts:28