org.apache.sshd.server
Interface HandshakingUserAuth

All Superinterfaces:
UserAuth
All Known Implementing Classes:
UserAuthGSS

public interface HandshakingUserAuth
extends UserAuth

Extension of UserAuth for use with methods which require handshakes, such as gssapi-with-mic.

Author:
Apache MINA SSHD Project

Method Summary
 void destroy()
          Free any system resources used by the module.
 String getUserName()
          Get a user name which has been derived from the handshaking process, or the intial name if nothing has been found.
 boolean handles(SshConstants.Message msg)
          Check whether a particular message is handled here.
 Boolean next(ServerSession session, SshConstants.Message msg, Buffer buffer)
          Handle another step in the authentication process.
 void setServiceName(String service)
          Set the service name from the original request.
 
Methods inherited from interface org.apache.sshd.server.UserAuth
auth
 

Method Detail

setServiceName

void setServiceName(String service)
Set the service name from the original request. This may be required for MIC verification later.

Parameters:
service - The service name

handles

boolean handles(SshConstants.Message msg)
Check whether a particular message is handled here.

Parameters:
msg - The message
Returns:
true if the message is handled

next

Boolean next(ServerSession session,
             SshConstants.Message msg,
             Buffer buffer)
             throws Exception
Handle another step in the authentication process.

Parameters:
session - the current ssh session
msg - The message type
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

getUserName

String getUserName()
                   throws Exception
Get a user name which has been derived from the handshaking process, or the intial name if nothing has been found.

Returns:
The user name
Throws:
Exception - if the request fails

destroy

void destroy()
Free any system resources used by the module.



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