ch.ethz.ssh2

Interface ServerAuthenticationCallback

public interface ServerAuthenticationCallback

A callback used during the authentication phase (see RFC 4252) when implementing a SSH server.

Version:

2.50, 03/15/10

Author:

Christian Plattner

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD_HOSTBASED The method name for host-based authentication.
static String	METHOD_PASSWORD The method name for password authentication.
static String	METHOD_PUBLICKEY The method name for public-key authentication.

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationResult	authenticateWithNone(ServerConnection sc, String username) Typically, this will be called be the client to get the list of authentication methods that can continue.
AuthenticationResult	authenticateWithPassword(ServerConnection sc, String username, String password)
AuthenticationResult	authenticateWithPublicKey(ServerConnection sc, String username, String algorithm, byte[] publickey, byte[] signature) NOTE: Not implemented yet.
String[]	getRemainingAuthMethods(ServerConnection sc) Return the authentication methods that are currently available to the client.
String	initAuthentication(ServerConnection sc) Called when the client enters authentication.

Field Detail

METHOD_HOSTBASED

static final String METHOD_HOSTBASED

The method name for host-based authentication.

See Also:

Constant Field Values

METHOD_PUBLICKEY

static final String METHOD_PUBLICKEY

The method name for public-key authentication.

See Also:

Constant Field Values

METHOD_PASSWORD

static final String METHOD_PASSWORD

The method name for password authentication.

See Also:

Constant Field Values

Method Detail

initAuthentication

String initAuthentication(ServerConnection sc)

Called when the client enters authentication. This gives you the chance to set a custom authentication banner for this SSH-2 session. This is the first method called in this interface. It will only called at most once per ServerConnection.

Parameters:

sc - The corresponding ServerConnection

Returns:

The authentication banner or NULL in case no banner should be send.

getRemainingAuthMethods

String[] getRemainingAuthMethods(ServerConnection sc)

Return the authentication methods that are currently available to the client. Be prepared to return this information at any time during the authentication procedure.

The returned name-list of 'method names' (see RFC4252) indicate the authentication methods that may productively continue the authentication dialog.

It is RECOMMENDED that servers only include those 'method name' values in the name-list that are actually useful. However, it is not illegal to include 'method name' values that cannot be used to authenticate the user.

Already successfully completed authentications SHOULD NOT be included in the name-list, unless they should be performed again for some reason.

Parameters:

sc -

Returns:

A list of method names.

See Also:

METHOD_HOSTBASED, METHOD_PASSWORD, METHOD_PUBLICKEY

authenticateWithNone

AuthenticationResult authenticateWithNone(ServerConnection sc,
                                        String username)

Typically, this will be called be the client to get the list of authentication methods that can continue. You should simply return AuthenticationResult.FAILURE.

Parameters:

sc -

username - Name of the user that wants to log in with the "none" method.

Returns:

authenticateWithPassword

AuthenticationResult authenticateWithPassword(ServerConnection sc,
                                            String username,
                                            String password)

authenticateWithPublicKey

AuthenticationResult authenticateWithPublicKey(ServerConnection sc,
                                             String username,
                                             String algorithm,
                                             byte[] publickey,
                                             byte[] signature)

NOTE: Not implemented yet.

Parameters:

sc -

username -

algorithm -

publickey -

signature -

Returns: