org.apache.sshd.server.auth

Class AbstractUserAuth

java.lang.Object

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

org.apache.sshd.server.auth.AbstractUserAuth

All Implemented Interfaces:

UserAuth

Direct Known Subclasses:

UserAuthGSS, UserAuthKeyboardInteractive, UserAuthNone, UserAuthPassword, UserAuthPublicKey

public abstract class AbstractUserAuth
extends AbstractLoggingBean
implements UserAuth

Field Summary

Fields

Modifier and Type	Field and Description
protected String	service
protected ServerSession	session
protected String	username

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

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUserAuth()

Method Summary

Modifier and Type	Method and Description
Boolean	auth(ServerSession session, String username, String service, Buffer buffer) Try to authenticate the user.
void	destroy() Free any system resources used by the module.
protected abstract Boolean	doAuth(Buffer buffer, boolean init)
String	getService()
String	getUserName() Get a user name which has been derived from the handshaking process, or the initial name if nothing has been found.
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

session

protected ServerSession session

service

protected String service

username

protected String username

Constructor Detail

AbstractUserAuth

protected AbstractUserAuth()

Method Detail

getUserName

public 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 String getService()

auth

public Boolean auth(ServerSession session,
                    String username,
                    String service,
                    Buffer buffer)
             throws 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

service - the requested service name

buffer - the request buffer containing parameters specific to this request

Returns:

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

Throws:

Exception - if the authentication fails

next

public Boolean next(Buffer buffer)
             throws 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 null if not finished yet

Throws:

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 Boolean doAuth(Buffer buffer,
                                  boolean init)
                           throws Exception

Throws:

Exception