dan/jose
1
0
Fork 0
mirror of https://github.com/danbulant/jose synced 2026-05-19 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
jose/docs/interfaces/key_generate_key_pair.GenerateKeyPairOptions.md
Filip Skokan dd2cf9ed2d
refactor: redo exports to support broader tooling 
BREAKING CHANGE: All module named exports have moved from subpaths to
just "jose". For example, `import { jwtVerify } from 'jose/jwt/verify'`
is now just `import { jwtVerify } from 'jose'`.

BREAKING CHANGE: All submodule default exports and named have been
removed in favour of just "jose" named exports.
2021-10-14 14:08:05 +02:00

1,019 B
Raw Permalink Blame History

Interface: 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.

extractable

• Optional extractable: boolean

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

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.