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

Modifier and Type	Field and Description
private String	current
private int	maxAttempts
public static final String	NAME
private int	nOfAttempts
private Iterator<String>	passwords

Access	Constructor and Description
public	UserAuthPassword()

Method Summary

Modifier and Type	Method and Description
public void	init(ClientSession The `ClientSession` session, String The requesting service name service) Overrides org.apache.sshd.client.auth.AbstractUserAuth.init. Implements org.apache.sshd.client.auth.UserAuth.init.
protected boolean	processAuthDataRequest(ClientSession session, String service, Buffer buffer) Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.
protected String	resolveAttemptedPassword(ClientSession session, String service)
protected boolean	sendAuthDataRequest(ClientSession session, String service) Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.
protected IoWriteFuture	Returns: An `IoWriteFuture` that can be used to wait and check on the success/failure of the request packet being sent sendPassword(Buffer The `Buffer` to re-use for sending the message buffer, ClientSession The target `ClientSession` session, String The previous password oldPassword, String The new password newPassword) Sends the password via a `SSH_MSG_USERAUTH_REQUEST` message.
public void	signalAuthMethodFailure(ClientSession The `ClientSession` session, String The requesting service name service, boolean `true` if some partial authentication success so far partial, List<String> The `List` of authentication methods that can continue serverMethods, Buffer The `Buffer` containing the failure message (after having consumed the relevant data from it) buffer) Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure. Signals reception of `SSH_MSG_USERAUTH_FAILURE` message
public void	signalAuthMethodSuccess(ClientSession The `ClientSession` session, String The requesting service name service, Buffer The `Buffer` containing the success message (after having consumed the relevant data from it) buffer) Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess. Signal reception of `SSH_MSG_USERAUTH_SUCCESS` message

Inherited from org.apache.sshd.client.auth.AbstractUserAuth:: destroy getClientSession getName getService getSession isCancellable process setCancellable toString

current	back to summary
private String current

maxAttempts	back to summary
private int maxAttempts

NAME	back to summary
public static final String NAME

nOfAttempts	back to summary
private int nOfAttempts

passwords	back to summary
private Iterator<String> passwords

UserAuthPassword	back to summary
public UserAuthPassword()

Method Detail

init back to summary

init	back to summary
public void init(ClientSession session, String service) throws Exception Overrides org.apache.sshd.client.auth.AbstractUserAuth.init. Implements org.apache.sshd.client.auth.UserAuth.init. Parameters session:ClientSession Doc from org.apache.sshd.client.auth.UserAuth.init. The `ClientSession` service:String Doc from org.apache.sshd.client.auth.UserAuth.init. The requesting service name Annotations @Override Exceptions Exception: Doc from org.apache.sshd.client.auth.UserAuth.init. If failed to initialize the mechanism

public void init(ClientSession session, String service) throws Exception

Overrides org.apache.sshd.client.auth.AbstractUserAuth.init.

Implements org.apache.sshd.client.auth.UserAuth.init.

Parameters

session:ClientSession

Doc from org.apache.sshd.client.auth.UserAuth.init.

The ClientSession

service:String

Doc from org.apache.sshd.client.auth.UserAuth.init.

The requesting service name

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.sshd.client.auth.UserAuth.init.

If failed to initialize the mechanism

processAuthDataRequest	back to summary
protected boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest. Annotations @Override

processAuthDataRequest

back to summary

protected boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.

Annotations

@Override

resolveAttemptedPassword	back to summary
protected String resolveAttemptedPassword(ClientSession session, String service) throws Exception

sendAuthDataRequest	back to summary
protected boolean sendAuthDataRequest(ClientSession session, String service) throws Exception Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest. Annotations @Override

sendAuthDataRequest

back to summary

protected boolean sendAuthDataRequest(ClientSession session, String service) throws Exception

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.

Annotations

@Override

sendPassword back to summary

sendPassword	back to summary
protected IoWriteFuture sendPassword(Buffer buffer, ClientSession session, String oldPassword, String newPassword) throws Exception Sends the password via a `SSH_MSG_USERAUTH_REQUEST` message. If old and new password are not the same then it requests a password modification from the server (which may be denied if the server does not support this feature). Parameters buffer:Buffer The `Buffer` to re-use for sending the message session:ClientSession The target `ClientSession` oldPassword:String The previous password newPassword:String The new password Returns:IoWriteFuture An `IoWriteFuture` that can be used to wait and check on the success/failure of the request packet being sent Exceptions Exception: If failed to send the message.

protected IoWriteFuture sendPassword(Buffer buffer, ClientSession session, String oldPassword, String newPassword) throws Exception

Sends the password via a SSH_MSG_USERAUTH_REQUEST message. If old and new password are not the same then it requests a password modification from the server (which may be denied if the server does not support this feature).

Parameters

buffer:Buffer: The Buffer to re-use for sending the message
session:ClientSession: The target ClientSession
oldPassword:String: The previous password
newPassword:String: The new password

Returns:IoWriteFuture

An IoWriteFuture that can be used to wait and check on the success/failure of the request packet being sent

Exceptions

Exception:: If failed to send the message.

signalAuthMethodFailure back to summary

signalAuthMethodFailure	back to summary
public void signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) throws Exception Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure. Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure. Signals reception of `SSH_MSG_USERAUTH_FAILURE` message Parameters session:ClientSession The `ClientSession` service:String The requesting service name partial:boolean `true` if some partial authentication success so far serverMethods:List<String> The `List` of authentication methods that can continue buffer:Buffer The `Buffer` containing the failure message (after having consumed the relevant data from it) Annotations @Override Exceptions Exception: If failed to handle the callback - Note: may cause session close

public void signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) throws Exception

Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure.

Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure.

Signals reception of SSH_MSG_USERAUTH_FAILURE message

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
partial:boolean: true if some partial authentication success so far
serverMethods:List<String>: The List of authentication methods that can continue
buffer:Buffer: The Buffer containing the failure message (after having consumed the relevant data from it)

Annotations

@Override

Exceptions

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

signalAuthMethodSuccess back to summary

signalAuthMethodSuccess	back to summary
public void signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) throws Exception Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess. Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess. Signal reception of `SSH_MSG_USERAUTH_SUCCESS` message Parameters session:ClientSession The `ClientSession` service:String The requesting service name buffer:Buffer The `Buffer` containing the success message (after having consumed the relevant data from it) Annotations @Override Exceptions Exception: If failed to handle the callback - Note: may cause session close

public void signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) throws Exception

Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess.

Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess.

Signal reception of SSH_MSG_USERAUTH_SUCCESS message

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
buffer:Buffer: The Buffer containing the success message (after having consumed the relevant data from it)

Annotations

@Override

Exceptions

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

public Class UserAuthPassword

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail