public class SshServer extends AbstractFactoryManager implements ServerFactoryManager, Closeable
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.ServerFactoryManager
,
FactoryManager
CloseableUtils.AbstractCloseable.State
Modifier and Type | Field and Description |
---|---|
protected IoAcceptor |
acceptor |
protected CommandFactory |
commandFactory |
static Factory<SshServer> |
DEFAULT_SSH_SERVER_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 |
agentFactory, channelFactories, cipherFactories, compressionFactories, executor, fileSystemFactory, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, keyExchangeFactories, keyPairProvider, macFactories, properties, randomFactory, serviceFactories, sessionTimeoutListener, shutdownExecutor, signatureFactories, tcpipForwarderFactory, tcpipForwardingFilter, timeoutListenerFuture, version
closeFuture, lock, log, state
AUTH_METHODS, COMMAND_EXIT_TIMEOUT, MAX_AUTH_REQUESTS, MAX_CONCURRENT_SESSIONS, MODULI_URL, REKEY_BYTES_LIMIT, REKEY_TIME_LIMIT, SERVER_IDENTIFICATION, WELCOME_BANNER
AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_NIO_WORKERS, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, MAX_PACKET_SIZE, NIO_WORKERS, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, TCP_NODELAY, WINDOW_SIZE
Constructor and Description |
---|
SshServer() |
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() |
createSessionTimeoutListener, getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getIoServiceFactoryFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getNioWorkers, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion, loadVersion, removeSessionTimeout, setAgentFactory, setChannelFactories, setCipherFactories, setCompressionFactories, setFileSystemFactory, setGlobalRequestHandlers, setIoServiceFactoryFactory, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setNioWorkers, setProperties, setRandomFactory, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setSignatureFactories, setTcpipForwarderFactory, setupSessionTimeout, stopSessionTimeoutListener
doCloseGracefully, doCloseImmediately
builder, close, isClosed, isClosing, preClose
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion
protected IoAcceptor acceptor
protected String host
protected int port
protected List<NamedFactory<UserAuth>> userAuthFactories
protected SessionFactory sessionFactory
protected CommandFactory commandFactory
protected List<NamedFactory<Command>> subsystemFactories
protected PasswordAuthenticator passwordAuthenticator
protected PublickeyAuthenticator publickeyAuthenticator
protected GSSAuthenticator gssAuthenticator
public String getHost()
public void setHost(String host)
public int getPort()
public void setPort(int port)
port
- the port number for this SSH serverpublic List<NamedFactory<UserAuth>> getUserAuthFactories()
ServerFactoryManager
UserAuth
objects.getUserAuthFactories
in interface ServerFactoryManager
UserAuth
factories, never null
public void setUserAuthFactories(List<NamedFactory<UserAuth>> userAuthFactories)
public Factory<Command> getShellFactory()
ServerFactoryManager
ShellFactory
object to be used to create shells.getShellFactory
in interface ServerFactoryManager
ShellFactory
object or null
if shells
are not supported on this serverpublic SessionFactory getSessionFactory()
public void setSessionFactory(SessionFactory sessionFactory)
public CommandFactory getCommandFactory()
ServerFactoryManager
CommandFactory
to be used to process commands requests.getCommandFactory
in interface ServerFactoryManager
CommandFactory
object or null
if commands
are not supported on this serverpublic void setCommandFactory(CommandFactory commandFactory)
public List<NamedFactory<Command>> getSubsystemFactories()
ServerFactoryManager
CommandFactory.Command
to
be used to create subsystems.getSubsystemFactories
in interface ServerFactoryManager
CommandFactory.Command
factories
or null
if subsystems are not supported on this serverpublic void setSubsystemFactories(List<NamedFactory<Command>> subsystemFactories)
public PasswordAuthenticator getPasswordAuthenticator()
ServerFactoryManager
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.getPasswordAuthenticator
in interface ServerFactoryManager
PasswordAuthenticator
or null
public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
public PublickeyAuthenticator getPublickeyAuthenticator()
ServerFactoryManager
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.getPublickeyAuthenticator
in interface ServerFactoryManager
PublickeyAuthenticato
or null
public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
public GSSAuthenticator getGSSAuthenticator()
ServerFactoryManager
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.getGSSAuthenticator
in interface ServerFactoryManager
GSSAuthenticator
or null
public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
public void setTcpipForwardingFilter(ForwardingFilter forwardingFilter)
setTcpipForwardingFilter
in class AbstractFactoryManager
protected void checkConfig()
public void start() throws IOException
IOException
public void stop() throws InterruptedException
InterruptedException
public void stop(boolean immediately) throws InterruptedException
InterruptedException
public void open() throws IOException
IOException
protected Closeable getInnerCloseable()
getInnerCloseable
in class CloseableUtils.AbstractInnerCloseable
public List<AbstractSession> getActiveSessions()
protected IoAcceptor createAcceptor()
protected SessionFactory createSessionFactory()
public static SshServer setUpDefaultServer()
Copyright © 2008–2017 The Apache Software Foundation. All rights reserved.