| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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.apache.nifi.security.kms; |
| |
| import java.security.KeyManagementException; |
| import java.util.List; |
| import javax.crypto.SecretKey; |
| |
| public interface KeyProvider { |
| /** |
| * Returns the key identified by this ID or throws an exception if one is not available. |
| * |
| * @param keyId the key identifier |
| * @return the key |
| * @throws KeyManagementException if the key cannot be retrieved |
| */ |
| SecretKey getKey(String keyId) throws KeyManagementException; |
| |
| /** |
| * Returns true if the key exists and is available. Null or empty IDs will return false. |
| * |
| * @param keyId the key identifier |
| * @return true if the key can be used |
| */ |
| boolean keyExists(String keyId); |
| |
| /** |
| * Returns a list of available key identifiers (useful for encryption, as retired keys may not be listed here even if they are available for decryption for legacy/BC reasons). |
| * |
| * @return a List of keyIds (empty list if none are available) |
| */ |
| List<String> getAvailableKeyIds(); |
| } |