com.nimbusds.jose.crypto

Class MACVerifier

java.lang.Object

com.nimbusds.jose.crypto.MACVerifier

All Implemented Interfaces:

AlgorithmProvider, JWSAlgorithmProvider, JWSVerifier

@ThreadSafe
public class MACVerifier
extends Object
implements JWSVerifier

Message Authentication Code (MAC) verifier of JWS objects. This class is thread-safe.

Supports the following JSON Web Algorithms (JWAs):

• JWSAlgorithm.HS256
• JWSAlgorithm.HS384
• JWSAlgorithm.HS512

Accepts all registered JWS header parameters. Use setAcceptedAlgorithms(java.util.Set<com.nimbusds.jose.JWSAlgorithm>) to restrict the acceptable JWS algorithms.

Version:

$version$ (2014-09-01)

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
protected Provider	provider The underlying cryptographic provider, null if not specified (implies default one).
static Set<JWSAlgorithm>	SUPPORTED_ALGORITHMS The supported JWS algorithms.

Constructor Summary

Constructors

Constructor and Description
MACVerifier(byte[] sharedSecret) Creates a new Message Authentication (MAC) verifier.
MACVerifier(String sharedSecretString) Creates a new Message Authentication (MAC) verifier.

Method Summary

Methods

Modifier and Type	Method and Description
Set<JWSAlgorithm>	getAcceptedAlgorithms() Gets the names of the accepted JWS algorithms.
Set<String>	getIgnoredCriticalHeaderParameters() Gets the names of the critical JWS header parameters to ignore.
protected static String	getJCAAlgorithmName(JWSAlgorithm alg) Gets the matching Java Cryptography Architecture (JCA) algorithm name for the specified HMAC-based JSON Web Algorithm (JWA).
byte[]	getSharedSecret() Gets the shared secret.
String	getSharedSecretString() Gets the shared secret as a UTF-8 encoded string.
void	setAcceptedAlgorithms(Set<JWSAlgorithm> acceptedAlgs) Sets the names of the accepted JWS algorithms.
void	setIgnoredCriticalHeaderParameters(Set<String> headers) Sets the names of the critical JWS header parameters to ignore.
void	setProvider(Provider provider) Sets a specific JCA provider, to be used for all operations.
Set<JWSAlgorithm>	supportedAlgorithms() Returns the names of the supported JWS algorithms.
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.JWSAlgorithmProvider

supportedAlgorithms

Methods inherited from interface com.nimbusds.jose.AlgorithmProvider

setProvider

Field Detail

SUPPORTED_ALGORITHMS

public static final Set<JWSAlgorithm> SUPPORTED_ALGORITHMS

The supported JWS algorithms.

provider

protected Provider provider

The underlying cryptographic provider, null if not specified (implies default one).

Constructor Detail

MACVerifier

public MACVerifier(byte[] sharedSecret)

Creates a new Message Authentication (MAC) verifier.

Parameters:

sharedSecret - The shared secret. Must not be null.

MACVerifier

public MACVerifier(String sharedSecretString)

Creates a new Message Authentication (MAC) verifier.

Parameters:

sharedSecretString - The shared secret as a UTF-8 encoded string. Must not be null.

Method Detail

getAcceptedAlgorithms

public Set<JWSAlgorithm> getAcceptedAlgorithms()

Description copied from interface: JWSVerifier

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

Specified by:

getAcceptedAlgorithms in interface JWSVerifier

Returns:

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

See Also:

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

setAcceptedAlgorithms

public void setAcceptedAlgorithms(Set<JWSAlgorithm> acceptedAlgs)

Description copied from interface: JWSVerifier

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.

Specified by:

setAcceptedAlgorithms in interface JWSVerifier

Parameters:

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

getIgnoredCriticalHeaderParameters

public Set<String> getIgnoredCriticalHeaderParameters()

Description copied from interface: JWSVerifier

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.

Specified by:

getIgnoredCriticalHeaderParameters in interface JWSVerifier

Returns:

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

setIgnoredCriticalHeaderParameters

public void setIgnoredCriticalHeaderParameters(Set<String> headers)

Description copied from interface: JWSVerifier

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.

Specified by:

setIgnoredCriticalHeaderParameters in interface JWSVerifier

Parameters:

headers - The names of the critical JWS header parameters to ignore, empty or null 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 an accepted JWS algorithm, must contain only accepted header parameters, 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, 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.

getJCAAlgorithmName

protected static String getJCAAlgorithmName(JWSAlgorithm alg)
                                     throws JOSEException

Gets the matching Java Cryptography Architecture (JCA) algorithm name for the specified HMAC-based JSON Web Algorithm (JWA).

Parameters:

alg - The JSON Web Algorithm (JWA). Must be supported and not null.

Returns:

The matching JCA algorithm name.

Throws:

JOSEException - If the algorithm is not supported.

getSharedSecret

public byte[] getSharedSecret()

Gets the shared secret.

Returns:

The shared secret.

getSharedSecretString

public String getSharedSecretString()

Gets the shared secret as a UTF-8 encoded string.

Returns:

The shared secret as a UTF-8 encoded string.

supportedAlgorithms

public Set<JWSAlgorithm> supportedAlgorithms()

Description copied from interface: JWSAlgorithmProvider

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

Specified by:

supportedAlgorithms in interface JWSAlgorithmProvider

Returns:

The supported JWS algorithms, empty set if none.

setProvider

public void setProvider(Provider provider)

Description copied from interface: AlgorithmProvider

Sets a specific JCA provider, to be used for all operations.

Specified by:

setProvider in interface AlgorithmProvider

Parameters:

provider - The JCA provider, or null to use the default one.