com.nimbusds.jose.proc

Class DefaultJOSEProcessor<C extends SecurityContext>

java.lang.Object

com.nimbusds.jose.proc.DefaultJOSEProcessor<C>

All Implemented Interfaces:

ConfigurableJOSEProcessor<C>, JOSEProcessor<C>, JOSEProcessorConfiguration<C>

@ThreadSafe
public class DefaultJOSEProcessor<C extends SecurityContext>
extends Object
implements ConfigurableJOSEProcessor<C>

Default processor of unsecured (plain), JWS and JWE objects.

Must be configured with the following:

1. To verify JWS objects: A JWS key selector to determine the key candidate(s) for the signature verification. The key selection procedure is application-specific and may involve key ID lookup, a certificate check and / or other information supplied in the message context.
2. To decrypt JWE objects: A JWE key selector to determine the key candidate(s) for decryption. The key selection procedure is application-specific and may involve key ID lookup, a certificate check and / or other information supplied in the message context.

See sections 6 of RFC 7515 (JWS) and RFC 7516 (JWE) for guidelines on key selection.

This processor comes with the default JWS verifier factory and the default JWE decrypter factory; they can construct verifiers / decrypters for all standard JOSE algorithms implemented by the library.

Note that for security reasons this processor is hardwired to reject unsecured (plain) JOSE objects. Override the process(PlainObject, SecurityContext) method if you need to handle unsecured JOSE objects as well.

To process JSON Web Tokens (JWTs) use the DefaultJWTProcessor class.

Version:

2015-10-20

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
DefaultJOSEProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
JWEDecrypterFactory	getJWEDecrypterFactory() Gets the factory for creating JWE decrypter instances.
JWEKeySelector<C>	getJWEKeySelector() Gets the JWE key selector.
JWSKeySelector<C>	getJWSKeySelector() Gets the JWS key selector.
JWSVerifierFactory	getJWSVerifierFactory() Gets the factory for creating JWS verifier instances.
Payload	process(JOSEObject joseObject, C context) Processes the specified JOSE object (unsecured, JWS or JWE).
Payload	process(JWEObject jweObject, C context) Processes the specified JWE object by decrypting it.
Payload	process(JWSObject jwsObject, C context) Processes the specified JWS object by verifying its signature.
Payload	process(PlainObject plainObject, C context) Processes the specified unsecured (plain) JOSE object, typically by checking its context.
Payload	process(String compactJOSE, C context) Parses and processes the specified JOSE object (unsecured, JWS or JWE).
void	setJWEDecrypterFactory(JWEDecrypterFactory factory) Sets the factory for creating JWE decrypter instances.
void	setJWEKeySelector(JWEKeySelector<C> jweKeySelector) Sets the JWE key selector.
void	setJWSKeySelector(JWSKeySelector<C> jwsKeySelector) Sets the JWS key selector.
void	setJWSVerifierFactory(JWSVerifierFactory factory) Sets the factory for creating JWS verifier instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJOSEProcessor

public DefaultJOSEProcessor()

Method Detail

getJWSKeySelector

public JWSKeySelector<C> getJWSKeySelector()

Description copied from interface: JOSEProcessorConfiguration

Gets the JWS key selector.

Specified by:

getJWSKeySelector in interface JOSEProcessorConfiguration<C extends SecurityContext>

Returns:

The JWS key selector, null if not specified.

setJWSKeySelector

public void setJWSKeySelector(JWSKeySelector<C> jwsKeySelector)

Description copied from interface: JOSEProcessorConfiguration

Sets the JWS key selector.

Specified by:

setJWSKeySelector in interface JOSEProcessorConfiguration<C extends SecurityContext>

Parameters:

jwsKeySelector - The JWS key selector, null if not specified.

getJWEKeySelector

public JWEKeySelector<C> getJWEKeySelector()

Description copied from interface: JOSEProcessorConfiguration

Gets the JWE key selector.

Specified by:

getJWEKeySelector in interface JOSEProcessorConfiguration<C extends SecurityContext>

Returns:

The JWE key selector, null if not specified.

setJWEKeySelector

public void setJWEKeySelector(JWEKeySelector<C> jweKeySelector)

Description copied from interface: JOSEProcessorConfiguration

Sets the JWE key selector.

Specified by:

setJWEKeySelector in interface JOSEProcessorConfiguration<C extends SecurityContext>

Parameters:

jweKeySelector - The JWE key selector, null if not specified.

getJWSVerifierFactory

public JWSVerifierFactory getJWSVerifierFactory()

Description copied from interface: JOSEProcessorConfiguration

Gets the factory for creating JWS verifier instances.

Specified by:

getJWSVerifierFactory in interface JOSEProcessorConfiguration<C extends SecurityContext>

Returns:

The JWS verifier factory, null if not specified.

setJWSVerifierFactory

public void setJWSVerifierFactory(JWSVerifierFactory factory)

Description copied from interface: JOSEProcessorConfiguration

Sets the factory for creating JWS verifier instances.

Specified by:

setJWSVerifierFactory in interface JOSEProcessorConfiguration<C extends SecurityContext>

Parameters:

factory - The JWS verifier factory, null if not specified.

getJWEDecrypterFactory

public JWEDecrypterFactory getJWEDecrypterFactory()

Description copied from interface: JOSEProcessorConfiguration

Gets the factory for creating JWE decrypter instances.

Specified by:

getJWEDecrypterFactory in interface JOSEProcessorConfiguration<C extends SecurityContext>

Returns:

The JWE decrypter factory, null if not specified.

setJWEDecrypterFactory

public void setJWEDecrypterFactory(JWEDecrypterFactory factory)

Description copied from interface: JOSEProcessorConfiguration

Sets the factory for creating JWE decrypter instances.

Specified by:

setJWEDecrypterFactory in interface JOSEProcessorConfiguration<C extends SecurityContext>

Parameters:

factory - The JWE decrypter factory, null if not specified.

process

public Payload process(String compactJOSE,
              C context)
                throws ParseException,
                       BadJOSEException,
                       JOSEException

Description copied from interface: JOSEProcessor

Parses and processes the specified JOSE object (unsecured, JWS or JWE).

Specified by:

process in interface JOSEProcessor<C extends SecurityContext>

Parameters:

compactJOSE - The JOSE object, compact-encoded to a URL-safe string. Must not be null.

context - Optional context of the JOSE object, null if not required.

Returns:

The payload on success.

Throws:

ParseException - If the string couldn't be parsed to a valid JOSE object.

BadJOSEException - If the JOSE object is rejected.

JOSEException - If an internal processing exception is encountered.

process

public Payload process(JOSEObject joseObject,
              C context)
                throws BadJOSEException,
                       JOSEException

Description copied from interface: JOSEProcessor

Processes the specified JOSE object (unsecured, JWS or JWE).

Specified by:

process in interface JOSEProcessor<C extends SecurityContext>

Parameters:

joseObject - The JOSE object. Must not be null.

context - Optional context of the JOSE object, null if not required.

Returns:

The payload on success.

Throws:

BadJOSEException - If the JOSE object is rejected.

JOSEException - If an internal processing exception is encountered.

process

public Payload process(PlainObject plainObject,
              C context)
                throws BadJOSEException

Description copied from interface: JOSEProcessor

Processes the specified unsecured (plain) JOSE object, typically by checking its context.

Specified by:

process in interface JOSEProcessor<C extends SecurityContext>

Parameters:

plainObject - The unsecured (plain) JOSE object. Not null.

context - Optional context of the unsecured JOSE object, null if not required.

Returns:

The payload on success.

Throws:

BadJOSEException - If the unsecured (plain) JOSE object is rejected.

process

public Payload process(JWSObject jwsObject,
              C context)
                throws BadJOSEException,
                       JOSEException

Description copied from interface: JOSEProcessor

Processes the specified JWS object by verifying its signature. The key candidate(s) are selected by examining the JWS header and / or the message context.

Specified by:

process in interface JOSEProcessor<C extends SecurityContext>

Parameters:

jwsObject - The JWS object. Not null.

context - Optional context of the JWS object, null if not required.

Returns:

The payload on success.

Throws:

BadJOSEException - If the JWS object is rejected, typically due to a bad signature.

JOSEException - If an internal processing exception is encountered.

process

public Payload process(JWEObject jweObject,
              C context)
                throws BadJOSEException,
                       JOSEException

Description copied from interface: JOSEProcessor

Processes the specified JWE object by decrypting it. The key candidate(s) are selected by examining the JWS header and / or the message context.

Specified by:

process in interface JOSEProcessor<C extends SecurityContext>

Parameters:

jweObject - The JWE object. Not null.

context - Optional context of the JWE object, null if not required.

Returns:

The payload on success.

Throws:

BadJOSEException - If the JWE object is rejected, typically due to failed decryption.

JOSEException - If an internal processing exception is encountered.