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.

This class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JWTVerifier.BaseVerification

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

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

Method Details

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