org.apache.sshd.client.auth.keyboard

Class UserAuthKeyboardInteractive

java.lang.Object

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

org.apache.sshd.client.auth.AbstractUserAuth

org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive

All Implemented Interfaces:

UserAuth, ClientSessionHolder, UserAuthInstance<ClientSession>, NamedResource

public class UserAuthKeyboardInteractive
extends AbstractUserAuth

Manages a "keyboard-interactive" exchange according to RFC4256

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_INTERACTIVE_LANGUAGE_TAG
static java.lang.String	DEFAULT_INTERACTIVE_SUBMETHODS
private java.util.concurrent.atomic.AtomicInteger	emptyCount
static java.lang.String	INTERACTIVE_LANGUAGE_TAG
static java.lang.String	INTERACTIVE_SUBMETHODS
private int	maxTrials
static java.lang.String	NAME
private java.util.Iterator<java.lang.String>	passwords
private java.util.concurrent.atomic.AtomicBoolean	requestPending
private java.util.concurrent.atomic.AtomicInteger	trialsCount

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

log

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Constructor and Description
UserAuthKeyboardInteractive()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAuthCommandName(int cmd)
protected java.lang.String	getCurrentPasswordCandidate()
protected java.lang.String	getExchangeLanguageTag(ClientSession session)
protected java.lang.String	getExchangeSubMethods(ClientSession session)
protected java.lang.String[]	getUserResponses(java.lang.String name, java.lang.String instruction, java.lang.String lang, java.lang.String[] prompt, boolean[] echo)
void	init(ClientSession session, java.lang.String service)
protected boolean	processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected boolean	sendAuthDataRequest(ClientSession session, java.lang.String service)
protected boolean	useCurrentPassword(ClientSession session, java.lang.String password, java.lang.String name, java.lang.String instruction, java.lang.String lang, java.lang.String[] prompt, boolean[] echo) Checks if we have a candidate password and exactly one prompt is requested with no echo, and the prompt matches a configurable pattern.
protected boolean	verifyTrialsCount(ClientSession session, java.lang.String service, int cmd, int nbTrials, int maxAllowed)

Methods inherited from class org.apache.sshd.client.auth.AbstractUserAuth

destroy, getClientSession, getName, getService, getSession, process, toString

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, getNameList, getNames, ofName, removeByName

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

INTERACTIVE_LANGUAGE_TAG

public static final java.lang.String INTERACTIVE_LANGUAGE_TAG

See Also:

Constant Field Values

DEFAULT_INTERACTIVE_LANGUAGE_TAG

public static final java.lang.String DEFAULT_INTERACTIVE_LANGUAGE_TAG

See Also:

Constant Field Values

INTERACTIVE_SUBMETHODS

public static final java.lang.String INTERACTIVE_SUBMETHODS

See Also:

Constant Field Values

DEFAULT_INTERACTIVE_SUBMETHODS

public static final java.lang.String DEFAULT_INTERACTIVE_SUBMETHODS

See Also:

Constant Field Values

requestPending

private final java.util.concurrent.atomic.AtomicBoolean requestPending

trialsCount

private final java.util.concurrent.atomic.AtomicInteger trialsCount

emptyCount

private final java.util.concurrent.atomic.AtomicInteger emptyCount

passwords

private java.util.Iterator<java.lang.String> passwords

maxTrials

private int maxTrials

Constructor Detail

UserAuthKeyboardInteractive

public UserAuthKeyboardInteractive()

Method Detail

init

public void init(ClientSession session,
                 java.lang.String service)
          throws java.lang.Exception

Specified by:

init in interface UserAuth

Overrides:

init in class AbstractUserAuth

Parameters:

session - The ClientSession

service - The requesting service name

Throws:

java.lang.Exception - If failed to initialize the mechanism

sendAuthDataRequest

protected boolean sendAuthDataRequest(ClientSession session,
                                      java.lang.String service)
                               throws java.lang.Exception

Specified by:

sendAuthDataRequest in class AbstractUserAuth

Throws:

java.lang.Exception

processAuthDataRequest

protected boolean processAuthDataRequest(ClientSession session,
                                         java.lang.String service,
                                         Buffer buffer)
                                  throws java.lang.Exception

Specified by:

processAuthDataRequest in class AbstractUserAuth

Throws:

java.lang.Exception

getExchangeLanguageTag

protected java.lang.String getExchangeLanguageTag(ClientSession session)

getExchangeSubMethods

protected java.lang.String getExchangeSubMethods(ClientSession session)

getCurrentPasswordCandidate

protected java.lang.String getCurrentPasswordCandidate()

verifyTrialsCount

protected boolean verifyTrialsCount(ClientSession session,
                                    java.lang.String service,
                                    int cmd,
                                    int nbTrials,
                                    int maxAllowed)

getUserResponses

protected java.lang.String[] getUserResponses(java.lang.String name,
                                              java.lang.String instruction,
                                              java.lang.String lang,
                                              java.lang.String[] prompt,
                                              boolean[] echo)

Parameters:

name - The interaction name - may be empty

instruction - The instruction - may be empty

lang - The language tag - may be empty

prompt - The prompts - may be empty

echo - Whether to echo the response for the prompt or not - same length as the prompts

Returns:

The response for each prompt - if null then the assumption is that some internal error occurred and no response is sent. Note: according to RFC4256 the number of responses should be exactly the same as the number of prompts. However, since it is the server's responsibility to enforce this we do not validate the response (other than logging it as a warning...)

useCurrentPassword

protected boolean useCurrentPassword(ClientSession session,
                                     java.lang.String password,
                                     java.lang.String name,
                                     java.lang.String instruction,
                                     java.lang.String lang,
                                     java.lang.String[] prompt,
                                     boolean[] echo)

Checks if we have a candidate password and exactly one prompt is requested with no echo, and the prompt matches a configurable pattern.

Parameters:

session - The ClientSession through which the request is received

password - The current password candidate to use

name - The service name

instruction - The request instruction

lang - The reported language tag

prompt - The requested prompts

echo - The matching prompts echo flags

Returns:

Whether to use the password candidate as reply to the prompts

See Also:

INTERACTIVE_PASSWORD_PROMPT, CHECK_INTERACTIVE_PASSWORD_DELIM

getAuthCommandName

public static java.lang.String getAuthCommandName(int cmd)