Module io.inverno.mod.security.jose

Package io.inverno.mod.security.jose.internal.jwe

Class JsonJWEHeader

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJOSEHeader<GenericJWEHeader>

io.inverno.mod.security.jose.internal.jwe.GenericJWEHeader

io.inverno.mod.security.jose.internal.jwe.JsonJWEHeader

All Implemented Interfaces:

JOSEHeader, JOSEHeaderConfigurator<GenericJWEHeader>, JWEHeader, JWEHeaderConfigurator<GenericJWEHeader>

public class JsonJWEHeader
extends GenericJWEHeader

A generic JWE header implementation used when building or reading JSON JWE objects.

This implementation has the following abilities:

• track the parameters set in the header to be able to easily determine whether two headers overlap
• merge a header into another

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields inherited from class io.inverno.mod.security.jose.internal.jwe.GenericJWEHeader

enc, PROCESSED_PARAMETERS, zip

Fields inherited from class io.inverno.mod.security.jose.internal.AbstractJOSEHeader

alg, crit, cty, customParameters, encoded, jku, jwk, key, kid, typ, x5c, x5t, x5t_S256, x5u

Constructor Summary

Constructors

Constructor	Description
JsonJWEHeader()	Creates a JSON JWE header.
JsonJWEHeader(String alg, String enc)	Creates a JSON JWE header.

Method Summary

Modifier and Type	Method	Description
JsonJWEHeader	addCustomParameter(String key, Object value)	Specifies a custom parameter to add to the header.
JsonJWEHeader	algorithm(String alg)	specifies the cryptographic algorithm to use to secure the JOSE object.
JsonJWEHeader	compressionAlgorithm(String zip)	Specifies the compression algorithm.
JsonJWEHeader	contentType(String cty)	Specifies the media type of the JOSE object payload.
JsonJWEHeader	critical(String... crit)	Specifies the set of custom parameters that must be understood and processed.
JsonJWEHeader	encryptionAlgorithm(String enc)	Specifies the encryption algorithm.
Set<String>	getParametersSet()	Returns the set of parameters sets in the JWE header.
JsonJWEHeader	jwk(Map<String,Object> jwk)	Specifies the JWK to use to secure the JOSE object.
JsonJWEHeader	jwkSetURL(URI jku)	Specifies the JWK Set URL that contains the key to use to secure the JOSE object.
JsonJWEHeader	keyId(String kid)	Specifies the id of the key to use to secure the JOSE object.
JsonJWEHeader	merge(JsonJWEHeader header)	Merges the specified header into this header.
JsonJWEHeader	type(String typ)	Specifies the media type of the complete JOSE object.
JsonJWEHeader	x509CertificateChain(String[] x5c)	Specifies the X.509 certificates chain that corresponds to the key to use to secure the JOSE object.
JsonJWEHeader	x509CertificateSHA1Thumbprint(String x5t)	Specifies the X.509 SHA1 thumbprint of the certificate that corresponds to the key to use to secure the JOSE object.
JsonJWEHeader	x509CertificateSHA256Thumbprint(String x5t_S256)	Specifies the X.509 SHA256 thumbprint of the certificate that corresponds to the key to use to secure the JOSE object.
JsonJWEHeader	x509CertificateURL(URI x5u)	Specifies the URL of the X.509 certificate or certificates chain that corresponds to the key to use to secure the JOSE object.

Methods inherited from class io.inverno.mod.security.jose.internal.jwe.GenericJWEHeader

equals, getCompressionAlgorithm, getEncryptionAlgorithm, getProcessedParameters, getRaw, hashCode, setEncoded, setExtraProcessedParameters, setRaw

Methods inherited from class io.inverno.mod.security.jose.internal.AbstractJOSEHeader

getAlgorithm, getContentType, getCritical, getCustomParameters, getEncoded, getJWK, getJWKSetURL, getKey, getKeyId, getType, getX509CertificateChain, getX509CertificateSHA1Thumbprint, getX509CertificateSHA256Thumbprint, getX509CertificateURL, setKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.security.jose.JOSEHeader

getAlgorithm, getContentType, getCritical, getCustomParameters, getEncoded, getJWK, getJWKSetURL, getKey, getKeyId, getType, getX509CertificateChain, getX509CertificateSHA1Thumbprint, getX509CertificateSHA256Thumbprint, getX509CertificateURL

Constructor Details

JsonJWEHeader

public JsonJWEHeader()

Creates a JSON JWE header.

JsonJWEHeader

public JsonJWEHeader(String alg,
 String enc)

Creates a JSON JWE header.

Parameters:

alg - a key management JWA algorithm

enc - an encryption JWA algorithm

Method Details

merge

public JsonJWEHeader merge(JsonJWEHeader header)

Merges the specified header into this header.

Parameters:

header - the JSON JWE header to merge

Returns:

this header after the merge

getParametersSet

public Set<String> getParametersSet()

Returns the set of parameters sets in the JWE header.

Returns:

a set of parameters

algorithm

public JsonJWEHeader algorithm(String alg)

Description copied from interface: JOSEHeaderConfigurator

specifies the cryptographic algorithm to use to secure the JOSE object.

Depending on the type of JOSE object to build, it might designate a signature or a key management algorithm.

Specified by:

algorithm in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

algorithm in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

alg - a JWA algorithm

Returns:

this builder

jwkSetURL

public JsonJWEHeader jwkSetURL(URI jku)

Description copied from interface: JOSEHeaderConfigurator

Specifies the JWK Set URL that contains the key to use to secure the JOSE object.

The URL must points to a set of JSON-encoded public keys.

Specified by:

jwkSetURL in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

jwkSetURL in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

jku - the JWK Set URL

Returns:

this builder

jwk

public JsonJWEHeader jwk(Map<String,Object> jwk)

Description copied from interface: JOSEHeaderConfigurator

Specifies the JWK to use to secure the JOSE object.

It is represented as a map to comply with the JOSE object definition, the builder eventually tries to resolve an actual JWK based on these parameters.

Specified by:

jwk in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

jwk in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

jwk - a JWK as a map

Returns:

this builder

keyId

public JsonJWEHeader keyId(String kid)

Description copied from interface: JOSEHeaderConfigurator

Specifies the id of the key to use to secure the JOSE object.

Specified by:

keyId in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

keyId in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

kid - a key id

Returns:

this builder

x509CertificateURL

public JsonJWEHeader x509CertificateURL(URI x5u)

Description copied from interface: JOSEHeaderConfigurator

Specifies the URL of the X.509 certificate or certificates chain that corresponds to the key to use to secure the JOSE object.

The certificates chain located at the URL must be in PEM format. The first certificate in the chain must correspond to the key to use to secure the JOSE object.

Specified by:

x509CertificateURL in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

x509CertificateURL in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

x5u - a URL

Returns:

this builder

x509CertificateChain

public JsonJWEHeader x509CertificateChain(String[] x5c)

Description copied from interface: JOSEHeaderConfigurator

Specifies the X.509 certificates chain that corresponds to the key to use to secure the JOSE object.

The certificates chain must be represented as an array of Base64URL encoded DER PKIX certificates. The first certificate in the chain must correspond to the key to use to secure the JOSE object.

Specified by:

x509CertificateChain in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

x509CertificateChain in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

x5c - a certificates chain

Returns:

this builder

x509CertificateSHA1Thumbprint

public JsonJWEHeader x509CertificateSHA1Thumbprint(String x5t)

Description copied from interface: JOSEHeaderConfigurator

Specifies the X.509 SHA1 thumbprint of the certificate that corresponds to the key to use to secure the JOSE object.

Specified by:

x509CertificateSHA1Thumbprint in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

x509CertificateSHA1Thumbprint in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

x5t - an X.509 SHA1 thumbprint

Returns:

this builder

x509CertificateSHA256Thumbprint

public JsonJWEHeader x509CertificateSHA256Thumbprint(String x5t_S256)

Description copied from interface: JOSEHeaderConfigurator

Specifies the X.509 SHA256 thumbprint of the certificate that corresponds to the key to use to secure the JOSE object.

Specified by:

x509CertificateSHA256Thumbprint in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

x509CertificateSHA256Thumbprint in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

x5t_S256 - an X.509 SHA256 thumbprint

Returns:

this builder

type

public JsonJWEHeader type(String typ)

Description copied from interface: JOSEHeaderConfigurator

Specifies the media type of the complete JOSE object.

To keep messages compact in common situations, the application/ prefix of a media type can be omitted when no other / appears in the value.

Specified by:

type in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

type in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

typ - a media type

Returns:

this builder

contentType

public JsonJWEHeader contentType(String cty)

Description copied from interface: JOSEHeaderConfigurator

Specifies the media type of the JOSE object payload.

To keep messages compact in common situations, the application/ prefix of a media type can be omitted when no other / appears in the value.

The builder might use this media type to determine how to serialize/deserialize a JOSE object payload.

Specified by:

contentType in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

contentType in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

cty - a media type

Returns:

this builder

critical

public JsonJWEHeader critical(String... crit)

Description copied from interface: JOSEHeaderConfigurator

Specifies the set of custom parameters that must be understood and processed.

Critical parameters can not be registered JOSE header parameters and they must be present in header's custom parameters.

Specified by:

critical in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

critical in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

crit - a set of custom parameters

Returns:

this builder

addCustomParameter

public JsonJWEHeader addCustomParameter(String key,
 Object value)

Description copied from interface: JOSEHeaderConfigurator

Specifies a custom parameter to add to the header.

Specified by:

addCustomParameter in interface JOSEHeaderConfigurator<GenericJWEHeader>

Overrides:

addCustomParameter in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

key - the custom parameter name

value - the custom parameter value

Returns:

this builder

encryptionAlgorithm

public JsonJWEHeader encryptionAlgorithm(String enc)

Description copied from interface: JWEHeaderConfigurator

Specifies the encryption algorithm.

Specified by:

encryptionAlgorithm in interface JWEHeaderConfigurator<GenericJWEHeader>

Overrides:

encryptionAlgorithm in class GenericJWEHeader

Parameters:

enc - the encryption algorithm

Returns:

the JWE JOSE header configurator

compressionAlgorithm

public JsonJWEHeader compressionAlgorithm(String zip)

Description copied from interface: JWEHeaderConfigurator

Specifies the compression algorithm.

Specified by:

compressionAlgorithm in interface JWEHeaderConfigurator<GenericJWEHeader>

Overrides:

compressionAlgorithm in class GenericJWEHeader

Parameters:

zip - the compression algorithm

Returns:

the JWE JOSE header configurator