it.cosenonjaviste.security.jwt.utils.JwtTokenVerifier Maven / Gradle / Ivy

Go to download
package it.cosenonjaviste.security.jwt.utils;

import java.io.IOException;
import java.nio.file.attribute.UserPrincipal;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.security.SignatureException;
import java.util.List;
import java.util.Map;

import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;

import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.JWTVerifyException;

/**
 * Helper class for simplifying token verification procedure.
 * 
 * This class provides convenience methods to access userId and roles claims values.
 * If not present, an {@link IllegalStateException} is thrown
 * 
 * These values are mandatory in order to create {@link UserPrincipal} for each request
 * 
 * @author acomo
 *
 */
public class JwtTokenVerifier {
	
	private static final Log LOG = LogFactory.getLog(JwtTokenVerifier.class);
	
	private JWTVerifier verifier;

	private Map claims;

	private JwtTokenVerifier() {

	}
	
	/**
	 * Creates a new instance of {@link JwtTokenVerifier} class
	 * 
	 * @param secret secret phrase
	 * 
	 * @return a new instance of {@link JwtTokenVerifier} class
	 */
	public static JwtTokenVerifier create(String secret) {
		JwtTokenVerifier tokenVerifier = new JwtTokenVerifier();
		tokenVerifier.verifier = new JWTVerifier(secret); 
		
		return tokenVerifier;
	}
	
	/**
	 * Verify provided token delegating verification logic to {@link JWTVerifier#verify(String)}
	 * 
	 * @param token JWT token
	 * 
	 * @return verification status
	 */
	public boolean verify(String token) {
		try {
			claims = this.verifier.verify(token);
			return claims != null;
		} catch (InvalidKeyException | SignatureException
				| IllegalStateException e) {
			LOG.info("Invalid token, caused by: " + e.getMessage(), e);
			return false;

		} catch (NoSuchAlgorithmException | IOException e) {
			LOG.info("Unable to parse token, caused by: " + e.getMessage(), e);
			return false;
		} catch (JWTVerifyException e) {
			LOG.info("Unable to verify token, caused by: " + e.getMessage(), e);
			return false;
		}
	}
	
	/**
	 * Convenience method to retrieve userId value from token claim
	 * 
	 * @return userId value
	 * 
	 * @throws IllegalStateException if claims do not contain userId key
	 */
	public String getUserId() {
		if (this.claims != null) {
			return (String) this.claims.get(JwtConstants.USER_ID);
		} else {
			throw new IllegalStateException("Please call verify method first!");
		}
	}
	
	/**
	 * Convenience method to retrieve roles value from token claim
	 * 
	 * @return roles value collection
	 * 
	 * @throws IllegalStateException if claims do not contain roles key
	 */
	@SuppressWarnings("unchecked")
	public List getRoles() {
		if (this.claims != null) {
			return (List) this.claims.get(JwtConstants.ROLES);
		} else {
			throw new IllegalStateException("Please call verify method first!");
		}
	}
	
	/**
	 * Return validated claims. For internal use only!
	 * 
	 * @return
	 */
	Map getClaims() {
		if (this.claims != null) {
			return this.claims;
		} else {
			throw new IllegalStateException("Please call verify method first!");
		}
	}
}