JsonWebKey interface

  • Reference
Package:
@azure/keyvault-keys

As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Properties

crv

Elliptic curve name. For valid values, see KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'
d

RSA private exponent, or the D component of an EC private key.
dp

RSA private key parameter.
dq

RSA private key parameter.
e

RSA public exponent.
k

Symmetric key.
keyOps

Json web key operations. For more information on possible key operations, see KeyOperation.
kid

Key identifier.
kty

JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', "oct-HSM"
n

RSA modulus.
p

RSA secret prime.
q

RSA secret prime, with p < q.
qi

RSA private key parameter.
t

HSM Token, used with 'Bring Your Own Key'.
x

X component of an EC public key.
y

Y component of an EC public key.

Property Details

crv

Elliptic curve name. For valid values, see KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'

crv?: string

Property Value

string

d

RSA private exponent, or the D component of an EC private key.

d?: Uint8Array

Property Value

Uint8Array

dp

RSA private key parameter.

dp?: Uint8Array

Property Value

Uint8Array

dq

RSA private key parameter.

dq?: Uint8Array

Property Value

Uint8Array

e

RSA public exponent.

e?: Uint8Array

Property Value

Uint8Array

k

Symmetric key.

k?: Uint8Array

Property Value

Uint8Array

keyOps

Json web key operations. For more information on possible key operations, see KeyOperation.

keyOps?: string[]

Property Value

string[]

kid

Key identifier.

kid?: string

Property Value

string

kty

JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', "oct-HSM"

kty?: string

Property Value

string

n

RSA modulus.

n?: Uint8Array

Property Value

Uint8Array

p

RSA secret prime.

p?: Uint8Array

Property Value

Uint8Array

q

RSA secret prime, with p < q.

q?: Uint8Array

Property Value

Uint8Array

qi

RSA private key parameter.

qi?: Uint8Array

Property Value

Uint8Array

t

HSM Token, used with 'Bring Your Own Key'.

t?: Uint8Array

Property Value

Uint8Array

x

X component of an EC public key.

x?: Uint8Array

Property Value

Uint8Array

y

Y component of an EC public key.

y?: Uint8Array

Property Value

Uint8Array