Apache Mina SSHD 2.15.0 · org.apache.sshd.server.session.AbstractServerSession

Modifier and Type	Field and Description
private SocketAddress	clientAddress
private GSSAuthenticator	gssAuthenticator
private HostBasedAuthenticator	hostBasedAuthenticator
private HostKeyCertificateProvider	hostKeyCertificateProvider
private KeyboardInteractiveAuthenticator	interactiveAuthenticator
private KeyPairProvider	keyPairProvider
private PasswordAuthenticator	passwordAuthenticator
private ServerProxyAcceptor	proxyAcceptor
private PublickeyAuthenticator	publickeyAuthenticator
private List<UserAuthFactory>	userAuthFactories

Modifier and Type

Field and Description

private SocketAddress

clientAddress

private GSSAuthenticator

gssAuthenticator

private HostBasedAuthenticator

hostBasedAuthenticator

private HostKeyCertificateProvider

hostKeyCertificateProvider

private KeyboardInteractiveAuthenticator

interactiveAuthenticator

private KeyPairProvider

keyPairProvider

private PasswordAuthenticator

passwordAuthenticator

private ServerProxyAcceptor

proxyAcceptor

private PublickeyAuthenticator

publickeyAuthenticator

private List<UserAuthFactory>

userAuthFactories

Access	Constructor and Description
protected	AbstractServerSession(ServerFactoryManager factoryManager, IoSession ioSession)

Access

Constructor and Description

protected

AbstractServerSession(ServerFactoryManager factoryManager, IoSession ioSession)

Modifier and Type	Method and Description
protected void	checkKeys() Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.checkKeys. Indicates the the key exchange is completed and the exchanged keys can now be verified - e.g., client can verify the server's key
public int	getActiveSessionCountForUser(String The name of the user - ignored if `null`/empty userName) Implements org.apache.sshd.server.session.ServerSession.getActiveSessionCountForUser. Retrieve the current number of sessions active for a given username.
public SocketAddress	getClientAddress() Implements org.apache.sshd.server.session.ServerSession.getClientAddress.
protected ConnectionService	getConnectionService() Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.getConnectionService.
public ServerFactoryManager	getFactoryManager() Overrides org.apache.sshd.common.session.helpers.SessionHelper.getFactoryManager. Implements org.apache.sshd.server.session.ServerSession.getFactoryManager, org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.
public GSSAuthenticator	getGSSAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getGSSAuthenticator. Retrieve the `GSSAuthenticator` to be used by the SSH server.
public HostBasedAuthenticator	getHostBasedAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getHostBasedAuthenticator. Retrieve the `HostBasedAuthenticator` to be used by the SSH server.
public KeyPair	getHostKey() Implements org.apache.sshd.server.session.ServerSession.getHostKey.
public HostKeyCertificateProvider	getHostKeyCertificateProvider() Implements org.apache.sshd.server.ServerAuthenticationManager.getHostKeyCertificateProvider.
public long	Returns: The underlying `IoSession` id. getId()
public KeyboardInteractiveAuthenticator	getKeyboardInteractiveAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getKeyboardInteractiveAuthenticator. Retrieve the `KeyboardInteractiveAuthenticator` to be used by the SSH server.
public KeyPairProvider	getKeyPairProvider() Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.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.
public PasswordAuthenticator	getPasswordAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getPasswordAuthenticator. Retrieve the `PasswordAuthenticator` to be used by the SSH server.
public PublickeyAuthenticator	getPublickeyAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getPublickeyAuthenticator. Retrieve the `PublickeyAuthenticator` to be used by SSH server.
public ServerProxyAcceptor	getServerProxyAcceptor() Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.getServerProxyAcceptor.
public List<UserAuthFactory>	getUserAuthFactories() Implements org.apache.sshd.common.auth.UserAuthFactoriesManager.getUserAuthFactories. Retrieve the list of named factories for `UserAuth` objects.
protected void	handleServiceAccept(String serviceName, Buffer buffer) Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceAccept.
protected boolean	handleServiceRequest(String serviceName, Buffer buffer) Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceRequest.
protected boolean	readIdentification(Buffer The `Buffer` containing the remote identification buffer) Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.readIdentification. Read the other side identification.
protected void	receiveKexInit(Map<KexProposalOption, String> proposal, byte[] seed) Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.receiveKexInit.
protected String	resolveAvailableSignaturesProposal(FactoryManager The `FactoryManager` proposedManager) Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.resolveAvailableSignaturesProposal. Computes the list of available host key signature algorithms supported.
protected String	Returns: The resolved proposal - `null` by default resolveEmptySignaturesProposal(Iterable<String> The supported key types - may be `null`/empty supported, Iterable<String> The available signature types - may be `null`/empty provided) Called by `resolveAvailableSignaturesProposal(FactoryManager)` if none of the provided keys is supported - last chance for the derived implementation to do something
protected byte[]	sendKexInit(Map<KexProposalOption, String> our proposal for key exchange negotiation proposal) Overrides org.apache.sshd.common.session.helpers.AbstractSession.sendKexInit. Send the key exchange initialization packet.
protected IoWriteFuture	Returns: An `IoWriteFuture` that can be used to be notified of identification data being written successfully or failing sendServerIdentification(List<String> Extra header lines to be prepended to the actual identification string - ignored if `null`/empty headerLines) Sends the server identification + any extra header lines
public void	setClientAddress(SocketAddress clientAddress)
public void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setGSSAuthenticator.
public void	setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setHostBasedAuthenticator.
public void	setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider) Implements org.apache.sshd.server.ServerAuthenticationManager.setHostKeyCertificateProvider.
protected void	setKexSeed(byte... The result of the KEXINIT handshake - required for correct session key establishment seed) Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.setKexSeed.
public void	setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setKeyboardInteractiveAuthenticator.
public void	setKeyPairProvider(KeyPairProvider keyPairProvider) Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.setKeyPairProvider.
public void	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setPasswordAuthenticator.
public void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setPublickeyAuthenticator.
public void	setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor) Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.setServerProxyAcceptor.
public void	setUserAuthFactories(List<UserAuthFactory> userAuthFactories) Implements org.apache.sshd.common.auth.UserAuthFactoriesManager.setUserAuthFactories.
public IoWriteFuture	signalAuthenticationSuccess(String The authenticated username username, String The service to start authService, Buffer Any extra data received to use to start the service buffer) Implements org.apache.sshd.server.session.ServerSession.signalAuthenticationSuccess. Marks the session as authenticated. Starts the specified service. Sends the `SSH_MSG_USERAUTH_SUCCESS` message.
public void	startService(String Service name name, Buffer Extra information provided when the service start request was received buffer) Implements org.apache.sshd.common.session.Session.startService.

Modifier and Type

Method and Description

protected void

checkKeys()

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.checkKeys.

Indicates the the key exchange is completed and the exchanged keys can now be verified - e.g., client can verify the server's key

public int

getActiveSessionCountForUser(String

The name of the user - ignored if null/empty

userName)

Implements org.apache.sshd.server.session.ServerSession.getActiveSessionCountForUser.

Retrieve the current number of sessions active for a given username.

public SocketAddress

getClientAddress()

Implements org.apache.sshd.server.session.ServerSession.getClientAddress.

protected ConnectionService

getConnectionService()

Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.getConnectionService.

public ServerFactoryManager

getFactoryManager()

Overrides org.apache.sshd.common.session.helpers.SessionHelper.getFactoryManager.

Implements org.apache.sshd.server.session.ServerSession.getFactoryManager, org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.

public GSSAuthenticator

getGSSAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getGSSAuthenticator.

Retrieve the GSSAuthenticator to be used by the SSH server.

public HostBasedAuthenticator

getHostBasedAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getHostBasedAuthenticator.

Retrieve the HostBasedAuthenticator to be used by the SSH server.

public KeyPair

getHostKey()

Implements org.apache.sshd.server.session.ServerSession.getHostKey.

public HostKeyCertificateProvider

getHostKeyCertificateProvider()

Implements org.apache.sshd.server.ServerAuthenticationManager.getHostKeyCertificateProvider.

public long

Returns:

The underlying IoSession id.

getId()

public KeyboardInteractiveAuthenticator

getKeyboardInteractiveAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getKeyboardInteractiveAuthenticator.

Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.

public KeyPairProvider

getKeyPairProvider()

Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.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.

public PasswordAuthenticator

getPasswordAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getPasswordAuthenticator.

Retrieve the PasswordAuthenticator to be used by the SSH server.

public PublickeyAuthenticator

getPublickeyAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getPublickeyAuthenticator.

Retrieve the PublickeyAuthenticator to be used by SSH server.

public ServerProxyAcceptor

getServerProxyAcceptor()

Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.getServerProxyAcceptor.

public List<UserAuthFactory>

getUserAuthFactories()

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

Retrieve the list of named factories for UserAuth objects.

protected void

handleServiceAccept(String serviceName, Buffer buffer)

Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceAccept.

protected boolean

handleServiceRequest(String serviceName, Buffer buffer)

Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceRequest.

protected boolean

readIdentification(Buffer

The Buffer containing the remote identification

buffer)

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.readIdentification.

Read the other side identification.

protected void

receiveKexInit(Map<KexProposalOption, String> proposal, byte[] seed)

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.receiveKexInit.

protected String

resolveAvailableSignaturesProposal(FactoryManager

The FactoryManager

proposedManager)

Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.resolveAvailableSignaturesProposal.

Computes the list of available host key signature algorithms supported.

protected String

Returns:

The resolved proposal - null by default

resolveEmptySignaturesProposal(Iterable<String>

The supported key types - may be null/empty

supported, Iterable<String>

The available signature types - may be null/empty

provided)

Called by resolveAvailableSignaturesProposal(FactoryManager) if none of the provided keys is supported - last chance for the derived implementation to do something

protected byte[]

sendKexInit(Map<KexProposalOption, String>

our proposal for key exchange negotiation

proposal)

Overrides org.apache.sshd.common.session.helpers.AbstractSession.sendKexInit.

Send the key exchange initialization packet.

protected IoWriteFuture

Returns:

An IoWriteFuture that can be used to be notified of identification data being written successfully or failing

sendServerIdentification(List<String>

Extra header lines to be prepended to the actual identification string - ignored if null/empty

headerLines)

Sends the server identification + any extra header lines

public void

setClientAddress(SocketAddress clientAddress)

public void

setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setGSSAuthenticator.

public void

setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setHostBasedAuthenticator.

public void

setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider)

Implements org.apache.sshd.server.ServerAuthenticationManager.setHostKeyCertificateProvider.

protected void

setKexSeed(byte...

The result of the KEXINIT handshake - required for correct session key establishment

seed)

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.setKexSeed.

public void

setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setKeyboardInteractiveAuthenticator.

public void

setKeyPairProvider(KeyPairProvider keyPairProvider)

Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.setKeyPairProvider.

public void

setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setPasswordAuthenticator.

public void

setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setPublickeyAuthenticator.

public void

setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)

Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.setServerProxyAcceptor.

public void

setUserAuthFactories(List<UserAuthFactory> userAuthFactories)

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

public IoWriteFuture

signalAuthenticationSuccess(String

The authenticated username

username, String

The service to start

authService, Buffer

Any extra data received to use to start the service

buffer)

Implements org.apache.sshd.server.session.ServerSession.signalAuthenticationSuccess.

Marks the session as authenticated.
Starts the specified service.
Sends the SSH_MSG_USERAUTH_SUCCESS message.

public void

startService(String

Service name

name, Buffer

Extra information provided when the service start request was received

buffer)

Implements org.apache.sshd.common.session.Session.startService.

clientAddress	back to summary
private SocketAddress clientAddress

clientAddress

back to summary

private SocketAddress clientAddress

gssAuthenticator	back to summary
private GSSAuthenticator gssAuthenticator

gssAuthenticator

back to summary

private GSSAuthenticator gssAuthenticator

hostBasedAuthenticator	back to summary
private HostBasedAuthenticator hostBasedAuthenticator

hostBasedAuthenticator

back to summary

private HostBasedAuthenticator hostBasedAuthenticator

hostKeyCertificateProvider	back to summary
private HostKeyCertificateProvider hostKeyCertificateProvider

hostKeyCertificateProvider

back to summary

private HostKeyCertificateProvider hostKeyCertificateProvider

interactiveAuthenticator	back to summary
private KeyboardInteractiveAuthenticator interactiveAuthenticator

interactiveAuthenticator

back to summary

private KeyboardInteractiveAuthenticator interactiveAuthenticator

keyPairProvider	back to summary
private KeyPairProvider keyPairProvider

keyPairProvider

back to summary

private KeyPairProvider keyPairProvider

passwordAuthenticator	back to summary
private PasswordAuthenticator passwordAuthenticator

passwordAuthenticator

back to summary

private PasswordAuthenticator passwordAuthenticator

proxyAcceptor	back to summary
private ServerProxyAcceptor proxyAcceptor

proxyAcceptor

back to summary

private ServerProxyAcceptor proxyAcceptor

publickeyAuthenticator	back to summary
private PublickeyAuthenticator publickeyAuthenticator

publickeyAuthenticator

back to summary

private PublickeyAuthenticator publickeyAuthenticator

userAuthFactories	back to summary
private List<UserAuthFactory> userAuthFactories

userAuthFactories

back to summary

private List<UserAuthFactory> userAuthFactories

AbstractServerSession	back to summary
protected AbstractServerSession(ServerFactoryManager factoryManager, IoSession ioSession)

AbstractServerSession

back to summary

protected AbstractServerSession(ServerFactoryManager factoryManager, IoSession ioSession)

Method Detail

checkKeys	back to summary
protected void checkKeys() Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.checkKeys. Doc from org.apache.sshd.common.session.helpers.AbstractSession.checkKeys. Indicates the the key exchange is completed and the exchanged keys can now be verified - e.g., client can verify the server's key Annotations @Override

checkKeys

back to summary

protected void checkKeys()

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.checkKeys.

Doc from org.apache.sshd.common.session.helpers.AbstractSession.checkKeys.

Indicates the the key exchange is completed and the exchanged keys can now be verified - e.g., client can verify the server's key

Annotations

@Override

getActiveSessionCountForUser back to summary

getActiveSessionCountForUser	back to summary
public int getActiveSessionCountForUser(String userName) Implements org.apache.sshd.server.session.ServerSession.getActiveSessionCountForUser. Doc from org.apache.sshd.server.session.ServerSession.getActiveSessionCountForUser. Retrieve the current number of sessions active for a given username. Parameters userName:String The name of the user - ignored if `null`/empty Returns:int The current number of live `SshSession` objects associated with the user Annotations @Override

public int getActiveSessionCountForUser(String userName)

Implements org.apache.sshd.server.session.ServerSession.getActiveSessionCountForUser.

Doc from org.apache.sshd.server.session.ServerSession.getActiveSessionCountForUser.

Retrieve the current number of sessions active for a given username.

Parameters

userName:String: The name of the user - ignored if null/empty

Returns:int

The current number of live SshSession objects associated with the user

Annotations

@Override

getClientAddress back to summary

getClientAddress	back to summary
public SocketAddress getClientAddress() Implements org.apache.sshd.server.session.ServerSession.getClientAddress. Returns:SocketAddress Doc from org.apache.sshd.server.session.ServerSession.getClientAddress. The `SocketAddress` of the remote client. If no proxy wrapping was used then this is the same as the `IoSession#getRemoteAddress()`. Otherwise, it indicates the real client's address that was somehow transmitted via the proxy meta-data Annotations @Override

public SocketAddress getClientAddress()

Implements org.apache.sshd.server.session.ServerSession.getClientAddress.

Returns:SocketAddress

Doc from org.apache.sshd.server.session.ServerSession.getClientAddress.

The SocketAddress of the remote client. If no proxy wrapping was used then this is the same as the IoSession#getRemoteAddress(). Otherwise, it indicates the real client's address that was somehow transmitted via the proxy meta-data

Annotations

@Override

getConnectionService	back to summary
protected ConnectionService getConnectionService() Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.getConnectionService. Annotations @Override

getConnectionService

back to summary

protected ConnectionService getConnectionService()

Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.getConnectionService.

Annotations

@Override

getFactoryManager back to summary

getFactoryManager	back to summary
public ServerFactoryManager getFactoryManager() Overrides org.apache.sshd.common.session.helpers.SessionHelper.getFactoryManager. Implements org.apache.sshd.server.session.ServerSession.getFactoryManager, org.apache.sshd.common.FactoryManagerHolder.getFactoryManager. Returns:ServerFactoryManager Doc from org.apache.sshd.server.session.ServerSession.getFactoryManager. The `ServerFactoryManager` for this session Annotations @Override

public ServerFactoryManager getFactoryManager()

Overrides org.apache.sshd.common.session.helpers.SessionHelper.getFactoryManager.

Implements org.apache.sshd.server.session.ServerSession.getFactoryManager, org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.

Returns:ServerFactoryManager

Doc from org.apache.sshd.server.session.ServerSession.getFactoryManager.

The ServerFactoryManager for this session

Annotations

@Override

getGSSAuthenticator back to summary

getGSSAuthenticator	back to summary
public GSSAuthenticator getGSSAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getGSSAuthenticator. Doc from org.apache.sshd.server.ServerAuthenticationManager.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` Annotations @Override

public GSSAuthenticator getGSSAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getGSSAuthenticator.

Doc from org.apache.sshd.server.ServerAuthenticationManager.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

Annotations

@Override

getHostBasedAuthenticator back to summary

getHostBasedAuthenticator	back to summary
public HostBasedAuthenticator getHostBasedAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getHostBasedAuthenticator. Doc from org.apache.sshd.server.ServerAuthenticationManager.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` Annotations @Override

public HostBasedAuthenticator getHostBasedAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getHostBasedAuthenticator.

Doc from org.apache.sshd.server.ServerAuthenticationManager.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

Annotations

@Override

getHostKey back to summary

getHostKey	back to summary
public KeyPair getHostKey() Implements org.apache.sshd.server.session.ServerSession.getHostKey. Returns:KeyPair Doc from org.apache.sshd.server.session.ServerSession.getHostKey. The `KeyPair` representing the current session's used keys on KEX - `null` if not negotiated yet Annotations @Override

public KeyPair getHostKey()

Implements org.apache.sshd.server.session.ServerSession.getHostKey.

Returns:KeyPair

Doc from org.apache.sshd.server.session.ServerSession.getHostKey.

The KeyPair representing the current session's used keys on KEX - null if not negotiated yet

Annotations

@Override

getHostKeyCertificateProvider back to summary

getHostKeyCertificateProvider	back to summary
public HostKeyCertificateProvider getHostKeyCertificateProvider() Implements org.apache.sshd.server.ServerAuthenticationManager.getHostKeyCertificateProvider. Returns:HostKeyCertificateProvider Doc from org.apache.sshd.server.ServerAuthenticationManager.getHostKeyCertificateProvider. a `HostKeyCertificateProvider` if available, null as default Annotations @Override

public HostKeyCertificateProvider getHostKeyCertificateProvider()

Implements org.apache.sshd.server.ServerAuthenticationManager.getHostKeyCertificateProvider.

Returns:HostKeyCertificateProvider

Doc from org.apache.sshd.server.ServerAuthenticationManager.getHostKeyCertificateProvider.

a HostKeyCertificateProvider if available, null as default

Annotations

@Override

getId	back to summary
public long getId() Returns:long The underlying `IoSession` id.

getKeyboardInteractiveAuthenticator back to summary

getKeyboardInteractiveAuthenticator	back to summary
public KeyboardInteractiveAuthenticator getKeyboardInteractiveAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getKeyboardInteractiveAuthenticator. Doc from org.apache.sshd.server.ServerAuthenticationManager.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` Annotations @Override

public KeyboardInteractiveAuthenticator getKeyboardInteractiveAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getKeyboardInteractiveAuthenticator.

Doc from org.apache.sshd.server.ServerAuthenticationManager.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

Annotations

@Override

getKeyPairProvider back to summary

getKeyPairProvider	back to summary
public KeyPairProvider getKeyPairProvider() Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.getKeyPairProvider. Doc from org.apache.sshd.common.keyprovider.KeyPairProviderHolder.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. Returns:KeyPairProvider the `KeyPairProvider`, never `null` Annotations @Override

public KeyPairProvider getKeyPairProvider()

Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.getKeyPairProvider.

Doc from org.apache.sshd.common.keyprovider.KeyPairProviderHolder.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.

Returns:KeyPairProvider

the KeyPairProvider, never null

Annotations

@Override

getPasswordAuthenticator back to summary

getPasswordAuthenticator	back to summary
public PasswordAuthenticator getPasswordAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getPasswordAuthenticator. Doc from org.apache.sshd.server.ServerAuthenticationManager.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` Annotations @Override

public PasswordAuthenticator getPasswordAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getPasswordAuthenticator.

Doc from org.apache.sshd.server.ServerAuthenticationManager.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

Annotations

@Override

getPublickeyAuthenticator back to summary

getPublickeyAuthenticator	back to summary
public PublickeyAuthenticator getPublickeyAuthenticator() Implements org.apache.sshd.server.ServerAuthenticationManager.getPublickeyAuthenticator. Doc from org.apache.sshd.server.ServerAuthenticationManager.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` Annotations @Override

public PublickeyAuthenticator getPublickeyAuthenticator()

Implements org.apache.sshd.server.ServerAuthenticationManager.getPublickeyAuthenticator.

Doc from org.apache.sshd.server.ServerAuthenticationManager.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

Annotations

@Override

getServerProxyAcceptor	back to summary
public ServerProxyAcceptor getServerProxyAcceptor() Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.getServerProxyAcceptor. Annotations @Override

getServerProxyAcceptor

back to summary

public ServerProxyAcceptor getServerProxyAcceptor()

Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.getServerProxyAcceptor.

Annotations

@Override

getUserAuthFactories back to summary

getUserAuthFactories	back to summary
public List<UserAuthFactory> getUserAuthFactories() Implements org.apache.sshd.common.auth.UserAuthFactoriesManager.getUserAuthFactories. Doc from org.apache.sshd.common.auth.UserAuthFactoriesManager.getUserAuthFactories. Retrieve the list of named factories for `UserAuth` objects. Returns:List<UserAuthFactory> a list of named `UserAuth` factories, never `null`/empty Annotations @Override

public List<UserAuthFactory> getUserAuthFactories()

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

Doc from org.apache.sshd.common.auth.UserAuthFactoriesManager.getUserAuthFactories.

Retrieve the list of named factories for UserAuth objects.

Returns:List<UserAuthFactory>

a list of named UserAuth factories, never null/empty

Annotations

@Override

handleServiceAccept	back to summary
protected void handleServiceAccept(String serviceName, Buffer buffer) throws Exception Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceAccept. Annotations @Override

handleServiceAccept

back to summary

protected void handleServiceAccept(String serviceName, Buffer buffer) throws Exception

Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceAccept.

Annotations

@Override

handleServiceRequest	back to summary
protected boolean handleServiceRequest(String serviceName, Buffer buffer) throws Exception Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceRequest. Annotations @Override

handleServiceRequest

back to summary

protected boolean handleServiceRequest(String serviceName, Buffer buffer) throws Exception

Overrides org.apache.sshd.common.session.helpers.AbstractSession.handleServiceRequest.

Annotations

@Override

readIdentification back to summary

readIdentification	back to summary
protected boolean readIdentification(Buffer buffer) throws Exception Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.readIdentification. Doc from org.apache.sshd.common.session.helpers.AbstractSession.readIdentification. Read the other side identification. This method is specific to the client or server side, but both should call `doReadIdentification(Buffer, boolean)` and store the result in the needed property. Parameters buffer:Buffer The `Buffer` containing the remote identification Returns:boolean `true` if the identification has been fully read or `false` if more data is needed Annotations @Override Exceptions Exception: if an error occurs such as a bad protocol version or unsuccessful KEX was involved

protected boolean readIdentification(Buffer buffer) throws Exception

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.readIdentification.

Doc from org.apache.sshd.common.session.helpers.AbstractSession.readIdentification.

Read the other side identification. This method is specific to the client or server side, but both should call doReadIdentification(Buffer, boolean) and store the result in the needed property.

Parameters

buffer:Buffer: The Buffer containing the remote identification

Returns:boolean

true if the identification has been fully read or false if more data is needed

Annotations

@Override

Exceptions

Exception:: if an error occurs such as a bad protocol version or unsuccessful KEX was involved

receiveKexInit	back to summary
protected void receiveKexInit(Map<KexProposalOption, String> proposal, byte[] seed) throws IOException Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.receiveKexInit. Annotations @Override

receiveKexInit

back to summary

protected void receiveKexInit(Map<KexProposalOption, String> proposal, byte[] seed) throws IOException

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.receiveKexInit.

Annotations

@Override

resolveAvailableSignaturesProposal back to summary

resolveAvailableSignaturesProposal	back to summary
protected String resolveAvailableSignaturesProposal(FactoryManager proposedManager) throws IOException, GeneralSecurityException Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.resolveAvailableSignaturesProposal. Doc from org.apache.sshd.common.session.helpers.SessionHelper.resolveAvailableSignaturesProposal. Computes the list of available host key signature algorithms supported. Parameters proposedManager:FactoryManager The `FactoryManager` Returns:String A comma-separated list of all the signature protocols to be included in the proposal - `null`/empty if no proposal Annotations @Override Exceptions IOException: If failed to read/parse the keys data GeneralSecurityException: If failed to generate the keys

protected String resolveAvailableSignaturesProposal(FactoryManager proposedManager) throws IOException, GeneralSecurityException

Implements abstract org.apache.sshd.common.session.helpers.SessionHelper.resolveAvailableSignaturesProposal.

Doc from org.apache.sshd.common.session.helpers.SessionHelper.resolveAvailableSignaturesProposal.

Computes the list of available host key signature algorithms supported.

Parameters

proposedManager:FactoryManager: The FactoryManager

Returns:String

A comma-separated list of all the signature protocols to be included in the proposal - null/empty if no proposal

Annotations

@Override

Exceptions

IOException:: If failed to read/parse the keys data
GeneralSecurityException:: If failed to generate the keys

resolveEmptySignaturesProposal back to summary

resolveEmptySignaturesProposal	back to summary
protected String resolveEmptySignaturesProposal(Iterable<String> supported, Iterable<String> provided) Called by `resolveAvailableSignaturesProposal(FactoryManager)` if none of the provided keys is supported - last chance for the derived implementation to do something Parameters supported:Iterable<String> The supported key types - may be `null`/empty provided:Iterable<String> The available signature types - may be `null`/empty Returns:String The resolved proposal - `null` by default

protected String resolveEmptySignaturesProposal(Iterable<String> supported, Iterable<String> provided)

Called by resolveAvailableSignaturesProposal(FactoryManager) if none of the provided keys is supported - last chance for the derived implementation to do something

Parameters

supported:Iterable<String>: The supported key types - may be null/empty
provided:Iterable<String>: The available signature types - may be null/empty

Returns:String

The resolved proposal - null by default

sendKexInit	back to summary
protected byte[] sendKexInit(Map<KexProposalOption, String> proposal) throws Exception Overrides org.apache.sshd.common.session.helpers.AbstractSession.sendKexInit. Doc from org.apache.sshd.common.session.helpers.AbstractSession.sendKexInit. Send the key exchange initialization packet. This packet contains random data along with our proposal. Parameters proposal:Map<KexProposalOption, String> our proposal for key exchange negotiation Returns:byte[] the sent packet data which must be kept for later use when deriving the session keys Annotations @Override Exceptions Exception: if an error occurred sending the packet

sendKexInit

back to summary

protected byte[] sendKexInit(Map<KexProposalOption, String> proposal) throws Exception

Overrides org.apache.sshd.common.session.helpers.AbstractSession.sendKexInit.

Doc from org.apache.sshd.common.session.helpers.AbstractSession.sendKexInit.

Send the key exchange initialization packet. This packet contains random data along with our proposal.

Parameters

proposal:Map<KexProposalOption, String>: our proposal for key exchange negotiation

Returns:byte[]

the sent packet data which must be kept for later use when deriving the session keys

Annotations

@Override

Exceptions

Exception:: if an error occurred sending the packet

sendServerIdentification back to summary

sendServerIdentification	back to summary
protected IoWriteFuture sendServerIdentification(List<String> headerLines) throws Exception Sends the server identification + any extra header lines Parameters headerLines:List<String> Extra header lines to be prepended to the actual identification string - ignored if `null`/empty Returns:IoWriteFuture An `IoWriteFuture` that can be used to be notified of identification data being written successfully or failing Exceptions Exception: If failed to send identification See Also RFC 4253 - section 4.2

protected IoWriteFuture sendServerIdentification(List<String> headerLines) throws Exception

Sends the server identification + any extra header lines

Parameters

headerLines:List<String>: Extra header lines to be prepended to the actual identification string - ignored if null/empty

Returns:IoWriteFuture

An IoWriteFuture that can be used to be notified of identification data being written successfully or failing

Exceptions

Exception:: If failed to send identification

See Also

RFC 4253 - section 4.2

setClientAddress	back to summary
public void setClientAddress(SocketAddress clientAddress)

setGSSAuthenticator	back to summary
public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setGSSAuthenticator. Annotations @Override

setGSSAuthenticator

back to summary

public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setGSSAuthenticator.

Annotations

@Override

setHostBasedAuthenticator	back to summary
public void setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setHostBasedAuthenticator. Annotations @Override

setHostBasedAuthenticator

back to summary

public void setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setHostBasedAuthenticator.

Annotations

@Override

setHostKeyCertificateProvider	back to summary
public void setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider) Implements org.apache.sshd.server.ServerAuthenticationManager.setHostKeyCertificateProvider. Annotations @Override

setHostKeyCertificateProvider

back to summary

public void setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider)

Implements org.apache.sshd.server.ServerAuthenticationManager.setHostKeyCertificateProvider.

Annotations

@Override

setKexSeed	back to summary
protected void setKexSeed(byte... seed) Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.setKexSeed. Parameters seed:byte[] Doc from org.apache.sshd.common.session.helpers.AbstractSession.setKexSeed. The result of the KEXINIT handshake - required for correct session key establishment Annotations @Override

setKexSeed

back to summary

protected void setKexSeed(byte... seed)

Implements abstract org.apache.sshd.common.session.helpers.AbstractSession.setKexSeed.

Parameters

seed:byte[]

Doc from org.apache.sshd.common.session.helpers.AbstractSession.setKexSeed.

The result of the KEXINIT handshake - required for correct session key establishment

Annotations

@Override

setKeyboardInteractiveAuthenticator	back to summary
public void setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setKeyboardInteractiveAuthenticator. Annotations @Override

setKeyboardInteractiveAuthenticator

back to summary

public void setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setKeyboardInteractiveAuthenticator.

Annotations

@Override

setKeyPairProvider	back to summary
public void setKeyPairProvider(KeyPairProvider keyPairProvider) Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.setKeyPairProvider. Annotations @Override

setKeyPairProvider

back to summary

public void setKeyPairProvider(KeyPairProvider keyPairProvider)

Implements org.apache.sshd.common.keyprovider.KeyPairProviderHolder.setKeyPairProvider.

Annotations

@Override

setPasswordAuthenticator	back to summary
public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setPasswordAuthenticator. Annotations @Override

setPasswordAuthenticator

back to summary

public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setPasswordAuthenticator.

Annotations

@Override

setPublickeyAuthenticator	back to summary
public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator) Implements org.apache.sshd.server.ServerAuthenticationManager.setPublickeyAuthenticator. Annotations @Override

setPublickeyAuthenticator

back to summary

public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

Implements org.apache.sshd.server.ServerAuthenticationManager.setPublickeyAuthenticator.

Annotations

@Override

setServerProxyAcceptor	back to summary
public void setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor) Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.setServerProxyAcceptor. Annotations @Override

setServerProxyAcceptor

back to summary

public void setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)

Implements org.apache.sshd.server.session.ServerProxyAcceptorHolder.setServerProxyAcceptor.

Annotations

@Override

setUserAuthFactories	back to summary
public void setUserAuthFactories(List<UserAuthFactory> userAuthFactories) Implements org.apache.sshd.common.auth.UserAuthFactoriesManager.setUserAuthFactories. Annotations @Override

setUserAuthFactories

back to summary

public void setUserAuthFactories(List<UserAuthFactory> userAuthFactories)

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

Annotations

@Override

signalAuthenticationSuccess back to summary

signalAuthenticationSuccess	back to summary
public IoWriteFuture signalAuthenticationSuccess(String username, String authService, Buffer buffer) throws Exception Implements org.apache.sshd.server.session.ServerSession.signalAuthenticationSuccess. Doc from org.apache.sshd.server.session.ServerSession.signalAuthenticationSuccess. Marks the session as authenticated. Starts the specified service. Sends the `SSH_MSG_USERAUTH_SUCCESS` message. Parameters username:String The authenticated username authService:String The service to start buffer:Buffer Any extra data received to use to start the service Returns:IoWriteFuture An `IoWriteFuture` that can be used to wait for the `SSH_MSG_USERAUTH_SUCCESS` message send result Annotations @Override Exceptions Exception: if cannot handle the request