Module io.inverno.mod.security.jose

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

Class GenericJWEHeader

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonJWEHeader

public class GenericJWEHeader
extends AbstractJOSEHeader<GenericJWEHeader>
implements JWEHeader, JWEHeaderConfigurator<GenericJWEHeader>

Generic JWE header implementation.

It processed the following parameters: enc, zip, alg, jku, jwk, kid, x5u, x5c, x5t, x5t#S256, typ, cty, crit

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
protected String	enc	The encryption algorithm parameter as defined by RFC7516 Section 4.1.2.
static final Set<String>	PROCESSED_PARAMETERS	The set of parameters processed in the JWE header.
protected String	zip	The compression algorithm parameter as defined by RFC7516 Section 4.1.3.

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
GenericJWEHeader()	Creates a generic JWE header.
GenericJWEHeader(String alg, String enc)	Creates a generic JWE header.

Method Summary

Modifier and Type	Method	Description
GenericJWEHeader	compressionAlgorithm(String zip)	Specifies the compression algorithm.
GenericJWEHeader	encryptionAlgorithm(String enc)	Specifies the encryption algorithm.
boolean	equals(Object obj)
String	getCompressionAlgorithm()	Returns the compression algorithm.
String	getEncryptionAlgorithm()	Returns the encryption algorithm.
Set<String>	getProcessedParameters()	Returns the parameters processed by the JOSE header.
byte[]	getRaw()	Returns the JSON serialized JWE header raw representation.
int	hashCode()
void	setEncoded(String encoded)	Sets the encoded header as Base64URL.
void	setExtraProcessedParameters(Set<String> extraParameters)	Adds extra processed parameters which usually coming from key management and encryption algorithms.
void	setRaw(byte[] raw)	Sets the JSON serialized JWE header raw representation.

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

addCustomParameter, algorithm, contentType, critical, getAlgorithm, getContentType, getCritical, getCustomParameters, getEncoded, getJWK, getJWKSetURL, getKey, getKeyId, getType, getX509CertificateChain, getX509CertificateSHA1Thumbprint, getX509CertificateSHA256Thumbprint, getX509CertificateURL, jwk, jwkSetURL, keyId, setKey, type, x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

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

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

addCustomParameter, algorithm, contentType, critical, jwk, jwkSetURL, keyId, type, x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

Field Details

PROCESSED_PARAMETERS

public static final Set<String> PROCESSED_PARAMETERS

The set of parameters processed in the JWE header.

enc

protected String enc

The encryption algorithm parameter as defined by RFC7516 Section 4.1.2.

zip

protected String zip

The compression algorithm parameter as defined by RFC7516 Section 4.1.3.

Constructor Details

GenericJWEHeader

public GenericJWEHeader()

Creates a generic JWE header.

GenericJWEHeader

public GenericJWEHeader(String alg,
 String enc)

Creates a generic JWE header.

Parameters:

alg - the key management JWA algorithm

enc - the encryption JWA algorithm

Method Details

setExtraProcessedParameters

public void setExtraProcessedParameters(Set<String> extraParameters)

Adds extra processed parameters which usually coming from key management and encryption algorithms.

Parameters:

extraParameters - a set of extra processed parameters

setEncoded

public void setEncoded(String encoded)

Description copied from class: AbstractJOSEHeader

Sets the encoded header as Base64URL.

Overrides:

setEncoded in class AbstractJOSEHeader<GenericJWEHeader>

Parameters:

encoded - the Base64URL encoded header

setRaw

public void setRaw(byte[] raw)

Sets the JSON serialized JWE header raw representation.

Parameters:

raw - the JSON serialized JWE header

getRaw

public byte[] getRaw()

Returns the JSON serialized JWE header raw representation.

Returns:

the JSON serialized JWE header

getProcessedParameters

public Set<String> getProcessedParameters()

Description copied from class: AbstractJOSEHeader

Returns the parameters processed by the JOSE header.

Overrides:

getProcessedParameters in class AbstractJOSEHeader<GenericJWEHeader>

Returns:

a set of processed parameters

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

Description copied from interface: JWEHeader

Returns the encryption algorithm.

.

Specified by:

getEncryptionAlgorithm in interface JWEHeader

Returns:

the encryption algorithm

getCompressionAlgorithm

public String getCompressionAlgorithm()

Description copied from interface: JWEHeader

Returns the compression algorithm.

Specified by:

getCompressionAlgorithm in interface JWEHeader

Returns:

the compression algorithm or null

encryptionAlgorithm

public GenericJWEHeader encryptionAlgorithm(String enc)

Description copied from interface: JWEHeaderConfigurator

Specifies the encryption algorithm.

Specified by:

encryptionAlgorithm in interface JWEHeaderConfigurator<GenericJWEHeader>

Parameters:

enc - the encryption algorithm

Returns:

the JWE JOSE header configurator

compressionAlgorithm

public GenericJWEHeader compressionAlgorithm(String zip)

Description copied from interface: JWEHeaderConfigurator

Specifies the compression algorithm.

Specified by:

compressionAlgorithm in interface JWEHeaderConfigurator<GenericJWEHeader>

Parameters:

zip - the compression algorithm

Returns:

the JWE JOSE header configurator

hashCode

public int hashCode()

Specified by:

hashCode in interface JOSEHeader

Specified by:

hashCode in interface JWEHeader

Overrides:

hashCode in class AbstractJOSEHeader<GenericJWEHeader>

equals

public boolean equals(Object obj)

Specified by:

equals in interface JOSEHeader

Specified by:

equals in interface JWEHeader

Overrides:

equals in class AbstractJOSEHeader<GenericJWEHeader>