jose/docs/interfaces/types.jwsheaderparameters.md
2021-05-14 11:49:42 +02:00

3.6 KiB

Interface: JWSHeaderParameters

types.JWSHeaderParameters

Recognized JWS Header Parameters, any other Header Members may also be present.

Hierarchy

Indexable

▪ [propName: string]: unknown

Any other JWS Header member.

Table of contents

Properties

Properties

alg

Optional alg: string

JWS "alg" (Algorithm) Header Parameter.

Defined in: types.d.ts:275


b64

Optional b64: boolean

This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing Input computation as per RFC7797.

Defined in: types.d.ts:282


crit

Optional crit: string[]

JWS "crit" (Critical) Header Parameter.

Defined in: types.d.ts:287


cty

Optional cty: string

"cty" (Content Type) Header Parameter.

Inherited from: JoseHeaderParameters.cty

Defined in: types.d.ts:264


jwk

Optional jwk: Pick<JWK, "kty" | "crv" | "x" | "y" | "e" | "n">

"jwk" (JSON Web Key) Header Parameter.

Inherited from: JoseHeaderParameters.jwk

Defined in: types.d.ts:254


kid

Optional kid: string

"kid" (Key ID) Header Parameter.

Inherited from: JoseHeaderParameters.kid

Defined in: types.d.ts:234


typ

Optional typ: string

"typ" (Type) Header Parameter.

Inherited from: JoseHeaderParameters.typ

Defined in: types.d.ts:259


x5c

Optional x5c: string[]

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

Inherited from: JoseHeaderParameters.x5c

Defined in: types.d.ts:244


x5t

Optional x5t: string

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

Inherited from: JoseHeaderParameters.x5t

Defined in: types.d.ts:239


x5u

Optional x5u: string

"x5u" (X.509 URL) Header Parameter.

Inherited from: JoseHeaderParameters.x5u

Defined in: types.d.ts:249