org.apache.sshd.common.session

Interface SessionContext

All Superinterfaces:

AttributeRepository, AttributeStore, ConnectionEndpointsIndicator, PropertyResolver, SessionHeartbeatController, UsernameHolder

public interface SessionContext
extends ConnectionEndpointsIndicator, UsernameHolder, SessionHeartbeatController, AttributeStore

A "succinct" summary of the most important attributes of an SSH session

Author:

Apache MINA SSHD Project

Nested Class Summary

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
static String	DEFAULT_SSH_VERSION_PREFIX Default prefix expected for the client / server identification string
static String	FALLBACK_SSH_VERSION_PREFIX Backward compatible special prefix
static int	MAX_VERSION_LINE_LENGTH Maximum number of characters for any single line sent as part of the initial handshake - according to RFC 4253 - section 4.2: The maximum length of the string is 255 characters, including the Carriage Return and Line Feed.

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

Method Summary

Modifier and Type	Method and Description
Map<KexProposalOption,String>	getClientKexProposals()
String	getClientVersion() Retrieve the client version for this session.
Map<KexProposalOption,String>	getKexNegotiationResult()
KexState	getKexState()
String	getNegotiatedKexParameter(KexProposalOption paramType) Retrieve one of the negotiated values during the KEX stage
Map<KexProposalOption,String>	getServerKexProposals()
String	getServerVersion() Retrieve the server version for this session.
byte[]	getSessionId()
boolean	isAuthenticated()
static boolean	isValidVersionPrefix(String version)

Methods inherited from interface org.apache.sshd.common.util.net.ConnectionEndpointsIndicator

getLocalAddress, getRemoteAddress

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

getUsername

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

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, 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, resolveAttribute

Field Detail

DEFAULT_SSH_VERSION_PREFIX

static final String DEFAULT_SSH_VERSION_PREFIX

Default prefix expected for the client / server identification string

See Also:

RFC 4253 - section 4.2, Constant Field Values

FALLBACK_SSH_VERSION_PREFIX

static final String FALLBACK_SSH_VERSION_PREFIX

Backward compatible special prefix

See Also:

RFC 4253 - section 5, Constant Field Values

MAX_VERSION_LINE_LENGTH

static final int MAX_VERSION_LINE_LENGTH

Maximum number of characters for any single line sent as part of the initial handshake - according to RFC 4253 - section 4.2:

The maximum length of the string is 255 characters, including the Carriage Return and Line Feed.

See Also:

Constant Field Values

Method Detail

getSessionId

byte[] getSessionId()

Returns:

A clone of the established session identifier - null if not yet established

getClientVersion

String getClientVersion()

Retrieve the client version for this session.

Returns:

the client version - may be null/empty if versions not yet exchanged

getClientKexProposals

Map<KexProposalOption,String> getClientKexProposals()

Returns:

An un-modifiable map of the latest KEX client proposal options May be empty if KEX not yet completed or re-keying in progress

See Also:

getKexState()

getServerVersion

String getServerVersion()

Retrieve the server version for this session.

Returns:

the server version - may be null/empty if versions not yet exchanged

getServerKexProposals

Map<KexProposalOption,String> getServerKexProposals()

Returns:

An un-modifiable map of the latest KEX client proposal options. May be empty if KEX not yet completed or re-keying in progress

See Also:

getKexState()

getKexState

KexState getKexState()

getKexNegotiationResult

Map<KexProposalOption,String> getKexNegotiationResult()

getNegotiatedKexParameter

String getNegotiatedKexParameter(KexProposalOption paramType)

Retrieve one of the negotiated values during the KEX stage

Parameters:

paramType - The request KexProposalOption value - ignored if null

Returns:

The negotiated parameter value - null if invalid parameter or no negotiated value.

See Also:

getKexState()

isAuthenticated

boolean isAuthenticated()

Returns:

true if session has successfully completed the authentication phase

isValidVersionPrefix

static boolean isValidVersionPrefix(String version)

Parameters:

version - The reported client/server version

Returns:

true if version not empty and starts with either "SSH-2.0-" or "SSH-1.99-"