Apache Mina SSHD 2.15.0 · org.apache.sshd.client.auth.password.PasswordAuthenticationReporter

Method Summary

Modifier and Type	Method and Description
public default void	signalAuthenticationAttempt(ClientSession The `ClientSession` session, String The requesting service name service, String The password being attempted oldPassword, boolean `true` if this is an attempt due to `SSH_MSG_USERAUTH_PASSWD_CHANGEREQ` modified, String The changed password newPassword)
public default void	signalAuthenticationExhausted(ClientSession The `ClientSession` session, String The requesting service name service) Signals end of passwords 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, String The password that was attempted password, 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, String The password that was attempted password)

Method Detail

signalAuthenticationAttempt back to summary

signalAuthenticationAttempt	back to summary
public default void signalAuthenticationAttempt(ClientSession session, String service, String oldPassword, boolean modified, String newPassword) throws Exception Parameters session:ClientSession The `ClientSession` service:String The requesting service name oldPassword:String The password being attempted modified:boolean `true` if this is an attempt due to `SSH_MSG_USERAUTH_PASSWD_CHANGEREQ` newPassword:String The changed password Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalAuthenticationAttempt(ClientSession session, String service, String oldPassword, boolean modified, String newPassword) throws Exception

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
oldPassword:String: The password being attempted
modified:boolean: true if this is an attempt due to SSH_MSG_USERAUTH_PASSWD_CHANGEREQ
newPassword:String: The changed password

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) throws Exception Signals end of passwords 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 Exceptions Exception: If failed to handle the callback - Note: may cause session close

public 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:ClientSession: The ClientSession
service:String: The requesting service name

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

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
password:String: The password that was attempted
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
public default void signalAuthenticationSuccess(ClientSession session, String service, String password) throws Exception Parameters session:ClientSession The `ClientSession` service:String The requesting service name password:String The password that was attempted Exceptions Exception: If failed to handle the callback - Note: may cause session close

public Interface PasswordAuthenticationReporter

Method Summary

Method Detail