Interface HostBasedAuthenticationReporter


  • public interface HostBasedAuthenticationReporter
    Provides report about the client side host-based authentication progress
    See Also:
    RFC-4252 section 9
    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default void signalAuthenticationAttempt​(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String hostname, java.lang.String username, byte[] signature)
      Sending the initial request to use host based authentication
      default void signalAuthenticationExhausted​(ClientSession session, java.lang.String service, java.lang.String hostname, java.lang.String username)
      Signals end of host based attempts and optionally switching to other authentication methods.
      default void signalAuthenticationFailure​(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String hostname, java.lang.String username, boolean partial, java.util.List<java.lang.String> serverMethods)  
      default void signalAuthenticationSuccess​(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String hostname, java.lang.String username)  
    • Method Detail

      • signalAuthenticationAttempt

        default void signalAuthenticationAttempt​(ClientSession session,
                                                 java.lang.String service,
                                                 java.security.KeyPair identity,
                                                 java.lang.String hostname,
                                                 java.lang.String username,
                                                 byte[] signature)
                                          throws java.lang.Exception
        Sending the initial request to use host based authentication
        Parameters:
        session - The ClientSession
        service - The requesting service name
        identity - The KeyPair identity being attempted
        hostname - The host name value sent to the server
        username - The username value sent to the server
        signature - The signature data that is being sent to the server
        Throws:
        java.lang.Exception - If failed to handle the callback - Note: may cause session close
      • signalAuthenticationExhausted

        default void signalAuthenticationExhausted​(ClientSession session,
                                                   java.lang.String service,
                                                   java.lang.String hostname,
                                                   java.lang.String username)
                                            throws java.lang.Exception
        Signals end of host based attempts and optionally switching to other authentication methods. Note: neither signalAuthenticationSuccess nor signalAuthenticationFailure are invoked.
        Parameters:
        session - The ClientSession
        service - The requesting service name
        hostname - The host name value sent to the server
        username - The username value sent to the server
        Throws:
        java.lang.Exception - If failed to handle the callback - Note: may cause session close
      • signalAuthenticationSuccess

        default void signalAuthenticationSuccess​(ClientSession session,
                                                 java.lang.String service,
                                                 java.security.KeyPair identity,
                                                 java.lang.String hostname,
                                                 java.lang.String username)
                                          throws java.lang.Exception
        Parameters:
        session - The ClientSession
        service - The requesting service name
        identity - The KeyPair identity being attempted
        hostname - The host name value sent to the server
        username - The username value sent to the server
        Throws:
        java.lang.Exception - If failed to handle the callback - Note: may cause session close
      • signalAuthenticationFailure

        default void signalAuthenticationFailure​(ClientSession session,
                                                 java.lang.String service,
                                                 java.security.KeyPair identity,
                                                 java.lang.String hostname,
                                                 java.lang.String username,
                                                 boolean partial,
                                                 java.util.List<java.lang.String> serverMethods)
                                          throws java.lang.Exception
        Parameters:
        session - The ClientSession
        service - The requesting service name
        identity - The KeyPair identity being attempted
        hostname - The host name value sent to the server
        username - The username value sent to the server
        partial - true if some partial authentication success so far
        serverMethods - The List of authentication methods that can continue
        Throws:
        java.lang.Exception - If failed to handle the callback - Note: may cause session close