public interface

InteractiveCallback

com.trilead.ssh2.InteractiveCallback

Class Overview

An InteractiveCallback is used to respond to challenges sent by the server if authentication mode "keyboard-interactive" is selected.

See Also

Summary

Public Methods
abstract String[] replyToChallenge(String name, String instruction, int numPrompts, String[] prompt, boolean[] echo)
This callback interface is used during a "keyboard-interactive" authentication.

Public Methods

public abstract String[] replyToChallenge (String name, String instruction, int numPrompts, String[] prompt, boolean[] echo)

This callback interface is used during a "keyboard-interactive" authentication. Every time the server sends a set of challenges (however, most often just one challenge at a time), this callback function will be called to give your application a chance to talk to the user and to determine the response(s).

Some copy-paste information from the standard: a command line interface (CLI) client SHOULD print the name and instruction (if non-empty), adding newlines. Then for each prompt in turn, the client SHOULD display the prompt and read the user input. The name and instruction fields MAY be empty strings, the client MUST be prepared to handle this correctly. The prompt field(s) MUST NOT be empty strings.

Please refer to draft-ietf-secsh-auth-kbdinteract-XX.txt for the details.

Note: clients SHOULD use control character filtering as discussed in RFC4251 to avoid attacks by including terminal control characters in the fields to be displayed.

Parameters
name The name String sent by the server.
instruction The instruction String sent by the server.
numPrompts Number of prompts - may be zero (in this case, you should just return a String array of length zero).
prompt An array (length numPrompts) of Strings
echo An array (length numPrompts) of booleans. For each prompt, the corresponding echo field indicates whether or not the user input should be echoed as characters are typed.
Returns
  • an array of reponses - the array size must match the parameter numPrompts.
Throws
Exception