Package org.apache.sshd.client.auth.pubkey

Interface PublicKeyAuthenticationReporter

public interface PublicKeyAuthenticationReporter
Provides report about the client side public key authentication progress
Author:
Apache MINA SSHD Project
See Also:

  • Method Details

    • signalAuthenticationAttempt

      default void signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature) throws Exception
      Sending the initial request to use public key authentication
      Parameters:
      session - The ClientSession
      service - The requesting service name
      identity - The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
      signature - The type of signature that is being used
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close

    • signalAuthenticationExhausted

      default void signalAuthenticationExhausted(ClientSession session, String service) throws Exception
      Signals end of public key attempts and optionally switching to other authentication methods. Note: neither signalAuthenticationSuccess nor signalAuthenticationFailure are invoked.
      Parameters:
      session - The ClientSession
      service - The requesting service name
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close

    • signalIdentitySkipped

      default void signalIdentitySkipped(ClientSession session, String service, KeyPair identity) throws Exception
      A KeyPair is is present, but is not attempted because no signature factory for it could be found.
      Parameters:
      session - The ClientSession
      service - The requesting service name
      identity - The KeyPair identity being skipped - Note: for agent based authentications the private key may be null
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close

    • signalSignatureAttempt

      default void signalSignatureAttempt(ClientSession session, String service, KeyPair identity, String signature, byte[] signed) throws Exception
      Sending the signed response to the server's challenge
      Parameters:
      session - The ClientSession
      service - The requesting service name
      identity - The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
      signature - The type of signature that is being used
      signed - The generated signature data
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close

    • signalAuthenticationSuccess

      default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) throws Exception
      Parameters:
      session - The ClientSession
      service - The requesting service name
      identity - The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close

    • signalAuthenticationFailure

      default void signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods) throws Exception
      Parameters:
      session - The ClientSession
      service - The requesting service name
      identity - The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
      partial - true if some partial authentication success so far
      serverMethods - The List of authentication methods that can continue
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close