com.nimbusds.jose

Interface JWSVerifier

All Superinterfaces:

AlgorithmProvider, JWSAlgorithmProvider

All Known Implementing Classes:

ECDSAVerifier, MACVerifier, RSASSAVerifier

public interface JWSVerifier
extends JWSAlgorithmProvider

Interface for verifying JSON Web Signature (JWS) objects.

Callers can query the verifier to determine its algorithm capabilities as well as the JWS algorithms and header parameters that are accepted for processing.

Version:

$version$ (2014-07-08)

Author:

Vladimir Dzhuvinov

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<JWSAlgorithm>	getAcceptedAlgorithms() Gets the names of the accepted JWS algorithms.
java.util.Set<java.lang.String>	getIgnoredCriticalHeaderParameters() Gets the names of the critical JWS header parameters to ignore.
void	setAcceptedAlgorithms(java.util.Set<JWSAlgorithm> acceptedAlgs) Sets the names of the accepted JWS algorithms.
void	setIgnoredCriticalHeaderParameters(java.util.Set<java.lang.String> headers) Sets the names of the critical JWS header parameters to ignore.
boolean	verify(JWSHeader header, byte[] signingInput, Base64URL signature) Verifies the specified signature of a JWS object.

Methods inherited from interface com.nimbusds.jose.JWSAlgorithmProvider

supportedAlgorithms

Methods inherited from interface com.nimbusds.jose.AlgorithmProvider

setProvider

Method Detail

getAcceptedAlgorithms

java.util.Set<JWSAlgorithm> getAcceptedAlgorithms()

Gets the names of the accepted JWS algorithms. These correspond to the alg JWS header parameter.

Returns:

The accepted JWS algorithms, as a read-only set, empty set if none.

See Also:

setAcceptedAlgorithms(java.util.Set<com.nimbusds.jose.JWSAlgorithm>)

setAcceptedAlgorithms

void setAcceptedAlgorithms(java.util.Set<JWSAlgorithm> acceptedAlgs)

Sets the names of the accepted JWS algorithms. These correspond to the alg JWS header parameter.

For JWS verifiers that support multiple JWS algorithms this method can be used to indicate that only a subset should be accepted for processing.

Parameters:

acceptedAlgs - The accepted JWS algorithms. Must be a subset of the supported algorithms and not null.

getIgnoredCriticalHeaderParameters

java.util.Set<java.lang.String> getIgnoredCriticalHeaderParameters()

Gets the names of the critical JWS header parameters to ignore. These are indicated by the crit header parameter. The JWS verifier should not ignore critical headers by default.

Returns:

The names of the critical JWS header parameters to ignore, empty or null if none.

setIgnoredCriticalHeaderParameters

void setIgnoredCriticalHeaderParameters(java.util.Set<java.lang.String> headers)

Sets the names of the critical JWS header parameters to ignore. These are indicated by the crit header parameter. The JWS verifier should not ignore critical headers by default. Use this setter to delegate processing of selected critical headers to the application.

Parameters:

headers - The names of the critical JWS header parameters to ignore, empty or null if none.

verify

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

Verifies the specified signature of a JWS object.

Parameters:

header - The JSON Web Signature (JWS) header. Must specify an accepted JWS algorithm, must contain only accepted header parameters, and must not be null.

signingInput - 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, else false.

Throws:

JOSEException - If the JWS algorithm is not accepted, if a header parameter is not accepted, or if signature verification failed for some other reason.