org.apache.sshd.server.auth

Class AbstractUserAuth

java.lang.Object

org.apache.sshd.server.auth.AbstractUserAuth

All Implemented Interfaces:

UserAuth

Direct Known Subclasses:

UserAuthGSS, UserAuthKeyboardInteractive, UserAuthNone, UserAuthPassword, UserAuthPublicKey

public abstract class AbstractUserAuth
extends java.lang.Object
implements UserAuth

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log
protected java.lang.String	service
protected ServerSession	session
protected java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
AbstractUserAuth()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	auth(ServerSession session, java.lang.String username, java.lang.String service, Buffer buffer) Try to authenticate the user.
void	destroy() Free any system resources used by the module.
protected abstract java.lang.Boolean	doAuth(Buffer buffer, boolean init)
java.lang.String	getService()
java.lang.String	getUserName() Get a user name which has been derived from the handshaking process, or the initial name if nothing has been found.
java.lang.Boolean	next(Buffer buffer) Handle another step in the authentication process.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

session

protected ServerSession session

service

protected java.lang.String service

username

protected java.lang.String username

Constructor Detail

AbstractUserAuth

public AbstractUserAuth()

Method Detail

getUserName

public java.lang.String getUserName()

Description copied from interface: UserAuth

Get a user name which has been derived from the handshaking process, or the initial name if nothing has been found.

Specified by:

getUserName in interface UserAuth

Returns:

The user name

getService

public java.lang.String getService()

auth

public java.lang.Boolean auth(ServerSession session,
                     java.lang.String username,
                     java.lang.String service,
                     Buffer buffer)
                       throws java.lang.Exception

Description copied from interface: UserAuth

Try to authenticate the user. This methods should return a non null object which is the user identity if the authentication succeeded. If the authentication failed, this method should throw an exception. If the authentication is still ongoing, a null value should be returned.

Specified by:

auth in interface UserAuth

Parameters:

session - the current ssh session

username - the user trying to log in

buffer - the request buffer containing parameters specific to this request

Returns:

true if the authentication succeeded, false if the authentication failed and nullis not finished yet

Throws:

java.lang.Exception - if the authentication fails

next

public java.lang.Boolean next(Buffer buffer)
                       throws java.lang.Exception

Description copied from interface: UserAuth

Handle another step in the authentication process.

Specified by:

next in interface UserAuth

Parameters:

buffer - the request buffer containing parameters specific to this request

Returns:

true if the authentication succeeded, false if the authentication failed and nullis not finished yet

Throws:

java.lang.Exception - if the authentication fails

destroy

public void destroy()

Description copied from interface: UserAuth

Free any system resources used by the module.

Specified by:

destroy in interface UserAuth

doAuth

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

Throws:

java.lang.Exception