com.nimbusds.jose.crypto

Class RSASSAVerifier

java.lang.Object

com.nimbusds.jose.crypto.RSASSAVerifier

All Implemented Interfaces:

CriticalHeaderParamsAware, JCAAware<JCAContext>, JOSEProvider, JWSProvider, JWSVerifier

@ThreadSafe
public class RSASSAVerifier
extends Object
implements JWSVerifier, CriticalHeaderParamsAware

RSA Signature-Scheme-with-Appendix (RSASSA) verifier of JWS objects. This class is thread-safe.

Supports the following algorithms:

• JWSAlgorithm.RS256
• JWSAlgorithm.RS384
• JWSAlgorithm.RS512
• JWSAlgorithm.PS256
• JWSAlgorithm.PS384
• JWSAlgorithm.PS512

Version:

2015-06-02

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static Set<JWSAlgorithm>	SUPPORTED_ALGORITHMS The supported JWS algorithms by the RSA-SSA provider class.

Constructor Summary

Constructors

Constructor and Description
RSASSAVerifier(RSAKey rsaJWK) Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
RSASSAVerifier(RSAPublicKey publicKey) Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
RSASSAVerifier(RSAPublicKey publicKey, Set<String> defCritHeaders) Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.

Method Summary

Modifier and Type	Method and Description
Set<String>	getDeferredCriticalHeaderParams() Returns the names of the critical (crit) header parameters that are deferred to the application for processing and will be ignored by the JWS verifier / JWE decrypter.
JCAContext	getJCAContext() Returns the Java Cryptography Architecture (JCA) context.
Set<String>	getProcessedCriticalHeaderParams() Returns the names of the critical (crit) header parameters that are understood and processed by the JWS verifier / JWE decrypter.
RSAPublicKey	getPublicKey() Gets the public RSA key.
Set<JWSAlgorithm>	supportedJWSAlgorithms() Returns the names of the supported algorithms by the JWS provider instance.
boolean	verify(JWSHeader header, byte[] signedContent, Base64URL signature) Verifies the specified signature of a JWS object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nimbusds.jose.JWSProvider

supportedJWSAlgorithms

Methods inherited from interface com.nimbusds.jose.jca.JCAAware

getJCAContext

Field Detail

SUPPORTED_ALGORITHMS

public static final Set<JWSAlgorithm> SUPPORTED_ALGORITHMS

The supported JWS algorithms by the RSA-SSA provider class.

Constructor Detail

RSASSAVerifier

public RSASSAVerifier(RSAPublicKey publicKey)

Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.

Parameters:

publicKey - The public RSA key. Must not be null.

RSASSAVerifier

public RSASSAVerifier(RSAKey rsaJWK)
               throws JOSEException

Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.

Parameters:

rsaJWK - The RSA JSON Web Key (JWK). Must not be null.

Throws:

JOSEException - If the RSA JWK extraction failed.

RSASSAVerifier

public RSASSAVerifier(RSAPublicKey publicKey,
                      Set<String> defCritHeaders)

Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.

Parameters:

publicKey - The public RSA key. Must not be null.

defCritHeaders - The names of the critical header parameters that are deferred to the application for processing, empty set or null if none.

Method Detail

getPublicKey

public RSAPublicKey getPublicKey()

Gets the public RSA key.

Returns:

The public RSA key.

getProcessedCriticalHeaderParams

public Set<String> getProcessedCriticalHeaderParams()

Description copied from interface: CriticalHeaderParamsAware

Returns the names of the critical (crit) header parameters that are understood and processed by the JWS verifier / JWE decrypter.

Specified by:

getProcessedCriticalHeaderParams in interface CriticalHeaderParamsAware

Returns:

The names of the critical header parameters that are understood and processed, empty set if none.

getDeferredCriticalHeaderParams

public Set<String> getDeferredCriticalHeaderParams()

Description copied from interface: CriticalHeaderParamsAware

Returns the names of the critical (crit) header parameters that are deferred to the application for processing and will be ignored by the JWS verifier / JWE decrypter.

Specified by:

getDeferredCriticalHeaderParams in interface CriticalHeaderParamsAware

Returns:

The names of the critical header parameters that are deferred to the application for processing, empty set if none.

verify

public boolean verify(JWSHeader header,
                      byte[] signedContent,
                      Base64URL signature)
               throws JOSEException

Description copied from interface: JWSVerifier

Verifies the specified signature of a JWS object.

Specified by:

verify in interface JWSVerifier

Parameters:

header - The JSON Web Signature (JWS) header. Must specify a supported JWS algorithm and must not be null.

signedContent - The signing input. Must not be null.

signature - The signature part of the JWS object. Must not be null.

Returns:

true if the signature was successfully verified, false if the signature is invalid or if a critical header is neither supported nor marked for deferral to the application.

Throws:

JOSEException - If the JWS algorithm is not supported, or if signature verification failed for some other internal reason.

supportedJWSAlgorithms

public Set<JWSAlgorithm> supportedJWSAlgorithms()

Description copied from interface: JWSProvider

Returns the names of the supported algorithms by the JWS provider instance. These correspond to the alg JWS header parameter.

Specified by:

supportedJWSAlgorithms in interface JWSProvider

Returns:

The supported JWS algorithms, empty set if none.

getJCAContext

public JCAContext getJCAContext()

Description copied from interface: JCAAware

Returns the Java Cryptography Architecture (JCA) context. May be used to set a specific JCA security provider or secure random generator.

Specified by:

getJCAContext in interface JCAAware<JCAContext>

Returns:

The JCA context. Not null.