/*
* 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.client.config.keys;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.security.KeyPair;
/**
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
@FunctionalInterface
public interface ClientIdentityProvider {
/**
* Provides a {@link KeyPair} representing the client identity
*
* @return The client identity - may be {@code null} if no currently
* available identity from this provider. <B>Note:</B> the provider
* may return a <U>different</U> value every time this method is called
* - e.g., if it is (re-)loading contents from a file.
* @throws IOException If failed to load the identity
* @throws GeneralSecurityException If failed to parse the identity
*/
KeyPair getClientIdentity() throws IOException, GeneralSecurityException;
}