Apache Mina SSHD 2.15.0 · org.apache.sshd.server.auth.keyboard.DefaultKeyboardInteractiveAuthenticator

Modifier and Type	Field and Description
public static final DefaultKeyboardInteractiveAuthenticator	INSTANCE

Access	Constructor and Description
public	DefaultKeyboardInteractiveAuthenticator()

Method Summary

Modifier and Type	Method and Description
public boolean	authenticate(ServerSession The `ServerSession` through which the response was received session, String The username username, List<String> 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 responses) Implements org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator.authenticate. Called to authenticate the response to the challenge(s) sent previously
public InteractiveChallenge	generateChallenge(ServerSession The `ServerSession` through which the request was received session, String The username username, String The language tag lang, String Sub-methods hints sent by the client subMethods) Implements org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator.generateChallenge. 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)

Inherited from 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

INSTANCE	back to summary
public static final DefaultKeyboardInteractiveAuthenticator INSTANCE

DefaultKeyboardInteractiveAuthenticator	back to summary
public DefaultKeyboardInteractiveAuthenticator()

authenticate back to summary

authenticate	back to summary
public boolean authenticate(ServerSession session, String username, List<String> responses) throws Exception Implements org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator.authenticate. Doc from org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator.authenticate. Called to authenticate the response to the challenge(s) sent previously Parameters session:ServerSession The `ServerSession` through which the response was received username:String The username responses:List<String> 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:boolean `true` if responses have been validated Annotations @Override Exceptions Exception: if bad responses and server should terminate the connection

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

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

Parameters

session:ServerSession: The ServerSession through which the response was received
username:String: The username
responses:List<String>: 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:boolean

true if responses have been validated

Annotations

Exceptions

generateChallenge back to summary

generateChallenge	back to summary
public InteractiveChallenge generateChallenge(ServerSession session, String username, String lang, String subMethods) throws Exception Implements org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator.generateChallenge. Doc from org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator.generateChallenge. Generates the interactive "challenge" to send to the client Parameters session:ServerSession The `ServerSession` through which the request was received username:String The username lang:String The language tag subMethods:String Sub-methods hints sent by the client Returns:InteractiveChallenge The `InteractiveChallenge` - if `null` then authentication attempt via "keyboard-interactive" method is rejected Annotations @Override Exceptions Exception: If unable to generate the challenge

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

Generates the interactive "challenge" to send to the client

Parameters

session:ServerSession: The ServerSession through which the request was received
username:String: The username
lang:String: The language tag
subMethods:String: Sub-methods hints sent by the client

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

Annotations

Exceptions

getInteractionInstruction	back to summary
protected String getInteractionInstruction(ServerSession session)

getInteractionLanguage	back to summary
protected String getInteractionLanguage(ServerSession session)

getInteractionName	back to summary
protected String getInteractionName(ServerSession session)

getInteractionPrompt	back to summary
protected String getInteractionPrompt(ServerSession session)

isInteractionPromptEchoEnabled	back to summary
protected boolean isInteractionPromptEchoEnabled(ServerSession session)