Apache Mina SSHD 2.15.0 · org.apache.sshd.client.auth.hostbased.HostBasedAuthenticationReporter

Method Summary

Modifier and Type	Method and Description
public default void	signalAuthenticationAttempt(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted identity, String The host name value sent to the server hostname, String The username value sent to the server username, byte[] The signature data that is being sent to the server signature) Sending the initial request to use host based authentication
public default void	signalAuthenticationExhausted(ClientSession The `ClientSession` session, String The requesting service name service, String The host name value sent to the server hostname, String The username value sent to the server username) Signals end of host based attempts and optionally switching to other authentication methods Note neither `signalAuthenticationSuccess` nor `signalAuthenticationFailure` are invoked.
public default void	signalAuthenticationFailure(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted identity, String The host name value sent to the server hostname, String The username value sent to the server username, boolean `true` if some partial authentication success so far partial, List<String> The `List` of authentication methods that can continue serverMethods)
public default void	signalAuthenticationSuccess(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted identity, String The host name value sent to the server hostname, String The username value sent to the server username)

Method Detail

signalAuthenticationAttempt back to summary

signalAuthenticationAttempt	back to summary
public 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:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being attempted hostname:String The host name value sent to the server username:String The username value sent to the server signature:byte[] The signature data that is being sent to the server Exceptions Exception: If failed to handle the callback - Note: may cause session close

public 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:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted
hostname:String: The host name value sent to the server
username:String: The username value sent to the server
signature:byte[]: The signature data that is being sent to the server

Exceptions

Exception:: If failed to handle the callback - Note: may cause session close

signalAuthenticationExhausted back to summary

signalAuthenticationExhausted	back to summary
public 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 neither `signalAuthenticationSuccess` nor `signalAuthenticationFailure` are invoked. Parameters session:ClientSession The `ClientSession` service:String The requesting service name hostname:String The host name value sent to the server username:String The username value sent to the server Exceptions Exception: If failed to handle the callback - Note: may cause session close

public 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

neither signalAuthenticationSuccess nor signalAuthenticationFailure are invoked.

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
hostname:String: The host name value sent to the server
username:String: The username value sent to the server

Exceptions

Exception:: If failed to handle the callback - Note: may cause session close

signalAuthenticationFailure back to summary

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

public default void signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, String hostname, String username, boolean partial, List<String> serverMethods) throws Exception

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted
hostname:String: The host name value sent to the server
username:String: The username value sent to the server
partial:boolean: true if some partial authentication success so far
serverMethods:List<String>: The List of authentication methods that can continue

Exceptions

Exception:: If failed to handle the callback - Note: may cause session close

signalAuthenticationSuccess back to summary

signalAuthenticationSuccess	back to summary
public default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity, String hostname, String username) throws Exception Parameters session:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being attempted hostname:String The host name value sent to the server username:String The username value sent to the server Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity, String hostname, String username) throws Exception

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted
hostname:String: The host name value sent to the server
username:String: The username value sent to the server

Exceptions

Exception:: If failed to handle the callback - Note: may cause session close

public Interface HostBasedAuthenticationReporter

Method Summary

Method Detail