Interface HostBasedAuthenticationReporter
public interface HostBasedAuthenticationReporter
Provides report about the client side host-based authentication progress
- Author:
- Apache MINA SSHD Project
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
signalAuthenticationAttempt
(ClientSession session, String service, KeyPair identity, String hostname, String username, byte[] signature) Sending the initial request to use host based authenticationdefault void
signalAuthenticationExhausted
(ClientSession session, String service, String hostname, String username) Signals end of host based attempts and optionally switching to other authentication methods.default void
signalAuthenticationFailure
(ClientSession session, String service, KeyPair identity, String hostname, String username, boolean partial, List<String> serverMethods) default void
signalAuthenticationSuccess
(ClientSession session, String service, KeyPair identity, String hostname, String username)
-
Method Details
-
signalAuthenticationAttempt
default void signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String hostname, String username, byte[] signature) throws Exception Sending the initial request to use host based authentication- Parameters:
session
- TheClientSession
service
- The requesting service nameidentity
- TheKeyPair
identity being attemptedhostname
- The host name value sent to the serverusername
- The username value sent to the serversignature
- The signature data that is being sent to the server- Throws:
Exception
- If failed to handle the callback - Note: may cause session close
-
signalAuthenticationExhausted
default void signalAuthenticationExhausted(ClientSession session, String service, String hostname, String username) throws Exception Signals end of host based attempts and optionally switching to other authentication methods. Note: neithersignalAuthenticationSuccess
norsignalAuthenticationFailure
are invoked.- Parameters:
session
- TheClientSession
service
- The requesting service namehostname
- The host name value sent to the serverusername
- The username value sent to the server- Throws:
Exception
- If failed to handle the callback - Note: may cause session close
-
signalAuthenticationSuccess
default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity, String hostname, String username) throws Exception - Parameters:
session
- TheClientSession
service
- The requesting service nameidentity
- TheKeyPair
identity being attemptedhostname
- The host name value sent to the serverusername
- The username value sent to the server- Throws:
Exception
- If failed to handle the callback - Note: may cause session close
-
signalAuthenticationFailure
default void signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, String hostname, String username, boolean partial, List<String> serverMethods) throws Exception - Parameters:
session
- TheClientSession
service
- The requesting service nameidentity
- TheKeyPair
identity being attemptedhostname
- The host name value sent to the serverusername
- The username value sent to the serverpartial
-true
if some partial authentication success so farserverMethods
- TheList
of authentication methods that can continue- Throws:
Exception
- If failed to handle the callback - Note: may cause session close
-