com.nimbusds.jose.proc

Class DefaultJOSEProcessor<C extends SecurityContext>

java.lang.Object

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

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

All Implemented Interfaces:

JOSEProcessor<Payload,C>

@ThreadSafe
public class DefaultJOSEProcessor<C extends SecurityContext>
extends BaseJOSEProcessor<C>
implements JOSEProcessor<Payload,C>

Default processor of received JOSEObjects.

Must be supplied with a JWS key selector to determine the key candidate(s) for the signature verification. The exact key selection procedure is application-specific and may involve key ID lookup, a certificate check and / or other information supplied in the message context.

Similarly, the processor must be supplied with a JWE key selector if JWE messages are expected to be processed.

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) if you need to handle plain JOSE objects as well.

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

Version:

2015-07-01

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
DefaultJOSEProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
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).

Methods inherited from class com.nimbusds.jose.proc.BaseJOSEProcessor

getJWEDecrypterFactory, getJWEKeySelector, getJWSKeySelector, getJWSVerifierFactory, setJWEDecrypterFactory, setJWEKeySelector, setJWSKeySelector, setJWSVerifierFactory

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

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<Payload,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:

An application-specific object (the payload) on success, or null if no return value is necessary.

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<Payload,C extends SecurityContext>

Parameters:

joseObject - The JOSE object. Must not be null.

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

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

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<Payload,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:

An application-specific object (the payload) on success, or null if no return value is necessary.

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<Payload,C extends SecurityContext>

Parameters:

jwsObject - The JWS object. Not null.

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

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

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<Payload,C extends SecurityContext>

Parameters:

jweObject - The JWE object. Not null.

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

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

Throws:

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

JOSEException - If an internal processing exception is encountered.