org.apache.sshd.server

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, AttributeStore, ChannelListenerManager, FactoryManager, PortForwardingEventListenerManager, KexFactoryManager, KeyPairProviderHolder, PropertyResolver, ReservedSessionMessagesManager, SessionListenerManager, SignatureFactoriesManager, ServerAuthenticationManager, ServerFactoryManager, ServerProxyAcceptorHolder

public class SshServer
extends AbstractFactoryManager
implements ServerFactoryManager, Closeable

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.

Author:

Apache MINA SSHD Project

See Also:

ServerFactoryManager, FactoryManager

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeStore

AttributeStore.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected IoAcceptor	acceptor
static List<ServiceFactory>	DEFAULT_SERVICE_FACTORIES
static Factory<SshServer>	DEFAULT_SSH_SERVER_FACTORY
protected String	host
protected int	port

Fields inherited from class org.apache.sshd.common.helpers.AbstractFactoryManager

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

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, lock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.server.ServerFactoryManager

COMMAND_EXIT_TIMEOUT, DEFAULT_COMMAND_EXIT_TIMEOUT, MAX_CONCURRENT_SESSIONS, MODULI_URL, SERVER_EXTRA_IDENT_LINES_SEPARATOR, SERVER_EXTRA_IDENTIFICATION_LINES, SERVER_IDENTIFICATION

Fields inherited from interface org.apache.sshd.common.FactoryManager

AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_AUTH_TIMEOUT, DEFAULT_CHANNEL_CLOSE_TIMEOUT, DEFAULT_DISCONNECT_TIMEOUT, DEFAULT_IDLE_TIMEOUT, DEFAULT_IGNORE_MESSAGE_FREQUENCY, DEFAULT_IGNORE_MESSAGE_SIZE, DEFAULT_IGNORE_MESSAGE_VARIANCE, DEFAULT_LIMIT_PACKET_SIZE, DEFAULT_MAX_IDENTIFICATION_SIZE, DEFAULT_MAX_PACKET_SIZE, DEFAULT_NIO_WORKERS, DEFAULT_NIO2_MIN_WRITE_TIMEOUT, DEFAULT_NIO2_READ_TIMEOUT, DEFAULT_REKEY_BYTES_LIMIT, DEFAULT_REKEY_PACKETS_LIMIT, DEFAULT_REKEY_TIME_LIMIT, DEFAULT_STOP_WAIT_TIME, DEFAULT_VERSION, DEFAULT_WINDOW_SIZE, DEFAULT_WINDOW_TIMEOUT, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, IGNORE_MESSAGE_FREQUENCY, IGNORE_MESSAGE_SIZE, IGNORE_MESSAGE_VARIANCE, LIMIT_PACKET_SIZE, MAX_IDENTIFICATION_SIZE, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_MIN_WRITE_TIMEOUT, NIO2_READ_BUFFER_SIZE, NIO2_READ_TIMEOUT, REKEY_BLOCKS_LIMIT, REKEY_BYTES_LIMIT, REKEY_PACKETS_LIMIT, REKEY_TIME_LIMIT, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, STOP_WAIT_TIME, TCP_NODELAY, WINDOW_SIZE, WINDOW_TIMEOUT

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Fields inherited from interface org.apache.sshd.server.ServerAuthenticationManager

AUTH_METHODS, AUTO_WELCOME_BANNER_VALUE, DEFAULT_BANNER_PHASE, DEFAULT_MAX_AUTH_REQUESTS, DEFAULT_USER_AUTH_GSS_FACTORY, DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY, DEFAULT_USER_AUTH_PASSWORD_FACTORY, DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY, DEFAULT_WELCOME_BANNER_LANGUAGE, MAX_AUTH_REQUESTS, WELCOME_BANNER, WELCOME_BANNER_CHARSET, WELCOME_BANNER_LANGUAGE, WELCOME_BANNER_PHASE

Fields inherited from interface org.apache.sshd.common.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SshServer()

Method Summary

Modifier and Type	Method and Description
protected void	checkConfig()
protected IoAcceptor	createAcceptor()
protected SessionFactory	createSessionFactory()
List<AbstractSession>	getActiveSessions() Obtain the list of active sessions.
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.
protected Closeable	getInnerCloseable()
KeyboardInteractiveAuthenticator	getKeyboardInteractiveAuthenticator() Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.
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()
Factory<Command>	getShellFactory() Retrieve the ShellFactory object to be used to create shells.
List<NamedFactory<Command>>	getSubsystemFactories() Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.
List<NamedFactory<UserAuth>>	getUserAuthFactories() Retrieve the list of named factories for UserAuth objects.
static void	main(String[] args)
void	open()
void	setCommandFactory(CommandFactory commandFactory)
void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
void	setHost(String host)
void	setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)
void	setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)
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(Factory<Command> shellFactory)
void	setSubsystemFactories(List<NamedFactory<Command>> subsystemFactories)
void	setTcpipForwardingFilter(ForwardingFilter forwardingFilter)
static SshServer	setUpDefaultServer()
static Object	setupServerBanner(ServerFactoryManager server, Map<String,?> options)
static KeyPairProvider	setupServerKeys(SshServer sshd, String hostKeyType, int hostKeySize, Collection<String> keyFiles)
void	setUserAuthFactories(List<NamedFactory<UserAuth>> 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 org.apache.sshd.common.helpers.AbstractFactoryManager

addChannelListener, addPortForwardingEventListener, addSessionListener, createSessionTimeoutListener, getAgentFactory, getAttribute, getChannelFactories, getChannelListenerProxy, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getIoServiceFactoryFactory, getNioWorkers, getParentPropertyResolver, getPortForwardingEventListenerProxy, getProperties, getRandomFactory, getReservedSessionMessagesHandler, getScheduledExecutorService, getServiceFactories, getSessionListenerProxy, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion, removeAttribute, removeChannelListener, removePortForwardingEventListener, removeSessionListener, removeSessionTimeout, resolveAttribute, setAgentFactory, setAttribute, setChannelFactories, setFileSystemFactory, setGlobalRequestHandlers, setIoServiceFactoryFactory, setNioWorkers, setParentPropertyResolver, setRandomFactory, setReservedSessionMessagesHandler, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setTcpipForwarderFactory, setupSessionTimeout, stopSessionTimeoutListener

Methods inherited from class org.apache.sshd.common.kex.AbstractKexFactoryManager

getCipherFactories, getCompressionFactories, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setSignatureFactories

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

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

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.FactoryManager

getAgentFactory, getChannelFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion

Methods inherited from interface org.apache.sshd.common.kex.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 org.apache.sshd.common.keyprovider.KeyPairProviderHolder

getKeyPairProvider, setKeyPairProvider

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager

getSignatureFactories, getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Methods inherited from interface org.apache.sshd.common.session.SessionListenerManager

addSessionListener, getSessionListenerProxy, removeSessionListener

Methods inherited from interface org.apache.sshd.common.session.ReservedSessionMessagesManager

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.apache.sshd.common.AttributeStore

getAttribute, removeAttribute, resolveAttribute, resolveAttribute, resolveAttribute, resolveAttribute, setAttribute

Methods inherited from interface org.apache.sshd.common.PropertyResolver

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

Methods inherited from interface org.apache.sshd.server.ServerAuthenticationManager

getUserAuthFactoriesNameList, getUserAuthFactoriesNames, resolveUserAuthFactories, resolveUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames, setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Detail

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

Constructor Detail

SshServer

public SshServer()

Method Detail

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

getUserAuthFactories

public List<NamedFactory<UserAuth>> getUserAuthFactories()

Description copied from interface: ServerAuthenticationManager

Retrieve the list of named factories for UserAuth objects.

Specified by:

getUserAuthFactories in interface ServerAuthenticationManager

Returns:

a list of named UserAuth factories, never null/empty

setUserAuthFactories

public void setUserAuthFactories(List<NamedFactory<UserAuth>> userAuthFactories)

Specified by:

setUserAuthFactories in interface ServerAuthenticationManager

getShellFactory

public Factory<Command> 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(Factory<Command> 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<NamedFactory<Command>> 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 CommandFactory.Command factories or null if subsystems are not supported on this server

setSubsystemFactories

public void setSubsystemFactories(List<NamedFactory<Command>> 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

setTcpipForwardingFilter

public void setTcpipForwardingFilter(ForwardingFilter forwardingFilter)

Overrides:

setTcpipForwardingFilter in class AbstractFactoryManager

checkConfig

protected void checkConfig()

Overrides:

checkConfig in class AbstractFactoryManager

start

public void start()
           throws IOException

Start the SSH server and accept incoming exceptions on the configured port.

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()

setupServerKeys

public static KeyPairProvider setupServerKeys(SshServer sshd,
                                              String hostKeyType,
                                              int hostKeySize,
                                              Collection<String> keyFiles)
                                       throws Exception

Throws:

Exception

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

setupServerBanner

public static Object setupServerBanner(ServerFactoryManager server,
                                       Map<String,?> options)
                                throws Exception

Throws:

Exception