All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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

There is a newer version: 9.47
Show newest version
/*
 * nimbus-jose-jwt
 *
 * Copyright 2012-2016, Connect2id Ltd.
 *
 * 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 com.nimbusds.jose.proc;


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

import com.nimbusds.jose.JWEHeader;
import com.nimbusds.jose.KeySourceException;


/**
 * Interface for selecting key candidates for decrypting a JSON Web Encryption
 * (JWE) object. Applications should utilise this interface or a similar
 * framework to determine whether a received JWE object (or encrypted JWT) is
 * eligible for {@link com.nimbusds.jose.JWEDecrypter decryption} and further 
 * processing.
 *
 * 

The interface supports keys selection based on: * *

    *
  • Recognised header parameters referencing the key (e.g. {@code kid}, * {@code x5t}). *
  • Additional {@link SecurityContext}, if required and set by the * application (e.g. endpoint where the JWE object was received). *
* *

See JSON Web Signature (JWE), Appendix D. Notes on Key Selection for * suggestions. * *

Possible key types: * *

    *
  • {@link javax.crypto.SecretKey} for AES keys. *
  • {@link java.security.interfaces.RSAPrivateKey} private RSA keys. *
  • {@link java.security.interfaces.ECPrivateKey} private EC keys. *
* * @author Vladimir Dzhuvinov * @version 2016-06-21 */ public interface JWEKeySelector { /** * Selects key candidates for decrypting a JWE object. * * @param header The header of the JWE object. Must not be * {@code null}. * @param context Optional context, {@code null} if not required. * * @return The key candidates in trial order, empty list if none. * * @throws KeySourceException If a key source exception is encountered, * e.g. on remote JWK retrieval. */ List selectJWEKeys(final JWEHeader header, final C context) throws KeySourceException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy