org.apache.sshd.server.session

Class AbstractServerSession

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.session.helpers.AbstractSession

org.apache.sshd.server.session.AbstractServerSession

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, AttributeStore, MutableUserHolder, UsernameHolder, ChannelListenerManager, FactoryManagerHolder, PortForwardingEventListenerManager, KexFactoryManager, KeyPairProviderHolder, PropertyResolver, ReservedSessionMessagesManager, Session, SessionListenerManager, SignatureFactoriesManager, ServerAuthenticationManager, ServerProxyAcceptorHolder, ServerSession

Direct Known Subclasses:

ServerSessionImpl

public abstract class AbstractServerSession
extends AbstractSession
implements ServerSession

Provides default implementations for ServerSession related methods

Author:

Apache MINA SSHD Project

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.session.Session

Session.TimeoutStatus

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

AttributeStore.AttributeKey<T>

Field Summary

Fields inherited from class org.apache.sshd.common.session.helpers.AbstractSession

authed, authTimeoutStart, channelListenerProxy, channelListeners, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, encodeLock, firstKexPacketFollows, i_c, i_s, idleTimeoutStart, ignorePacketDataLength, ignorePacketsCount, ignorePacketsFrequency, ignorePacketsVariance, inBlocksCount, inBytesCount, inCipher, inCipherSize, inCompression, inMac, inMacResult, inPacketsCount, ioSession, isServer, kex, kexFutureHolder, kexState, lastKeyTimeValue, maxRekeyBlocks, maxRekeyBytes, maxRekeyInterval, maxRekyPackets, negotiationResult, outBlocksCount, outBytesCount, outCipher, outCipherSize, outCompression, outMac, outPacketsCount, pendingPackets, random, requestLock, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, sessionListenerProxy, sessionListeners, timeoutStatus, tunnelListenerProxy, tunnelListeners, uncompressBuffer, username

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.common.session.Session

DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

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

EMPTY

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	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
int	getActiveSessionCountForUser(String userName) Retrieve the current number of sessions active for a given username.
SocketAddress	getClientAddress()
ServerFactoryManager	getFactoryManager()
GSSAuthenticator	getGSSAuthenticator() Retrieve the GSSAuthenticator to be used by the SSH server.
HostBasedAuthenticator	getHostBasedAuthenticator() Retrieve the HostBasedAuthenticator to be used by the SSH server.
KeyPair	getHostKey()
long	getId() Returns the session id.
KeyboardInteractiveAuthenticator	getKeyboardInteractiveAuthenticator() Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.
PasswordAuthenticator	getPasswordAuthenticator() Retrieve the PasswordAuthenticator to be used by the SSH server.
PublickeyAuthenticator	getPublickeyAuthenticator() Retrieve the PublickeyAuthenticator to be used by SSH server.
ServerProxyAcceptor	getServerProxyAcceptor()
List<NamedFactory<UserAuth>>	getUserAuthFactories() Retrieve the list of named factories for UserAuth objects.
protected void	handleServiceAccept(String serviceName, Buffer buffer)
protected boolean	handleServiceRequest(String serviceName, Buffer buffer)
protected boolean	readIdentification(Buffer buffer) Read the other side identification.
protected void	receiveKexInit(Map<KexProposalOption,String> proposal, byte[] seed)
protected String	resolveAvailableSignaturesProposal(FactoryManager proposedManager)
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
protected byte[]	sendKexInit(Map<KexProposalOption,String> proposal) Send the key exchange initialization packet.
protected IoWriteFuture	sendServerIdentification(String... headerLines) Sends the server identification + any extra header lines
void	setClientAddress(SocketAddress clientAddress)
void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
void	setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)
protected void	setKexSeed(byte... seed)
void	setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)
void	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
void	setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)
void	setUserAuthFactories(List<NamedFactory<UserAuth>> userAuthFactories)
void	startService(String name)

Methods inherited from class org.apache.sshd.common.session.helpers.AbstractSession

addChannelListener, addPortForwardingEventListener, addSessionListener, attachSession, calculateNextIgnorePacketCount, checkAuthenticationTimeout, checkForTimeouts, checkIdleTimeout, checkRekey, comparePreferredKexProposalOption, createBuffer, createBuffer, createProposal, decode, disconnect, doHandleMessage, doReadIdentification, doWritePacket, encode, exceptionCaught, getAttribute, getAuthTimeout, getChannelListenerProxy, getCipherInformation, getClientVersion, getCompressionInformation, getIdleTimeout, getInnerCloseable, getIoSession, getKex, getLock, getMacInformation, getNegotiatedKexParameter, getParentPropertyResolver, getPortForwardingEventListenerProxy, getProperties, getReservedSessionMessagesHandler, getServerVersion, getService, getServices, getSession, getSession, getSessionId, getSessionListenerProxy, getTimeoutStatus, getUsername, handleDebug, handleDisconnect, handleDisconnect, handleFirstKexPacketFollows, handleIgnore, handleKexInit, handleKexMessage, handleMessage, handleNewKeys, handleServiceAccept, handleServiceRequest, handleUnimplemented, invokeSessionSignaller, isAuthenticated, isRekeyBlocksCountExceeded, isRekeyDataSizeExceeded, isRekeyPacketCountsExceeded, isRekeyRequired, isRekeyTimeIntervalExceeded, mergeProposals, messageReceived, negotiate, notImplemented, preClose, prepareBuffer, receiveKexInit, receiveKexInit, receiveNewKeys, reExchangeKeys, refreshConfiguration, removeAttribute, removeChannelListener, removePortForwardingEventListener, removeSessionListener, request, requestFailure, requestNewKeysExchange, requestSuccess, resetIdleTimeout, resizeKey, resolveAttribute, resolveAvailableSignaturesProposal, resolveIdentificationString, resolveIgnoreBufferDataLength, resolvePeerAddress, resolveReservedSessionMessagesHandler, sendDebugMessage, sendIdentification, sendIgnoreMessage, sendKexInit, sendNewKeys, sendNotImplemented, setAttribute, setAuthenticated, setNegotiationResult, setReservedSessionMessagesHandler, setUsername, signalExceptionCaught, signalExceptionCaught, signalNegotiationEnd, signalNegotiationEnd, signalNegotiationStart, signalNegotiationStart, signalSessionClosed, signalSessionClosed, signalSessionCreated, signalSessionCreated, signalSessionEvent, signalSessionEvent, toString, validateKexState, validateTargetBuffer, writePacket, writePacket

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, 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.session.Session

createBuffer, createBuffer, disconnect, exceptionCaught, getAuthTimeout, getCipherInformation, getClientVersion, getCompressionInformation, getIdleTimeout, getIoSession, getKex, getMacInformation, getNegotiatedKexParameter, getServerVersion, getService, getSessionId, getTimeoutStatus, isAuthenticated, isValidVersionPrefix, prepareBuffer, reExchangeKeys, request, resetIdleTimeout, sendDebugMessage, sendIgnoreMessage, setAuthenticated, writePacket, writePacket

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.PropertyResolver

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

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

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

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

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

Methods inherited from interface org.apache.sshd.common.auth.MutableUserHolder

setUsername

Methods inherited from interface org.apache.sshd.common.auth.UsernameHolder

getUsername

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

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

Constructor Detail

AbstractServerSession

protected AbstractServerSession(ServerFactoryManager factoryManager,
                                IoSession ioSession)

Method Detail

getFactoryManager

public ServerFactoryManager getFactoryManager()

Specified by:

getFactoryManager in interface FactoryManagerHolder

Specified by:

getFactoryManager in interface ServerSession

Overrides:

getFactoryManager in class AbstractSession

Returns:

The currently associated FactoryManager

getServerProxyAcceptor

public ServerProxyAcceptor getServerProxyAcceptor()

Specified by:

getServerProxyAcceptor in interface ServerProxyAcceptorHolder

setServerProxyAcceptor

public void setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)

Specified by:

setServerProxyAcceptor in interface ServerProxyAcceptorHolder

getClientAddress

public SocketAddress getClientAddress()

Specified by:

getClientAddress in interface ServerSession

Returns:

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

setClientAddress

public void setClientAddress(SocketAddress clientAddress)

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

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

sendServerIdentification

protected IoWriteFuture sendServerIdentification(String... headerLines)

Sends the server identification + any extra header lines

Parameters:

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

Returns:

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

See Also:

RFC 4253 - section 4.2

checkKeys

protected void checkKeys()

Description copied from class: AbstractSession

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

Specified by:

checkKeys in class AbstractSession

handleServiceRequest

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

Overrides:

handleServiceRequest in class AbstractSession

Throws:

Exception

startService

public void startService(String name)
                  throws Exception

Specified by:

startService in interface Session

Parameters:

name - Service name

Throws:

Exception - If failed to start it

handleServiceAccept

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

Overrides:

handleServiceAccept in class AbstractSession

Throws:

Exception

sendKexInit

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

Description copied from class: AbstractSession

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

Overrides:

sendKexInit in class AbstractSession

Parameters:

proposal - our proposal for key exchange negotiation

Returns:

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

Throws:

IOException - if an error occurred sending the packet

setKexSeed

protected void setKexSeed(byte... seed)

Specified by:

setKexSeed in class AbstractSession

Parameters:

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

resolveAvailableSignaturesProposal

protected String resolveAvailableSignaturesProposal(FactoryManager proposedManager)

Specified by:

resolveAvailableSignaturesProposal in class AbstractSession

Parameters:

proposedManager - The FactoryManager

Returns:

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

resolveEmptySignaturesProposal

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 - The supported key types - may be null/empty

provided - The available signature types - may be null/empty

Returns:

The resolved proposal - null by default

readIdentification

protected boolean readIdentification(Buffer buffer)
                              throws IOException

Description copied from class: AbstractSession

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

Specified by:

readIdentification in class AbstractSession

Parameters:

buffer - The Buffer containing the remote identification

Returns:

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

Throws:

IOException - if an error occurs such as a bad protocol version

receiveKexInit

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

Specified by:

receiveKexInit in class AbstractSession

Throws:

IOException

getHostKey

public KeyPair getHostKey()

Specified by:

getHostKey in interface ServerSession

Returns:

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

getActiveSessionCountForUser

public int getActiveSessionCountForUser(String userName)

Description copied from interface: ServerSession

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

Specified by:

getActiveSessionCountForUser in interface ServerSession

Parameters:

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

Returns:

The current number of live SshSession objects associated with the user

getId

public long getId()

Returns the session id.

Returns:

The session id.