Class CryptFilter

java.lang.Object

org.apache.sshd.common.filter.IoFilter

org.apache.sshd.common.session.filters.CryptFilter

All Implemented Interfaces:

Filter, Owned<FilterContext>, CryptStatisticsProvider

public class CryptFilter
extends IoFilter
implements CryptStatisticsProvider

A filter that decrypts incoming packets and encrypts outgoing ones.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CryptFilter.Counters
static interface	CryptFilter.EncryptionListener
static class	CryptFilter.Settings

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_PADDING	The maximum padding length we use.
static final int	MAX_TAG_LENGTH	An arbitrary constant >= the largest authentication tag size we will ever have.

Constructor Summary

Constructors

Constructor	Description
CryptFilter()

Method Summary

Modifier and Type	Method	Description
void	addEncryptionListener(CryptFilter.EncryptionListener listener)
CryptFilter.Counters	getInputCounters()	Retrieves the input counters.
long	getInputSequenceNumber()	Retrieves the current input sequence number.
CryptFilter.Settings	getInputSettings()
long	getLastInputSequenceNumber()	Retrieves the previous input sequence number.
CryptFilter.Counters	getOutputCounters()	Retrieves the output counters.
long	getOutputSequenceNumber()	Retrieves the current output sequence number.
CryptFilter.Settings	getOutputSettings()
InputHandler	in()	Retrieves the filter's InputHandler.
boolean	isSecure()	Tells whether the connection is secure: encrypted and having a message authentication code, either via an explicit MAC or as part of an AEAD cipher.
OutputHandler	out()	Retrieves the filter's OutputHandler.
void	removeEncryptionListener(CryptFilter.EncryptionListener listener)
void	resetInputCounters()
void	resetOutputCounters()
void	setInput(CryptFilter.Settings settings, boolean resetSequence)
void	setOutput(CryptFilter.Settings settings, boolean resetSequence)
void	setRandom(org.apache.sshd.common.random.Random random)
void	setSession(Session session)

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

Field Details

MAX_PADDING

public static final int MAX_PADDING

The maximum padding length we use. RFC 4253: at least 4 bytes padding, at most 255 bytes.

Keep the padding size <= 127, though: JSch has a bug where it reads the pad byte as a signed value when compression is used!

See Also:

• Constant Field Values

MAX_TAG_LENGTH

public static final int MAX_TAG_LENGTH

An arbitrary constant >= the largest authentication tag size we will ever have.

See Also:

• Constant Field Values

Constructor Details

CryptFilter

public CryptFilter()

Method Details

setRandom

public void setRandom(org.apache.sshd.common.random.Random random)

setSession

public void setSession(Session session)

in

public InputHandler in()

Description copied from interface: Filter

Retrieves the filter's InputHandler.

Specified by:

in in interface Filter

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.

Specified by:

out in interface Filter

Returns:

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

resetInputCounters

public void resetInputCounters()

resetOutputCounters

public void resetOutputCounters()

getInputCounters

public CryptFilter.Counters getInputCounters()

Description copied from interface: CryptStatisticsProvider

Retrieves the input counters.

Specified by:

getInputCounters in interface CryptStatisticsProvider

Returns:

the input counters

getOutputCounters

public CryptFilter.Counters getOutputCounters()

Description copied from interface: CryptStatisticsProvider

Retrieves the output counters.

Specified by:

getOutputCounters in interface CryptStatisticsProvider

Returns:

the output counters

setInput

public void setInput(CryptFilter.Settings settings,
 boolean resetSequence)

setOutput

public void setOutput(CryptFilter.Settings settings,
 boolean resetSequence)

getInputSettings

public CryptFilter.Settings getInputSettings()

getOutputSettings

public CryptFilter.Settings getOutputSettings()

getLastInputSequenceNumber

public long getLastInputSequenceNumber()

Description copied from interface: CryptStatisticsProvider

Retrieves the previous input sequence number.

This is the sequence number of the last received packet.

Specified by:

getLastInputSequenceNumber in interface CryptStatisticsProvider

Returns:

the sequence number as an unsigned 32bit value.

getInputSequenceNumber

public long getInputSequenceNumber()

Description copied from interface: CryptStatisticsProvider

Retrieves the current input sequence number.

This is the sequence number expected for the next packet.

Specified by:

getInputSequenceNumber in interface CryptStatisticsProvider

Returns:

the sequence number as an unsigned 32bit value.

getOutputSequenceNumber

public long getOutputSequenceNumber()

Description copied from interface: CryptStatisticsProvider

Retrieves the current output sequence number.

This is the sequence number for the next packet.

Specified by:

getOutputSequenceNumber in interface CryptStatisticsProvider

Returns:

the sequence number as an unsigned 32bit value.

isSecure

public boolean isSecure()

Description copied from interface: CryptStatisticsProvider

Tells whether the connection is secure: encrypted and having a message authentication code, either via an explicit MAC or as part of an AEAD cipher.

Specified by:

isSecure in interface CryptStatisticsProvider

Returns:

whether the connection is secure

addEncryptionListener

public void addEncryptionListener(CryptFilter.EncryptionListener listener)

removeEncryptionListener

public void removeEncryptionListener(CryptFilter.EncryptionListener listener)