Package org.apache.sshd.common.kex.extension

Class DefaultClientKexExtensionHandler

java.lang.Object

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

org.apache.sshd.common.kex.extension.DefaultClientKexExtensionHandler

All Implemented Interfaces:

KexExtensionHandler

public class DefaultClientKexExtensionHandler
extends AbstractLoggingBean
implements KexExtensionHandler

Detects if the server sends a "server-sig-algs" and updates the client session by adding the "rsa-sha2-256/512" signature factories (if not already added).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandler

KexExtensionHandler.AvailabilityPhase, KexExtensionHandler.KexPhase

Field Summary

Fields

Modifier and Type	Field	Description
static AttributeRepository.AttributeKey<java.lang.Boolean>	CLIENT_PROPOSAL_MADE	Session AttributeRepository.AttributeKey used to store whether the extension indicator was already sent.
static DefaultClientKexExtensionHandler	INSTANCE	Default singleton instance.
static AttributeRepository.AttributeKey<java.util.Set<java.lang.String>>	SERVER_ALGORITHMS	Session AttributeRepository.AttributeKey storing the algorithms announced by the server as known.

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

log

Constructor Summary

Constructors

Constructor	Description
DefaultClientKexExtensionHandler()

Method Summary

Modifier and Type	Method	Description
boolean	handleKexExtensionRequest(Session session, int index, int count, java.lang.String name, byte[] data)	Invoked by KexExtensionHandler.handleKexExtensionsMessage(Session, Buffer) in order to handle a specific extension.
void	handleKexInitProposal(Session session, boolean initiator, java.util.Map<KexProposalOption,java.lang.String> proposal)	Invoked when a peer is ready to send the KEX options proposal or has received such a proposal.
protected void	handleServerSignatureAlgorithms(Session session, java.util.Collection<java.lang.String> serverAlgorithms)	Perform updates after a server-sig-algs extension has been received.
boolean	isKexExtensionsAvailable(Session session, KexExtensionHandler.AvailabilityPhase phase)

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

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandler

handleKexCompressionMessage, handleKexExtensionNegotiation, handleKexExtensionsMessage, sendKexExtensions

Field Detail

INSTANCE

public static final DefaultClientKexExtensionHandler INSTANCE

Default singleton instance.

CLIENT_PROPOSAL_MADE

public static final AttributeRepository.AttributeKey<java.lang.Boolean> CLIENT_PROPOSAL_MADE

Session AttributeRepository.AttributeKey used to store whether the extension indicator was already sent.

SERVER_ALGORITHMS

public static final AttributeRepository.AttributeKey<java.util.Set<java.lang.String>> SERVER_ALGORITHMS

Session AttributeRepository.AttributeKey storing the algorithms announced by the server as known.

Constructor Detail

DefaultClientKexExtensionHandler

public DefaultClientKexExtensionHandler()

Method Detail

isKexExtensionsAvailable

public boolean isKexExtensionsAvailable(Session session,
                                        KexExtensionHandler.AvailabilityPhase phase)
                                 throws java.io.IOException

Specified by:

isKexExtensionsAvailable in interface KexExtensionHandler

Parameters:

session - The Session about to execute KEX

phase - The KexExtensionHandler.AvailabilityPhase hint as to why the query is being made

Returns:

true whether to KEX extensions are supported/allowed for the session

Throws:

java.io.IOException - If failed to process the request

handleKexInitProposal

public void handleKexInitProposal(Session session,
                                  boolean initiator,
                                  java.util.Map<KexProposalOption,java.lang.String> proposal)
                           throws java.io.IOException

Description copied from interface: KexExtensionHandler

Invoked when a peer is ready to send the KEX options proposal or has received such a proposal. Note: this method is called during the negotiation phase even if isKexExtensionsAvailable returns false for the session.

Specified by:

handleKexInitProposal in interface KexExtensionHandler

Parameters:

session - The Session initiating or receiving the proposal

initiator - true if the proposal is about to be sent, false if this is a proposal received from the peer.

proposal - The proposal contents - Caveat emptor: the proposal is modifiable i.e., the handler can modify it before being sent or before being processed (if incoming)

Throws:

java.io.IOException

handleKexExtensionRequest

public boolean handleKexExtensionRequest(Session session,
                                         int index,
                                         int count,
                                         java.lang.String name,
                                         byte[] data)
                                  throws java.io.IOException

Description copied from interface: KexExtensionHandler

Invoked by KexExtensionHandler.handleKexExtensionsMessage(Session, Buffer) in order to handle a specific extension.

Specified by:

handleKexExtensionRequest in interface KexExtensionHandler

Parameters:

session - The Session through which the message was received

index - The 0-based extension index

count - The total extensions in the message

name - The extension name

data - The extension data

Returns:

true whether to proceed to the next extension or stop processing the rest

Throws:

java.io.IOException

handleServerSignatureAlgorithms

protected void handleServerSignatureAlgorithms(Session session,
                                               java.util.Collection<java.lang.String> serverAlgorithms)

Perform updates after a server-sig-algs extension has been received. The set of algorithms announced by the server is set as attribute SERVER_ALGORITHMS of the session.

Parameters:

session - the message was received for

serverAlgorithms - signature algorithm names announced by the server