Apache Mina SSHD 2.15.0 · org.apache.sshd.common.session.helpers.SessionHelper

Modifier and Type	Field and Description
private final Map<AttributeRepository.AttributeKey<?>, Object>	attributes Session specific attributes
private volatile boolean	authed Boolean indicating if this session has been authenticated or not
protected Instant	authStart
private ChannelStreamWriterResolver	channelStreamPacketWriterResolver
protected Instant	idleStart
protected Map<KexProposalOption, String>	initialKexProposal Stores the initial KEX proposal after it has been run through the hooks allowing client code to modify it; see `getKexProposal()`.
private final IoSession	ioSession The underlying network session
private final Map<String, Object>	properties The session specific properties
private ReservedSessionMessagesHandler	reservedSessionMessagesHandler
private final boolean	serverSession Client or server side
private SessionDisconnectHandler	sessionDisconnectHandler
private final AtomicReference<TimeoutIndicator>	timeoutStatus
private UnknownChannelReferenceHandler	unknownChannelReferenceHandler
private volatile String	username The name of the authenticated user

Access	Constructor and Description
protected	SessionHelper(boolean `true` if this is a server session, `false` if client one serverSession, FactoryManager the factory manager factoryManager, IoSession the underlying I/O session ioSession) Create a new session.

Method Summary

Modifier and Type	Method and Description
public Collection<AttributeRepository.AttributeKey<?>>	attributeKeys() Implements org.apache.sshd.common.AttributeRepository.attributeKeys.
protected long	calculateNextIgnorePacketCount(Random r, long freq, int variance)
protected TimeoutIndicator	Returns: A `TimeoutIndicator` specifying the timeout status and disconnect reason message if timeout expired, `null` or `NoTimeout` if no timeout occurred checkAuthenticationTimeout(Instant The current time in millis now, Duration The configured timeout - if non-positive then no timeout authTimeout) Checks if authentication timeout expired
protected TimeoutIndicator	Returns: An indication whether timeout has been detected checkForTimeouts() Checks whether the session has timed out (both authentication and idle timeouts are checked).
protected TimeoutIndicator	Returns: A `TimeoutIndicator` specifying the timeout status and disconnect reason message if timeout expired, `null` or `NoTimeout` if no timeout occurred checkIdleTimeout(Instant The current time in millis now, Duration The configured timeout - if non-positive then no timeout idleTimeout) Checks if idle timeout expired
public void	clearAttributes() Implements org.apache.sshd.common.AttributeStore.clearAttributes. Removes all currently stored user-defined attributes
public <T> T	computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> The key of the attribute; must not be `null`. key, Function<? super AttributeRepository.AttributeKey<T>, ? extends T> The (never `null`) mapping function to use if value not already mapped. If returns `null` then value is not mapped to the provided key. resolver) Overrides default org.apache.sshd.common.AttributeStore.computeAttributeIfAbsent. 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 Map<KexProposalOption, String>	Returns: The proposal `Map` createProposal(String The comma-separated list of supported host key types hostKeyTypes) Create our proposal for SSH negotiation
public void	disconnect(int the reason code for this disconnect reason, String the text message msg) Implements org.apache.sshd.common.session.Session.disconnect. Send a disconnect packet with the given reason and message.
protected void	doInvokeDebugMessageHandler(Buffer The input `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 The input `Buffer` buffer) Invoked by `handleDebug(Buffer)` after validating that the buffer structure seems well-formed and also resetting the idle timeout.
protected boolean	Returns: Result of invoking `handleUnimplementedMessage` doInvokeUnimplementedMessageHandler(int The unimplemented command cmd, Buffer The input `Buffer` buffer)
protected List<String>	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 doReadIdentification(Buffer the buffer containing the identification string buffer, boolean `true` if it is called by the server session, `false` if by the client session server) Read the remote identification from this buffer.
public void	exceptionCaught(Throwable the exception to process t) Implements org.apache.sshd.common.session.Session.exceptionCaught. Handle any exceptions that occurred on this session.
public <T> T	getAttribute(AttributeRepository.AttributeKey<T> The key of the attribute; must not be `null`. key) Implements org.apache.sshd.common.AttributeRepository.getAttribute. Returns the value of the user-defined attribute.
public int	getAttributesCount() Implements org.apache.sshd.common.AttributeRepository.getAttributesCount.
public Duration	getAuthTimeout() Implements org.apache.sshd.common.session.Session.getAuthTimeout.
public Instant	getAuthTimeoutStart() Implements org.apache.sshd.common.session.Session.getAuthTimeoutStart.
public List<SshdSocketAddress>	getBoundLocalPortForwards(int The port number port) Implements org.apache.sshd.common.forward.PortForwardingInformationProvider.getBoundLocalPortForwards.
public SshdSocketAddress	getBoundRemotePortForward(int The port number port) Implements org.apache.sshd.common.forward.PortForwardingInformationProvider.getBoundRemotePortForward.
public ChannelStreamWriterResolver	getChannelStreamWriterResolver() Implements org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager.getChannelStreamWriterResolver.
protected abstract ConnectionService	getConnectionService()
public FactoryManager	getFactoryManager() Implements org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.
protected Forwarder	getForwarder()
public Duration	getIdleTimeout() Implements org.apache.sshd.common.session.Session.getIdleTimeout.
public Instant	getIdleTimeoutStart() Implements org.apache.sshd.common.session.Session.getIdleTimeoutStart.
public IoSession	getIoSession() Implements org.apache.sshd.common.session.Session.getIoSession.
protected Map<KexProposalOption, String>	Returns: the proposal `Map` getKexProposal() Retrieves this side's initial proposal for KEX negotiation.
public List<Map.Entry<SshdSocketAddress, SshdSocketAddress>>	getLocalForwardsBindings() Implements org.apache.sshd.common.forward.PortForwardingInformationProvider.getLocalForwardsBindings.
public PropertyResolver	getParentPropertyResolver() Implements org.apache.sshd.common.PropertyResolver.getParentPropertyResolver.
public Map<String, Object>	getProperties() Implements org.apache.sshd.common.PropertyResolver.getProperties. A map of properties that can be used to configure the SSH server or client.
public List<Map.Entry<Integer, SshdSocketAddress>>	getRemoteForwardsBindings() Implements org.apache.sshd.common.forward.PortForwardingInformationProvider.getRemoteForwardsBindings.
public ReservedSessionMessagesHandler	getReservedSessionMessagesHandler() Implements org.apache.sshd.common.session.ReservedSessionMessagesManager.getReservedSessionMessagesHandler.
public SessionDisconnectHandler	getSessionDisconnectHandler() Implements org.apache.sshd.common.session.SessionDisconnectHandlerManager.getSessionDisconnectHandler.
public List<SshdSocketAddress>	getStartedLocalPortForwards() Implements org.apache.sshd.common.forward.PortForwardingInformationProvider.getStartedLocalPortForwards.
public NavigableSet<Integer>	getStartedRemotePortForwards() Implements org.apache.sshd.common.forward.PortForwardingInformationProvider.getStartedRemotePortForwards.
public TimeoutIndicator	getTimeoutStatus() Implements org.apache.sshd.common.session.Session.getTimeoutStatus. Check if timeout has occurred.
public UnknownChannelReferenceHandler	getUnknownChannelReferenceHandler() Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.getUnknownChannelReferenceHandler.
public String	getUsername() Implements org.apache.sshd.common.auth.UsernameHolder.getUsername.
protected void	handleDebug(Buffer buffer)
protected void	handleDisconnect(Buffer buffer)
protected void	handleDisconnect(int code, String msg, String lang, Buffer buffer)
protected void	handleIgnore(Buffer buffer)
protected void	handleUnimplemented(Buffer buffer)
protected void	invokeSessionSignaller(Invoker<SessionListener, Void> invoker)
public boolean	isAuthenticated() Implements org.apache.sshd.common.session.SessionContext.isAuthenticated.
public boolean	isLocalPortForwardingStartedForPort(int The local port port) Overrides default org.apache.sshd.common.forward.PortForwardingInformationProvider.isLocalPortForwardingStartedForPort. Test if local port forwarding is started
public boolean	isRemotePortForwardingStartedForPort(int The remote port port) Overrides default org.apache.sshd.common.forward.PortForwardingInformationProvider.isRemotePortForwardingStartedForPort. Test if remote port forwarding is started
public boolean	isServerSession() Implements org.apache.sshd.common.session.SessionContext.isServerSession. Quick indication if this is a server or client session (instead of having to ask `instanceof`).
protected Map<KexProposalOption, String>	mergeProposals(Map<KexProposalOption, String> current, Map<KexProposalOption, String> proposal)
protected Buffer	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. preProcessEncodeBuffer(int The command stored in the buffer cmd, Buffer The original `Buffer` - assumed to be properly formatted and be of at least the required minimum length. 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`.
public <T> T	removeAttribute(AttributeRepository.AttributeKey<T> The key of the attribute; must not be `null`. key) Implements org.apache.sshd.common.AttributeStore.removeAttribute. Removes the user-defined attribute
public Instant	resetAuthTimeout() Implements org.apache.sshd.common.session.Session.resetAuthTimeout. Re-start the authentication timeout timer
public Instant	resetIdleTimeout() Implements org.apache.sshd.common.session.Session.resetIdleTimeout. Re-start idle timeout timer
protected byte[]	Returns: the resized key resizeKey(byte[] the key to resize e, int the cipher key-derivation-factor (in bytes) kdfSize, Digest the hash algorithm hash, byte[] the key exchange k parameter k, byte[] the key exchange h parameter h) Method used while putting new keys into use that will resize the key used to initialize the cipher to the needed length.
protected String	Returns: A comma-separated list of all the signature protocols to be included in the proposal - `null`/empty if no proposal resolveAvailableSignaturesProposal() Computes the list of available host key signature algorithms supported.
protected abstract String	Returns: A comma-separated list of all the signature protocols to be included in the proposal - `null`/empty if no proposal resolveAvailableSignaturesProposal(FactoryManager The `FactoryManager` manager) Computes the list of available host key signature algorithms supported.
public ChannelStreamWriterResolver	resolveChannelStreamWriterResolver() Overrides default org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager.resolveChannelStreamWriterResolver.
protected String	Returns: The resolved identification value resolveIdentificationString(String The property used to query the factory manager configPropName) Resolves the identification to send to the peer session by consulting the associated `FactoryManager`.
protected SocketAddress	Returns: The external address if not `null` otherwise, the `IoSession` peer address resolvePeerAddress(SocketAddress Any externally set peer address - e.g., due to some proxy mechanism meta-data knownAddress)
protected ReservedSessionMessagesHandler	resolveReservedSessionMessagesHandler()
protected String	resolveSessionKexProposal(String hostKeyTypes)
public UnknownChannelReferenceHandler	resolveUnknownChannelReferenceHandler() Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.resolveUnknownChannelReferenceHandler. Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)
public IoWriteFuture	sendDebugMessage(boolean `true` if OK to display the message at the peer as-is display, Object The message object whose `toString()` value to be used - if `null` then the "null" string is sent msg, String The language - `null`/empty if some pre-agreed default is used lang) Implements org.apache.sshd.common.session.Session.sendDebugMessage. Sends an `SSH_MSG_DEBUG` to the peer session
protected IoWriteFuture	Returns: `IoWriteFuture` that can be used to wait for notification that identification has been send sendIdentification(String our identification to send version, List<String> Extra lines to send - used only by server sessions extraLines) Send our identification.
public IoWriteFuture	sendIgnoreMessage(byte... The message data data) Implements org.apache.sshd.common.session.Session.sendIgnoreMessage. Sends an `SSH_MSG_IGNORE` to the peer session
protected IoWriteFuture	Returns: An `IoWriteFuture` that can be used to wait for packet write completion sendNotImplemented(long The referenced sequence number seqNoValue) Sends a `SSH_MSG_UNIMPLEMENTED` message
public <T> T	setAttribute(AttributeRepository.AttributeKey<T> The key of the attribute; must not be `null`. key, T The value of the attribute; must not be `null`. value) Implements org.apache.sshd.common.AttributeStore.setAttribute. Sets a user-defined attribute.
public void	setAuthenticated() Implements org.apache.sshd.common.session.Session.setAuthenticated.
public void	setChannelStreamWriterResolver(ChannelStreamWriterResolver resolver) Implements org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager.setChannelStreamWriterResolver.
public void	setReservedSessionMessagesHandler(ReservedSessionMessagesHandler The `ReservedSessionMessagesHandler` to use - may be `null` handler) Implements org.apache.sshd.common.session.ReservedSessionMessagesManager.setReservedSessionMessagesHandler.
public void	setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler) Implements org.apache.sshd.common.session.SessionDisconnectHandlerManager.setSessionDisconnectHandler.
public void	setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler The `UnknownChannelReferenceHandlerManager` to use - if `null` then any reference to unknown channel causes an `SshChannelNotFoundException` unknownChannelReferenceHandler) Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.setUnknownChannelReferenceHandler.
public void	setUsername(String username) Implements org.apache.sshd.common.auth.MutableUserHolder.setUsername.
protected void	signalDisconnect(int code, String msg, String lang, boolean initiator)
protected void	signalDisconnect(SessionListener listener, int code, String msg, String lang, boolean initiator)
protected void	signalExceptionCaught(Throwable t)
protected void	signalExceptionCaught(SessionListener listener, Throwable t)
protected void	signalNegotiationEnd(Map<KexProposalOption, String> c2sOptions, Map<KexProposalOption, String> s2cOptions, Map<KexProposalOption, String> negotiatedGuess, Throwable reason)
protected void	signalNegotiationEnd(SessionListener listener, Map<KexProposalOption, String> c2sOptions, Map<KexProposalOption, String> s2cOptions, Map<KexProposalOption, String> negotiatedGuess, Throwable reason)
protected void	signalNegotiationOptionsCreated(Map<KexProposalOption, String> proposal)
protected void	signalNegotiationOptionsCreated(SessionListener listener, Map<KexProposalOption, String> proposal)
protected void	signalNegotiationStart(Map<KexProposalOption, String> c2sOptions, Map<KexProposalOption, String> s2cOptions)
protected void	signalNegotiationStart(SessionListener listener, Map<KexProposalOption, String> c2sOptions, Map<KexProposalOption, String> s2cOptions)
protected void	signalPeerIdentificationReceived(String version, List<String> extraLines)
protected void	signalPeerIdentificationReceived(SessionListener listener, String version, List<String> extraLines)
protected void	signalReadPeerIdentificationLine(String line, List<String> extraLines)
protected void	signalReadPeerIdentificationLine(SessionListener listener, String version, List<String> extraLines)
protected void	signalSendIdentification(String version, List<String> extraLines)
protected void	signalSendIdentification(SessionListener listener, String version, List<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 The event to send event) Sends a session event to all currently registered session listeners
protected void	signalSessionEvent(SessionListener listener, SessionListener.Event event)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.common.kex.AbstractKexFactoryManager:: getCipherFactories getCompressionFactories getDelegate getKexExtensionHandler getKeyExchangeFactories getMacFactories getSignatureFactories resolveEffectiveFactories resolveEffectiveProvider setCipherFactories setCompressionFactories setKexExtensionHandler setKeyExchangeFactories setMacFactories setSignatureFactories

public abstract Class SessionHelper

Field Summary

Constructor Summary

Method Summary