Package org.apache.sshd.client.auth.password

Interface PasswordAuthenticationReporter

public interface PasswordAuthenticationReporter
Used to inform the about the progress of a password authentication
Author:
Apache MINA SSHD Project
See Also:

  • Method Details

    • signalAuthenticationAttempt

      default void signalAuthenticationAttempt(ClientSession session, String service, String oldPassword, boolean modified, String newPassword) throws Exception
      Parameters:
      session - The ClientSession
      service - The requesting service name
      oldPassword - The password being attempted
      modified - true if this is an attempt due to SSH_MSG_USERAUTH_PASSWD_CHANGEREQ
      newPassword - The changed password
      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 passwords 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

    • signalAuthenticationSuccess

      default void signalAuthenticationSuccess(ClientSession session, String service, String password) throws Exception
      Parameters:
      session - The ClientSession
      service - The requesting service name
      password - The password that was attempted
      Throws:
      Exception - If failed to handle the callback - Note: may cause session close

    • signalAuthenticationFailure

      default void signalAuthenticationFailure(ClientSession session, String service, String password, boolean partial, List<String> serverMethods) throws Exception
      Parameters:
      session - The ClientSession
      service - The requesting service name
      password - The password that was attempted
      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