Interface Jwk

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

interface Jwk {
    alg?: string;
    crv?: string;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    ext?: "true" | "false";
    k?: string;
    key_ops?: JwkOperation[];
    kid?: string;
    kty: JwkType;
    n?: string;
    oth?: {
        d: string;
        r: string;
        t: string;
    }[];
    p?: string;
    q?: string;
    qi?: string;
    use?: string;
    x?: string;
    x5c?: string;
    x5t?: string;
    x5t#S256?: string;
    x5u?: string;
    y?: string;
    [key: string]: unknown;
}

Indexable

[key: string]: unknown

Properties

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

Properties

Optional alg

alg?: string

JWK Algorithm Parameter. The algorithm intended for use with the key.

Optional crv

crv?: string

The cryptographic curve used with the key.

Optional d

d?: string

Private key component for EC, OKP, or RSA keys.

Optional dp

dp?: string

First factor's CRT exponent for RSA

Optional dq

dq?: string

Second factor's CRT exponent for RSA

Optional e

e?: string

Public exponent for RSA

Optional ext

ext?: "true" | "false"

JWK Extractable Parameter

Optional k

k?: string

The "k" (key value) parameter contains the value of the symmetric (or other single-valued) key.

Optional key_ops

key_ops?: JwkOperation[]

JWK Key Operations Parameter

Optional kid

kid?: string

JWK Key ID Parameter

kty

kty: JwkType

JWK Key Type Parameter

Optional n

n?: string

Modulus for RSA

Optional oth

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

Other primes information (optional in RFC 7518)

Type declaration

  • d: string

    Other primes' CRT exponent

  • r: string

    Other primes' factor

  • t: string

    Other primes' CRT coefficient

Optional p

p?: string

First prime factor for RSA

Optional q

q?: string

Second prime factor for RSA

Optional qi

qi?: string

First CRT coefficient for RSA

Optional use

use?: string

JWK Public Key Use Parameter

Optional x

x?: string

The x-coordinate for the Elliptic Curve point.

Optional x5c

x5c?: string

JWK X.509 Certificate Chain Parameter

Optional x5t

x5t?: string

JWK X.509 Certificate SHA-1 Thumbprint Parameter

Optional x5t#S256

x5t#S256?: string

JWK X.509 Certificate SHA-256 Thumbprint Parameter

Optional x5u

x5u?: string

JWK X.509 URL Parameter

Optional y

y?: string

The y-coordinate for the Elliptic Curve point.

Settings

Member Visibility

Theme

On This Page

algcrvddpdqeextkkey_opskidktynothpqqiusexx5cx5tx5t#S256x5uy