Package com.nimbusds.jose.crypto
Class RSASSAVerifier
java.lang.Object
com.nimbusds.jose.crypto.impl.BaseJWSProvider
com.nimbusds.jose.crypto.impl.RSASSAProvider
com.nimbusds.jose.crypto.RSASSAVerifier
- All Implemented Interfaces:
CriticalHeaderParamsAware
,JCAAware<JCAContext>
,JOSEProvider
,JWSProvider
,JWSVerifier
@ThreadSafe
public class RSASSAVerifier
extends RSASSAProvider
implements JWSVerifier, CriticalHeaderParamsAware
RSA Signature-Scheme-with-Appendix (RSASSA) verifier of
JWS objects
. Expects a public RSA key.
See RFC 7518, sections 3.3 and 3.5 for more information.
This class is thread-safe.
Supports the following algorithms:
JWSAlgorithm.RS256
JWSAlgorithm.RS384
JWSAlgorithm.RS512
JWSAlgorithm.PS256
JWSAlgorithm.PS384
JWSAlgorithm.PS512
Supports the BouncyCastle FIPS provider for the PSxxx family of JWS algorithms.
- Version:
- 2024-04-20
- Author:
- Vladimir Dzhuvinov
-
Field Summary
Fields inherited from class com.nimbusds.jose.crypto.impl.RSASSAProvider
SUPPORTED_ALGORITHMS
-
Constructor Summary
ConstructorsConstructorDescriptionRSASSAVerifier
(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 TypeMethodDescriptionReturns 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.Returns the names of the critical (crit
) header parameters that are understood and processed by the JWS verifier / JWE decrypter.Gets the public RSA key.boolean
Verifies the specifiedsignature
of aJWS object
.Methods inherited from class com.nimbusds.jose.crypto.impl.BaseJWSProvider
getJCAContext, supportedJWSAlgorithms
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.jca.JCAAware
getJCAContext
Methods inherited from interface com.nimbusds.jose.JWSProvider
supportedJWSAlgorithms
-
Constructor Details
-
RSASSAVerifier
Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.- Parameters:
publicKey
- The public RSA key. Must not benull
.
-
RSASSAVerifier
Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.- Parameters:
rsaJWK
- The RSA JSON Web Key (JWK). Must not benull
.- Throws:
JOSEException
- If the RSA JWK extraction failed.
-
RSASSAVerifier
Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.- Parameters:
publicKey
- The public RSA key. Must not benull
.defCritHeaders
- The names of the critical header parameters that are deferred to the application for processing, empty set ornull
if none.
-
-
Method Details
-
getPublicKey
Gets the public RSA key.- Returns:
- The public RSA key.
-
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 interfaceCriticalHeaderParamsAware
- Returns:
- The names of the critical header parameters that are understood and processed, empty set if none.
-
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 interfaceCriticalHeaderParamsAware
- 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 specifiedsignature
of aJWS object
.- Specified by:
verify
in interfaceJWSVerifier
- Parameters:
header
- The JSON Web Signature (JWS) header. Must specify a supported JWS algorithm and must not benull
.signedContent
- The signing input. Must not benull
.signature
- The signature part of the JWS object. Must not benull
.- 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.
-