Package 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
Methods inherited from interface org.apache.sshd.common.NamedResource
getNameMethods inherited from interface org.apache.sshd.server.session.ServerSessionHolder
getServerSessionMethods inherited from interface org.apache.sshd.common.auth.UserAuthInstance
getSessionMethods inherited from interface org.apache.sshd.common.auth.UsernameHolder
getUsername
-
Method Details
-
auth
Boolean auth(ServerSession session, String username, String service, Buffer buffer) throws AsyncAuthException, Exception Try to authenticate the user. This methods should return a nonnullvalue indicating if the authentication succeeded. If the authentication is still ongoing, anullvalue should be returned.- Parameters:
session- the currentServerSessionsessionusername- the user trying to log inservice- the requested service namebuffer- the request buffer containing parameters specific to this request- Returns:
trueif the authentication succeeded,falseif the authentication failed andnullif not finished yet- Throws:
AsyncAuthException- if the service is willing to perform an asynchronous authenticationException- if the authentication fails
-
next
Handle another step in the authentication process.- Parameters:
buffer- the request buffer containing parameters specific to this request- Returns:
trueif the authentication succeeded,falseif the authentication failed andnullif not finished yet- Throws:
AsyncAuthException- if the service is willing to perform an asynchronous authenticationException- if the authentication fails
-
destroy
void destroy()Free any system resources used by the module.
-