com.nimbusds.jose.crypto

Class MACVerifier

java.lang.Object

com.nimbusds.jose.crypto.MACVerifier

All Implemented Interfaces:

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. Modify the header filter properties to restrict the acceptable JWS algorithms and header parameters, or to allow custom JWS header parameters.

Version:

$version$ (2013-10-07)

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
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
protected static String	getJCAAlgorithmName(JWSAlgorithm alg) Gets the matching Java Cryptography Architecture (JCA) algorithm name for the specified HMAC-based JSON Web Algorithm (JWA).
JWSHeaderFilter	getJWSHeaderFilter() Gets the JWS header filter associated with the verifier.
byte[]	getSharedSecret() Gets the shared secret.
String	getSharedSecretString() Gets the shared secret as a UTF-8 encoded string.
Set<JWSAlgorithm>	supportedAlgorithms() Returns the names of the supported JWS algorithms.
boolean	verify(ReadOnlyJWSHeader 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

Field Detail

SUPPORTED_ALGORITHMS

public static final Set<JWSAlgorithm> SUPPORTED_ALGORITHMS

The supported JWS algorithms.

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

getJWSHeaderFilter

public JWSHeaderFilter getJWSHeaderFilter()

Description copied from interface: JWSVerifier

Gets the JWS header filter associated with the verifier. Specifies the names of those supported JWS algorithms and header parameters that the verifier is configured to accept.

Attempting to verify a JWS object signature with an algorithm or header parameter that is not accepted must result in a JOSEException.

Specified by:

getJWSHeaderFilter in interface JWSVerifier

Returns:

The JWS header filter.

verify

public boolean verify(ReadOnlyJWSHeader 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.