org.jose4j.keys.resolvers.DecryptionKeyResolver Maven / Gradle / Ivy
/*
* Copyright 2012-2017 Brian Campbell
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jose4j.keys.resolvers;
import org.jose4j.jwe.JsonWebEncryption;
import org.jose4j.jwx.JsonWebStructure;
import org.jose4j.lang.UnresolvableKeyException;
import java.security.Key;
import java.util.List;
/**
* A callback interface for resolving the key (by looking at headers like "kid", for example) to use to decrypt the JWE.
*/
public interface DecryptionKeyResolver
{
/**
* Choose the key to be used for decryption on the given JWE.
* @param jwe the JsonWebEncryption that's about to be decrypted
* @param nestingContext a list of JOSE objects, if any, in which the JWE was nested.
* The last item in the list is the outer most JOSE object (not including the current JWE).
* @return the decryption key
* @throws UnresolvableKeyException if no appropriate key can be found
*/
Key resolveKey(JsonWebEncryption jwe, List nestingContext) throws UnresolvableKeyException;
}