Apache Mina SSHD 2.15.0 · org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractive

Modifier and Type	Field and Description
private int	maxAttempts
public static final String	NAME
private int	nOfAttempts
private Iterator<String>	passwords
private final AtomicBoolean	requestPending
private boolean	wasChallenged
private boolean	withUserInteraction

Access	Constructor and Description
public	UserAuthKeyboardInteractive()

Method Summary

Modifier and Type	Method and Description
public static String	getAuthCommandName(int cmd)
protected String	getCurrentPasswordCandidate()
protected String	getExchangeLanguageTag(ClientSession session)
protected String	getExchangeSubMethods(ClientSession session)
protected String[]	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...) getUserResponses(String The interaction name - may be empty name, String The instruction - may be empty instruction, String The language tag - may be empty lang, String[] The prompts - may be empty prompt, boolean[] Whether to echo the response for the prompt or not - same length as the prompts echo)
public void	init(ClientSession The `ClientSession` session, String The requesting service name service) Overrides org.apache.sshd.client.auth.AbstractUserAuth.init. Implements org.apache.sshd.client.auth.UserAuth.init.
protected boolean	processAuthDataRequest(ClientSession session, String service, Buffer buffer) Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.
protected boolean	sendAuthDataRequest(ClientSession session, String service) Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.
protected boolean	Returns: Whether to use the password candidate as reply to the prompts useCurrentPassword(ClientSession The `ClientSession` through which the request is received session, String The current password candidate to use password, String The service name name, String The request instruction instruction, String The reported language tag lang, String[] The requested prompts prompt, boolean[] The matching prompts echo flags 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, String service, int cmd, int nbTrials, int maxAllowed)

Inherited from org.apache.sshd.client.auth.AbstractUserAuth:: destroy getClientSession getName getService getSession isCancellable process setCancellable toString

maxAttempts	back to summary
private int maxAttempts

NAME	back to summary
public static final String NAME

nOfAttempts	back to summary
private int nOfAttempts

passwords	back to summary
private Iterator<String> passwords

requestPending	back to summary
private final AtomicBoolean requestPending

wasChallenged	back to summary
private boolean wasChallenged

withUserInteraction	back to summary
private boolean withUserInteraction

UserAuthKeyboardInteractive	back to summary
public UserAuthKeyboardInteractive()

Method Detail

getAuthCommandName	back to summary
public static String getAuthCommandName(int cmd)

getCurrentPasswordCandidate	back to summary
protected String getCurrentPasswordCandidate()

getExchangeLanguageTag	back to summary
protected String getExchangeLanguageTag(ClientSession session)

getExchangeSubMethods	back to summary
protected String getExchangeSubMethods(ClientSession session)

getUserResponses back to summary

getUserResponses	back to summary
protected String[] getUserResponses(String name, String instruction, String lang, String[] prompt, boolean[] echo) Parameters name:String The interaction name - may be empty instruction:String The instruction - may be empty lang:String The language tag - may be empty prompt:String[] The prompts - may be empty echo:boolean[] Whether to echo the response for the prompt or not - same length as the prompts Returns:String[] 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...)

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

Parameters

name:String: The interaction name - may be empty
instruction:String: The instruction - may be empty
lang:String: The language tag - may be empty
prompt:String[]: The prompts - may be empty
echo:boolean[]: Whether to echo the response for the prompt or not - same length as the prompts

Returns:String[]

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...)

init back to summary

init	back to summary
public void init(ClientSession session, String service) throws Exception Overrides org.apache.sshd.client.auth.AbstractUserAuth.init. Implements org.apache.sshd.client.auth.UserAuth.init. Parameters session:ClientSession Doc from org.apache.sshd.client.auth.UserAuth.init. The `ClientSession` service:String Doc from org.apache.sshd.client.auth.UserAuth.init. The requesting service name Annotations @Override Exceptions Exception: Doc from org.apache.sshd.client.auth.UserAuth.init. If failed to initialize the mechanism

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

Overrides org.apache.sshd.client.auth.AbstractUserAuth.init.

Implements org.apache.sshd.client.auth.UserAuth.init.

Parameters

session:ClientSession

Doc from org.apache.sshd.client.auth.UserAuth.init.

The ClientSession

service:String

Doc from org.apache.sshd.client.auth.UserAuth.init.

The requesting service name

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.sshd.client.auth.UserAuth.init.

If failed to initialize the mechanism

processAuthDataRequest	back to summary
protected boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest. Annotations @Override

processAuthDataRequest

back to summary

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

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.

Annotations

@Override

sendAuthDataRequest	back to summary
protected boolean sendAuthDataRequest(ClientSession session, String service) throws Exception Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest. Annotations @Override

sendAuthDataRequest

back to summary

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

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.

Annotations

@Override

useCurrentPassword back to summary

useCurrentPassword	back to summary
protected boolean useCurrentPassword(ClientSession session, String password, String name, String instruction, String 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:ClientSession The `ClientSession` through which the request is received password:String The current password candidate to use name:String The service name instruction:String The request instruction lang:String The reported language tag prompt:String[] The requested prompts echo:boolean[] The matching prompts echo flags Returns:boolean Whether to use the password candidate as reply to the prompts See Also `INTERACTIVE_PASSWORD_PROMPT`, `CHECK_INTERACTIVE_PASSWORD_DELIM`

protected boolean useCurrentPassword(ClientSession session, String password, String name, String instruction, String 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:ClientSession: The ClientSession through which the request is received
password:String: The current password candidate to use
name:String: The service name
instruction:String: The request instruction
lang:String: The reported language tag
prompt:String[]: The requested prompts
echo:boolean[]: The matching prompts echo flags

Returns:boolean

Whether to use the password candidate as reply to the prompts

verifyTrialsCount	back to summary
protected boolean verifyTrialsCount(ClientSession session, String service, int cmd, int nbTrials, int maxAllowed)

public Class UserAuthKeyboardInteractive

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail