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

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

org.apache.sshd.server.session.AbstractServerSession

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, AttributeRepository, AttributeStore, MutableUserHolder, UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>, UsernameHolder, ChannelListenerManager, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, FactoryManagerHolder, PortForwardingEventListenerManager, PortForwardingInformationProvider, PacketWriter, KexExtensionHandlerManager, KexFactoryManager, KeyPairProviderHolder, PropertyResolver, ReservedSessionMessagesManager, Session, SessionContext, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesManager, ConnectionEndpointsIndicator, ServerAuthenticationManager, ServerProxyAcceptorHolder, ServerSession

Direct Known Subclasses:

ServerSessionImpl

public abstract class AbstractServerSession
extends AbstractSession
implements ServerSession

Provides default implementations for ServerSession related methods

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

SessionHeartbeatController.HeartbeatType

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

AttributeRepository.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
private java.net.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 java.util.List<UserAuthFactory>	userAuthFactories

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

channelListenerProxy, channelListeners, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, encodeLock, firstKexPacketFollows, globalRequestSeqo, ignorePacketDataLength, ignorePacketsCount, ignorePacketsFrequency, ignorePacketsVariance, inBlocksCount, inBytesCount, inCipher, inCipherSize, inCompression, inMac, inMacResult, inMacSize, inPacketsCount, kex, kexFutureHolder, kexState, lastKeyTimeValue, maxRekeyBlocks, maxRekeyBytes, maxRekeyInterval, maxRekyPackets, negotiationResult, outBlocksCount, outBytesCount, outCipher, outCipherSize, outCompression, outMac, outMacSize, outPacketsCount, pendingGlobalRequest, pendingPackets, random, requestLock, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, sessionListenerProxy, sessionListeners, tunnelListenerProxy, tunnelListeners, uncompressBuffer, unmodClientProposal, unmodNegotiationResult, unmodServerProposal

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

authNanoStart, idleNanoStart, sessionLock

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

closeFuture, futureLock, state

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

log

Fields inherited from interface org.apache.sshd.common.session.SessionContext

DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

Fields inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

DEFAULT_CONNECTION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_TYPE

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.common.channel.throttle.ChannelStreamPacketWriterResolver

NONE

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(java.lang.String userName) Retrieve the current number of sessions active for a given username.
java.net.SocketAddress	getClientAddress()
protected ConnectionService	getConnectionService()
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.
java.security.KeyPair	getHostKey()
HostKeyCertificateProvider	getHostKeyCertificateProvider()
long	getId()
KeyboardInteractiveAuthenticator	getKeyboardInteractiveAuthenticator() Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server.
KeyPairProvider	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.
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()
java.util.List<UserAuthFactory>	getUserAuthFactories() Retrieve the list of named factories for UserAuth objects.
protected void	handleServiceAccept(java.lang.String serviceName, Buffer buffer)
protected boolean	handleServiceRequest(java.lang.String serviceName, Buffer buffer)
protected boolean	readIdentification(Buffer buffer) Read the other side identification.
protected void	receiveKexInit(java.util.Map<KexProposalOption,java.lang.String> proposal, byte[] seed)
protected java.lang.String	resolveAvailableSignaturesProposal(FactoryManager proposedManager)
protected java.lang.String	resolveEmptySignaturesProposal(java.lang.Iterable<java.lang.String> supported, java.lang.Iterable<java.lang.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(java.util.Map<KexProposalOption,java.lang.String> proposal) Send the key exchange initialization packet.
protected IoWriteFuture	sendServerIdentification(java.lang.String... headerLines) Sends the server identification + any extra header lines
void	setClientAddress(java.net.SocketAddress clientAddress)
void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
void	setHostBasedAuthenticator(HostBasedAuthenticator hostBasedAuthenticator)
void	setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider)
protected void	setKexSeed(byte... seed)
void	setKeyboardInteractiveAuthenticator(KeyboardInteractiveAuthenticator interactiveAuthenticator)
void	setKeyPairProvider(KeyPairProvider keyPairProvider)
void	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
void	setServerProxyAcceptor(ServerProxyAcceptor proxyAcceptor)
void	setUserAuthFactories(java.util.List<UserAuthFactory> userAuthFactories)
IoWriteFuture	signalAuthenticationSuccess(java.lang.String username, java.lang.String authService, Buffer buffer)
void	startService(java.lang.String name, Buffer buffer)

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

addChannelListener, addPortForwardingEventListener, addSessionListener, appendOutgoingMac, attachSession, checkRekey, comparePreferredKexProposalOption, createBuffer, decode, doHandleMessage, doInvokeUnimplementedMessageHandler, doKexNegotiation, doWritePacket, encode, encryptOutgoingBuffer, enqueuePendingPacket, getChannelListenerProxy, getCipherInformation, getClientKexData, getClientKexProposals, getClientVersion, getCompressionInformation, getInnerCloseable, getKex, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getPortForwardingEventListenerProxy, getServerKexData, getServerKexProposals, getServerVersion, getService, getServices, getSession, getSession, getSessionId, getSessionListenerProxy, handleFirstKexPacketFollows, handleKexExtension, handleKexInit, handleKexMessage, handleMessage, handleNewCompression, handleNewKeys, handleServiceAccept, handleServiceRequest, isRekeyBlocksCountExceeded, isRekeyDataSizeExceeded, isRekeyPacketCountsExceeded, isRekeyRequired, isRekeyTimeIntervalExceeded, messageReceived, negotiate, notImplemented, preClose, prepareBuffer, preProcessEncodeBuffer, receiveKexInit, receiveKexInit, receiveNewKeys, reExchangeKeys, refreshConfiguration, removeChannelListener, removePortForwardingEventListener, removeSessionListener, request, requestFailure, requestNewKeysExchange, requestSuccess, resolveAvailableSignaturesProposal, resolveIgnoreBufferDataLength, resolveOutputPacket, resolveSessionKexProposal, sendKexInit, sendNewKeys, sendPendingPackets, setClientKexData, setNegotiationResult, setServerKexData, signalRequestFailure, validateIncomingMac, validateKexState, validateTargetBuffer, writePacket

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

attributeKeys, calculateNextIgnorePacketCount, checkAuthenticationTimeout, checkForTimeouts, checkIdleTimeout, clearAttributes, computeAttributeIfAbsent, createProposal, disconnect, doInvokeDebugMessageHandler, doInvokeIgnoreMessageHandler, doReadIdentification, exceptionCaught, getAttribute, getAttributesCount, getAuthTimeout, getAuthTimeoutStart, getBoundLocalPortForward, getBoundRemotePortForward, getChannelStreamPacketWriterResolver, getForwardingFilter, getIdleTimeout, getIdleTimeoutStart, getIoSession, getLocalForwardsBindings, getParentPropertyResolver, getProperties, getRemoteForwardsBindings, getReservedSessionMessagesHandler, getSessionDisconnectHandler, getStartedLocalPortForwards, getStartedRemotePortForwards, getTimeoutStatus, getUnknownChannelReferenceHandler, getUsername, handleDebug, handleDisconnect, handleDisconnect, handleIgnore, handleUnimplemented, invokeSessionSignaller, isAuthenticated, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPort, isServerSession, mergeProposals, removeAttribute, resetAuthTimeout, resetIdleTimeout, resizeKey, resolveChannelStreamPacketWriterResolver, resolveIdentificationString, resolvePeerAddress, resolveReservedSessionMessagesHandler, resolveUnknownChannelReferenceHandler, sendDebugMessage, sendIdentification, sendIgnoreMessage, sendNotImplemented, setAttribute, setAuthenticated, setChannelStreamPacketWriterResolver, setReservedSessionMessagesHandler, setSessionDisconnectHandler, setUnknownChannelReferenceHandler, setUsername, signalDisconnect, signalDisconnect, signalExceptionCaught, signalExceptionCaught, signalNegotiationEnd, signalNegotiationEnd, signalNegotiationStart, signalNegotiationStart, signalPeerIdentificationReceived, signalPeerIdentificationReceived, signalSessionClosed, signalSessionClosed, signalSessionCreated, signalSessionCreated, signalSessionEstablished, signalSessionEstablished, signalSessionEvent, signalSessionEvent, toString, writePacket

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

getCipherFactories, getCompressionFactories, getDelegate, getKexExtensionHandler, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKexExtensionHandler, setKeyExchangeFactories, 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, getFutureLock, 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, getAuthTimeoutStart, getIdleTimeout, getIdleTimeoutStart, getIoSession, getKex, getLocalAddress, getRemoteAddress, getService, getTimeoutStatus, prepareBuffer, reExchangeKeys, request, request, request, resetAuthTimeout, resetIdleTimeout, resolveAttribute, resolveAttribute, sendDebugMessage, sendIgnoreMessage, setAuthenticated, writePacket, writePacket, writePacket

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

getCipherInformation, getClientKexProposals, getClientVersion, getCompressionInformation, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getServerKexProposals, getServerVersion, getSessionId, isAuthenticated, isDataIntegrityTransport, isSecureSessionTransport, isServerSession, isValidVersionPrefix

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

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

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

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

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

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

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

attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair

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.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.signature.SignatureFactoriesManager

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

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

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

getSessionDisconnectHandler, setSessionDisconnectHandler

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

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager

getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

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

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

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

getBoundLocalPortForward, getBoundRemotePortForward, getLocalForwardsBindings, getRemoteForwardsBindings, getStartedLocalPortForwards, getStartedRemotePortForwards, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPort

Methods inherited from interface org.apache.sshd.common.io.PacketWriter

calculatePadLength, writePacket

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

resolveUserAuthFactories, resolveUserAuthFactories, setUserAuthFactoriesNames

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

getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Field Detail

proxyAcceptor

private ServerProxyAcceptor proxyAcceptor

clientAddress

private java.net.SocketAddress clientAddress

passwordAuthenticator

private PasswordAuthenticator passwordAuthenticator

publickeyAuthenticator

private PublickeyAuthenticator publickeyAuthenticator

interactiveAuthenticator

private KeyboardInteractiveAuthenticator interactiveAuthenticator

gssAuthenticator

private GSSAuthenticator gssAuthenticator

hostBasedAuthenticator

private HostBasedAuthenticator hostBasedAuthenticator

userAuthFactories

private java.util.List<UserAuthFactory> userAuthFactories

keyPairProvider

private KeyPairProvider keyPairProvider

hostKeyCertificateProvider

private HostKeyCertificateProvider hostKeyCertificateProvider

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 SessionHelper

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 java.net.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(java.net.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 java.util.List<UserAuthFactory> getUserAuthFactories()

Description copied from interface: UserAuthFactoriesManager

Retrieve the list of named factories for UserAuth objects.

Specified by:

getUserAuthFactories in interface UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>

Returns:

a list of named UserAuth factories, never null/empty

setUserAuthFactories

public void setUserAuthFactories(java.util.List<UserAuthFactory> userAuthFactories)

Specified by:

setUserAuthFactories in interface UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>

getKeyPairProvider

public KeyPairProvider getKeyPairProvider()

Description copied from interface: KeyPairProviderHolder

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.

Specified by:

getKeyPairProvider in interface KeyPairProviderHolder

Returns:

the KeyPairProvider, never null

getHostKeyCertificateProvider

public HostKeyCertificateProvider getHostKeyCertificateProvider()

Specified by:

getHostKeyCertificateProvider in interface ServerAuthenticationManager

Returns:

a HostKeyCertificateProvider if available, null as default

setHostKeyCertificateProvider

public void setHostKeyCertificateProvider(HostKeyCertificateProvider hostKeyCertificateProvider)

Specified by:

setHostKeyCertificateProvider in interface ServerAuthenticationManager

setKeyPairProvider

public void setKeyPairProvider(KeyPairProvider keyPairProvider)

Specified by:

setKeyPairProvider in interface KeyPairProviderHolder

sendServerIdentification

protected IoWriteFuture sendServerIdentification(java.lang.String... headerLines)
                                          throws java.io.IOException

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

Throws:

java.io.IOException - If failed to send identification

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(java.lang.String serviceName,
                                       Buffer buffer)
                                throws java.lang.Exception

Overrides:

handleServiceRequest in class AbstractSession

Throws:

java.lang.Exception

startService

public void startService(java.lang.String name,
                         Buffer buffer)
                  throws java.lang.Exception

Specified by:

startService in interface Session

Parameters:

name - Service name

buffer - Extra information provided when the service start request was received

Throws:

java.lang.Exception - If failed to start it

signalAuthenticationSuccess

public IoWriteFuture signalAuthenticationSuccess(java.lang.String username,
                                                 java.lang.String authService,
                                                 Buffer buffer)
                                          throws java.lang.Exception

Description copied from interface: ServerSession

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

Specified by:

signalAuthenticationSuccess in interface ServerSession

Parameters:

username - The authenticated username

authService - The service to start

buffer - Any extra data received to use to start the service

Returns:

An IoWriteFuture that can be used to wait for the SSH_MSG_USERAUTH_SUCCESS message send result

Throws:

java.lang.Exception - if cannot handle the request

handleServiceAccept

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

Overrides:

handleServiceAccept in class AbstractSession

Throws:

java.lang.Exception

sendKexInit

protected byte[] sendKexInit(java.util.Map<KexProposalOption,java.lang.String> proposal)
                      throws java.io.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:

java.io.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 java.lang.String resolveAvailableSignaturesProposal(FactoryManager proposedManager)
                                                       throws java.io.IOException,
                                                              java.security.GeneralSecurityException

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

Throws:

java.io.IOException - If failed to read/parse the keys data

java.security.GeneralSecurityException - If failed to generate the keys

resolveEmptySignaturesProposal

protected java.lang.String resolveEmptySignaturesProposal(java.lang.Iterable<java.lang.String> supported,
                                                          java.lang.Iterable<java.lang.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 java.lang.Exception

Description copied from class: AbstractSession

Read the other side identification. This method is specific to the client or server side, but both should call SessionHelper.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:

java.lang.Exception - if an error occurs such as a bad protocol version or unsuccessful KEX was involved

receiveKexInit

protected void receiveKexInit(java.util.Map<KexProposalOption,java.lang.String> proposal,
                              byte[] seed)
                       throws java.io.IOException

Specified by:

receiveKexInit in class AbstractSession

Throws:

java.io.IOException

getHostKey

public java.security.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(java.lang.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 underlying IoSession id.

getConnectionService

protected ConnectionService getConnectionService()

Specified by:

getConnectionService in class SessionHelper