org.apache.sshd.server

Class SshServer

java.lang.Object

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

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.AbstractFactoryManager

org.apache.sshd.server.SshServer

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, FactoryManager, ServerFactoryManager

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 AbstractFactoryManager.setProperties(java.util.Map) method.

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.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected IoAcceptor	acceptor
protected CommandFactory	commandFactory
static List<ServiceFactory>	DEFAULT_SERVICE_FACTORIES
static Factory<SshServer>	DEFAULT_SSH_SERVER_FACTORY
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
protected GSSAuthenticator	gssAuthenticator
protected String	host
protected PasswordAuthenticator	passwordAuthenticator
protected int	port
protected PublickeyAuthenticator	publickeyAuthenticator
protected SessionFactory	sessionFactory
protected Factory<Command>	shellFactory
protected List<NamedFactory<Command>>	subsystemFactories
protected List<NamedFactory<UserAuth>>	userAuthFactories

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

agentFactory, channelFactories, cipherFactories, compressionFactories, executor, fileSystemFactory, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, keyExchangeFactories, keyPairProvider, macFactories, properties, randomFactory, serviceFactories, sessionTimeoutListener, shutdownExecutor, signatureFactories, tcpipForwarderFactory, tcpipForwardingFilter, timeoutListenerFuture

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.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

AUTH_METHODS, COMMAND_EXIT_TIMEOUT, MAX_AUTH_REQUESTS, MAX_CONCURRENT_SESSIONS, MODULI_URL, REKEY_BYTES_LIMIT, REKEY_TIME_LIMIT, SERVER_IDENTIFICATION, WELCOME_BANNER

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

AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_NIO_WORKERS, DEFAULT_VERSION, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_READ_BUFFER_SIZE, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, TCP_NODELAY, WINDOW_SIZE, WINDOW_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()
protected Closeable	getInnerCloseable()
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.
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	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
void	setPort(int port) Configure the port number to use for this SSH server.
void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
void	setSessionFactory(SessionFactory sessionFactory)
void	setShellFactory(Factory<Command> shellFactory)
void	setSubsystemFactories(List<NamedFactory<Command>> subsystemFactories)
void	setTcpipForwardingFilter(ForwardingFilter forwardingFilter)
static SshServer	setUpDefaultServer()
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.AbstractFactoryManager

createSessionTimeoutListener, getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getIoServiceFactoryFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getNioWorkers, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion, removeSessionTimeout, setAgentFactory, setChannelFactories, setCipherFactories, setCompressionFactories, setFileSystemFactory, setGlobalRequestHandlers, setIoServiceFactoryFactory, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setNioWorkers, setProperties, setRandomFactory, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setSignatureFactories, setTcpipForwarderFactory, setupSessionTimeout, stopSessionTimeoutListener

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

doCloseGracefully, doCloseImmediately

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

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

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, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion

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

close, isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

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

DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

public static final UserAuthPublicKeyFactory DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

DEFAULT_USER_AUTH_GSS_FACTORY

public static final UserAuthGSSFactory DEFAULT_USER_AUTH_GSS_FACTORY

DEFAULT_USER_AUTH_PASSWORD_FACTORY

public static final UserAuthPasswordFactory DEFAULT_USER_AUTH_PASSWORD_FACTORY

DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY

public static final UserAuthKeyboardInteractiveFactory DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY

acceptor

protected IoAcceptor acceptor

host

protected String host

port

protected int port

userAuthFactories

protected List<NamedFactory<UserAuth>> userAuthFactories

shellFactory

protected Factory<Command> shellFactory

sessionFactory

protected SessionFactory sessionFactory

commandFactory

protected CommandFactory commandFactory

subsystemFactories

protected List<NamedFactory<Command>> subsystemFactories

passwordAuthenticator

protected PasswordAuthenticator passwordAuthenticator

publickeyAuthenticator

protected PublickeyAuthenticator publickeyAuthenticator

gssAuthenticator

protected GSSAuthenticator gssAuthenticator

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: ServerFactoryManager

Retrieve the list of named factories for UserAuth objects.

Specified by:

getUserAuthFactories in interface ServerFactoryManager

Returns:

a list of named UserAuth factories, never null

setUserAuthFactories

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

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)

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: ServerFactoryManager

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 ServerFactoryManager

Returns:

the PasswordAuthenticator or null

setPasswordAuthenticator

public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

getPublickeyAuthenticator

public PublickeyAuthenticator getPublickeyAuthenticator()

Description copied from interface: ServerFactoryManager

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 ServerFactoryManager

Returns:

the PublickeyAuthenticato or null

setPublickeyAuthenticator

public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

getGSSAuthenticator

public GSSAuthenticator getGSSAuthenticator()

Description copied from interface: ServerFactoryManager

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 ServerFactoryManager

Returns:

the GSSAuthenticator or null

setGSSAuthenticator

public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

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

main

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

Throws:

Exception