JSON Web Signature (JWS) Header Parameters

The Header Parameter names for use in JWSs are registered in the IANA "JSON Web Signature and Encryption Header Parameters" registry.

interface JwsHeaderParams {
    alg: string;
    crit?: string[];
    cty?: string;
    jku?: string;
    jwk?: Jwk;
    kid?: string;
    typ?: string;
    x5c?: string[];
    x5t?: string;
    x5u?: string;
    [key: string]: unknown;
}

Hierarchy (view full)

Indexable

[key: string]: unknown

Additional Public or Private Header Parameter names.

Properties

alg: string

Algorithm Header Parameter

Identifies the cryptographic algorithm used to secure the JWS. The JWS Signature value is not valid if the "alg" value does not represent a supported algorithm or if there is not a key for use with that algorithm associated with the party that digitally signed or MACed the content.

"alg" values should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry or be a value that contains a Collision-Resistant Name. The "alg" value is a case-sensitive ASCII string. This Header Parameter MUST be present and MUST be understood and processed by implementations.

crit?: string[]

Critical Header Parameter

Indicates that extensions to JOSE RFCs are being used that MUST be understood and processed.

cty?: string

Content Type Header Parameter

jku?: string

JWK Set URL Header Parameter

jwk?: Jwk

JSON Web Key Header Parameter

kid?: string

Key ID Header Parameter

typ?: string

Type Header Parameter

x5c?: string[]

X.509 Certificate Chain Header Parameter

x5t?: string

X.509 Certificate SHA-1 Thumbprint Header Parameter

x5u?: string

X.509 URL Header Parameter