com.auth0.jwt.interfaces.JWTVerifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-jwt Show documentation

Java implementation of JSON Web Token (JWT)

There is a newer version: 4.4.0

package com.auth0.jwt.interfaces;

import com.auth0.jwt.exceptions.JWTVerificationException;


/**
 * Used to verify the JWT for its signature and claims. Implementations must be thread-safe. Instances are created
 * using {@link Verification}.
 *
 *  * try {
 *      JWTVerifier verifier = JWTVerifier.init(Algorithm.RSA256(publicKey, privateKey)
 *          .withIssuer("auth0")
 *          .build();
 *      DecodedJWT jwt = verifier.verify("token");
 * } catch (JWTVerificationException e) {
 *      // invalid signature or claims
 * }
 * 
 */
public interface JWTVerifier {

    /**
     * Performs the verification against the given Token.
     *
     * @param token to verify.
     * @return a verified and decoded JWT.
     * @throws JWTVerificationException if any of the verification steps fail
     */
    DecodedJWT verify(String token) throws JWTVerificationException;

    /**
     * Performs the verification against the given {@link DecodedJWT}.
     *
     * @param jwt to verify.
     * @return a verified and decoded JWT.
     * @throws JWTVerificationException if any of the verification steps fail
     */
    DecodedJWT verify(DecodedJWT jwt) throws JWTVerificationException;
}