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

Method Summary

Modifier and Type	Method	Description
void	addPasswordIdentity(String password)
void	addPublicKeyIdentity(KeyPair key)
HostBasedAuthenticationReporter	getHostBasedAuthenticationReporter()
PasswordAuthenticationReporter	getPasswordAuthenticationReporter()
PasswordIdentityProvider	getPasswordIdentityProvider()	Retrieve PasswordIdentityProvider used to provide password candidates
PublicKeyAuthenticationReporter	getPublicKeyAuthenticationReporter()
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	setHostBasedAuthenticationReporter(HostBasedAuthenticationReporter reporter)
void	setPasswordAuthenticationReporter(PasswordAuthenticationReporter reporter)
void	setPasswordIdentityProvider(PasswordIdentityProvider provider)
void	setPublicKeyAuthenticationReporter(PublicKeyAuthenticationReporter reporter)
void	setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)
default void	setUserAuthFactoriesNames(Collection<String> names)
void	setUserInteraction(UserInteraction userInteraction)

Methods inherited from interface KeyIdentityProviderHolder

getKeyIdentityProvider, setKeyIdentityProvider

Methods inherited from interface UserAuthFactoriesManager

getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Method Details

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)

getPasswordAuthenticationReporter

PasswordAuthenticationReporter getPasswordAuthenticationReporter()

setPasswordAuthenticationReporter

void setPasswordAuthenticationReporter(PasswordAuthenticationReporter reporter)

getPublicKeyAuthenticationReporter

PublicKeyAuthenticationReporter getPublicKeyAuthenticationReporter()

setPublicKeyAuthenticationReporter

void setPublicKeyAuthenticationReporter(PublicKeyAuthenticationReporter reporter)

getHostBasedAuthenticationReporter

HostBasedAuthenticationReporter getHostBasedAuthenticationReporter()

setHostBasedAuthenticationReporter

void setHostBasedAuthenticationReporter(HostBasedAuthenticationReporter reporter)

setUserAuthFactoriesNames

default void setUserAuthFactoriesNames(Collection<String> names)

Specified by:

setUserAuthFactoriesNames in interface UserAuthFactoriesManager<ClientSession, UserAuth, UserAuthFactory>