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

Class KexExtensions

java.lang.Object

org.apache.sshd.common.kex.extension.KexExtensions

public final class KexExtensions
extends Object

Provides some helpers for RFC 8308

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLIENT_KEX_EXTENSION
static Predicate<String>	IS_KEX_EXTENSION_SIGNAL
static String	SERVER_KEX_EXTENSION
static byte	SSH_MSG_EXT_INFO
static byte	SSH_MSG_NEWCOMPRESS

Method Summary

Modifier and Type	Method	Description
static KexExtensionParser<?>	getRegisteredExtensionParser(String name)
static NavigableSet<String>	getRegisteredExtensionParserNames()
static List<Map.Entry<String,?>>	parseExtensions(Buffer buffer)	Attempts to parse an SSH_MSG_EXT_INFO message
static void	putExtensions(Collection<? extends Map.Entry<String,?>> exts, Buffer buffer)	Creates an SSH_MSG_EXT_INFO message using the provided extensions.
static KexExtensionParser<?>	registerExtensionParser(KexExtensionParser<?> parser)	Registers a KexExtensionParser for a named extension
static KexExtensionParser<?>	unregisterExtensionParser(String name)	Registers KexExtensionParser for a named extension

Methods inherited from class java.lang.Object

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

Field Detail

SSH_MSG_EXT_INFO

public static final byte SSH_MSG_EXT_INFO

See Also:

Constant Field Values

SSH_MSG_NEWCOMPRESS

public static final byte SSH_MSG_NEWCOMPRESS

See Also:

Constant Field Values

CLIENT_KEX_EXTENSION

public static final String CLIENT_KEX_EXTENSION

See Also:

Constant Field Values

SERVER_KEX_EXTENSION

public static final String SERVER_KEX_EXTENSION

See Also:

Constant Field Values

IS_KEX_EXTENSION_SIGNAL

public static final Predicate<String> IS_KEX_EXTENSION_SIGNAL

Method Detail

getRegisteredExtensionParserNames

public static NavigableSet<String> getRegisteredExtensionParserNames()

Returns:

A case insensitive copy of the currently registered KexExtensionParsers names

getRegisteredExtensionParser

public static KexExtensionParser<?> getRegisteredExtensionParser(String name)

Parameters:

name - The (never null/empty) extension name

Returns:

The registered KexExtensionParser for the (case insensitive) extension name - null if no match found

registerExtensionParser

public static KexExtensionParser<?> registerExtensionParser(KexExtensionParser<?> parser)

Registers a KexExtensionParser for a named extension

Parameters:

parser - The (never null) parser to register

Returns:

The replaced parser for the named extension (case insensitive) - null if no previous parser registered for this extension

unregisterExtensionParser

public static KexExtensionParser<?> unregisterExtensionParser(String name)

Registers KexExtensionParser for a named extension

Parameters:

name - The (never null/empty) extension name

Returns:

The removed KexExtensionParser for the (case insensitive) extension name - null if no match found

parseExtensions

public static List<Map.Entry<String,?>> parseExtensions(Buffer buffer)
                                                       throws IOException

Attempts to parse an SSH_MSG_EXT_INFO message

Parameters:

buffer - The Buffer containing the message

Returns:

A List of key/value "pairs" where key=the extension name, value=the parsed value using the matching registered KexExtensionParser. 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:

RFC-8308 - section 2.3

putExtensions

public static void putExtensions(Collection<? extends Map.Entry<String,?>> exts,
                                 Buffer buffer)
                          throws IOException

Creates an SSH_MSG_EXT_INFO message using the provided extensions.

Parameters:

exts - A Collection of key/value "pairs" where key=the extension name, value=the extension value. Note: if a registered KexExtensionParser exists 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 another Readable (e.g., another Buffer) or a ByteBuffer.

buffer - The target Buffer - assumed to already contain the SSH_MSG_EXT_INFO opcode

Throws:

IOException - If failed to encode