com.nimbusds.jose.proc.JWSKeySelector Maven / Gradle / Ivy

Go to download
package com.nimbusds.jose.proc;


import java.security.Key;
import java.util.List;

import com.nimbusds.jose.JWSHeader;
import com.nimbusds.jose.KeySourceException;


/**
 * Interface for selecting key candidates for verifying a JSON Web Signature
 * (JWS) object. Applications should utilise this interface or a similar
 * framework to determine whether a received JWS object (or signed JWT) is
 * eligible for {@link com.nimbusds.jose.JWSVerifier verification} and further
 * processing.
 *
 * The key selection should be based on application specific criteria, such
 * as recognised header parameters referencing the key (e.g. {@code kid},
 * {@code x5t}) and / or the JWS object {@link SecurityContext}.
 *
 * 
See JSON Web Signature (JWS), Appendix D. Notes on Key Selection for
 * suggestions.
 *
 * 
Possible key types:
 *
 * 

 *     {@link javax.crypto.SecretKey} for HMAC keys.
 *     
{@link java.security.interfaces.RSAPublicKey} public RSA keys.
 *     
{@link java.security.interfaces.ECPublicKey} public EC keys.
 * 
 *
 * @author Vladimir Dzhuvinov
 * @version 2016-06-21
 */
public interface JWSKeySelector  {


	/**
	 * Selects key candidates for verifying a JWS object.
	 *
	 * @param header  The header of the JWS object. Must not be
	 *                {@code null}.
	 * @param context Optional context of the JWS object, {@code null} if
	 *                not required.
	 *
	 * @return The key candidates in trial order, empty list if none.
	 *
	 * @throws KeySourceException If a key sourcing exception is
	 *                            encountered, e.g. on remote JWK
	 *                            retrieval.
	 */
	List selectJWSKeys(final JWSHeader header, final C context)
		throws KeySourceException;
}