org.apache.sshd.server
Interface UserAuth

All Known Subinterfaces:
HandshakingUserAuth
All Known Implementing Classes:
UserAuthGSS, UserAuthNone, UserAuthPassword, UserAuthPublicKey

public interface UserAuth

Server side authentication mechanism.

Author:
Apache MINA SSHD Project

Method Summary
 Boolean auth(ServerSession session, String username, Buffer buffer)
          Try to authenticate the user.
 

Method Detail

auth

Boolean auth(ServerSession session,
             String username,
             Buffer buffer)
             throws 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 is not finished yet
Throws:
Exception - if the authentication fails


Copyright © 2008-2012 Apache Software Foundation. All Rights Reserved.