org.apache.sshd.common.session.helpers

Class SessionHelper

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, AttributeRepository, AttributeStore, MutableUserHolder, UsernameHolder, ChannelListenerManager, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, FactoryManagerHolder, PortForwardingEventListenerManager, PortForwardingInformationProvider, PacketWriter, KexExtensionHandlerManager, KexFactoryManager, PropertyResolver, ReservedSessionMessagesManager, Session, SessionContext, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesManager, ConnectionEndpointsIndicator

Direct Known Subclasses:

AbstractSession

public abstract class SessionHelper
extends AbstractKexFactoryManager
implements Session

Contains split code in order to make AbstractSession class smaller

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.util.Map<AttributeRepository.AttributeKey<?>,java.lang.Object>	attributes Session specific attributes
private boolean	authed Boolean indicating if this session has been authenticated or not
protected long	authNanoStart
private long	authTimeoutStart
private ChannelStreamPacketWriterResolver	channelStreamPacketWriterResolver
protected long	idleNanoStart
private long	idleTimeoutStart
private IoSession	ioSession The underlying network session
private java.util.Map<java.lang.String,java.lang.Object>	properties The session specific properties
private ReservedSessionMessagesHandler	reservedSessionMessagesHandler
private boolean	serverSession Client or server side
private SessionDisconnectHandler	sessionDisconnectHandler
protected java.lang.Object	sessionLock Session level lock for regulating access to sensitive data
private java.util.concurrent.atomic.AtomicReference<TimeoutIndicator>	timeoutStatus
private UnknownChannelReferenceHandler	unknownChannelReferenceHandler
private java.lang.String	username The name of the authenticated user

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionHelper(boolean serverSession, FactoryManager factoryManager, IoSession ioSession) Create a new session.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<AttributeRepository.AttributeKey<?>>	attributeKeys()
protected long	calculateNextIgnorePacketCount(Random r, long freq, int variance)
protected TimeoutIndicator	checkAuthenticationTimeout(long now, long nanoTime, long authTimeoutMs) Checks if authentication timeout expired
protected TimeoutIndicator	checkForTimeouts() Checks whether the session has timed out (both authentication and idle timeouts are checked).
protected TimeoutIndicator	checkIdleTimeout(long now, long nanoTime, long idleTimeoutMs) Checks if idle timeout expired
void	clearAttributes() Removes all currently stored user-defined attributes
<T> T	computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key, java.util.function.Function<? super AttributeRepository.AttributeKey<T>,? extends T> resolver) If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
protected java.util.Map<KexProposalOption,java.lang.String>	createProposal(java.lang.String hostKeyTypes) Create our proposal for SSH negotiation
void	disconnect(int reason, java.lang.String msg) Send a disconnect packet with the given reason and message.
protected void	doInvokeDebugMessageHandler(Buffer buffer) Invoked by handleDebug(Buffer) after validating that the buffer structure seems well-formed and also resetting the idle timeout.
protected void	doInvokeIgnoreMessageHandler(Buffer buffer) Invoked by handleDebug(Buffer) after validating that the buffer structure seems well-formed and also resetting the idle timeout.
protected boolean	doInvokeUnimplementedMessageHandler(int cmd, Buffer buffer)
protected java.util.List<java.lang.String>	doReadIdentification(Buffer buffer, boolean server) Read the remote identification from this buffer.
void	exceptionCaught(java.lang.Throwable t) Handle any exceptions that occurred on this session.
<T> T	getAttribute(AttributeRepository.AttributeKey<T> key) Returns the value of the user-defined attribute.
int	getAttributesCount()
long	getAuthTimeout()
long	getAuthTimeoutStart()
SshdSocketAddress	getBoundLocalPortForward(int port)
SshdSocketAddress	getBoundRemotePortForward(int port)
ChannelStreamPacketWriterResolver	getChannelStreamPacketWriterResolver()
protected abstract ConnectionService	getConnectionService()
FactoryManager	getFactoryManager()
protected ForwardingFilter	getForwardingFilter()
long	getIdleTimeout()
long	getIdleTimeoutStart()
IoSession	getIoSession()
java.util.List<java.util.Map.Entry<java.lang.Integer,SshdSocketAddress>>	getLocalForwardsBindings()
PropertyResolver	getParentPropertyResolver()
java.util.Map<java.lang.String,java.lang.Object>	getProperties() A map of properties that can be used to configure the SSH server or client.
java.util.List<java.util.Map.Entry<java.lang.Integer,SshdSocketAddress>>	getRemoteForwardsBindings()
ReservedSessionMessagesHandler	getReservedSessionMessagesHandler()
SessionDisconnectHandler	getSessionDisconnectHandler()
java.util.NavigableSet<java.lang.Integer>	getStartedLocalPortForwards()
java.util.NavigableSet<java.lang.Integer>	getStartedRemotePortForwards()
TimeoutIndicator	getTimeoutStatus() Check if timeout has occurred.
UnknownChannelReferenceHandler	getUnknownChannelReferenceHandler()
java.lang.String	getUsername()
protected void	handleDebug(Buffer buffer)
protected void	handleDisconnect(Buffer buffer)
protected void	handleDisconnect(int code, java.lang.String msg, java.lang.String lang, Buffer buffer)
protected void	handleIgnore(Buffer buffer)
protected void	handleUnimplemented(Buffer buffer)
protected void	invokeSessionSignaller(Invoker<SessionListener,java.lang.Void> invoker)
boolean	isAuthenticated()
boolean	isLocalPortForwardingStartedForPort(int port) Test if local port forwarding is started
boolean	isRemotePortForwardingStartedForPort(int port) Test if remote port forwarding is started
boolean	isServerSession() Quick indication if this is a server or client session (instead of having to ask instanceof).
protected java.util.Map<KexProposalOption,java.lang.String>	mergeProposals(java.util.Map<KexProposalOption,java.lang.String> current, java.util.Map<KexProposalOption,java.lang.String> proposal)
protected Buffer	preProcessEncodeBuffer(int cmd, Buffer buffer) Invoked by the session before encoding the buffer in order to make sure that it is at least of size SSH_PACKET_HEADER_LEN.
<T> T	removeAttribute(AttributeRepository.AttributeKey<T> key) Removes the user-defined attribute
long	resetAuthTimeout() Re-start the authentication timeout timer
long	resetIdleTimeout() Re-start idle timeout timer
protected byte[]	resizeKey(byte[] e, int kdfSize, Digest hash, byte[] k, byte[] h) Method used while putting new keys into use that will resize the key used to initialize the cipher to the needed length.
ChannelStreamPacketWriterResolver	resolveChannelStreamPacketWriterResolver()
protected java.lang.String	resolveIdentificationString(java.lang.String configPropName) Resolves the identification to send to the peer session by consulting the associated FactoryManager.
protected java.net.SocketAddress	resolvePeerAddress(java.net.SocketAddress knownAddress)
protected ReservedSessionMessagesHandler	resolveReservedSessionMessagesHandler()
protected java.lang.String	resolveSessionKexProposal(java.lang.String hostKeyTypes)
UnknownChannelReferenceHandler	resolveUnknownChannelReferenceHandler() Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)
IoWriteFuture	sendDebugMessage(boolean display, java.lang.Object msg, java.lang.String lang) Sends an SSH_MSG_DEBUG to the peer session
protected IoWriteFuture	sendIdentification(java.lang.String ident) Send our identification.
IoWriteFuture	sendIgnoreMessage(byte... data) Sends an SSH_MSG_IGNORE to the peer session
protected IoWriteFuture	sendNotImplemented(long seqNoValue) Sends a SSH_MSG_UNIMPLEMENTED message
<T> T	setAttribute(AttributeRepository.AttributeKey<T> key, T value) Sets a user-defined attribute.
void	setAuthenticated()
void	setChannelStreamPacketWriterResolver(ChannelStreamPacketWriterResolver resolver)
void	setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)
void	setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler)
void	setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler unknownChannelReferenceHandler)
void	setUsername(java.lang.String username)
protected void	signalDisconnect(int code, java.lang.String msg, java.lang.String lang, boolean initiator)
protected void	signalDisconnect(SessionListener listener, int code, java.lang.String msg, java.lang.String lang, boolean initiator)
protected void	signalExceptionCaught(SessionListener listener, java.lang.Throwable t)
protected void	signalExceptionCaught(java.lang.Throwable t)
protected void	signalNegotiationEnd(java.util.Map<KexProposalOption,java.lang.String> c2sOptions, java.util.Map<KexProposalOption,java.lang.String> s2cOptions, java.util.Map<KexProposalOption,java.lang.String> negotiatedGuess, java.lang.Throwable reason)
protected void	signalNegotiationEnd(SessionListener listener, java.util.Map<KexProposalOption,java.lang.String> c2sOptions, java.util.Map<KexProposalOption,java.lang.String> s2cOptions, java.util.Map<KexProposalOption,java.lang.String> negotiatedGuess, java.lang.Throwable reason)
protected void	signalNegotiationStart(java.util.Map<KexProposalOption,java.lang.String> c2sOptions, java.util.Map<KexProposalOption,java.lang.String> s2cOptions)
protected void	signalNegotiationStart(SessionListener listener, java.util.Map<KexProposalOption,java.lang.String> c2sOptions, java.util.Map<KexProposalOption,java.lang.String> s2cOptions)
protected void	signalPeerIdentificationReceived(SessionListener listener, java.lang.String version, java.util.List<java.lang.String> extraLines)
protected void	signalPeerIdentificationReceived(java.lang.String version, java.util.List<java.lang.String> extraLines)
protected void	signalSessionClosed()
protected void	signalSessionClosed(SessionListener listener)
protected void	signalSessionCreated(IoSession ioSession)
protected void	signalSessionCreated(SessionListener listener)
protected void	signalSessionEstablished(IoSession ioSession)
protected void	signalSessionEstablished(SessionListener listener)
protected void	signalSessionEvent(SessionListener.Event event) Sends a session event to all currently registered session listeners
protected void	signalSessionEvent(SessionListener listener, SessionListener.Event event)
java.lang.String	toString()
IoWriteFuture	writePacket(Buffer buffer, long timeout, java.util.concurrent.TimeUnit unit) Encode and send the given buffer with the specified timeout.

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, getInnerCloseable

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

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, preClose, 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, getKex, getLocalAddress, getRemoteAddress, getService, prepareBuffer, reExchangeKeys, request, request, request, resolveAttribute, resolveAttribute, startService, writePacket, writePacket

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

getCipherInformation, getClientKexProposals, getClientVersion, getCompressionInformation, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getServerKexProposals, getServerVersion, getSessionId, isDataIntegrityTransport, isSecureSessionTransport, 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, getString, getStringProperty

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

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.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.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

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

resolveChannelStreamPacketWriter

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

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

calculatePadLength, writePacket

Field Detail

sessionLock

protected final java.lang.Object sessionLock

Session level lock for regulating access to sensitive data

authNanoStart

protected long authNanoStart

idleNanoStart

protected long idleNanoStart

serverSession

private final boolean serverSession

Client or server side

ioSession

private final IoSession ioSession

The underlying network session

properties

private final java.util.Map<java.lang.String,java.lang.Object> properties

The session specific properties

attributes

private final java.util.Map<AttributeRepository.AttributeKey<?>,java.lang.Object> attributes

Session specific attributes

authTimeoutStart

private long authTimeoutStart

idleTimeoutStart

private long idleTimeoutStart

timeoutStatus

private final java.util.concurrent.atomic.AtomicReference<TimeoutIndicator> timeoutStatus

reservedSessionMessagesHandler

private ReservedSessionMessagesHandler reservedSessionMessagesHandler

sessionDisconnectHandler

private SessionDisconnectHandler sessionDisconnectHandler

unknownChannelReferenceHandler

private UnknownChannelReferenceHandler unknownChannelReferenceHandler

channelStreamPacketWriterResolver

private ChannelStreamPacketWriterResolver channelStreamPacketWriterResolver

username

private volatile java.lang.String username

The name of the authenticated user

authed

private volatile boolean authed

Boolean indicating if this session has been authenticated or not

Constructor Detail

SessionHelper

protected SessionHelper(boolean serverSession,
                        FactoryManager factoryManager,
                        IoSession ioSession)

Create a new session.

Parameters:

serverSession - true if this is a server session, false if client one

factoryManager - the factory manager

ioSession - the underlying I/O session

Method Detail

getIoSession

public IoSession getIoSession()

Specified by:

getIoSession in interface Session

Returns:

The IoSession associated to this session

isServerSession

public boolean isServerSession()

Description copied from interface: SessionContext

Quick indication if this is a server or client session (instead of having to ask instanceof).

Specified by:

isServerSession in interface SessionContext

Returns:

true if this is a server session

getFactoryManager

public FactoryManager getFactoryManager()

Specified by:

getFactoryManager in interface FactoryManagerHolder

Returns:

The currently associated FactoryManager

getParentPropertyResolver

public PropertyResolver getParentPropertyResolver()

Specified by:

getParentPropertyResolver in interface PropertyResolver

Returns:

The parent resolver that can be used to query for missing properties - null if no parent

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Description copied from interface: PropertyResolver

A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.

Note: the type of the mapped property should match the expected configuration value type - Long, Integer, Boolean, String, etc.... If it doesn't, the toString() result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is a long then it will be parsed into one. Also, if the mapped value is an Integer but a long is expected, then it will be converted into one.

Specified by:

getProperties in interface PropertyResolver

Returns:

a valid Map containing configuration values, never null. Note: may be immutable.

getAttributesCount

public int getAttributesCount()

Specified by:

getAttributesCount in interface AttributeRepository

Returns:

Current number of user-defined attributes stored in the repository

getAttribute

public <T> T getAttribute(AttributeRepository.AttributeKey<T> key)

Description copied from interface: AttributeRepository

Returns the value of the user-defined attribute.

Specified by:

getAttribute in interface AttributeRepository

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

null if there is no value associated with the specified key

attributeKeys

public java.util.Collection<AttributeRepository.AttributeKey<?>> attributeKeys()

Specified by:

attributeKeys in interface AttributeRepository

Returns:

A Collection snapshot of all the currently registered attributes in the repository

computeAttributeIfAbsent

public <T> T computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key,
                                      java.util.function.Function<? super AttributeRepository.AttributeKey<T>,? extends T> resolver)

Description copied from interface: AttributeStore

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

Specified by:

computeAttributeIfAbsent in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

resolver - The (never null) mapping function to use if value not already mapped. If returns null then value is not mapped to the provided key.

Returns:

The resolved value - null if value not mapped and resolver did not return a non-null value for it

setAttribute

public <T> T setAttribute(AttributeRepository.AttributeKey<T> key,
                          T value)

Description copied from interface: AttributeStore

Sets a user-defined attribute.

Specified by:

setAttribute in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

value - The value of the attribute; must not be null.

Returns:

The old value of the attribute; null if it is new.

removeAttribute

public <T> T removeAttribute(AttributeRepository.AttributeKey<T> key)

Description copied from interface: AttributeStore

Removes the user-defined attribute

Specified by:

removeAttribute in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

The removed value; null if no previous value

clearAttributes

public void clearAttributes()

Description copied from interface: AttributeStore

Removes all currently stored user-defined attributes

Specified by:

clearAttributes in interface AttributeStore

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface UsernameHolder

Returns:

The attached username - may be null/empty if holder not yet initialized

setUsername

public void setUsername(java.lang.String username)

Specified by:

setUsername in interface MutableUserHolder

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in interface SessionContext

Returns:

true if session has successfully completed the authentication phase

setAuthenticated

public void setAuthenticated()
                      throws java.io.IOException

Specified by:

setAuthenticated in interface Session

Throws:

java.io.IOException

checkForTimeouts

protected TimeoutIndicator checkForTimeouts()
                                     throws java.io.IOException

Checks whether the session has timed out (both authentication and idle timeouts are checked). If the session has timed out, a DISCONNECT message will be sent.

Returns:

An indication whether timeout has been detected

Throws:

java.io.IOException - If failed to check

See Also:

checkAuthenticationTimeout(long, long, long), checkIdleTimeout(long, long, long)

getAuthTimeoutStart

public long getAuthTimeoutStart()

Specified by:

getAuthTimeoutStart in interface Session

Returns:

The timestamp value (milliseconds since EPOCH) when timer was started

resetAuthTimeout

public long resetAuthTimeout()

Description copied from interface: Session

Re-start the authentication timeout timer

Specified by:

resetAuthTimeout in interface Session

Returns:

The timestamp value (milliseconds since EPOCH) when timer was started

See Also:

Session.getAuthTimeoutStart()

checkAuthenticationTimeout

protected TimeoutIndicator checkAuthenticationTimeout(long now,
                                                      long nanoTime,
                                                      long authTimeoutMs)

Checks if authentication timeout expired

Parameters:

now - The current time in millis

nanoTime - System.nanoTime() value

authTimeoutMs - The configured timeout in millis - if non-positive then no timeout

Returns:

A TimeoutIndicator specifying the timeout status and disconnect reason message if timeout expired, null or NoTimeout if no timeout occurred

See Also:

getAuthTimeout()

getIdleTimeoutStart

public long getIdleTimeoutStart()

Specified by:

getIdleTimeoutStart in interface Session

Returns:

The timestamp value (milliseconds since EPOCH) when timer was started

checkIdleTimeout

protected TimeoutIndicator checkIdleTimeout(long now,
                                            long nanoTime,
                                            long idleTimeoutMs)

Checks if idle timeout expired

Parameters:

now - The current time in millis

nanoTime - System.nanoTime() value

idleTimeoutMs - The configured timeout in millis - if non-positive then no timeout

Returns:

A TimeoutIndicator specifying the timeout status and disconnect reason message if timeout expired, null or NoTimeout if no timeout occurred

See Also:

getIdleTimeout()

resetIdleTimeout

public long resetIdleTimeout()

Description copied from interface: Session

Re-start idle timeout timer

Specified by:

resetIdleTimeout in interface Session

Returns:

The timestamp value (milliseconds since EPOCH) when timer was started

See Also:

Session.getIdleTimeoutStart()

getTimeoutStatus

public TimeoutIndicator getTimeoutStatus()

Description copied from interface: Session

Check if timeout has occurred.

Specified by:

getTimeoutStatus in interface Session

Returns:

the timeout status - never null

getReservedSessionMessagesHandler

public ReservedSessionMessagesHandler getReservedSessionMessagesHandler()

Specified by:

getReservedSessionMessagesHandler in interface ReservedSessionMessagesManager

Returns:

The currently registered ReservedSessionMessagesHandler - may be null

setReservedSessionMessagesHandler

public void setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)

Specified by:

setReservedSessionMessagesHandler in interface ReservedSessionMessagesManager

Parameters:

handler - The ReservedSessionMessagesHandler to use - may be null

getSessionDisconnectHandler

public SessionDisconnectHandler getSessionDisconnectHandler()

Specified by:

getSessionDisconnectHandler in interface SessionDisconnectHandlerManager

setSessionDisconnectHandler

public void setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler)

Specified by:

setSessionDisconnectHandler in interface SessionDisconnectHandlerManager

handleIgnore

protected void handleIgnore(Buffer buffer)
                     throws java.lang.Exception

Throws:

java.lang.Exception

doInvokeIgnoreMessageHandler

protected void doInvokeIgnoreMessageHandler(Buffer buffer)
                                     throws java.lang.Exception

Invoked by handleDebug(Buffer) after validating that the buffer structure seems well-formed and also resetting the idle timeout. By default, retrieves the ReservedSessionMessagesHandler and invokes its handleIgnoreMessage method.

Parameters:

buffer - The input Buffer

Throws:

java.lang.Exception - if failed to handle the message

sendNotImplemented

protected IoWriteFuture sendNotImplemented(long seqNoValue)
                                    throws java.io.IOException

Sends a SSH_MSG_UNIMPLEMENTED message

Parameters:

seqNoValue - The referenced sequence number

Returns:

An IoWriteFuture that can be used to wait for packet write completion

Throws:

java.io.IOException - if an error occurred sending the packet

handleUnimplemented

protected void handleUnimplemented(Buffer buffer)
                            throws java.lang.Exception

Throws:

java.lang.Exception

doInvokeUnimplementedMessageHandler

protected boolean doInvokeUnimplementedMessageHandler(int cmd,
                                                      Buffer buffer)
                                               throws java.lang.Exception

Parameters:

cmd - The unimplemented command

buffer - The input Buffer

Returns:

Result of invoking handleUnimplementedMessage

Throws:

java.lang.Exception - if failed to handle the message

sendDebugMessage

public IoWriteFuture sendDebugMessage(boolean display,
                                      java.lang.Object msg,
                                      java.lang.String lang)
                               throws java.io.IOException

Description copied from interface: Session

Sends an SSH_MSG_DEBUG to the peer session

Specified by:

sendDebugMessage in interface Session

Parameters:

display - true if OK to display the message at the peer as-is

msg - The message object whose toString() value to be used - if null then the "null" string is sent

lang - The language - null/empty if some pre-agreed default is used

Returns:

An IoWriteFuture that can be used to check when the packet has actually been sent

Throws:

java.io.IOException - if an error occurred when encoding sending the packet

See Also:

RFC 4253 - section 11.3

handleDebug

protected void handleDebug(Buffer buffer)
                    throws java.lang.Exception

Throws:

java.lang.Exception

doInvokeDebugMessageHandler

protected void doInvokeDebugMessageHandler(Buffer buffer)
                                    throws java.lang.Exception

Invoked by handleDebug(Buffer) after validating that the buffer structure seems well-formed and also resetting the idle timeout. By default, retrieves the ReservedSessionMessagesHandler and invokes its handleDebugMessage method.

Parameters:

buffer - The input Buffer

Throws:

java.lang.Exception - if failed to handle the message

resolveReservedSessionMessagesHandler

protected ReservedSessionMessagesHandler resolveReservedSessionMessagesHandler()

getUnknownChannelReferenceHandler

public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler()

Specified by:

getUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Returns:

The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

setUnknownChannelReferenceHandler

public void setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler unknownChannelReferenceHandler)

Specified by:

setUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Parameters:

unknownChannelReferenceHandler - The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

resolveUnknownChannelReferenceHandler

public UnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler()

Description copied from interface: UnknownChannelReferenceHandlerManager

Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)

Specified by:

resolveUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Returns:

The resolved handler instance

getChannelStreamPacketWriterResolver

public ChannelStreamPacketWriterResolver getChannelStreamPacketWriterResolver()

Specified by:

getChannelStreamPacketWriterResolver in interface ChannelStreamPacketWriterResolverManager

setChannelStreamPacketWriterResolver

public void setChannelStreamPacketWriterResolver(ChannelStreamPacketWriterResolver resolver)

Specified by:

setChannelStreamPacketWriterResolver in interface ChannelStreamPacketWriterResolverManager

resolveChannelStreamPacketWriterResolver

public ChannelStreamPacketWriterResolver resolveChannelStreamPacketWriterResolver()

Specified by:

resolveChannelStreamPacketWriterResolver in interface ChannelStreamPacketWriterResolverManager

sendIgnoreMessage

public IoWriteFuture sendIgnoreMessage(byte... data)
                                throws java.io.IOException

Description copied from interface: Session

Sends an SSH_MSG_IGNORE to the peer session

Specified by:

sendIgnoreMessage in interface Session

Parameters:

data - The message data

Returns:

An IoWriteFuture that can be used to check when the packet has actually been sent

Throws:

java.io.IOException - if an error occurred when encoding sending the packet

See Also:

RFC 4253 - section 11.2

writePacket

public IoWriteFuture writePacket(Buffer buffer,
                                 long timeout,
                                 java.util.concurrent.TimeUnit unit)
                          throws java.io.IOException

Description copied from interface: Session

Encode and send the given buffer with the specified timeout. If the buffer could not be written before the timeout elapses, the returned IoWriteFuture will be set with a TimeoutException exception to indicate a timeout.

Specified by:

writePacket in interface Session

Parameters:

buffer - the buffer to encode and spend

timeout - the timeout

unit - the time unit of the timeout parameter

Returns:

a future that can be used to check when the packet has actually been sent

Throws:

java.io.IOException - if an error occurred when encoding sending the packet

signalSessionEstablished

protected void signalSessionEstablished(IoSession ioSession)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

signalSessionEstablished

protected void signalSessionEstablished(SessionListener listener)

signalSessionCreated

protected void signalSessionCreated(IoSession ioSession)
                             throws java.lang.Exception

Throws:

java.lang.Exception

signalSessionCreated

protected void signalSessionCreated(SessionListener listener)

signalPeerIdentificationReceived

protected void signalPeerIdentificationReceived(java.lang.String version,
                                                java.util.List<java.lang.String> extraLines)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

signalPeerIdentificationReceived

protected void signalPeerIdentificationReceived(SessionListener listener,
                                                java.lang.String version,
                                                java.util.List<java.lang.String> extraLines)

signalSessionEvent

protected void signalSessionEvent(SessionListener.Event event)
                           throws java.io.IOException

Sends a session event to all currently registered session listeners

Parameters:

event - The event to send

Throws:

java.io.IOException - If any of the registered listeners threw an exception.

signalSessionEvent

protected void signalSessionEvent(SessionListener listener,
                                  SessionListener.Event event)
                           throws java.io.IOException

Throws:

java.io.IOException

invokeSessionSignaller

protected void invokeSessionSignaller(Invoker<SessionListener,java.lang.Void> invoker)
                               throws java.lang.Throwable

Throws:

java.lang.Throwable

resizeKey

protected byte[] resizeKey(byte[] e,
                           int kdfSize,
                           Digest hash,
                           byte[] k,
                           byte[] h)
                    throws java.lang.Exception

Method used while putting new keys into use that will resize the key used to initialize the cipher to the needed length.

Parameters:

e - the key to resize

kdfSize - the cipher key-derivation-factor (in bytes)

hash - the hash algorithm

k - the key exchange k parameter

h - the key exchange h parameter

Returns:

the resized key

Throws:

java.lang.Exception - if a problem occur while resizing the key

resolvePeerAddress

protected java.net.SocketAddress resolvePeerAddress(java.net.SocketAddress knownAddress)

Parameters:

knownAddress - Any externally set peer address - e.g., due to some proxy mechanism meta-data

Returns:

The external address if not null otherwise, the IoSession peer address

calculateNextIgnorePacketCount

protected long calculateNextIgnorePacketCount(Random r,
                                              long freq,
                                              int variance)

resolveIdentificationString

protected java.lang.String resolveIdentificationString(java.lang.String configPropName)

Resolves the identification to send to the peer session by consulting the associated FactoryManager. If a value is set, then it is appended to the standard SessionContext.DEFAULT_SSH_VERSION_PREFIX. Otherwise a default value is returned consisting of the prefix and the core artifact name + version in uppercase - e.g.,' "SSH-2.0-APACHE-SSHD-1.2.3.4"

Parameters:

configPropName - The property used to query the factory manager

Returns:

The resolved identification value

sendIdentification

protected IoWriteFuture sendIdentification(java.lang.String ident)
                                    throws java.io.IOException

Send our identification.

Parameters:

ident - our identification to send

Returns:

IoWriteFuture that can be used to wait for notification that identification has been send

Throws:

java.io.IOException - If failed to send the packet

doReadIdentification

protected java.util.List<java.lang.String> doReadIdentification(Buffer buffer,
                                                                boolean server)
                                                         throws java.io.IOException

Read the remote identification from this buffer. If more data is needed, the buffer will be reset to its original state and a null value will be returned. Else the identification string will be returned and the data read will be consumed from the buffer.

Parameters:

buffer - the buffer containing the identification string

server - true if it is called by the server session, false if by the client session

Returns:

A List of all received remote identification lines until the version line was read or null if more data is needed. The identification line is the last one in the list

Throws:

java.io.IOException - if malformed identification found

resolveSessionKexProposal

protected java.lang.String resolveSessionKexProposal(java.lang.String hostKeyTypes)
                                              throws java.io.IOException

Throws:

java.io.IOException

createProposal

protected java.util.Map<KexProposalOption,java.lang.String> createProposal(java.lang.String hostKeyTypes)
                                                                    throws java.io.IOException

Create our proposal for SSH negotiation

Parameters:

hostKeyTypes - The comma-separated list of supported host key types

Returns:

The proposal Map

Throws:

java.io.IOException - If internal problem - e.g., KEX extensions negotiation issue

mergeProposals

protected java.util.Map<KexProposalOption,java.lang.String> mergeProposals(java.util.Map<KexProposalOption,java.lang.String> current,
                                                                           java.util.Map<KexProposalOption,java.lang.String> proposal)

signalNegotiationStart

protected void signalNegotiationStart(java.util.Map<KexProposalOption,java.lang.String> c2sOptions,
                                      java.util.Map<KexProposalOption,java.lang.String> s2cOptions)

signalNegotiationStart

protected void signalNegotiationStart(SessionListener listener,
                                      java.util.Map<KexProposalOption,java.lang.String> c2sOptions,
                                      java.util.Map<KexProposalOption,java.lang.String> s2cOptions)

signalNegotiationEnd

protected void signalNegotiationEnd(java.util.Map<KexProposalOption,java.lang.String> c2sOptions,
                                    java.util.Map<KexProposalOption,java.lang.String> s2cOptions,
                                    java.util.Map<KexProposalOption,java.lang.String> negotiatedGuess,
                                    java.lang.Throwable reason)

signalNegotiationEnd

protected void signalNegotiationEnd(SessionListener listener,
                                    java.util.Map<KexProposalOption,java.lang.String> c2sOptions,
                                    java.util.Map<KexProposalOption,java.lang.String> s2cOptions,
                                    java.util.Map<KexProposalOption,java.lang.String> negotiatedGuess,
                                    java.lang.Throwable reason)

preProcessEncodeBuffer

protected Buffer preProcessEncodeBuffer(int cmd,
                                        Buffer buffer)
                                 throws java.io.IOException

Invoked by the session before encoding the buffer in order to make sure that it is at least of size SSH_PACKET_HEADER_LEN. This is required in order to efficiently handle the encoding. If necessary, it re-allocates a new buffer and returns it instead.

Parameters:

cmd - The command stored in the buffer

buffer - The original Buffer - assumed to be properly formatted and be of at least the required minimum length.

Returns:

The adjusted Buffer. Note: users may use this method to totally alter the contents of the buffer being sent but it is highly discouraged as it may have unexpected results.

Throws:

java.io.IOException - If failed to process the buffer

disconnect

public void disconnect(int reason,
                       java.lang.String msg)
                throws java.io.IOException

Description copied from interface: Session

Send a disconnect packet with the given reason and message. Once the packet has been sent, the session will be closed asynchronously.

Specified by:

disconnect in interface Session

Parameters:

reason - the reason code for this disconnect

msg - the text message

Throws:

java.io.IOException - if an error occurred sending the packet

handleDisconnect

protected void handleDisconnect(Buffer buffer)
                         throws java.lang.Exception

Throws:

java.lang.Exception

handleDisconnect

protected void handleDisconnect(int code,
                                java.lang.String msg,
                                java.lang.String lang,
                                Buffer buffer)
                         throws java.lang.Exception

Throws:

java.lang.Exception

signalDisconnect

protected void signalDisconnect(int code,
                                java.lang.String msg,
                                java.lang.String lang,
                                boolean initiator)

signalDisconnect

protected void signalDisconnect(SessionListener listener,
                                int code,
                                java.lang.String msg,
                                java.lang.String lang,
                                boolean initiator)

exceptionCaught

public void exceptionCaught(java.lang.Throwable t)

Handle any exceptions that occurred on this session. The session will be closed and a disconnect packet will be sent before if the given exception is an SshException.

Specified by:

exceptionCaught in interface Session

Parameters:

t - the exception to process

signalExceptionCaught

protected void signalExceptionCaught(java.lang.Throwable t)

signalExceptionCaught

protected void signalExceptionCaught(SessionListener listener,
                                     java.lang.Throwable t)

signalSessionClosed

protected void signalSessionClosed()

signalSessionClosed

protected void signalSessionClosed(SessionListener listener)

getConnectionService

protected abstract ConnectionService getConnectionService()

getForwardingFilter

protected ForwardingFilter getForwardingFilter()

getLocalForwardsBindings

public java.util.List<java.util.Map.Entry<java.lang.Integer,SshdSocketAddress>> getLocalForwardsBindings()

Specified by:

getLocalForwardsBindings in interface PortForwardingInformationProvider

Returns:

A snapshot of the currently bound forwarded local ports as "pairs" of port + bound SshdSocketAddress

isLocalPortForwardingStartedForPort

public boolean isLocalPortForwardingStartedForPort(int port)

Description copied from interface: PortForwardingInformationProvider

Test if local port forwarding is started

Specified by:

isLocalPortForwardingStartedForPort in interface PortForwardingInformationProvider

Parameters:

port - The local port

Returns:

true if local port forwarding is started

See Also:

getBoundLocalPortForward

getStartedLocalPortForwards

public java.util.NavigableSet<java.lang.Integer> getStartedLocalPortForwards()

Specified by:

getStartedLocalPortForwards in interface PortForwardingInformationProvider

Returns:

A NavigableSet snapshot of the currently started local port forwards

getBoundLocalPortForward

public SshdSocketAddress getBoundLocalPortForward(int port)

Specified by:

getBoundLocalPortForward in interface PortForwardingInformationProvider

Parameters:

port - The port number

Returns:

The local bound SshdSocketAddress for the port - null if none bound

See Also:

isLocalPortForwardingStartedForPort, PortForwardingInformationProvider.getStartedLocalPortForwards()

getRemoteForwardsBindings

public java.util.List<java.util.Map.Entry<java.lang.Integer,SshdSocketAddress>> getRemoteForwardsBindings()

Specified by:

getRemoteForwardsBindings in interface PortForwardingInformationProvider

Returns:

A snapshot of the currently bound forwarded remote ports as "pairs" of port + bound SshdSocketAddress

isRemotePortForwardingStartedForPort

public boolean isRemotePortForwardingStartedForPort(int port)

Description copied from interface: PortForwardingInformationProvider

Test if remote port forwarding is started

Specified by:

isRemotePortForwardingStartedForPort in interface PortForwardingInformationProvider

Parameters:

port - The remote port

Returns:

true if remote port forwarding is started

See Also:

getBoundRemotePortForward

getStartedRemotePortForwards

public java.util.NavigableSet<java.lang.Integer> getStartedRemotePortForwards()

Specified by:

getStartedRemotePortForwards in interface PortForwardingInformationProvider

Returns:

A NavigableSet snapshot of the currently started remote port forwards

getBoundRemotePortForward

public SshdSocketAddress getBoundRemotePortForward(int port)

Specified by:

getBoundRemotePortForward in interface PortForwardingInformationProvider

Parameters:

port - The port number

Returns:

The remote bound SshdSocketAddress for the port - null if none bound

See Also:

isRemotePortForwardingStartedForPort, PortForwardingInformationProvider.getStartedRemotePortForwards()

getAuthTimeout

public long getAuthTimeout()

Specified by:

getAuthTimeout in interface Session

Returns:

Timeout value in milliseconds for authentication stage

getIdleTimeout

public long getIdleTimeout()

Specified by:

getIdleTimeout in interface Session

Returns:

Timeout value in milliseconds for communication

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object