com.nimbusds.jose.HeaderParameterNames Maven / Gradle / Ivy

Go to download
package com.nimbusds.jose;


/**
 * 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.
 *
 * @author Nathaniel Hart
 * @version 2021-07-11
 */
public final class HeaderParameterNames {
	
	
	////////////////////////////////////////////////////////////////////////////////
	// Generic JWS and JWE Header Parameters
	////////////////////////////////////////////////////////////////////////////////
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "alg" (JWS Algorithm) Header Parameter
	 * @see RFC 7516 "alg" (JWE Algorithm) Header Parameter
	 */
	public static final String ALGORITHM = "alg";
	
	
	/**
	 * Used in {@link JWEHeader}.
	 *
	 * @see RFC 7516 "enc" (Encryption Algorithm) Header Parameter
	 */
	public static final String ENCRYPTION_ALGORITHM = "enc";
	
	
	/**
	 * Used in {@link JWEHeader}.
	 *
	 * @see RFC 7516 "zip" (Compression Algorithm) Header Parameter
	 */
	public static final String COMPRESSION_ALGORITHM = "zip";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "jku" (JWK Set URL) Header Parameter
	 * @see RFC 7516 "jku" (JWK Set URL) Header Parameter
	 */
	public static final String JWK_SET_URL = "jku";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "jwk" (JSON Web Key) Header Parameter
	 * @see RFC 7516 "jwk" (JSON Web Key) Header Parameter
	 */
	public static final String JWK = "jwk";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "kid" (Key ID) Header Parameter
	 * @see RFC 7516 "kid" (Key ID) Header Parameter
	 */
	public static final String KEY_ID = "kid";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "x5u" (X.509 Certificate URL) Header Parameter
	 * @see RFC 7516 "x5u" (X.509 Certificate URL) Header Parameter
	 */
	public static final String X_509_CERT_URL = "x5u";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "x5c" (X.509 Certificate Chain) Header Parameter
	 * @see RFC 7516 "x5c" (X.509 Certificate Chain) Header Parameter
	 */
	public static final String X_509_CERT_CHAIN = "x5c";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter
	 * @see RFC 7516 "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter
	 */
	public static final String X_509_CERT_SHA_1_THUMBPRINT = "x5t";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Header Parameter
	 * @see RFC 7516 "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Header Parameter
	 */
	public static final String X_509_CERT_SHA_256_THUMBPRINT = "x5t#S256";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "typ" (Type) Header Parameter
	 * @see RFC 7516 "typ" (Type) Header Parameter
	 */
	public static final String TYPE = "typ";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "cty" (Content Type) Header Parameter
	 * @see RFC 7516 "cty" (Content Type) Header Parameter
	 */
	public static final String CONTENT_TYPE = "cty";
	
	
	/**
	 * Used in {@link JWSHeader} and {@link JWEHeader}.
	 *
	 * @see RFC 7515 "crit" (Critical) Header Parameter
	 * @see RFC 7516 "crit" (Critical) Header Parameter
	 */
	public static final String CRITICAL = "crit";
	
	
	////////////////////////////////////////////////////////////////////////////////
	// Algorithm-Specific Header Parameters
	////////////////////////////////////////////////////////////////////////////////
	
	
	/**
	 * Used in {@link JWEHeader} with ECDH key agreement.
	 *
	 * @see RFC 7518 "epk" (Ephemeral Public Key) Header Parameter
	 */
	public static final String EPHEMERAL_PUBLIC_KEY = "epk";
	
	
	/**
	 * Used in {@link JWEHeader} with ECDH key agreement.
	 *
	 * @see RFC 7518 "apu" (Agreement PartyUInfo) Header Parameter
	 */
	public static final String AGREEMENT_PARTY_U_INFO = "apu";
	
	
	/**
	 * Used in {@link JWEHeader} with ECDH key agreement.
	 *
	 * @see RFC 7518 "apv" (Agreement PartyVInfo) Header Parameter
	 */
	public static final String AGREEMENT_PARTY_V_INFO = "apv";
	
	
	/**
	 * Used in {@link JWEHeader} with AES GCN key encryption.
	 *
	 * @see RFC 7518 "iv" (Initialization Vector) Header Parameter
	 */
	public static final String INITIALIZATION_VECTOR = "iv";
	
	
	/**
	 * Used in {@link JWEHeader} with AES GCN key encryption.
	 *
	 * @see RFC 7518 "tag" (Authentication Tag) Header Parameter
	 */
	public static final String AUTHENTICATION_TAG = "tag";
	
	
	/**
	 * Used in {@link JWEHeader} with PBES2 key encryption.
	 *
	 * @see RFC 7518 "p2s" (PBES2 Salt Input) Header Parameter
	 */
	public static final String PBES2_SALT_INPUT = "p2s";
	
	
	/**
	 * Used in {@link JWEHeader} with PBES2 key encryption.
	 *
	 * @see RFC 7518 "p2c" (PBES2 Count) Header Parameter
	 */
	public static final String PBES2_COUNT = "p2c";
	
	
	////////////////////////////////////////////////////////////////////////////////
	// RFC 7797 (JWS Unencoded Payload Option) Header Parameters
	////////////////////////////////////////////////////////////////////////////////
	
	
	/**
	 * Used in {@link JWSHeader} with unencoded {@link Payload}.
	 *
	 * @see RFC 7797 "b64" (base64url-encode payload) Header Parameter
	 */
	public static final String BASE64_URL_ENCODE_PAYLOAD = "b64";
	
	
	private HeaderParameterNames() {}
}