com.nimbusds.jose.CriticalHeaderParamsAware 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: 9.48

package com.nimbusds.jose;


import java.util.Set;


/**
 * JSON Web Signature (JWS) verifier or JSON Web Encryption (JWE) decrypter
 * that supports processing and / or deferral of critical ({@code crit}) header
 * parameters.
 *
 * JWS verification / JWE decryption will fail with a {@link JOSEException}
 * if a critical header is encountered that is neither processed by the
 * verifier / decrypter nor deferred to the application.
 *
 * @author Vladimir Dzhuvinov
 * @version 2015-04-21
 */
public interface CriticalHeaderParamsAware {


	/**
	 * Returns the names of the critical ({@code crit}) header parameters
	 * that are understood and processed by the JWS verifier / JWE
	 * decrypter.
	 *
	 * @return The names of the critical header parameters that are
	 *         understood and processed, empty set if none.
	 */
	Set getProcessedCriticalHeaderParams();


	/**
	 * Returns the names of the critical ({@code crit}) header parameters
	 * that are deferred to the application for processing and will be
	 * ignored by the JWS verifier / JWE decrypter.
	 *
	 * @return The names of the critical header parameters that are
	 *         deferred to the application for processing, empty set if
	 *         none.
	 */
	Set getDeferredCriticalHeaderParams();
}