org.apache.sshd.server.session

Class ServerSessionImpl

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.session.AbstractSession

org.apache.sshd.server.session.ServerSessionImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Session, ServerSession

public class ServerSessionImpl
extends AbstractSession
implements ServerSession

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

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

Session.AttributeKey<T>, Session.TimeoutStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	MAX_PACKETS

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

attributes, authed, authTimeoutMs, authTimeoutTimestamp, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, DEFAULT_SSH_VERSION_PREFIX, disconnectTimeoutMs, encodeLock, factoryManager, i_c, i_s, idleTimeoutMs, idleTimeoutTimestamp, inBytesCount, inCipher, inCipherSize, inCompression, inMac, inMacResult, inPacketsCount, ioSession, isServer, kex, kexState, lastKeyTimeValue, listeners, negotiationResult, outBytesCount, outCipher, outCipherSize, outCompression, outMac, outPacketsCount, pendingPackets, random, reexchangeFuture, requestLock, requestResult, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, sessionListenerProxy, timeoutStatus, uncompressBuffer, username

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

closeFuture, lock, state

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

log

Constructor Summary

Constructors

Constructor and Description
ServerSessionImpl(ServerFactoryManager server, IoSession ioSession)

Method Summary

Modifier and Type	Method and Description
protected void	checkKeys()
protected void	checkRekey()
int	getActiveSessionCountForUser(String userName) Retrieve the current number of sessions active for a given username.
ServerFactoryManager	getFactoryManager()
KeyPair	getHostKey()
long	getId() Returns the session id.
protected boolean	readIdentification(Buffer buffer) Read the other side identification.
protected void	receiveKexInit(Map<KexProposalOption,String> proposal, byte[] seed)
protected String	resolveAvailableSignaturesProposal(FactoryManager manager)
protected String	resolveEmptySignaturesProposal(Iterable<String> supported, Iterable<String> provided) Called by resolveAvailableSignaturesProposal(FactoryManager) if none of the provided keys is supported - last chance for the derived implementation to do something
protected byte[]	sendKexInit(Map<KexProposalOption,String> proposal) Send the key exchange initialization packet.
protected void	sendServerIdentification()
protected void	serviceAccept()
protected void	setKexSeed(byte... seed)
void	startService(String name)

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

addListener, attachSession, checkForTimeouts, createBuffer, createBuffer, createProposal, decode, disconnect, doCloseImmediately, doHandleMessage, doReadIdentification, doWritePacket, exceptionCaught, getAttribute, getAuthTimeout, getClientVersion, getIdleTimeout, getInnerCloseable, getIntProperty, getIoSession, getKex, getLock, getLongProperty, getNegotiatedKexParameter, getServerVersion, getService, getServices, getSession, getSession, getSessionId, getTimeoutStatus, getUsername, handleMessage, isAuthenticated, mergeProposals, messageReceived, negotiate, notImplemented, receiveKexInit, receiveKexInit, receiveNewKeys, reExchangeKeys, removeListener, request, requestFailure, requestSuccess, resetIdleTimeout, resolveAvailableSignaturesProposal, sendEvent, sendIdentification, sendKexInit, sendNewKeys, setAttribute, setAuthenticated, setNegotiationResult, setUsername, toString, validateKexState, writePacket, writePacket

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully

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

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

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

addListener, createBuffer, createBuffer, disconnect, exceptionCaught, getAttribute, getAuthTimeout, getClientVersion, getIdleTimeout, getIntProperty, getIoSession, getKex, getNegotiatedKexParameter, getServerVersion, getService, getSessionId, getTimeoutStatus, getUsername, isAuthenticated, reExchangeKeys, removeListener, request, resetIdleTimeout, setAttribute, setAuthenticated, setUsername, writePacket, writePacket

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

close, isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

MAX_PACKETS

protected static final long MAX_PACKETS

See Also:

Constant Field Values

Constructor Detail

ServerSessionImpl

public ServerSessionImpl(ServerFactoryManager server,
                         IoSession ioSession)
                  throws Exception

Throws:

Exception

Method Detail

getFactoryManager

public ServerFactoryManager getFactoryManager()

Specified by:

getFactoryManager in interface Session

Specified by:

getFactoryManager in interface ServerSession

Overrides:

getFactoryManager in class AbstractSession

Returns:

the FactoryManager that has created this session, can not be null

checkKeys

protected void checkKeys()

Specified by:

checkKeys in class AbstractSession

startService

public void startService(String name)
                  throws Exception

Specified by:

startService in interface Session

Parameters:

name - Service name

Throws:

Exception - If failed to start it

serviceAccept

protected void serviceAccept()
                      throws IOException

Overrides:

serviceAccept in class AbstractSession

Throws:

IOException

checkRekey

protected void checkRekey()
                   throws IOException

Overrides:

checkRekey in class AbstractSession

Throws:

IOException

sendServerIdentification

protected void sendServerIdentification()

sendKexInit

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

Description copied from class: AbstractSession

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

Overrides:

sendKexInit in class AbstractSession

Parameters:

proposal - our proposal for key exchange negotiation

Returns:

the sent packet which must be kept for later use

Throws:

IOException - if an error occurred sending the packet

setKexSeed

protected void setKexSeed(byte... seed)

Specified by:

setKexSeed in class AbstractSession

Parameters:

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

resolveAvailableSignaturesProposal

protected String resolveAvailableSignaturesProposal(FactoryManager manager)

Specified by:

resolveAvailableSignaturesProposal in class AbstractSession

Parameters:

manager - The FactoryManager

Returns:

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

resolveEmptySignaturesProposal

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

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

Parameters:

supported - The supported key types - may be null/empty

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

Returns:

The resolved proposal - null by default

readIdentification

protected boolean readIdentification(Buffer buffer)
                              throws IOException

Description copied from class: AbstractSession

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

Specified by:

readIdentification in class AbstractSession

Parameters:

buffer - the buffer containing the remote identification

Returns:

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

Throws:

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

receiveKexInit

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

Specified by:

receiveKexInit in class AbstractSession

Throws:

IOException

getHostKey

public KeyPair getHostKey()

Specified by:

getHostKey in interface ServerSession

Returns:

The KeyPair representing the current session's used keys on KEX

getActiveSessionCountForUser

public int getActiveSessionCountForUser(String userName)

Description copied from interface: ServerSession

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

Specified by:

getActiveSessionCountForUser in interface ServerSession

Parameters:

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

Returns:

The current number of live SshSession objects associated with the user

getId

public long getId()

Returns the session id.

Returns:

The session id.