types.JWK.md

Interface: JWK

💗 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.

---

JSON Web Key (JWK). "RSA", "EC", "OKP", and "oct" key types are supported.

See

• JWK_OKP_Public
• JWK_OKP_Private
• JWK_EC_Public
• JWK_EC_Private
• JWK_RSA_Public
• JWK_RSA_Private
• JWK_oct

Table of contents

Properties

• kty
• alg
• crv
• d
• dp
• dq
• e
• ext
• k
• key_ops
• kid
• n
• oth
• p
• q
• qi
• use
• x
• x5c
• x5t
• x5t#S256
• x5u
• y

Properties

kty

• kty: string

JWK "kty" (Key Type) Parameter

---

alg

• Optional alg: string

JWK "alg" (Algorithm) Parameter

See

Algorithm Key Requirements

---

crv

• Optional crv: string

• EC JWK "crv" (Curve) Parameter
• OKP JWK "crv" (The Subtype of Key Pair) Parameter

---

d

• Optional d: string

• Private RSA JWK "d" (Private Exponent) Parameter
• Private EC JWK "d" (ECC Private Key) Parameter
• Private OKP JWK "d" (The Private Key) Parameter

---

dp

• Optional dp: string

Private RSA JWK "dp" (First Factor CRT Exponent) Parameter

---

dq

• Optional dq: string

Private RSA JWK "dq" (Second Factor CRT Exponent) Parameter

---

e

• Optional e: string

RSA JWK "e" (Exponent) Parameter

---

ext

• Optional ext: boolean

JWK "ext" (Extractable) Parameter

---

k

• Optional k: string

Oct JWK "k" (Key Value) Parameter

---

key_ops

• Optional key_ops: string[]

JWK "key_ops" (Key Operations) Parameter

---

kid

• Optional kid: string

JWK "kid" (Key ID) Parameter

---

n

• Optional n: string

RSA JWK "n" (Modulus) Parameter

---

oth

• Optional oth: { d?: string ; r?: string ; t?: string }[]

Private RSA JWK "oth" (Other Primes Info) Parameter

This parameter is not supported

---

p

• Optional p: string

Private RSA JWK "p" (First Prime Factor) Parameter

---

q

• Optional q: string

Private RSA JWK "q" (Second Prime Factor) Parameter

---

qi

• Optional qi: string

Private RSA JWK "qi" (First CRT Coefficient) Parameter

---

use

• Optional use: string

JWK "use" (Public Key Use) Parameter

---

x

• Optional x: string

• EC JWK "x" (X Coordinate) Parameter
• OKP JWK "x" (The public key) Parameter

---

x5c

• Optional x5c: string[]

JWK "x5c" (X.509 Certificate Chain) Parameter

---

x5t

• Optional x5t: string

JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter

---

x5t#S256

• Optional x5t#S256: string

JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter

---

x5u

• Optional x5u: string

JWK "x5u" (X.509 URL) Parameter

---

y

• Optional y: string

EC JWK "y" (Y Coordinate) Parameter