org.apache.sshd.client

Interface ClientAuthenticationManager

All Superinterfaces:

KeyIdentityProviderHolder, UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>

All Known Subinterfaces:

ClientFactoryManager, ClientSession

All Known Implementing Classes:

AbstractClientSession, ClientSessionImpl, SshClient

public interface ClientAuthenticationManager
extends UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>, KeyIdentityProviderHolder

Holds information required for the client to perform authentication with the server

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PASSWORD_PROMPTS Default value for PASSWORD_PROMPTS if none configured
static String	PASSWORD_PROMPTS Specifies the number of interactive prompts before giving up.
static String	PREFERRED_AUTHS Ordered comma separated list of authentications methods.

Method Summary

Modifier and Type	Method and Description
void	addPasswordIdentity(String password)
void	addPublicKeyIdentity(KeyPair key)
PasswordIdentityProvider	getPasswordIdentityProvider() Retrieve PasswordIdentityProvider used to provide password candidates
AuthenticationIdentitiesProvider	getRegisteredIdentities()
ServerKeyVerifier	getServerKeyVerifier() Retrieve the server key verifier to be used to check the key when connecting to an SSH server.
UserInteraction	getUserInteraction()
String	removePasswordIdentity(String password)
KeyPair	removePublicKeyIdentity(KeyPair kp)
void	setPasswordIdentityProvider(PasswordIdentityProvider provider)
void	setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)
default void	setUserAuthFactoriesNames(Collection<String> names)
void	setUserInteraction(UserInteraction userInteraction)

Methods inherited from interface org.apache.sshd.common.auth.UserAuthFactoriesManager

getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProviderHolder

getKeyIdentityProvider, setKeyIdentityProvider

Field Detail

PREFERRED_AUTHS

static final String PREFERRED_AUTHS

Ordered comma separated list of authentications methods. Authentications methods accepted by the server will be tried in the given order. If not configured or null/empty, then the session's UserAuthFactoriesManager.getUserAuthFactories() is used as-is

See Also:

Constant Field Values

PASSWORD_PROMPTS

static final String PASSWORD_PROMPTS

Specifies the number of interactive prompts before giving up. The argument to this keyword must be an integer.

See Also:

DEFAULT_PASSWORD_PROMPTS, Constant Field Values

DEFAULT_PASSWORD_PROMPTS

static final int DEFAULT_PASSWORD_PROMPTS

Default value for PASSWORD_PROMPTS if none configured

See Also:

Constant Field Values

Method Detail

getRegisteredIdentities

AuthenticationIdentitiesProvider getRegisteredIdentities()

Returns:

The AuthenticationIdentitiesProvider to be used for attempting password or public key authentication

getPasswordIdentityProvider

PasswordIdentityProvider getPasswordIdentityProvider()

Retrieve PasswordIdentityProvider used to provide password candidates

Returns:

The PasswordIdentityProvider instance - ignored if null (i.e., no passwords available).

See Also:

addPasswordIdentity(String)

setPasswordIdentityProvider

void setPasswordIdentityProvider(PasswordIdentityProvider provider)

addPasswordIdentity

void addPasswordIdentity(String password)

Parameters:

password - Password to be added - may not be null/empty. Note: this password is in addition to whatever passwords are available via the PasswordIdentityProvider (if any)

removePasswordIdentity

String removePasswordIdentity(String password)

Parameters:

password - The password to remove - ignored if null/empty

Returns:

The removed password - same one that was added via addPasswordIdentity(String) - or null if no match found

addPublicKeyIdentity

void addPublicKeyIdentity(KeyPair key)

Parameters:

key - The KeyPair to add - may not be null Note: this key is in addition to whatever keys are available via the KeyIdentityProvider (if any)

removePublicKeyIdentity

KeyPair removePublicKeyIdentity(KeyPair kp)

Parameters:

kp - The KeyPair to remove - ignored if null

Returns:

The removed KeyPair - same one that was added via addPublicKeyIdentity(KeyPair) - or null if no match found

getServerKeyVerifier

ServerKeyVerifier getServerKeyVerifier()

Retrieve the server key verifier to be used to check the key when connecting to an SSH server.

Returns:

the ServerKeyVerifier to use - never null

setServerKeyVerifier

void setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)

getUserInteraction

UserInteraction getUserInteraction()

Returns:

A UserInteraction object to communicate with the user (may be null to indicate that no such communication is allowed)

setUserInteraction

void setUserInteraction(UserInteraction userInteraction)

setUserAuthFactoriesNames

default void setUserAuthFactoriesNames(Collection<String> names)

Specified by:

setUserAuthFactoriesNames in interface UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>