com.nimbusds.jwt.proc.JWTClaimsSetVerifier Maven / Gradle / Ivy

Go to download

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

Java library for Javascript Object Signing and Encryption (JOSE) and JSON Web Tokens (JWT)

There is a newer version: 10.0.1

package com.nimbusds.jwt.proc;


import com.nimbusds.jose.proc.SecurityContext;
import com.nimbusds.jwt.JWTClaimsSet;


/**
 * JWT claims set verifier. Ensures the claims set of a JWT that is being
 * {@link JWTProcessor processed} complies with an application's requirements.
 *
 * An application may implement JWT claims checks such as:
 *
 * 

 *     The JWT is within the required validity time window;
 *     
has a specific issuer;
 *     
has a specific audience;
 *     
has a specific subject;
 *     
etc.
 * 
 *
 * @author Vladimir Dzhuvinov
 * @version 2016-07-25
 * @since 4.23
 */
public interface JWTClaimsSetVerifier  {
	
	
	/**
	 * Verifies selected or all claims from the specified JWT claims set.
	 *
	 * @param claimsSet The JWT claims set. Not {@code null}.
	 * @param context   Optional context, {@code null} if not required.
	 *
	 * @throws BadJWTException If the JWT claims set is rejected.
	 */
	void verify(final JWTClaimsSet claimsSet, final C context)
		throws BadJWTException;
}