Top Inners Fields Constructors Methods
org.apache.sshd.common.kex

public sealed Enum BuiltinDHFactories

extends Enum<BuiltinDHFactories>
implements DHFactory
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.kex.DHFactory, org.apache.sshd.common.OptionalFeature, org.apache.sshd.common.NamedResource
Imports
java.math.BigInteger, java.util.ArrayList, .Arrays, .Collection, .Collections, .EnumSet, .List, .Map, .NavigableSet, .Objects, .Set, .TreeMap, org.apache.sshd.common.NamedResource, org.apache.sshd.common.cipher.ECCurves, org.apache.sshd.common.config.NamedResourceListParseResult, org.apache.sshd.common.digest.BuiltinDigests, .Digest, org.apache.sshd.common.util.GenericUtils, .ValidateUtils, org.apache.sshd.common.util.security.SecurityUtils

Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class

Field Summary

Modifier and TypeField and Description
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
dhg1

Deprecated
public static final BuiltinDHFactories
dhg14

Deprecated
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
dhgex

Deprecated
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
private static final Map<String, DHFactory>
private final String
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final BuiltinDHFactories
public static final Set<BuiltinDHFactories>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static BuiltinDHFactories

Returns:

The matching BuiltinDHFactories (case insensitive) or null if no match found
fromFactoryName
(String
The factory name - ignored if null/empty
name
)

public final String
public static NavigableSet<DHFactory>

Returns:

A NavigableSet of the currently registered extensions, sorted according to the factory name (case insensitive)
getRegisteredExtensions
()

public boolean
public boolean
public static BuiltinDHFactories.ParseResult

Returns:

A ParseResult of all the DHFactory-ies whose name appears in the string and represent a built-in value. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ones

Note

it is up to caller to ensure that the list does not contain duplicates

parseDHFactoriesList
(String
A comma-separated list of ciphers' names - ignored if null/empty
dhList
)

public static BuiltinDHFactories.ParseResult
public static BuiltinDHFactories.ParseResult
public static void
registerExtension(DHFactory
The factory to register
extension
)

Registered a org.apache.sshd.common.NamedFactory to be available besides the built-in ones when parsing configuration

public static DHFactory

Returns:

The factory or null if it is neither a built-in one or a registered extension
resolveFactory
(String
The factory name
name
)

public final String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static DHFactory

Returns:

The registered extension - null if not found
unregisterExtension
(String
The factory name - ignored if null/empty
name
)

Unregisters specified extension

public static BuiltinDHFactories
public static BuiltinDHFactories[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

curve25519back to summary
public static final BuiltinDHFactories curve25519
See Also
RFC 8731
curve25519_libsshback to summary
public static final BuiltinDHFactories curve25519_libssh
curve448back to summary
public static final BuiltinDHFactories curve448
See Also
RFC 8731
dhg1back to summary
public static final BuiltinDHFactories dhg1

Deprecated

Annotations
@Deprecated
See Also
SSHD-1004
dhg14back to summary
public static final BuiltinDHFactories dhg14

Deprecated

Annotations
@Deprecated
See Also
SSHD-1004
dhg14_256back to summary
public static final BuiltinDHFactories dhg14_256
dhg15_512back to summary
public static final BuiltinDHFactories dhg15_512
dhg16_512back to summary
public static final BuiltinDHFactories dhg16_512
dhg17_512back to summary
public static final BuiltinDHFactories dhg17_512
dhg18_512back to summary
public static final BuiltinDHFactories dhg18_512
dhgexback to summary
public static final BuiltinDHFactories dhgex

Deprecated

Annotations
@Deprecated
See Also
SSHD-1004
dhgex256back to summary
public static final BuiltinDHFactories dhgex256
ecdhp256back to summary
public static final BuiltinDHFactories ecdhp256
ecdhp384back to summary
public static final BuiltinDHFactories ecdhp384
ecdhp521back to summary
public static final BuiltinDHFactories ecdhp521
EXTENSIONSback to summary
private static final Map<String, DHFactory> EXTENSIONS
factoryNameback to summary
private final String factoryName
mlkem1024nistp384back to summary
public static final BuiltinDHFactories mlkem1024nistp384
See Also
PQ/T Hybrid Key Exchange in SSH
mlkem768nistp256back to summary
public static final BuiltinDHFactories mlkem768nistp256
See Also
PQ/T Hybrid Key Exchange in SSH
mlkem768x25519back to summary
public static final BuiltinDHFactories mlkem768x25519
See Also
PQ/T Hybrid Key Exchange in SSH
sntrup761x25519back to summary
public static final BuiltinDHFactories sntrup761x25519
See Also
draft-josefsson-ntruprime-ssh-02.html
sntrup761x25519_opensshback to summary
public static final BuiltinDHFactories sntrup761x25519_openssh
See Also
draft-josefsson-ntruprime-ssh-02.html
VALUESback to summary
public static final Set<BuiltinDHFactories> VALUES

Constructor Detail

BuiltinDHFactoriesback to summary
private BuiltinDHFactories(String name)

Method Detail

fromFactoryNameback to summary
public static BuiltinDHFactories fromFactoryName(String name)
Parameters
name:String

The factory name - ignored if null/empty

Returns:BuiltinDHFactories

The matching BuiltinDHFactories (case insensitive) or null if no match found

getNameback to summary
public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations
@Override
getRegisteredExtensionsback to summary
public static NavigableSet<DHFactory> getRegisteredExtensions()
Returns:NavigableSet<DHFactory>

A NavigableSet of the currently registered extensions, sorted according to the factory name (case insensitive)

isGroupExchangeback to summary
public boolean isGroupExchange()

Implements org.apache.sshd.common.kex.DHFactory.isGroupExchange.

Annotations
@Override
isSupportedback to summary
public boolean isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

Annotations
@Override
parseDHFactoriesListback to summary
public static BuiltinDHFactories.ParseResult parseDHFactoriesList(String dhList)
Parameters
dhList:String

A comma-separated list of ciphers' names - ignored if null/empty

Returns:BuiltinDHFactories.ParseResult

A ParseResult of all the DHFactory-ies whose name appears in the string and represent a built-in value. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ones

Note

it is up to caller to ensure that the list does not contain duplicates

parseDHFactoriesListback to summary
public static BuiltinDHFactories.ParseResult parseDHFactoriesList(String... dhList)
parseDHFactoriesListback to summary
public static BuiltinDHFactories.ParseResult parseDHFactoriesList(Collection<String> dhList)
registerExtensionback to summary
public static void registerExtension(DHFactory extension)

Registered a org.apache.sshd.common.NamedFactory to be available besides the built-in ones when parsing configuration

Parameters
extension:DHFactory

The factory to register

Exceptions
IllegalArgumentException:
if factory instance is null, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).
resolveFactoryback to summary
public static DHFactory resolveFactory(String name)
Parameters
name:String

The factory name

Returns:DHFactory

The factory or null if it is neither a built-in one or a registered extension

toStringback to summary
public final String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
unregisterExtensionback to summary
public static DHFactory unregisterExtension(String name)

Unregisters specified extension

Parameters
name:String

The factory name - ignored if null/empty

Returns:DHFactory

The registered extension - null if not found

valueOfback to summary
public static BuiltinDHFactories valueOf(String name)
valuesback to summary
public static BuiltinDHFactories[] values()
org.apache.sshd.common.kex back to summary

public final Class BuiltinDHFactories.Constants

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CURVE25519_SHA256back to summary
public static final String CURVE25519_SHA256
CURVE25519_SHA256_LIBSSHback to summary
public static final String CURVE25519_SHA256_LIBSSH
CURVE448_SHA512back to summary
public static final String CURVE448_SHA512
DIFFIE_HELLMAN_GROUP14_SHA1back to summary
public static final String DIFFIE_HELLMAN_GROUP14_SHA1
DIFFIE_HELLMAN_GROUP14_SHA256back to summary
public static final String DIFFIE_HELLMAN_GROUP14_SHA256
DIFFIE_HELLMAN_GROUP15_SHA512back to summary
public static final String DIFFIE_HELLMAN_GROUP15_SHA512
DIFFIE_HELLMAN_GROUP16_SHA512back to summary
public static final String DIFFIE_HELLMAN_GROUP16_SHA512
DIFFIE_HELLMAN_GROUP17_SHA512back to summary
public static final String DIFFIE_HELLMAN_GROUP17_SHA512
DIFFIE_HELLMAN_GROUP18_SHA512back to summary
public static final String DIFFIE_HELLMAN_GROUP18_SHA512
DIFFIE_HELLMAN_GROUP1_SHA1back to summary
public static final String DIFFIE_HELLMAN_GROUP1_SHA1
DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1back to summary
public static final String DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1
DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256back to summary
public static final String DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256
ECDH_SHA2_NISTP256back to summary
public static final String ECDH_SHA2_NISTP256
ECDH_SHA2_NISTP384back to summary
public static final String ECDH_SHA2_NISTP384
ECDH_SHA2_NISTP521back to summary
public static final String ECDH_SHA2_NISTP521
MLKEM1024_NISTP384_SHA384back to summary
public static final String MLKEM1024_NISTP384_SHA384
MLKEM768_25519_SHA256back to summary
public static final String MLKEM768_25519_SHA256
MLKEM768_NISTP256_SHA256back to summary
public static final String MLKEM768_NISTP256_SHA256
SNTRUP761_25519_SHA512back to summary
public static final String SNTRUP761_25519_SHA512
SNTRUP761_25519_SHA512_OPENSSHback to summary
public static final String SNTRUP761_25519_SHA512_OPENSSH

Constructor Detail

Constantsback to summary
private Constants()
org.apache.sshd.common.kex back to summary

public final Class BuiltinDHFactories.ParseResult

extends NamedResourceListParseResult<DHFactory>
Class Inheritance

Represents the result of BuiltinDHFactories#parseDHFactoriesList(String)
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final BuiltinDHFactories.ParseResult

Constructor Summary

AccessConstructor and Description
public
ParseResult(List<DHFactory> parsed, List<String> unsupported)

Method Summary

Modifier and TypeMethod and Description
public List<DHFactory>
public List<String>
Inherited from org.apache.sshd.common.config.NamedResourceListParseResult:
getParsedResourcesgetUnsupportedResourcestoString

Field Detail

EMPTYback to summary
public static final BuiltinDHFactories.ParseResult EMPTY

Constructor Detail

ParseResultback to summary
public ParseResult(List<DHFactory> parsed, List<String> unsupported)

Method Detail

getParsedFactoriesback to summary
public List<DHFactory> getParsedFactories()
getUnsupportedFactoriesback to summary
public List<String> getUnsupportedFactories()