nifi-commons/nifi-security-kms/src/main/java/org/apache/nifi/security/kms/reader/FileBasedKeyReader.java

/*
 * 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.reader;

import javax.crypto.SecretKey;
import java.nio.file.Path;
import java.util.Map;

/**
 * File Based Key Reader
 */
public interface FileBasedKeyReader {
    /**
     * Read Secret Keys from File Path and decrypt using provided Root Key
     *
     * @param path File Path
     * @param rootKey Root Key
     * @return Map of Key Identifier to Secret key
     */
    Map<String, SecretKey> readSecretKeys(Path path, SecretKey rootKey);
}