com.nimbusds.jose.crypto

Class MACSigner

java.lang.Object

com.nimbusds.jose.crypto.MACSigner

All Implemented Interfaces:

JWSAlgorithmProvider, JWSSigner

@ThreadSafe
public class MACSigner
extends java.lang.Object
implements JWSSigner

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

Supports the following JSON Web Algorithms (JWAs):

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

Version:

$version$ (2013-03-22)

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
MACSigner(byte[] sharedSecret) Creates a new Message Authentication (MAC) signer.

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.lang.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.
Base64URL	sign(ReadOnlyJWSHeader header, byte[] signableContent) Signs the specified signable content of a JWS object.
java.util.Set<JWSAlgorithm>	supportedAlgorithms() Returns the names of the supported JWS algorithms.

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

Constructor Detail

MACSigner

public MACSigner(byte[] sharedSecret)

Creates a new Message Authentication (MAC) signer.

Parameters:

sharedSecret - The shared secret. Must not be null.

Method Detail

sign

public Base64URL sign(ReadOnlyJWSHeader header,
             byte[] signableContent)
               throws JOSEException

Description copied from interface: JWSSigner

Signs the specified signable content of a JWS object.

Specified by:

sign in interface JWSSigner

Parameters:

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

signableContent - The content to sign. Must not be null.

Returns:

The resulting signature part (third part) of the JWS object.

Throws:

JOSEException - If the JWS algorithm is not supported or if signing failed for some other reason.

getJCAAlgorithmName

protected static java.lang.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.

supportedAlgorithms

public java.util.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.