org.apache.sshd.server

Interface ServerAuthenticationManager

All Superinterfaces:

KeyPairProviderHolder, UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>

All Known Subinterfaces:

ServerFactoryManager, ServerSession

All Known Implementing Classes:

AbstractServerSession, ServerSessionImpl, SshServer

public interface ServerAuthenticationManager
extends UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>, KeyPairProviderHolder

Holds providers and helpers related to the server side authentication process

Field Summary

Fields

Modifier and Type	Field and Description
static UserAuthGSSFactory	DEFAULT_USER_AUTH_GSS_FACTORY
static UserAuthKeyboardInteractiveFactory	DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY
static UserAuthPasswordFactory	DEFAULT_USER_AUTH_PASSWORD_FACTORY
static UserAuthPublicKeyFactory	DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

Method Summary

Modifier and Type	Method and Description
GSSAuthenticator	getGSSAuthenticator() Retrieve the GSSAuthenticator to be used by the SSH server.
HostBasedAuthenticator	getHostBasedAuthenticator() Retrieve the HostBasedAuthenticator to be used by the SSH server.
HostKeyCertificateProvider	getHostKeyCertificateProvider()
KeyboardInteractiveAuthenticator	getKeyboardInteractiveAuthenticator() Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.
PasswordAuthenticator	getPasswordAuthenticator() Retrieve the PasswordAuthenticator to be used by the SSH server.
PublickeyAuthenticator	getPublickeyAuthenticator() Retrieve the PublickeyAuthenticator to be used by SSH server.
static java.util.List<UserAuthFactory>	resolveUserAuthFactories(ServerAuthenticationManager manager) If user authentication factories already set, then simply returns them.
static java.util.List<UserAuthFactory>	resolveUserAuthFactories(ServerAuthenticationManager manager, java.util.List<UserAuthFactory> userFactories) If user authentication factories already set, then simply returns them.
void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
void	setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)
void	setHostKeyCertificateProvider(HostKeyCertificateProvider provider)
void	setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)
void	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
default void	setUserAuthFactoriesNames(java.util.Collection<java.lang.String> names)

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.KeyPairProviderHolder

getKeyPairProvider, setKeyPairProvider

Field Detail

DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

static final UserAuthPublicKeyFactory DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

DEFAULT_USER_AUTH_GSS_FACTORY

static final UserAuthGSSFactory DEFAULT_USER_AUTH_GSS_FACTORY

DEFAULT_USER_AUTH_PASSWORD_FACTORY

static final UserAuthPasswordFactory DEFAULT_USER_AUTH_PASSWORD_FACTORY

DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY

static final UserAuthKeyboardInteractiveFactory DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY

Method Detail

setUserAuthFactoriesNames

default void setUserAuthFactoriesNames(java.util.Collection<java.lang.String> names)

Specified by:

setUserAuthFactoriesNames in interface UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>

getPublickeyAuthenticator

PublickeyAuthenticator getPublickeyAuthenticator()

Retrieve the PublickeyAuthenticator to be used by SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on keys will be rejected.

Returns:

the PublickeyAuthenticator or null

setPasswordAuthenticator

void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

getPasswordAuthenticator

PasswordAuthenticator getPasswordAuthenticator()

Retrieve the PasswordAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on passwords will be rejected.

Returns:

the PasswordAuthenticator or null

setPublickeyAuthenticator

void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

getKeyboardInteractiveAuthenticator

KeyboardInteractiveAuthenticator getKeyboardInteractiveAuthenticator()

Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on this method will be rejected.

Returns:

The KeyboardInteractiveAuthenticator or null

setKeyboardInteractiveAuthenticator

void setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)

getGSSAuthenticator

GSSAuthenticator getGSSAuthenticator()

Retrieve the GSSAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on gssapi will be rejected.

Returns:

the GSSAuthenticator or null

setGSSAuthenticator

void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

getHostBasedAuthenticator

HostBasedAuthenticator getHostBasedAuthenticator()

Retrieve the HostBasedAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on this method will be rejected.

Returns:

the HostBasedAuthenticator or null

setHostBasedAuthenticator

void setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)

getHostKeyCertificateProvider

HostKeyCertificateProvider getHostKeyCertificateProvider()

Returns:

a HostKeyCertificateProvider if available, null as default

setHostKeyCertificateProvider

void setHostKeyCertificateProvider(HostKeyCertificateProvider provider)

resolveUserAuthFactories

static java.util.List<UserAuthFactory> resolveUserAuthFactories(ServerAuthenticationManager manager)

If user authentication factories already set, then simply returns them. Otherwise, builds the factories list from the individual authenticators available for the manager - password public key, keyboard-interactive, GSS, etc...

Parameters:

manager - The ServerAuthenticationManager - ignored if null

Returns:

The resolved List of NamedFactory for the UserAuths

See Also:

resolveUserAuthFactories(ServerAuthenticationManager, List)

resolveUserAuthFactories

static java.util.List<UserAuthFactory> resolveUserAuthFactories(ServerAuthenticationManager manager,
                                                                java.util.List<UserAuthFactory> userFactories)

If user authentication factories already set, then simply returns them. Otherwise, builds the factories list from the individual authenticators available for the manager - password public key, keyboard-interactive, GSS, etc...

Parameters:

manager - The ServerAuthenticationManager - ignored if null

userFactories - The currently available UserAuth factories - if not null/empty then they are used as-is.

Returns:

The resolved List of NamedFactory for the UserAuths