mirror of
https://github.com/danbulant/jose
synced 2026-05-21 21:39:04 +00:00
dd2cf9ed2d
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.
38 lines
1,019 B
Markdown
38 lines
1,019 B
Markdown
# Interface: GenerateKeyPairOptions
|
|
|
|
## Table of contents
|
|
|
|
### Properties
|
|
|
|
- [crv](key_generate_key_pair.GenerateKeyPairOptions.md#crv)
|
|
- [extractable](key_generate_key_pair.GenerateKeyPairOptions.md#extractable)
|
|
- [modulusLength](key_generate_key_pair.GenerateKeyPairOptions.md#moduluslength)
|
|
|
|
## 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()](https://developer.mozilla.org/en-US/docs/Web/API/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.
|