org.apache.sshd.client.auth.password

Class UserAuthPassword

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.auth.AbstractUserAuth

org.apache.sshd.client.auth.password.UserAuthPassword

All Implemented Interfaces:

UserAuth, ClientSessionHolder, UserAuthInstance<ClientSession>, NamedResource

public class UserAuthPassword
extends AbstractUserAuth

Implements the client-side "password" authentication mechanism

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	current
static java.lang.String	NAME
private java.util.Iterator<java.lang.String>	passwords

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Constructor and Description
UserAuthPassword()

Method Summary

Modifier and Type	Method and Description
void	init(ClientSession session, java.lang.String service)
protected boolean	processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected boolean	sendAuthDataRequest(ClientSession session, java.lang.String service)
protected IoWriteFuture	sendPassword(Buffer buffer, ClientSession session, java.lang.String oldPassword, java.lang.String newPassword) Sends the password via a SSH_MSG_USERAUTH_REQUEST message.

Methods inherited from class org.apache.sshd.client.auth.AbstractUserAuth

destroy, getClientSession, getName, getService, getSession, process, toString

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, getNameList, getNames, ofName, removeByName

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

passwords

private java.util.Iterator<java.lang.String> passwords

current

private java.lang.String current

Constructor Detail

UserAuthPassword

public UserAuthPassword()

Method Detail

init

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

Specified by:

init in interface UserAuth

Overrides:

init in class AbstractUserAuth

Parameters:

session - The ClientSession

service - The requesting service name

Throws:

java.lang.Exception - If failed to initialize the mechanism

sendAuthDataRequest

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

Specified by:

sendAuthDataRequest in class AbstractUserAuth

Throws:

java.lang.Exception

processAuthDataRequest

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

Specified by:

processAuthDataRequest in class AbstractUserAuth

Throws:

java.lang.Exception

sendPassword

protected IoWriteFuture sendPassword(Buffer buffer,
                                     ClientSession session,
                                     java.lang.String oldPassword,
                                     java.lang.String newPassword)
                              throws java.io.IOException

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 - The Buffer to re-use for sending the message

session - The target ClientSession

oldPassword - The previous password

newPassword - The new password

Returns:

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

Throws:

java.io.IOException - If failed to send the message.