Top Description Fields Methods
org.apache.sshd.server

public Interface ServerAuthenticationManager

extends UserAuthFactoriesManager<ServerSession, UserAuth, UserAuthFactory>, KeyPairProviderHolder
Known Direct Subinterfaces
org.apache.sshd.server.ServerFactoryManager, org.apache.sshd.server.session.ServerSession
Imports
java.util.ArrayList, .Collection, .Collections, .List, org.apache.sshd.common.NamedFactory, org.apache.sshd.common.auth.UserAuthFactoriesManager, org.apache.sshd.common.keyprovider.HostKeyCertificateProvider, .KeyPairProviderHolder, org.apache.sshd.common.util.GenericUtils, .ValidateUtils, org.apache.sshd.server.auth.BuiltinUserAuthFactories, .UserAuth, .UserAuthFactory, org.apache.sshd.server.auth.gss.GSSAuthenticator, .UserAuthGSSFactory, org.apache.sshd.server.auth.hostbased.HostBasedAuthenticator, org.apache.sshd.server.auth.keyboard.KeyboardInteractiveAuthenticator, .UserAuthKeyboardInteractiveFactory, org.apache.sshd.server.auth.password.PasswordAuthenticator, .UserAuthPasswordFactory, org.apache.sshd.server.auth.pubkey.PublickeyAuthenticator, .UserAuthPublicKeyFactory, org.apache.sshd.server.session.ServerSession
Holds providers and helpers related to the server side authentication process
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final UserAuthGSSFactory
DEFAULT_USER_AUTH_GSS_FACTORY

public static final UserAuthKeyboardInteractiveFactory
DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY

public static final UserAuthPasswordFactory
DEFAULT_USER_AUTH_PASSWORD_FACTORY

public static final UserAuthPublicKeyFactory
DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

Method Summary

Modifier and TypeMethod and Description
public GSSAuthenticator

Returns:

the GSSAuthenticator or null
getGSSAuthenticator()

Retrieve the GSSAuthenticator to be used by the SSH server.

public HostBasedAuthenticator

Returns:

the HostBasedAuthenticator or null
getHostBasedAuthenticator()

Retrieve the HostBasedAuthenticator to be used by the SSH server.

public HostKeyCertificateProvider

Returns:

a HostKeyCertificateProvider if available, null as default
getHostKeyCertificateProvider()

public KeyboardInteractiveAuthenticator

Returns:

The KeyboardInteractiveAuthenticator or null
getKeyboardInteractiveAuthenticator()

Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.

public PasswordAuthenticator

Returns:

the PasswordAuthenticator or null
getPasswordAuthenticator()

Retrieve the PasswordAuthenticator to be used by the SSH server.

public PublickeyAuthenticator

Returns:

the PublickeyAuthenticator or null
getPublickeyAuthenticator()

Retrieve the PublickeyAuthenticator to be used by SSH server.

public static List<UserAuthFactory>

Returns:

The resolved List of NamedFactory for the UserAuths
resolveUserAuthFactories(ServerAuthenticationManager
The ServerAuthenticationManager - ignored if null
manager)

If user authentication factories already set, then simply returns them.

public static List<UserAuthFactory>

Returns:

The resolved List of NamedFactory for the UserAuths
resolveUserAuthFactories(ServerAuthenticationManager
The ServerAuthenticationManager - ignored if null
manager, List<UserAuthFactory>
The currently available UserAuth factories - if not null/empty then they are used as-is.
userFactories)

If user authentication factories already set, then simply returns them.

public void
setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

public void
setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)

public void
setHostKeyCertificateProvider(HostKeyCertificateProvider provider)

public void
setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)

public void
setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

public void
setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

public default void
setUserAuthFactoriesNames(Collection<String> names)

Implements org.apache.sshd.common.auth.UserAuthFactoriesManager.setUserAuthFactoriesNames.

Inherited from org.apache.sshd.common.auth.UserAuthFactoriesManager:
getUserAuthFactoriesgetUserAuthFactoriesNameListgetUserAuthFactoriesNamessetUserAuthFactoriessetUserAuthFactoriesNameListsetUserAuthFactoriesNames
Inherited from org.apache.sshd.common.keyprovider.KeyPairProviderHolder:
getKeyPairProvidersetKeyPairProvider

Field Detail

DEFAULT_USER_AUTH_GSS_FACTORYback to summary
public static final UserAuthGSSFactory DEFAULT_USER_AUTH_GSS_FACTORY
DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORYback to summary
public static final UserAuthKeyboardInteractiveFactory DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY
DEFAULT_USER_AUTH_PASSWORD_FACTORYback to summary
public static final UserAuthPasswordFactory DEFAULT_USER_AUTH_PASSWORD_FACTORY
DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORYback to summary
public static final UserAuthPublicKeyFactory DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

Method Detail

getGSSAuthenticatorback to summary
public 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:GSSAuthenticator

the GSSAuthenticator or null

getHostBasedAuthenticatorback to summary
public 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:HostBasedAuthenticator

the HostBasedAuthenticator or null

getHostKeyCertificateProviderback to summary
public HostKeyCertificateProvider getHostKeyCertificateProvider()
Returns:HostKeyCertificateProvider

a HostKeyCertificateProvider if available, null as default

getKeyboardInteractiveAuthenticatorback to summary
public 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:KeyboardInteractiveAuthenticator

The KeyboardInteractiveAuthenticator or null

getPasswordAuthenticatorback to summary
public 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:PasswordAuthenticator

the PasswordAuthenticator or null

getPublickeyAuthenticatorback to summary
public 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:PublickeyAuthenticator

the PublickeyAuthenticator or null

resolveUserAuthFactoriesback to summary
public static 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:ServerAuthenticationManager

The ServerAuthenticationManager - ignored if null

Returns:List<UserAuthFactory>

The resolved List of NamedFactory for the UserAuths

See Also
resolveUserAuthFactories(ServerAuthenticationManager, List)
resolveUserAuthFactoriesback to summary
public static List<UserAuthFactory> resolveUserAuthFactories(ServerAuthenticationManager manager, 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:ServerAuthenticationManager

The ServerAuthenticationManager - ignored if null

userFactories:List<UserAuthFactory>

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

Returns:List<UserAuthFactory>

The resolved List of NamedFactory for the UserAuths

setGSSAuthenticatorback to summary
public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
setHostBasedAuthenticatorback to summary
public void setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)
setHostKeyCertificateProviderback to summary
public void setHostKeyCertificateProvider(HostKeyCertificateProvider provider)
setKeyboardInteractiveAuthenticatorback to summary
public void setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)
setPasswordAuthenticatorback to summary
public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
setPublickeyAuthenticatorback to summary
public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
setUserAuthFactoriesNamesback to summary
public default void setUserAuthFactoriesNames(Collection<String> names)

Implements org.apache.sshd.common.auth.UserAuthFactoriesManager.setUserAuthFactoriesNames.

Annotations
@Override