Class KexExtensions
java.lang.Object
org.apache.sshd.common.kex.extension.KexExtensions
Provides some helpers for RFC 8308
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprivate static final NavigableMap<String, KexExtensionParser<?>> A case insensitive map of all the default knownKexExtensionParserwhere key=the extension namestatic final Stringstatic final bytestatic final bytestatic final StringReminder: These pseudo-algorithms are only valid in the initial SSH2_MSG_KEXINIT and MUST be ignored if they are present in subsequent SSH2_MSG_KEXINIT packets.static final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic KexExtensionParser<?> static NavigableSet<String> parseExtensions(Buffer buffer) Attempts to parse anSSH_MSG_EXT_INFOmessagestatic voidputExtensions(Collection<? extends Map.Entry<String, ?>> exts, Buffer buffer) Creates anSSH_MSG_EXT_INFOmessage using the provided extensions.static KexExtensionParser<?> registerExtensionParser(KexExtensionParser<?> parser) Registers aKexExtensionParserfor a named extensionstatic KexExtensionParser<?> RegistersKexExtensionParserfor a named extension
-
Field Details
-
SSH_MSG_EXT_INFO
public static final byte SSH_MSG_EXT_INFO- See Also:
-
SSH_MSG_NEWCOMPRESS
public static final byte SSH_MSG_NEWCOMPRESS- See Also:
-
CLIENT_KEX_EXTENSION
- See Also:
-
SERVER_KEX_EXTENSION
- See Also:
-
IS_KEX_EXTENSION_SIGNAL
-
STRICT_KEX_CLIENT_EXTENSION
Reminder: These pseudo-algorithms are only valid in the initial SSH2_MSG_KEXINIT and MUST be ignored if they are present in subsequent SSH2_MSG_KEXINIT packets. Note: these values are appended to the initial proposals and removed if received before proceeding with the standard KEX proposals negotiation.- See Also:
-
STRICT_KEX_SERVER_EXTENSION
- See Also:
-
EXTENSION_PARSERS
A case insensitive map of all the default knownKexExtensionParserwhere key=the extension name
-
-
Constructor Details
-
KexExtensions
private KexExtensions()
-
-
Method Details
-
getRegisteredExtensionParserNames
- Returns:
- A case insensitive copy of the currently registered
KexExtensionParsers names
-
getRegisteredExtensionParser
- Parameters:
name- The (nevernull/empty) extension name- Returns:
- The registered
KexExtensionParserfor the (case insensitive) extension name -nullif no match found
-
registerExtensionParser
Registers aKexExtensionParserfor a named extension- Parameters:
parser- The (nevernull) parser to register- Returns:
- The replaced parser for the named extension (case insensitive) -
nullif no previous parser registered for this extension
-
unregisterExtensionParser
RegistersKexExtensionParserfor a named extension- Parameters:
name- The (nevernull/empty) extension name- Returns:
- The removed
KexExtensionParserfor the (case insensitive) extension name -nullif no match found
-
parseExtensions
Attempts to parse anSSH_MSG_EXT_INFOmessage- Parameters:
buffer- TheBuffercontaining the message- Returns:
- A
Listof key/value "pairs" where key=the extension name, value=the parsed value using the matching registeredKexExtensionParser. If no such parser found then the raw value bytes are set as the extension value. - Throws:
IOException- If failed to parse one of the extensions- See Also:
-
putExtensions
public static void putExtensions(Collection<? extends Map.Entry<String, ?>> exts, Buffer buffer) throws IOExceptionCreates anSSH_MSG_EXT_INFOmessage using the provided extensions.- Parameters:
exts- ACollectionof key/value "pairs" where key=the extension name, value=the extension value. Note: if a registeredKexExtensionParserexists for the name, then it is assumed that the value is of the correct type. If no registered parser found the value is assumed to be either the encoded value as an array of bytes or as anotherReadable(e.g., anotherBuffer) or aByteBuffer.buffer- The targetBuffer- assumed to already contain theSSH_MSG_EXT_INFOopcode- Throws:
IOException- If failed to encode
-