org.apache.sshd.client.auth.pubkey.PublicKeyAuthenticationReporter Maven / Gradle / Ivy
/*
* 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.auth.pubkey;
import java.security.KeyPair;
import java.util.List;
import org.apache.sshd.client.session.ClientSession;
/**
* Provides report about the client side public key authentication progress
*
* @see RFC-4252 section 7
* @author Apache MINA SSHD Project
*/
public interface PublicKeyAuthenticationReporter {
/**
* Sending the initial request to use public key authentication
*
* @param session The {@link ClientSession}
* @param service The requesting service name
* @param identity The {@link KeyPair} identity being attempted - Note: for agent based authentications the
* private key may be {@code null}
* @param signature The type of signature that is being used
* @throws Exception If failed to handle the callback - Note: may cause session close
*/
default void signalAuthenticationAttempt(
ClientSession session, String service, KeyPair identity, String signature)
throws Exception {
// ignored
}
/**
* Signals end of public key attempts and optionally switching to other authentication methods. Note: neither
* {@link #signalAuthenticationSuccess(ClientSession, String, KeyPair) signalAuthenticationSuccess} nor
* {@link #signalAuthenticationFailure(ClientSession, String, KeyPair, boolean, List) signalAuthenticationFailure}
* are invoked.
*
* @param session The {@link ClientSession}
* @param service The requesting service name
* @throws Exception If failed to handle the callback - Note: may cause session close
*/
default void signalAuthenticationExhausted(ClientSession session, String service) throws Exception {
// ignored
}
/**
* A {@link KeyPair} is is present, but is not attempted because no signature factory for it could be found.
*
* @param session The {@link ClientSession}
* @param service The requesting service name
* @param identity The {@link KeyPair} identity being skipped - Note: for agent based authentications the
* private key may be {@code null}
* @throws Exception If failed to handle the callback - Note: may cause session close
*/
default void signalIdentitySkipped(ClientSession session, String service, KeyPair identity) throws Exception {
// ignored
}
/**
* Sending the signed response to the server's challenge
*
* @param session The {@link ClientSession}
* @param service The requesting service name
* @param identity The {@link KeyPair} identity being attempted - Note: for agent based authentications the
* private key may be {@code null}
* @param signature The type of signature that is being used
* @param signed The generated signature data
* @throws Exception If failed to handle the callback - Note: may cause session close
*/
default void signalSignatureAttempt(
ClientSession session, String service, KeyPair identity, String signature, byte[] signed)
throws Exception {
// ignored
}
/**
* @param session The {@link ClientSession}
* @param service The requesting service name
* @param identity The {@link KeyPair} identity being attempted - Note: for agent based authentications the
* private key may be {@code null}
* @throws Exception If failed to handle the callback - Note: may cause session close
*/
default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) throws Exception {
// ignored
}
/**
* @param session The {@link ClientSession}
* @param service The requesting service name
* @param identity The {@link KeyPair} identity being attempted - Note: for agent based authentications
* the private key may be {@code null}
* @param partial {@code true} if some partial authentication success so far
* @param serverMethods The {@link List} of authentication methods that can continue
* @throws Exception If failed to handle the callback - Note: may cause session close
*/
default void signalAuthenticationFailure(
ClientSession session, String service, KeyPair identity, boolean partial, List serverMethods)
throws Exception {
// ignored
}
}