Package com.auth0.jwt

Class JWTVerifier

java.lang.Object

com.auth0.jwt.JWTVerifier

All Implemented Interfaces:

JWTVerifier

public final class JWTVerifier
extends Object
implements JWTVerifier

The JWTVerifier class holds the verify method to assert that a given Token has not only a proper JWT format, but also it's signature matches.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JWTVerifier.BaseVerification	The Verification class holds the Claims required by a JWT to be valid.

Field Summary

Fields

Modifier and Type	Field	Description
private final Algorithm	algorithm
(package private) final Map<String,Object>	claims
private final Clock	clock
private final JWTParser	parser

Constructor Summary

Constructors

Constructor	Description
JWTVerifier(Algorithm algorithm, Map<String,Object> claims, Clock clock)

Method Summary

Modifier and Type	Method	Description
private void	assertDateIsFuture(Date date, long leeway, Date today)
private void	assertDateIsPast(Date date, long leeway, Date today)
private void	assertValidAudienceClaim(List<String> audience, List<String> value)
private void	assertValidClaim(Claim claim, String claimName, Object value)
private void	assertValidDateClaim(Date date, long leeway, boolean shouldBeFuture)
private void	assertValidIssuerClaim(String issuer, List<String> value)
private void	assertValidStringClaim(String claimName, String value, String expectedValue)
(package private) static Verification	init(Algorithm algorithm)	Initialize a JWTVerifier instance using the given Algorithm.
DecodedJWT	verify(DecodedJWT jwt)	Perform the verification against the given decoded JWT, using any previous configured options.
DecodedJWT	verify(String token)	Perform the verification against the given Token, using any previous configured options.
private void	verifyAlgorithm(DecodedJWT jwt, Algorithm expectedAlgorithm)
private void	verifyClaims(DecodedJWT jwt, Map<String,Object> claims)

Methods inherited from class java.lang.Object

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

Field Details

algorithm

private final Algorithm algorithm

claims

final Map<String,Object> claims

clock

private final Clock clock

parser

private final JWTParser parser

Constructor Details

JWTVerifier

JWTVerifier(Algorithm algorithm,
 Map<String,Object> claims,
 Clock clock)

Method Details

init

static Verification init(Algorithm algorithm)
                  throws IllegalArgumentException

Initialize a JWTVerifier instance using the given Algorithm.

Parameters:

algorithm - the Algorithm to use on the JWT verification.

Returns:

a JWTVerifier.Verification instance to configure.

Throws:

IllegalArgumentException - if the provided algorithm is null.

verify

public DecodedJWT verify(String token)
                  throws JWTVerificationException

Perform the verification against the given Token, using any previous configured options.

Specified by:

verify in interface JWTVerifier

Parameters:

token - to verify.

Returns:

a verified and decoded JWT.

Throws:

AlgorithmMismatchException - if the algorithm stated in the token's header it's not equal to the one defined in the JWTVerifier.

SignatureVerificationException - if the signature is invalid.

TokenExpiredException - if the token has expired.

InvalidClaimException - if a claim contained a different value than the expected one.

JWTVerificationException - if any of the verification steps fail

verify

public DecodedJWT verify(DecodedJWT jwt)
                  throws JWTVerificationException

Perform the verification against the given decoded JWT, using any previous configured options.

Specified by:

verify in interface JWTVerifier

Parameters:

jwt - to verify.

Returns:

a verified and decoded JWT.

Throws:

AlgorithmMismatchException - if the algorithm stated in the token's header it's not equal to the one defined in the JWTVerifier.

SignatureVerificationException - if the signature is invalid.

TokenExpiredException - if the token has expired.

InvalidClaimException - if a claim contained a different value than the expected one.

JWTVerificationException - if any of the verification steps fail

verifyAlgorithm

private void verifyAlgorithm(DecodedJWT jwt,
 Algorithm expectedAlgorithm)
                      throws AlgorithmMismatchException

Throws:

AlgorithmMismatchException

verifyClaims

private void verifyClaims(DecodedJWT jwt,
 Map<String,Object> claims)
                   throws TokenExpiredException,
InvalidClaimException

Throws:

TokenExpiredException

InvalidClaimException

assertValidClaim

private void assertValidClaim(Claim claim,
 String claimName,
 Object value)

assertValidStringClaim

private void assertValidStringClaim(String claimName,
 String value,
 String expectedValue)

assertValidDateClaim

private void assertValidDateClaim(Date date,
 long leeway,
 boolean shouldBeFuture)

assertDateIsFuture

private void assertDateIsFuture(Date date,
 long leeway,
 Date today)

assertDateIsPast

private void assertDateIsPast(Date date,
 long leeway,
 Date today)

assertValidAudienceClaim

private void assertValidAudienceClaim(List<String> audience,
 List<String> value)

assertValidIssuerClaim

private void assertValidIssuerClaim(String issuer,
 List<String> value)