Package org.apache.sshd.server.auth.keyboard

Class DefaultKeyboardInteractiveAuthenticator

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.auth.keyboard.DefaultKeyboardInteractiveAuthenticator

All Implemented Interfaces:

KeyboardInteractiveAuthenticator

public class DefaultKeyboardInteractiveAuthenticator
extends AbstractLoggingBean
implements KeyboardInteractiveAuthenticator

Provides a default implementation for KeyboardInteractiveAuthenticator where it prompts for the password.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
static DefaultKeyboardInteractiveAuthenticator	INSTANCE

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator

NONE

Constructor Summary

Constructors

Constructor	Description
DefaultKeyboardInteractiveAuthenticator()

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(ServerSession session, String username, List<String> responses)	Called to authenticate the response to the challenge(s) sent previously
InteractiveChallenge	generateChallenge(ServerSession session, String username, String lang, String subMethods)	Generates the interactive "challenge" to send to the client
protected String	getInteractionInstruction(ServerSession session)
protected String	getInteractionLanguage(ServerSession session)
protected String	getInteractionName(ServerSession session)
protected String	getInteractionPrompt(ServerSession session)
protected boolean	isInteractionPromptEchoEnabled(ServerSession session)

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DefaultKeyboardInteractiveAuthenticator INSTANCE

Constructor Detail

DefaultKeyboardInteractiveAuthenticator

public DefaultKeyboardInteractiveAuthenticator()

Method Detail

generateChallenge

public InteractiveChallenge generateChallenge(ServerSession session,
                                              String username,
                                              String lang,
                                              String subMethods)
                                       throws Exception

Description copied from interface: KeyboardInteractiveAuthenticator

Generates the interactive "challenge" to send to the client

Specified by:

generateChallenge in interface KeyboardInteractiveAuthenticator

Parameters:

session - The ServerSession through which the request was received

username - The username

lang - The language tag

subMethods - Sub-methods hints sent by the client

Returns:

The InteractiveChallenge - if null then authentication attempt via "keyboard-interactive" method is rejected

Throws:

Exception - If unable to generate the challenge

authenticate

public boolean authenticate(ServerSession session,
                            String username,
                            List<String> responses)
                     throws Exception

Description copied from interface: KeyboardInteractiveAuthenticator

Called to authenticate the response to the challenge(s) sent previously

Specified by:

authenticate in interface KeyboardInteractiveAuthenticator

Parameters:

session - The ServerSession through which the response was received

username - The username

responses - The received responses - Note: it is up to the authenticator to make sure that the number of responses matches the number of prompts sent in the initial challenge. The order of the responses matches the order of the prompts sent to the client

Returns:

true if responses have been validated

Throws:

Exception - if bad responses and server should terminate the connection

getInteractionName

protected String getInteractionName(ServerSession session)

getInteractionInstruction

protected String getInteractionInstruction(ServerSession session)

getInteractionLanguage

protected String getInteractionLanguage(ServerSession session)

getInteractionPrompt

protected String getInteractionPrompt(ServerSession session)

isInteractionPromptEchoEnabled

protected boolean isInteractionPromptEchoEnabled(ServerSession session)