Class SshServer

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.util.closeable.AbstractInnerCloseable

org.apache.sshd.common.kex.AbstractKexFactoryManager

org.apache.sshd.common.helpers.AbstractFactoryManager

org.apache.sshd.server.SshServer

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, AttributeRepository, AttributeStore, UserAuthFactoriesManager<ServerSession, UserAuth, UserAuthFactory>, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, FactoryManager, PortForwardingEventListenerManager, IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, KeyPairProviderHolder, PropertyResolver, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesHolder, SignatureFactoriesManager, ServerAuthenticationManager, ServerFactoryManager, ServerProxyAcceptorHolder

public class SshServer
extends AbstractFactoryManager
implements ServerFactoryManager

The SshServer class is the main entry point for the server side of the SSH protocol.

The SshServer has to be configured before being started. Such configuration can be done either using a dependency injection mechanism (such as the Spring framework) or programmatically. Basic setup is usually done using the setUpDefaultServer() method, which will known ciphers, macs, channels, etc... Besides this basic setup, a few things have to be manually configured such as the port number, Factory, the KeyPairProvider and the PasswordAuthenticator.

Some properties can also be configured using the PropertyResolverUtils updateProperty methods.

Once the SshServer instance has been configured, it can be started using the start() method and stopped using the stop() method.

See Also:

• ServerFactoryManager
• FactoryManager

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface AttributeRepository

AttributeRepository.AttributeKey<T>

Nested classes/interfaces inherited from interface SessionHeartbeatController

SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field	Description
protected IoAcceptor	acceptor
private CommandFactory	commandFactory
static final List<ServiceFactory>	DEFAULT_SERVICE_FACTORIES
static final Factory<SshServer>	DEFAULT_SSH_SERVER_FACTORY
private GSSAuthenticator	gssAuthenticator
protected String	host
private HostBasedAuthenticator	hostBasedAuthenticator
private HostKeyCertificateProvider	hostKeyCertificateProvider
private KeyboardInteractiveAuthenticator	interactiveAuthenticator
private KeyPairProvider	keyPairProvider
private PasswordAuthenticator	passwordAuthenticator
protected int	port
private ServerProxyAcceptor	proxyAcceptor
private PublickeyAuthenticator	publickeyAuthenticator
private SessionFactory	sessionFactory
private ShellFactory	shellFactory
private final AtomicBoolean	started
private List<? extends SubsystemFactory>	subsystemFactories
private List<UserAuthFactory>	userAuthFactories

Fields inherited from class AbstractFactoryManager

agentFactory, channelFactories, channelListenerProxy, channelListeners, executor, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, randomFactory, serviceFactories, sessionListenerProxy, sessionListeners, sessionTimeoutListener, shutdownExecutor, timeoutListenerFuture, tunnelListenerProxy, tunnelListeners

Fields inherited from class AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface ChannelStreamWriterResolver

NONE

Fields inherited from interface FactoryManager

DEFAULT_VERSION

Fields inherited from interface PropertyResolver

EMPTY

Fields inherited from interface ServerAuthenticationManager

DEFAULT_USER_AUTH_GSS_FACTORY, DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY, DEFAULT_USER_AUTH_PASSWORD_FACTORY, DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

Constructor Summary

Constructors

Constructor	Description
SshServer()

Method Summary

Modifier and Type	Method	Description
protected void	checkConfig()
protected IoAcceptor	createAcceptor()
protected SessionFactory	createSessionFactory()
List<AbstractSession>	getActiveSessions()	Obtain the list of active sessions.
Set<SocketAddress>	getBoundAddresses()
CommandFactory	getCommandFactory()	Retrieve the CommandFactory to be used to process commands requests.
GSSAuthenticator	getGSSAuthenticator()	Retrieve the GSSAuthenticator to be used by the SSH server.
String	getHost()
HostBasedAuthenticator	getHostBasedAuthenticator()	Retrieve the HostBasedAuthenticator to be used by the SSH server.
HostKeyCertificateProvider	getHostKeyCertificateProvider()
protected Closeable	getInnerCloseable()
KeyboardInteractiveAuthenticator	getKeyboardInteractiveAuthenticator()	Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.
KeyPairProvider	getKeyPairProvider()	Retrieve the KeyPairProvider that will be used to find the host key to use on the server side or the user key on the client side.
PasswordAuthenticator	getPasswordAuthenticator()	Retrieve the PasswordAuthenticator to be used by the SSH server.
int	getPort()
PublickeyAuthenticator	getPublickeyAuthenticator()	Retrieve the PublickeyAuthenticator to be used by SSH server.
ServerProxyAcceptor	getServerProxyAcceptor()
SessionFactory	getSessionFactory()
ShellFactory	getShellFactory()	Retrieve the ShellFactory object to be used to create shells.
List<? extends SubsystemFactory>	getSubsystemFactories()	Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.
List<UserAuthFactory>	getUserAuthFactories()	Retrieve the list of named factories for UserAuth objects.
boolean	isStarted()
void	open()
void	setCommandFactory(CommandFactory commandFactory)
void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
void	setHost(String host)
void	setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)
void	setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider)
void	setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)
void	setKeyPairProvider(KeyPairProvider keyPairProvider)
void	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
void	setPort(int port)	Configure the port number to use for this SSH server.
void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
void	setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)
void	setSessionFactory(SessionFactory sessionFactory)
void	setShellFactory(ShellFactory shellFactory)
void	setSubsystemFactories(List<? extends SubsystemFactory> subsystemFactories)
static SshServer	setUpDefaultServer()	Setup a default server
void	setUserAuthFactories(List<UserAuthFactory> userAuthFactories)
void	start()	Start the SSH server and accept incoming exceptions on the configured port.
void	stop()	Stop the SSH server.
void	stop(boolean immediately)
String	toString()

Methods inherited from class AbstractFactoryManager

addChannelListener, addPortForwardingEventListener, addSessionListener, attributeKeys, clearAttributes, computeAttributeIfAbsent, createSessionTimeoutListener, getAgentFactory, getAttribute, getAttributesCount, getChannelFactories, getChannelListenerProxy, getChannelStreamWriterResolver, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceEventListener, getIoServiceFactory, getIoServiceFactoryFactory, getNioWorkers, getParentPropertyResolver, getPortForwardingEventListenerProxy, getProperties, getRandomFactory, getReservedSessionMessagesHandler, getScheduledExecutorService, getServiceFactories, getSessionDisconnectHandler, getSessionListenerProxy, getUnknownChannelReferenceHandler, getVersion, removeAttribute, removeChannelListener, removePortForwardingEventListener, removeSessionListener, removeSessionTimeout, resolveUnknownChannelReferenceHandler, setAgentFactory, setAttribute, setChannelFactories, setChannelStreamWriterResolver, setFileSystemFactory, setForwarderFactory, setForwardingFilter, setGlobalRequestHandlers, setIoServiceEventListener, setIoServiceFactoryFactory, setNioWorkers, setParentPropertyResolver, setRandomFactory, setReservedSessionMessagesHandler, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setSessionDisconnectHandler, setUnknownChannelReferenceHandler, setupSessionTimeout, stopSessionTimeoutListener

Methods inherited from class AbstractKexFactoryManager

getCipherFactories, getCompressionFactories, getDelegate, getKexExtensionHandler, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKexExtensionHandler, setKeyExchangeFactories, setMacFactories, setSignatureFactories

Methods inherited from class AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class AbstractCloseable

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, preClose, removeCloseFutureListener

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

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

Methods inherited from interface AttributeRepository

attributeKeys, getAttribute, getAttributesCount

Methods inherited from interface AttributeStore

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

Methods inherited from interface ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface ChannelStreamWriterResolverManager

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

Methods inherited from interface Closeable

close, isOpen

Methods inherited from interface FactoryManager

getAgentFactory, getAgentForwardingFilter, getChannelFactories, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpForwardingFilter, getVersion, getX11ForwardingFilter, resolveAttribute

Methods inherited from interface IoServiceEventListenerManager

getIoServiceEventListener, setIoServiceEventListener

Methods inherited from interface KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

Methods inherited from interface KexFactoryManager

getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames

Methods inherited from interface PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface PropertyResolver

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty, isEmpty

Methods inherited from interface ReservedSessionMessagesManager

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface ServerAuthenticationManager

setUserAuthFactoriesNames

Methods inherited from interface SessionDisconnectHandlerManager

getSessionDisconnectHandler, setSessionDisconnectHandler

Methods inherited from interface SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface SessionListenerManager

addSessionListener, getSessionListenerProxy, removeSessionListener

Methods inherited from interface SignatureFactoriesHolder

getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames

Methods inherited from interface SignatureFactoriesManager

setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Methods inherited from interface UnknownChannelReferenceHandlerManager

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

Methods inherited from interface UserAuthFactoriesManager

getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Field Details

DEFAULT_SSH_SERVER_FACTORY

public static final Factory<SshServer> DEFAULT_SSH_SERVER_FACTORY

DEFAULT_SERVICE_FACTORIES

public static final List<ServiceFactory> DEFAULT_SERVICE_FACTORIES

acceptor

protected IoAcceptor acceptor

host

protected String host

port

protected int port

proxyAcceptor

private ServerProxyAcceptor proxyAcceptor

shellFactory

private ShellFactory shellFactory

sessionFactory

private SessionFactory sessionFactory

commandFactory

private CommandFactory commandFactory

subsystemFactories

private List<? extends SubsystemFactory> subsystemFactories

userAuthFactories

private List<UserAuthFactory> userAuthFactories

keyPairProvider

private KeyPairProvider keyPairProvider

hostKeyCertificateProvider

private HostKeyCertificateProvider hostKeyCertificateProvider

passwordAuthenticator

private PasswordAuthenticator passwordAuthenticator

publickeyAuthenticator

private PublickeyAuthenticator publickeyAuthenticator

interactiveAuthenticator

private KeyboardInteractiveAuthenticator interactiveAuthenticator

hostBasedAuthenticator

private HostBasedAuthenticator hostBasedAuthenticator

gssAuthenticator

private GSSAuthenticator gssAuthenticator

started

private final AtomicBoolean started

Constructor Details

SshServer

public SshServer()

Method Details

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

setPort

public void setPort(int port)

Configure the port number to use for this SSH server.

Parameters:

port - the port number for this SSH server

getBoundAddresses

public Set<SocketAddress> getBoundAddresses()

Returns:

The currently bound addresses - valid only after server started and while not stopped

getUserAuthFactories

public List<UserAuthFactory> getUserAuthFactories()

Description copied from interface: UserAuthFactoriesManager

Retrieve the list of named factories for UserAuth objects.

Specified by:

getUserAuthFactories in interface UserAuthFactoriesManager<ServerSession, UserAuth, UserAuthFactory>

Returns:

a list of named UserAuth factories, never null/empty

setUserAuthFactories

public void setUserAuthFactories(List<UserAuthFactory> userAuthFactories)

Specified by:

setUserAuthFactories in interface UserAuthFactoriesManager<ServerSession, UserAuth, UserAuthFactory>

getShellFactory

public ShellFactory getShellFactory()

Description copied from interface: ServerFactoryManager

Retrieve the ShellFactory object to be used to create shells.

Specified by:

getShellFactory in interface ServerFactoryManager

Returns:

a valid ShellFactory object or null if shells are not supported on this server

setShellFactory

public void setShellFactory(ShellFactory shellFactory)

getSessionFactory

public SessionFactory getSessionFactory()

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

getServerProxyAcceptor

public ServerProxyAcceptor getServerProxyAcceptor()

Specified by:

getServerProxyAcceptor in interface ServerProxyAcceptorHolder

setServerProxyAcceptor

public void setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)

Specified by:

setServerProxyAcceptor in interface ServerProxyAcceptorHolder

getCommandFactory

public CommandFactory getCommandFactory()

Description copied from interface: ServerFactoryManager

Retrieve the CommandFactory to be used to process commands requests.

Specified by:

getCommandFactory in interface ServerFactoryManager

Returns:

A valid CommandFactory object or null if commands are not supported on this server

setCommandFactory

public void setCommandFactory(CommandFactory commandFactory)

getSubsystemFactories

public List<? extends SubsystemFactory> getSubsystemFactories()

Description copied from interface: ServerFactoryManager

Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.

Specified by:

getSubsystemFactories in interface ServerFactoryManager

Returns:

a list of named SubsystemFactory-ies or null/empty if subsystems are not supported on this server

setSubsystemFactories

public void setSubsystemFactories(List<? extends SubsystemFactory> subsystemFactories)

getPasswordAuthenticator

public PasswordAuthenticator getPasswordAuthenticator()

Description copied from interface: ServerAuthenticationManager

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.

Specified by:

getPasswordAuthenticator in interface ServerAuthenticationManager

Returns:

the PasswordAuthenticator or null

setPasswordAuthenticator

public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

Specified by:

setPasswordAuthenticator in interface ServerAuthenticationManager

getPublickeyAuthenticator

public PublickeyAuthenticator getPublickeyAuthenticator()

Description copied from interface: ServerAuthenticationManager

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.

Specified by:

getPublickeyAuthenticator in interface ServerAuthenticationManager

Returns:

the PublickeyAuthenticator or null

setPublickeyAuthenticator

public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

Specified by:

setPublickeyAuthenticator in interface ServerAuthenticationManager

getKeyboardInteractiveAuthenticator

public KeyboardInteractiveAuthenticator getKeyboardInteractiveAuthenticator()

Description copied from interface: ServerAuthenticationManager

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.

Specified by:

getKeyboardInteractiveAuthenticator in interface ServerAuthenticationManager

Returns:

The KeyboardInteractiveAuthenticator or null

setKeyboardInteractiveAuthenticator

public void setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)

Specified by:

setKeyboardInteractiveAuthenticator in interface ServerAuthenticationManager

getGSSAuthenticator

public GSSAuthenticator getGSSAuthenticator()

Description copied from interface: ServerAuthenticationManager

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.

Specified by:

getGSSAuthenticator in interface ServerAuthenticationManager

Returns:

the GSSAuthenticator or null

setGSSAuthenticator

public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

Specified by:

setGSSAuthenticator in interface ServerAuthenticationManager

getHostBasedAuthenticator

public HostBasedAuthenticator getHostBasedAuthenticator()

Description copied from interface: ServerAuthenticationManager

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.

Specified by:

getHostBasedAuthenticator in interface ServerAuthenticationManager

Returns:

the HostBasedAuthenticator or null

setHostBasedAuthenticator

public void setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)

Specified by:

setHostBasedAuthenticator in interface ServerAuthenticationManager

getKeyPairProvider

public KeyPairProvider getKeyPairProvider()

Description copied from interface: KeyPairProviderHolder

Retrieve the KeyPairProvider that will be used to find the host key to use on the server side or the user key on the client side.

Specified by:

getKeyPairProvider in interface KeyPairProviderHolder

Returns:

the KeyPairProvider, never null

setKeyPairProvider

public void setKeyPairProvider(KeyPairProvider keyPairProvider)

Specified by:

setKeyPairProvider in interface KeyPairProviderHolder

getHostKeyCertificateProvider

public HostKeyCertificateProvider getHostKeyCertificateProvider()

Specified by:

getHostKeyCertificateProvider in interface ServerAuthenticationManager

Returns:

a HostKeyCertificateProvider if available, null as default

setHostKeyCertificateProvider

public void setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider)

Specified by:

setHostKeyCertificateProvider in interface ServerAuthenticationManager

checkConfig

protected void checkConfig()

Overrides:

checkConfig in class AbstractFactoryManager

isStarted

public boolean isStarted()

start

public void start()
           throws IOException

Start the SSH server and accept incoming exceptions on the configured port. Ignored if already started

Throws:

IOException - If failed to start

stop

public void stop()
          throws IOException

Stop the SSH server. This method will block until all resources are actually disposed.

Throws:

IOException - if stopping failed somehow

stop

public void stop(boolean immediately)
          throws IOException

Throws:

IOException

open

public void open()
          throws IOException

Throws:

IOException

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class AbstractInnerCloseable

getActiveSessions

public List<AbstractSession> getActiveSessions()

Obtain the list of active sessions.

Returns:

A List of the currently active session

createAcceptor

protected IoAcceptor createAcceptor()

createSessionFactory

protected SessionFactory createSessionFactory()

toString

public String toString()

Overrides:

toString in class Object

setUpDefaultServer

public static SshServer setUpDefaultServer()

Setup a default server

Returns:

a newly create SshServer with default configurations