Package com.auth0.jwt.algorithms

Class HMACAlgorithm

java.lang.Object

com.auth0.jwt.algorithms.Algorithm

com.auth0.jwt.algorithms.HMACAlgorithm

class HMACAlgorithm
extends Algorithm

Field Summary

Fields

Modifier and Type	Field	Description
private final CryptoHelper	crypto
private final byte[]	secret

Constructor Summary

Constructors

Constructor	Description
HMACAlgorithm(CryptoHelper crypto, String id, String algorithm, byte[] secretBytes)
HMACAlgorithm(String id, String algorithm, byte[] secretBytes)
HMACAlgorithm(String id, String algorithm, String secret)

Method Summary

Modifier and Type	Method	Description
(package private) static byte[]	getSecretBytes(String secret)
byte[]	sign(byte[] contentBytes)	Deprecated.
byte[]	sign(byte[] headerBytes, byte[] payloadBytes)	Sign the given content using this Algorithm instance.
void	verify(DecodedJWT jwt)	Verify the given token using this Algorithm instance.

Methods inherited from class com.auth0.jwt.algorithms.Algorithm

ECDSA256, ECDSA256, ECDSA256, ECDSA384, ECDSA384, ECDSA384, ECDSA512, ECDSA512, ECDSA512, getDescription, getName, getSigningKeyId, HMAC256, HMAC256, HMAC384, HMAC384, HMAC512, HMAC512, none, RSA256, RSA256, RSA256, RSA384, RSA384, RSA384, RSA512, RSA512, RSA512, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

crypto

private final CryptoHelper crypto

secret

private final byte[] secret

Constructor Details

HMACAlgorithm

HMACAlgorithm(CryptoHelper crypto,
 String id,
 String algorithm,
 byte[] secretBytes)
       throws IllegalArgumentException

Throws:

IllegalArgumentException

HMACAlgorithm

HMACAlgorithm(String id,
 String algorithm,
 byte[] secretBytes)
       throws IllegalArgumentException

Throws:

IllegalArgumentException

HMACAlgorithm

HMACAlgorithm(String id,
 String algorithm,
 String secret)
       throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

getSecretBytes

static byte[] getSecretBytes(String secret)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

verify

public void verify(DecodedJWT jwt)
            throws SignatureVerificationException

Description copied from class: Algorithm

Verify the given token using this Algorithm instance.

Specified by:

verify in class Algorithm

Parameters:

jwt - the already decoded JWT that it's going to be verified.

Throws:

SignatureVerificationException - if the Token's Signature is invalid, meaning that it doesn't match the signatureBytes, or if the Key is invalid.

sign

public byte[] sign(byte[] headerBytes,
 byte[] payloadBytes)
            throws SignatureGenerationException

Description copied from class: Algorithm

Sign the given content using this Algorithm instance.

Overrides:

sign in class Algorithm

Parameters:

headerBytes - an array of bytes representing the base64 encoded header content to be verified against the signature.

payloadBytes - an array of bytes representing the base64 encoded payload content to be verified against the signature.

Returns:

the signature in a base64 encoded array of bytes

Throws:

SignatureGenerationException - if the Key is invalid.

sign

@Deprecated
public byte[] sign(byte[] contentBytes)
            throws SignatureGenerationException

Deprecated.

Description copied from class: Algorithm

Sign the given content using this Algorithm instance.

Specified by:

sign in class Algorithm

Parameters:

contentBytes - an array of bytes representing the base64 encoded content to be verified against the signature.

Returns:

the signature in a base64 encoded array of bytes

Throws:

SignatureGenerationException - if the Key is invalid.