Package org.apache.sshd.contrib.client.auth.password

Class InteractivePasswordIdentityProvider

java.lang.Object

org.apache.sshd.contrib.client.auth.password.InteractivePasswordIdentityProvider

All Implemented Interfaces:

java.util.Iterator<java.lang.String>, ClientSessionHolder, SessionContextHolder, SessionHolder<ClientSession>

public class InteractivePasswordIdentityProvider
extends java.lang.Object
implements java.util.Iterator<java.lang.String>, SessionHolder<ClientSession>, ClientSessionHolder

Helps implement a PasswordIdentityProvider by delegating calls to UserInteraction.getUpdatedPassword(ClientSession, String, String). The way to use it would be as follows:

 
 try (ClientSession session = client.connect(login, host, port).await().getSession()) {
     session.setUserInteraction(...);     // this can also be set at the client level
     PasswordIdentityProvider passwordIdentityProvider =
          InteractivePasswordIdentityProvider.providerOf(session, "My prompt");
     session.setPasswordIdentityProvider(passwordIdentityProvider);
     session.auth.verify(...timeout...);
 }

 or

 UserInteraction ui = ....;
 try (ClientSession session = client.connect(login, host, port).await().getSession()) {
     PasswordIdentityProvider passwordIdentityProvider =
          InteractivePasswordIdentityProvider.providerOf(session, ui, "My prompt");
     session.setPasswordIdentityProvider(passwordIdentityProvider);
     session.auth.verify(...timeout...);
 }
 
 

Note: UserInteraction.isInteractionAllowed(ClientSession) is consulted prior to invoking getUpdatedPassword - if returns false then password retrieval method is not invoked, and it is assumed that no more passwords are available

Field Summary

Fields

Modifier and Type	Field	Description
private ClientSession	clientSession
protected static java.lang.String	EOF	Special marker to indicate that we exhausted all attempts
private java.util.concurrent.atomic.AtomicReference<java.lang.String>	nextPassword
private java.lang.String	prompt
private UserInteraction	userInteraction

Constructor Summary

Constructors

Constructor	Description
InteractivePasswordIdentityProvider(ClientSession clientSession, UserInteraction userInteraction, java.lang.String prompt)

Method Summary

Modifier and Type	Method	Description
ClientSession	getClientSession()
java.lang.String	getPrompt()
ClientSession	getSession()
UserInteraction	getUserInteraction()
boolean	hasNext()
java.lang.String	next()
static PasswordIdentityProvider	providerOf(ClientSession clientSession, java.lang.String prompt)
static PasswordIdentityProvider	providerOf(ClientSession clientSession, UserInteraction userInteraction, java.lang.String prompt)
protected java.lang.String	resolveNextPassword()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Field Detail

EOF

protected static final java.lang.String EOF

Special marker to indicate that we exhausted all attempts

See Also:

Constant Field Values

clientSession

private ClientSession clientSession

userInteraction

private UserInteraction userInteraction

prompt

private java.lang.String prompt

nextPassword

private java.util.concurrent.atomic.AtomicReference<java.lang.String> nextPassword

Constructor Detail

InteractivePasswordIdentityProvider

public InteractivePasswordIdentityProvider(ClientSession clientSession,
                                           UserInteraction userInteraction,
                                           java.lang.String prompt)

Method Detail

getClientSession

public ClientSession getClientSession()

Specified by:

getClientSession in interface ClientSessionHolder

Returns:

The underlying ClientSession used

getSession

public ClientSession getSession()

Specified by:

getSession in interface SessionHolder<ClientSession>

getUserInteraction

public UserInteraction getUserInteraction()

getPrompt

public java.lang.String getPrompt()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.lang.String>

next

public java.lang.String next()

Specified by:

next in interface java.util.Iterator<java.lang.String>

resolveNextPassword

protected java.lang.String resolveNextPassword()

providerOf

public static PasswordIdentityProvider providerOf(ClientSession clientSession,
                                                  java.lang.String prompt)

providerOf

public static PasswordIdentityProvider providerOf(ClientSession clientSession,
                                                  UserInteraction userInteraction,
                                                  java.lang.String prompt)