Package com.sshtools.common.auth

Class KeyboardInteractiveAuthentication<C extends Context>

java.lang.Object

com.sshtools.common.auth.KeyboardInteractiveAuthentication<C>

All Implemented Interfaces:

AuthenticationMechanism

public class KeyboardInteractiveAuthentication<C extends Context>
extends Object
implements AuthenticationMechanism

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATION_METHOD
static final int	SSH_MSG_USERAUTH_INFO_REQUEST
static final int	SSH_MSG_USERAUTH_INFO_RESPONSE

Constructor Summary

Constructors

Constructor	Description
KeyboardInteractiveAuthentication(AbstractServerTransport<C> transport, AbstractAuthenticationProtocol<C> authentication, SshConnection con, KeyboardInteractiveAuthenticationProvider[] providers)

Method Summary

Modifier and Type	Method	Description
String	getMethod()	Return the SSH method name for this authentication.
KeyboardInteractiveProvider	getSelectedProvider()
boolean	processMessage(byte[] msg)	If the SSH protocol authentication method defines additional messages which are sent from the client, they will be passed into your implementation here when received.
boolean	startRequest(String username, byte[] msg)	Start an authentication transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SSH_MSG_USERAUTH_INFO_REQUEST

public static final int SSH_MSG_USERAUTH_INFO_REQUEST

See Also:

• Constant Field Values

SSH_MSG_USERAUTH_INFO_RESPONSE

public static final int SSH_MSG_USERAUTH_INFO_RESPONSE

See Also:

• Constant Field Values

AUTHENTICATION_METHOD

public static final String AUTHENTICATION_METHOD

See Also:

• Constant Field Values

Constructor Details

KeyboardInteractiveAuthentication

public KeyboardInteractiveAuthentication(AbstractServerTransport<C> transport,
 AbstractAuthenticationProtocol<C> authentication,
 SshConnection con,
 KeyboardInteractiveAuthenticationProvider[] providers)

Method Details

getMethod

public String getMethod()

Description copied from interface: AuthenticationMechanism

Return the SSH method name for this authentication. e.g "password"

Specified by:

getMethod in interface AuthenticationMechanism

Returns:

String

processMessage

public boolean processMessage(byte[] msg)
                       throws IOException

Description copied from interface: AuthenticationMechanism

If the SSH protocol authentication method defines additional messages which are sent from the client, they will be passed into your implementation here when received.

Specified by:

processMessage in interface AuthenticationMechanism

Returns:

boolean

Throws:

IOException

startRequest

public boolean startRequest(String username,
 byte[] msg)
                     throws IOException

Description copied from interface: AuthenticationMechanism

Start an authentication transaction. If the authentication mechanism is simple and you can determine the result from all information received in the SSH_MSG_USERAUTH_REQUEST message, you should call the approriate completion methods on the com.maverick.sshd.AuthenticationProtocol instance that was passed in the initialization process. The request data varies according to the authentication method.

 if (success)
        authentication.completedAuthentication(method, username, service);
 else
        authentication.failedAuthentication(method);
 

Specified by:

startRequest in interface AuthenticationMechanism

msg - the request data from the SSH_MSG_USERAUTH_REQUEST message

Returns:

true if the message was processed, otherwise false

Throws:

IOException

getSelectedProvider

public KeyboardInteractiveProvider getSelectedProvider()