com.nimbusds.jose

Class JWEHeader

java.lang.Object

com.nimbusds.jose.Header

com.nimbusds.jose.JWEHeader

All Implemented Interfaces:

ReadOnlyHeader, ReadOnlyJWEHeader

public class JWEHeader
extends Header
implements ReadOnlyJWEHeader

JSON Web Encryption (JWE) header.

Supports all registered header parameters of the JWE specification:

• alg
• enc
• epk
• zip
• jku
• jwk
• x5u
• x5t
• x5c
• kid
• typ
• cty
• crit
• apu
• apv
• p2s
• p2c

The header may also carry custom parameters; these will be serialised and parsed along the registered ones.

Example header:

 { 
   "alg" : "RSA1_5",
   "enc" : "A128CBC-HS256"
 }
 

Version:

$version$ (2013-10-07)

Author:

Vladimir Dzhuvinov

Field Summary

Fields inherited from class com.nimbusds.jose.Header

alg

Constructor Summary

Constructors

Constructor and Description
JWEHeader(JWEAlgorithm alg, EncryptionMethod enc) Creates a new JSON Web Encryption (JWE) header.

Method Summary

Methods

Modifier and Type	Method and Description
Base64URL	getAgreementPartyUInfo() Gets the agreement PartyUInfo (apu) parameter.
Base64URL	getAgreementPartyVInfo() Gets the agreement PartyVInfo (apv) parameter.
JWEAlgorithm	getAlgorithm() Gets the algorithm (alg) parameter.
CompressionAlgorithm	getCompressionAlgorithm() Gets the compression algorithm (zip) parameter.
EncryptionMethod	getEncryptionMethod() Gets the encryption method (enc) parameter.
ECKey	getEphemeralPublicKey() Gets the Ephemeral Public Key (epk) parameter.
Set<String>	getIncludedParameters() Gets the names of all included parameters (registered and custom) in the header instance.
JWK	getJWK() Gets the JSON Web Key (JWK) (jwk) parameter.
JWK	getJWK() Gets the JSON Web Key (JWK) (jwk) parameter.
URL	getJWKURL() Gets the JSON Web Key (JWK) Set URL (jku) parameter.
URL	getJWKURL() Gets the JSON Web Key (JWK) Set URL (jku) parameter.
String	getKeyID() Gets the key ID (kid) parameter.
String	getKeyID() Gets the key ID (kid) parameter.
int	getPBES2Count() Gets the PBES2 count (p2c) parameter.
Base64URL	getPBES2Salt() Gets the PBES2 salt (p2s) parameter.
static Set<String>	getRegisteredParameterNames() Gets the registered parameter names for JWE headers.
List<Base64>	getX509CertChain() Gets the X.509 certificate chain (x5c) parameter corresponding to the key used to sign or encrypt the JWS / JWE object.
List<Base64>	getX509CertChain() Gets the X.509 certificate chain (x5c) parameter corresponding to the key used to sign or encrypt the JWS / JWE object.
Base64URL	getX509CertThumbprint() Gets the X.509 certificate thumbprint (x5t) parameter.
Base64URL	getX509CertThumbprint() Gets the X.509 certificate thumbprint (x5t) parameter.
URL	getX509CertURL() Gets the X.509 certificate URL (x5u) parameter.
URL	getX509CertURL() Gets the X.509 certificate URL (x5u) parameter.
static JWEHeader	parse(Base64URL base64URL) Parses a JWE header from the specified Base64URL.
static JWEHeader	parse(net.minidev.json.JSONObject json) Parses a JWE header from the specified JSON object.
static JWEHeader	parse(String s) Parses a JWE header from the specified JSON object string.
void	setAgreementPartyUInfo(Base64URL apu) Sets the agreement PartyUInfo (apu) parameter.
void	setAgreementPartyVInfo(Base64URL apv) Sets the agreement PartyVInfo (apv) parameter.
void	setCompressionAlgorithm(CompressionAlgorithm zip) Sets the compression algorithm (zip) parameter.
void	setCustomParameter(String name, Object value) Sets a custom (non-registered) parameter.
void	setEphemeralPublicKey(ECKey epk) Sets the Ephemeral Public Key (epk) parameter.
void	setJWK(JWK jwk) Sets the JSON Web Key (JWK) (jwk) parameter.
void	setJWKURL(URL jku) Sets the JSON Web Key (JWK) Set URL (jku) parameter.
void	setKeyID(String kid) Sets the key ID (kid) parameter.
void	setPBES2Count(int p2c) Sets the PBES2 count (p2c) parameter.
void	setPBES2Salt(Base64URL p2s) Sets the PBES2 salt (p2s) parameter.
void	setX509CertChain(List<Base64> x5c) Sets the X.509 certificate chain parameter (x5c) corresponding to the key used to sign or encrypt the JWS / JWE object.
void	setX509CertThumbprint(Base64URL x5t) Sets the X.509 certificate thumbprint (x5t) parameter.
void	setX509CertURL(URL x5u) Sets the X.509 certificate URL (x5u) parameter.
net.minidev.json.JSONObject	toJSONObject() Returns a JSON object representation of the header.

Methods inherited from class com.nimbusds.jose.Header

getContentType, getCriticalHeaders, getCustomParameter, getCustomParameters, getType, parseAlgorithm, setContentType, setCriticalHeaders, setCustomParameters, setParsedBase64URL, setType, toBase64URL, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nimbusds.jose.ReadOnlyHeader

getContentType, getCriticalHeaders, getCustomParameter, getCustomParameters, getType, toBase64URL, toString

Constructor Detail

JWEHeader

public JWEHeader(JWEAlgorithm alg,
         EncryptionMethod enc)

Creates a new JSON Web Encryption (JWE) header.

Note: Use PlainHeader to create a header with algorithm none.

Parameters:

alg - The JWE algorithm parameter. Must not be "none" or null.

enc - The encryption method parameter. Must not be null.

Method Detail

getRegisteredParameterNames

public static Set<String> getRegisteredParameterNames()

Gets the registered parameter names for JWE headers.

Returns:

The registered parameter names, as an unmodifiable set.

getAlgorithm

public JWEAlgorithm getAlgorithm()

Description copied from interface: ReadOnlyJWEHeader

Gets the algorithm (alg) parameter.

Specified by:

getAlgorithm in interface ReadOnlyHeader

Specified by:

getAlgorithm in interface ReadOnlyJWEHeader

Returns:

The algorithm parameter.

getEncryptionMethod

public EncryptionMethod getEncryptionMethod()

Description copied from interface: ReadOnlyJWEHeader

Gets the encryption method (enc) parameter.

Specified by:

getEncryptionMethod in interface ReadOnlyJWEHeader

Returns:

The encryption method parameter.

getEphemeralPublicKey

public ECKey getEphemeralPublicKey()

Description copied from interface: ReadOnlyJWEHeader

Gets the Ephemeral Public Key (epk) parameter.

Specified by:

getEphemeralPublicKey in interface ReadOnlyJWEHeader

Returns:

The Ephemeral Public Key parameter, null if not specified.

setEphemeralPublicKey

public void setEphemeralPublicKey(ECKey epk)

Sets the Ephemeral Public Key (epk) parameter.

Parameters:

epk - The Ephemeral Public Key parameter, null if not specified.

getCompressionAlgorithm

public CompressionAlgorithm getCompressionAlgorithm()

Description copied from interface: ReadOnlyJWEHeader

Gets the compression algorithm (zip) parameter.

Specified by:

getCompressionAlgorithm in interface ReadOnlyJWEHeader

Returns:

The compression algorithm parameter, null if not specified.

setCompressionAlgorithm

public void setCompressionAlgorithm(CompressionAlgorithm zip)

Sets the compression algorithm (zip) parameter.

Parameters:

zip - The compression algorithm parameter, null if not specified.

getAgreementPartyUInfo

public Base64URL getAgreementPartyUInfo()

Description copied from interface: ReadOnlyJWEHeader

Gets the agreement PartyUInfo (apu) parameter.

Specified by:

getAgreementPartyUInfo in interface ReadOnlyJWEHeader

Returns:

The agreement PartyUInfo parameter, null if not specified.

setAgreementPartyUInfo

public void setAgreementPartyUInfo(Base64URL apu)

Sets the agreement PartyUInfo (apu) parameter.

Parameters:

apu - The agreement PartyUInfo parameter, null if not specified.

getAgreementPartyVInfo

public Base64URL getAgreementPartyVInfo()

Description copied from interface: ReadOnlyJWEHeader

Gets the agreement PartyVInfo (apv) parameter.

Specified by:

getAgreementPartyVInfo in interface ReadOnlyJWEHeader

Returns:

The agreement PartyVInfo parameter, null if not specified.

setAgreementPartyVInfo

public void setAgreementPartyVInfo(Base64URL apv)

Sets the agreement PartyVInfo (apv) parameter.

Parameters:

apv - The agreement PartyVInfo parameter, null if not specified.

getPBES2Salt

public Base64URL getPBES2Salt()

Description copied from interface: ReadOnlyJWEHeader

Gets the PBES2 salt (p2s) parameter.

Specified by:

getPBES2Salt in interface ReadOnlyJWEHeader

Returns:

The PBES2 salt parameter, null if not specified.

setPBES2Salt

public void setPBES2Salt(Base64URL p2s)

Sets the PBES2 salt (p2s) parameter.

Parameters:

p2s - The PBES2 salt parameter, null if not specified.

getPBES2Count

public int getPBES2Count()

Description copied from interface: ReadOnlyJWEHeader

Gets the PBES2 count (p2c) parameter.

Specified by:

getPBES2Count in interface ReadOnlyJWEHeader

Returns:

The PBES2 count parameter, zero if not specified.

setPBES2Count

public void setPBES2Count(int p2c)

Sets the PBES2 count (p2c) parameter.

Parameters:

p2c - The PBES2 count parameter, zero if not specified. Must not be negative.

setCustomParameter

public void setCustomParameter(String name,
                      Object value)

Description copied from class: Header

Sets a custom (non-registered) parameter. Callers and extending classes should ensure the parameter name doesn't match a registered parameter name.

Overrides:

setCustomParameter in class Header

Parameters:

name - The name of the custom parameter. Must not match a registered parameter name and must not be null.

value - The value of the custom parameter, should map to a valid JSON entity, null if not specified.

Throws:

IllegalArgumentException - If the specified parameter name matches a registered parameter name.

getIncludedParameters

public Set<String> getIncludedParameters()

Description copied from interface: ReadOnlyHeader

Gets the names of all included parameters (registered and custom) in the header instance.

Specified by:

getIncludedParameters in interface ReadOnlyHeader

Returns:

The included parameters.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Description copied from interface: ReadOnlyHeader

Returns a JSON object representation of the header. All custom parameters are included if they serialise to a JSON entity and their names don't conflict with the registered ones.

Specified by:

toJSONObject in interface ReadOnlyHeader

Returns:

The JSON object representation of the header.

parse

public static JWEHeader parse(net.minidev.json.JSONObject json)
                       throws ParseException

Parses a JWE header from the specified JSON object.

Parameters:

json - The JSON object to parse. Must not be null.

Returns:

The JWE header.

Throws:

ParseException - If the specified JSON object doesn't represent a valid JWE header.

parse

public static JWEHeader parse(String s)
                       throws ParseException

Parses a JWE header from the specified JSON object string.

Parameters:

s - The JSON object string to parse. Must not be null.

Returns:

The JWE header.

Throws:

ParseException - If the specified JSON object string doesn't represent a valid JWE header.

parse

public static JWEHeader parse(Base64URL base64URL)
                       throws ParseException

Parses a JWE header from the specified Base64URL.

Parameters:

base64URL - The Base64URL to parse. Must not be null.

Returns:

The JWE header.

Throws:

ParseException - If the specified Base64URL doesn't represent a valid JWE header.

getJWKURL

public URL getJWKURL()

Gets the JSON Web Key (JWK) Set URL (jku) parameter.

Returns:

The JSON Web Key (JWK) Set URL parameter, null if not specified.

getJWK

public JWK getJWK()

Gets the JSON Web Key (JWK) (jwk) parameter.

Returns:

The JSON Web Key (JWK) parameter, null if not specified.

getX509CertURL

public URL getX509CertURL()

Gets the X.509 certificate URL (x5u) parameter.

Returns:

The X.509 certificate URL parameter, null if not specified.

getX509CertThumbprint

public Base64URL getX509CertThumbprint()

Gets the X.509 certificate thumbprint (x5t) parameter.

Returns:

The X.509 certificate thumbprint parameter, null if not specified.

getX509CertChain

public List<Base64> getX509CertChain()

Gets the X.509 certificate chain (x5c) parameter corresponding to the key used to sign or encrypt the JWS / JWE object.

Returns:

The X.509 certificate chain parameter as a unmodifiable list, null if not specified.

getKeyID

public String getKeyID()

Gets the key ID (kid) parameter.

Returns:

The key ID parameter, null if not specified.

getJWKURL

public URL getJWKURL()

Gets the JSON Web Key (JWK) Set URL (jku) parameter.

Returns:

The JSON Web Key (JWK) Set URL parameter, null if not specified.

setJWKURL

public void setJWKURL(URL jku)

Sets the JSON Web Key (JWK) Set URL (jku) parameter.

Parameters:

jku - The JSON Web Key (JWK) Set URL parameter, null if not specified.

getJWK

public JWK getJWK()

Gets the JSON Web Key (JWK) (jwk) parameter.

Returns:

The JSON Web Key (JWK) parameter, null if not specified.

setJWK

public void setJWK(JWK jwk)

Sets the JSON Web Key (JWK) (jwk) parameter.

Parameters:

jwk - The JSON Web Key (JWK) (jwk) parameter, null if not specified.

getX509CertURL

public URL getX509CertURL()

Gets the X.509 certificate URL (x5u) parameter.

Returns:

The X.509 certificate URL parameter, null if not specified.

setX509CertURL

public void setX509CertURL(URL x5u)

Sets the X.509 certificate URL (x5u) parameter.

Parameters:

x5u - The X.509 certificate URL parameter, null if not specified.

getX509CertThumbprint

public Base64URL getX509CertThumbprint()

Gets the X.509 certificate thumbprint (x5t) parameter.

Returns:

The X.509 certificate thumbprint parameter, null if not specified.

setX509CertThumbprint

public void setX509CertThumbprint(Base64URL x5t)

Sets the X.509 certificate thumbprint (x5t) parameter.

Parameters:

x5t - The X.509 certificate thumbprint parameter, null if not specified.

getX509CertChain

public List<Base64> getX509CertChain()

Gets the X.509 certificate chain (x5c) parameter corresponding to the key used to sign or encrypt the JWS / JWE object.

Returns:

The X.509 certificate chain parameter as a unmodifiable list, null if not specified.

setX509CertChain

public void setX509CertChain(List<Base64> x5c)

Sets the X.509 certificate chain parameter (x5c) corresponding to the key used to sign or encrypt the JWS / JWE object.

Parameters:

x5c - The X.509 certificate chain parameter, null if not specified.

getKeyID

public String getKeyID()

Gets the key ID (kid) parameter.

Returns:

The key ID parameter, null if not specified.

setKeyID

public void setKeyID(String kid)

Sets the key ID (kid) parameter.

Parameters:

kid - The key ID parameter, null if not specified.