org.apache.sshd.client.auth

Class UserAuthKeyboardInteractive

java.lang.Object

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

org.apache.sshd.client.auth.UserAuthKeyboardInteractive

All Implemented Interfaces:

UserAuth

public class UserAuthKeyboardInteractive
extends AbstractLoggingBean
implements UserAuth

Manages a "keyboard-interactive" exchange according to RFC4256

Author:

Apache MINA SSHD Project

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
UserAuthKeyboardInteractive()

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected String	getCurrentPasswordCandidate()
protected String[]	getUserResponses(String name, String instruction, String lang, String[] prompt, boolean[] echo)
void	init(ClientSession session, String service, Collection<?> identities)
boolean	process(Buffer buffer)
protected boolean	useCurrentPassword(String password, String name, String instruction, String lang, String[] prompt, boolean[] echo)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAuthKeyboardInteractive

public UserAuthKeyboardInteractive()

Method Detail

init

public void init(ClientSession session,
                 String service,
                 Collection<?> identities)
          throws Exception

Specified by:

init in interface UserAuth

Throws:

Exception

process

public boolean process(Buffer buffer)
                throws Exception

Specified by:

process in interface UserAuth

Throws:

Exception

getCurrentPasswordCandidate

protected String getCurrentPasswordCandidate()

getUserResponses

protected String[] getUserResponses(String name,
                                    String instruction,
                                    String 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(String password,
                                     String name,
                                     String instruction,
                                     String lang,
                                     String[] prompt,
                                     boolean[] echo)

destroy

public void destroy()

Specified by:

destroy in interface UserAuth