JsonWebKey Class

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

Inheritance

Model

JsonWebKey

Constructor

JsonWebKey(*, kid: Optional[str] = None, kty=None, key_ops=None, n: Optional[bytes] = None, e: Optional[bytes] = None, d: Optional[bytes] = None, dp: Optional[bytes] = None, dq: Optional[bytes] = None, qi: Optional[bytes] = None, p: Optional[bytes] = None, q: Optional[bytes] = None, k: Optional[bytes] = None, t: Optional[bytes] = None, crv=None, x: Optional[bytes] = None, y: Optional[bytes] = None, **kwargs)

Parameters

kid

str

Required

Key identifier.

kty

str or JsonWebKeyType

Required

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'

key_ops

list[str]

Required

n

bytes

Required

RSA modulus.

e

bytes

Required

RSA public exponent.

d

bytes

Required

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

dp

bytes

Required

RSA private key parameter.

dq

bytes

Required

RSA private key parameter.

qi

bytes

Required

RSA private key parameter.

p

bytes

Required

RSA secret prime.

q

bytes

Required

RSA secret prime, with p < q.

k

bytes

Required

Symmetric key.

t

bytes

Required

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

crv

str or JsonWebKeyCurveName

Required

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

x

bytes

Required

X component of an EC public key.

y

bytes

Required

Y component of an EC public key.