org.apache.sshd.server.auth

Interface UserAuth

All Superinterfaces:

NamedResource, ServerSessionHolder, UserAuthInstance<ServerSession>, UsernameHolder

All Known Implementing Classes:

AbstractUserAuth, UserAuthGSS, UserAuthHostBased, UserAuthKeyboardInteractive, UserAuthNone, UserAuthPassword, UserAuthPublicKey

public interface UserAuth
extends ServerSessionHolder, UserAuthInstance<ServerSession>, UsernameHolder

Server side authentication mechanism.

Field Summary

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

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.Boolean	next(Buffer buffer) Handle another step in the authentication process.

Methods inherited from interface org.apache.sshd.server.session.ServerSessionHolder

getServerSession

Methods inherited from interface org.apache.sshd.common.auth.UserAuthInstance

getSession

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

findByName, getName, getNameList, getNames, ofName, removeByName

Methods inherited from interface org.apache.sshd.common.auth.UsernameHolder

getUsername

Method Detail

auth

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

Try to authenticate the user. This methods should return a non null value indicating if the authentication succeeded. If the authentication is still ongoing, a null value should be returned.

Parameters:

session - the current ServerSession 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:

AsyncAuthException - if the service is willing to perform an asynchronous authentication

java.lang.Exception - if the authentication fails

next

java.lang.Boolean next(Buffer buffer)
                throws AsyncAuthException,
                       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 null if not finished yet

Throws:

AsyncAuthException - if the service is willing to perform an asynchronous authentication

java.lang.Exception - if the authentication fails

destroy

void destroy()

Free any system resources used by the module.