org.apache.sshd.server

Interface UserAuth

All Known Implementing Classes:

AbstractUserAuth, UserAuthGSS, UserAuthKeyboardInteractive, UserAuthNone, UserAuthPassword, UserAuthPublicKey

public interface UserAuth

Server side authentication mechanism.

Author:

Apache MINA SSHD Project

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.
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.

Method Detail

auth

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

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.

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

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

Handle another step in the authentication process.

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

getUserName

java.lang.String getUserName()
                             throws java.lang.Exception

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

Returns:

The user name

Throws:

java.lang.Exception - if the request fails

destroy

void destroy()

Free any system resources used by the module.