Package com.nimbusds.jose

Class HeaderParameterNames

java.lang.Object

com.nimbusds.jose.HeaderParameterNames

public final class HeaderParameterNames
extends Object

JSON Web Signature (JWS) and JSON Web Encryption (JWE) header parameter names.

The header parameter names defined in RFC 7515 (JWS), RFC 7516 (JWE) and other JOSE related standards are tracked in a JWS and JWE header parameters registry administered by IANA.

Note, some header parameters here may not be present in the IANA registry (yet).

Version:

2024-06-27

Author:

Nathaniel Hart, Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGREEMENT_PARTY_U_INFO	Used in JWEHeader with ECDH key agreement.
static final String	AGREEMENT_PARTY_V_INFO	Used in JWEHeader with ECDH key agreement.
static final String	ALGORITHM	Used in JWSHeader and JWEHeader.
static final String	AUDIENCE	Used in JWEHeader where the issuer claim is replicated as a header parameter.
static final String	AUTHENTICATION_TAG	Used in JWEHeader with AES GCN key encryption.
static final String	BASE64_URL_ENCODE_PAYLOAD	Used in JWSHeader with unencoded Payload.
static final String	COMPRESSION_ALGORITHM	Used in JWEHeader.
static final String	CONTENT_TYPE	Used in JWSHeader and JWEHeader.
static final String	CRITICAL	Used in JWSHeader and JWEHeader.
static final String	ENCRYPTION_ALGORITHM	Used in JWEHeader.
static final String	EPHEMERAL_PUBLIC_KEY	Used in JWEHeader with ECDH key agreement.
static final String	INITIALIZATION_VECTOR	Used in JWEHeader with AES GCN key encryption.
static final String	ISSUER	Used in JWEHeader where the issuer claim is replicated as a header parameter.
static final String	JWK	Used in JWSHeader and JWEHeader.
static final String	JWK_SET_URL	Used in JWSHeader and JWEHeader.
static final String	KEY_ID	Used in JWSHeader and JWEHeader.
static final String	PBES2_COUNT	Used in JWEHeader with PBES2 key encryption.
static final String	PBES2_SALT_INPUT	Used in JWEHeader with PBES2 key encryption.
static final String	SENDER_KEY_ID	Used in JWEHeader with ECDH-1PU key agreement.
static final String	SUBJECT	Used in JWEHeader where the issuer claim is replicated as a header parameter.
static final String	TYPE	Used in JWSHeader and JWEHeader.
static final String	X_509_CERT_CHAIN	Used in JWSHeader and JWEHeader.
static final String	X_509_CERT_SHA_1_THUMBPRINT	Used in JWSHeader and JWEHeader.
static final String	X_509_CERT_SHA_256_THUMBPRINT	Used in JWSHeader and JWEHeader.
static final String	X_509_CERT_URL	Used in JWSHeader and JWEHeader.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALGORITHM

public static final String ALGORITHM

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "alg" (JWS Algorithm) Header Parameter
• RFC 7516 "alg" (JWE Algorithm) Header Parameter
• Constant Field Values

ENCRYPTION_ALGORITHM

public static final String ENCRYPTION_ALGORITHM

Used in JWEHeader.

See Also:

• RFC 7516 "enc" (Encryption Algorithm) Header Parameter
• Constant Field Values

COMPRESSION_ALGORITHM

public static final String COMPRESSION_ALGORITHM

Used in JWEHeader.

See Also:

• RFC 7516 "zip" (Compression Algorithm) Header Parameter
• Constant Field Values

JWK_SET_URL

public static final String JWK_SET_URL

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "jku" (JWK Set URL) Header Parameter
• RFC 7516 "jku" (JWK Set URL) Header Parameter
• Constant Field Values

JWK

public static final String JWK

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "jwk" (JSON Web Key) Header Parameter
• RFC 7516 "jwk" (JSON Web Key) Header Parameter
• Constant Field Values

KEY_ID

public static final String KEY_ID

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "kid" (Key ID) Header Parameter
• RFC 7516 "kid" (Key ID) Header Parameter
• Constant Field Values

X_509_CERT_URL

public static final String X_509_CERT_URL

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "x5u" (X.509 Certificate URL) Header Parameter
• RFC 7516 "x5u" (X.509 Certificate URL) Header Parameter
• Constant Field Values

X_509_CERT_CHAIN

public static final String X_509_CERT_CHAIN

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "x5c" (X.509 Certificate Chain) Header Parameter
• RFC 7516 "x5c" (X.509 Certificate Chain) Header Parameter
• Constant Field Values

X_509_CERT_SHA_1_THUMBPRINT

public static final String X_509_CERT_SHA_1_THUMBPRINT

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter
• RFC 7516 "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter
• Constant Field Values

X_509_CERT_SHA_256_THUMBPRINT

public static final String X_509_CERT_SHA_256_THUMBPRINT

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Header Parameter
• RFC 7516 "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Header Parameter
• Constant Field Values

TYPE

public static final String TYPE

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "typ" (Type) Header Parameter
• RFC 7516 "typ" (Type) Header Parameter
• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "cty" (Content Type) Header Parameter
• RFC 7516 "cty" (Content Type) Header Parameter
• Constant Field Values

CRITICAL

public static final String CRITICAL

Used in JWSHeader and JWEHeader.

See Also:

• RFC 7515 "crit" (Critical) Header Parameter
• RFC 7516 "crit" (Critical) Header Parameter
• Constant Field Values

EPHEMERAL_PUBLIC_KEY

public static final String EPHEMERAL_PUBLIC_KEY

Used in JWEHeader with ECDH key agreement.

See Also:

• RFC 7518 "epk" (Ephemeral Public Key) Header Parameter
• Constant Field Values

AGREEMENT_PARTY_U_INFO

public static final String AGREEMENT_PARTY_U_INFO

Used in JWEHeader with ECDH key agreement.

See Also:

• RFC 7518 "apu" (Agreement PartyUInfo) Header Parameter
• Constant Field Values

AGREEMENT_PARTY_V_INFO

public static final String AGREEMENT_PARTY_V_INFO

Used in JWEHeader with ECDH key agreement.

See Also:

• RFC 7518 "apv" (Agreement PartyVInfo) Header Parameter
• Constant Field Values

INITIALIZATION_VECTOR

public static final String INITIALIZATION_VECTOR

Used in JWEHeader with AES GCN key encryption.

See Also:

• RFC 7518 "iv" (Initialization Vector) Header Parameter
• Constant Field Values

AUTHENTICATION_TAG

public static final String AUTHENTICATION_TAG

Used in JWEHeader with AES GCN key encryption.

See Also:

• RFC 7518 "tag" (Authentication Tag) Header Parameter
• Constant Field Values

PBES2_SALT_INPUT

public static final String PBES2_SALT_INPUT

Used in JWEHeader with PBES2 key encryption.

See Also:

• RFC 7518 "p2s" (PBES2 Salt Input) Header Parameter
• Constant Field Values

PBES2_COUNT

public static final String PBES2_COUNT

Used in JWEHeader with PBES2 key encryption.

See Also:

• RFC 7518 "p2c" (PBES2 Count) Header Parameter
• Constant Field Values

SENDER_KEY_ID

public static final String SENDER_KEY_ID

Used in JWEHeader with ECDH-1PU key agreement.

See Also:

• "skid" Header Parameter
• Constant Field Values

BASE64_URL_ENCODE_PAYLOAD

public static final String BASE64_URL_ENCODE_PAYLOAD

Used in JWSHeader with unencoded Payload.

See Also:

• RFC 7797 "b64" (base64url-encode payload) Header Parameter
• Constant Field Values

ISSUER

public static final String ISSUER

Used in JWEHeader where the issuer claim is replicated as a header parameter.

See Also:

• Constant Field Values

SUBJECT

public static final String SUBJECT

Used in JWEHeader where the issuer claim is replicated as a header parameter.

See Also:

• Constant Field Values

AUDIENCE

public static final String AUDIENCE

Used in JWEHeader where the issuer claim is replicated as a header parameter.

See Also:

• Constant Field Values