Class SshTransportFilter

java.lang.Object

org.apache.sshd.common.filter.IoFilter

org.apache.sshd.common.session.filters.SshTransportFilter

All Implemented Interfaces:

Filter, Owned<FilterContext>

public class SshTransportFilter
extends IoFilter

A filter encapsulating the basic SSH transport up to and including KEX.

Constructor Summary

Constructors

Constructor	Description
SshTransportFilter(AbstractSession session, org.apache.sshd.common.random.Random random, SshIdentHandler identities, SessionListener events, KexFilter.Proposer proposer, KexFilter.HostKeyChecker checker)	Creates a new SSH transport filter.

Method Summary

Modifier and Type	Method	Description
void	addEncryptionListener(CryptFilter.EncryptionListener listener)
void	addKexListener(KexListener listener)
void	enableInputCompression()
void	enableOutputCompression()
org.apache.sshd.common.cipher.CipherInformation	getCipherInformation(boolean incoming)
Map<org.apache.sshd.common.kex.KexProposalOption, String>	getClientProposal()
org.apache.sshd.common.compression.CompressionInformation	getCompressionInformation(boolean incoming)
long	getInputSequenceNumber()
AtomicReference<org.apache.sshd.common.kex.KexState>	getKexState()
long	getLastInputSequenceNumber()
org.apache.sshd.common.mac.MacInformation	getMacInformation(boolean incoming)
Map<org.apache.sshd.common.kex.KexProposalOption, String>	getNegotiated()
long	getOutputSequenceNumber()
Map<org.apache.sshd.common.kex.KexProposalOption, String>	getServerProposal()
byte[]	getSessionId()
InputHandler	in()	Retrieves the filter's InputHandler.
boolean	isInitialKexDone()
boolean	isSecure()
boolean	isStrictKex()
OutputHandler	out()	Retrieves the filter's OutputHandler.
void	removeEncryptionListener(CryptFilter.EncryptionListener listener)
void	removeKexListener(KexListener listener)
void	shutdown()
KeyExchangeFuture	startKex()

Methods inherited from class IoFilter

added, adding, init, owner, removed, removing

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SshTransportFilter

public SshTransportFilter(AbstractSession session,
 org.apache.sshd.common.random.Random random,
 SshIdentHandler identities,
 SessionListener events,
 KexFilter.Proposer proposer,
 KexFilter.HostKeyChecker checker)

Creates a new SSH transport filter.

Parameters:

session - AbstractSession this filter is for

random - Random instance to use

identities - SshIdentHandler for handling the SSH identificaton string

events - SessionListener to report some events

proposer - KexFilter.Proposer to get KEX proposals

checker - KexFilter.HostKeyChecker to check the peer's host key; may be null if on a server

Method Details

in

public InputHandler in()

Description copied from interface: Filter

Retrieves the filter's InputHandler.

Returns:

the InputHandler or code null if this filter is an output-only filter

out

public OutputHandler out()

Description copied from interface: Filter

Retrieves the filter's OutputHandler.

Returns:

the OutputHandler or code null if this filter is an input-only filter

startKex

public KeyExchangeFuture startKex()
                           throws Exception

Throws:

Exception

shutdown

public void shutdown()

isStrictKex

public boolean isStrictKex()

isInitialKexDone

public boolean isInitialKexDone()

getKexState

public AtomicReference<org.apache.sshd.common.kex.KexState> getKexState()

getNegotiated

public Map<org.apache.sshd.common.kex.KexProposalOption, String> getNegotiated()

getClientProposal

public Map<org.apache.sshd.common.kex.KexProposalOption, String> getClientProposal()

getServerProposal

public Map<org.apache.sshd.common.kex.KexProposalOption, String> getServerProposal()

getSessionId

public byte[] getSessionId()

addKexListener

public void addKexListener(KexListener listener)

removeKexListener

public void removeKexListener(KexListener listener)

addEncryptionListener

public void addEncryptionListener(CryptFilter.EncryptionListener listener)

removeEncryptionListener

public void removeEncryptionListener(CryptFilter.EncryptionListener listener)

isSecure

public boolean isSecure()

getLastInputSequenceNumber

public long getLastInputSequenceNumber()

getInputSequenceNumber

public long getInputSequenceNumber()

getOutputSequenceNumber

public long getOutputSequenceNumber()

getCipherInformation

public org.apache.sshd.common.cipher.CipherInformation getCipherInformation(boolean incoming)

getMacInformation

public org.apache.sshd.common.mac.MacInformation getMacInformation(boolean incoming)

enableInputCompression

public void enableInputCompression()

enableOutputCompression

public void enableOutputCompression()

getCompressionInformation

public org.apache.sshd.common.compression.CompressionInformation getCompressionInformation(boolean incoming)