Package org.apache.sshd.server.auth.password

Class UserAuthPassword

java.lang.Object

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

org.apache.sshd.server.auth.AbstractUserAuth

org.apache.sshd.server.auth.password.UserAuthPassword

All Implemented Interfaces:

UserAuthInstance<ServerSession>, UsernameHolder, NamedResource, UserAuth, ServerSessionHolder

public class UserAuthPassword
extends AbstractUserAuth

Implements the server-side "password" authentication mechanism

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

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	Description
UserAuthPassword()

Method Summary

Modifier and Type	Method	Description
protected java.lang.Boolean	checkPassword(Buffer buffer, ServerSession session, java.lang.String username, java.lang.String password)	Invokes the configured PasswordAuthenticator and returns the result.
java.lang.Boolean	doAuth(Buffer buffer, boolean init)
protected java.lang.Boolean	handleClientPasswordChangeRequest(Buffer buffer, ServerSession session, java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword)	Invoked when the client sends a SSH_MSG_USERAUTH_REQUEST indicating a password change.
protected java.lang.Boolean	handleServerPasswordChangeRequest(Buffer buffer, ServerSession session, java.lang.String username, java.lang.String password, PasswordChangeRequiredException e)	Invoked by checkPassword(Buffer, ServerSession, String, String) when a PasswordChangeRequiredException was thrown by the authenticator.

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

auth, destroy, getName, getServerSession, getService, getSession, getUsername, next, toString

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

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

UserAuthPassword

public UserAuthPassword()

Method Detail

doAuth

public java.lang.Boolean doAuth(Buffer buffer,
                                boolean init)
                         throws java.lang.Exception

Specified by:

doAuth in class AbstractUserAuth

Throws:

java.lang.Exception

checkPassword

protected java.lang.Boolean checkPassword(Buffer buffer,
                                          ServerSession session,
                                          java.lang.String username,
                                          java.lang.String password)
                                   throws java.lang.Exception

Invokes the configured PasswordAuthenticator and returns the result. If PasswordChangeRequiredException thrown by the authenticator then handleServerPasswordChangeRequest(Buffer, ServerSession, String, String, PasswordChangeRequiredException) is invoked

Parameters:

buffer - The received Buffer to be re-used if need to send a password change request

session - The ServerSession through which the request was received

username - The username

password - The password

Returns:

The authentication result - if null then exception was handled internally and authentication is still in progress

Throws:

java.lang.Exception - If internal error during authentication (exception for PasswordChangeRequiredException which is handled internally)

See Also:

handleServerPasswordChangeRequest(Buffer, ServerSession, String, String, PasswordChangeRequiredException)

handleClientPasswordChangeRequest

protected java.lang.Boolean handleClientPasswordChangeRequest(Buffer buffer,
                                                              ServerSession session,
                                                              java.lang.String username,
                                                              java.lang.String oldPassword,
                                                              java.lang.String newPassword)
                                                       throws java.lang.Exception

Invoked when the client sends a SSH_MSG_USERAUTH_REQUEST indicating a password change. Throws UnsupportedOperationException by default

Parameters:

buffer - The Buffer to re-use in order to respond

session - The associated ServerSession

username - The username

oldPassword - The old password

newPassword - The new password

Returns:

Password change and authentication result - null means authentication incomplete - i.e., handler has sent some extra query.

Throws:

java.lang.Exception - If failed to handle the request.

handleServerPasswordChangeRequest

protected java.lang.Boolean handleServerPasswordChangeRequest(Buffer buffer,
                                                              ServerSession session,
                                                              java.lang.String username,
                                                              java.lang.String password,
                                                              PasswordChangeRequiredException e)
                                                       throws java.lang.Exception

Invoked by checkPassword(Buffer, ServerSession, String, String) when a PasswordChangeRequiredException was thrown by the authenticator. By default it re-throws the original exception.

Parameters:

buffer - The received Buffer to be re-used if need to send a password change request

session - The ServerSession through which the request was received

username - The username

password - The (rejected) password

e - The original thrown exception

Returns:

null by default to indicate incomplete authentication

Throws:

java.lang.Exception - If failed to dispatch the message