/*
* 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.sshd.common.config.keys;
import java.io.IOException;
/**
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
@FunctionalInterface
public interface FilePasswordProvider {
/**
* An "empty" provider that returns {@code null} - i.e., unprotected key file
*/
FilePasswordProvider EMPTY = resourceKey -> null;
/**
* @param resourceKey The resource key representing the <U>private</U>
* file
* @return The password - if {@code null}/empty then no password is required
* @throws IOException if cannot resolve password
*/
String getPassword(String resourceKey) throws IOException;
}