org.eclipse.californium.scandium.dtls.cipher

Enum XECDHECryptography.SupportedGroup

java.lang.Object

java.lang.Enum<XECDHECryptography.SupportedGroup>

org.eclipse.californium.scandium.dtls.cipher.XECDHECryptography.SupportedGroup

All Implemented Interfaces:

Serializable, Comparable<XECDHECryptography.SupportedGroup>

Enclosing class:

XECDHECryptography

public static enum XECDHECryptography.SupportedGroup
extends Enum<XECDHECryptography.SupportedGroup>

The Supported Groups as defined in the official IANA Transport Layer Security (TLS) Parameters. Also see RFC 4492, Section 5.1.1 Supported Elliptic Curves Extension.

Enum Constant Summary

Enum Constants

Enum Constant and Description
arbitrary_explicit_char2_curves
arbitrary_explicit_prime_curves
brainpoolP256r1
brainpoolP384r1
brainpoolP512r1
ffdhe2048
ffdhe3072
ffdhe4096
ffdhe6144
ffdhe8192
secp160k1
secp160r1
secp160r2
secp192k1
secp192r1
secp224k1
secp224r1
secp256k1
secp256r1
secp384r1
secp521r1
sect163k1
sect163r1
sect163r2
sect193r1
sect193r2
sect233k1
sect233r1
sect239k1
sect283k1
sect283r1
sect409k1
sect409r1
sect571k1
sect571r1
X25519
X448

Method Summary

Methods

Modifier and Type	Method and Description
static XECDHECryptography.SupportedGroup	fromId(int id) Gets the group for a given id.
static XECDHECryptography.SupportedGroup	fromPublicKey(PublicKey publicKey) Gets the group for a given public key.
String	getAlgorithmName()
int	getId() Gets this group's official id as registered with IANA.
int	getKeySizeInBytes() Returns size of public key in bytes.
static List<XECDHECryptography.SupportedGroup>	getPreferredGroups() Gets the preferred supported groups.
static List<XECDHECryptography.SupportedGroup>	getUsableGroups() Gets all SupportedGroups that can be used on this platform.
static boolean	isEcPublicKey(PublicKey publicKey) Checks, if provided public key is a EC or XEC key.
boolean	isRecommended()
static boolean	isSupported(List<XECDHECryptography.SupportedGroup> list, List<X509Certificate> certificateChain) Check, if all ECDSA certificates uses a supported group (curve) from the provided list.
boolean	isUsable() Checks whether this group can be used on this platform.
static XECDHECryptography.SupportedGroup	valueOf(String name) Returns the enum constant of this type with the specified name.
static XECDHECryptography.SupportedGroup[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

sect163k1

public static final XECDHECryptography.SupportedGroup sect163k1

sect163r1

public static final XECDHECryptography.SupportedGroup sect163r1

sect163r2

public static final XECDHECryptography.SupportedGroup sect163r2

sect193r1

public static final XECDHECryptography.SupportedGroup sect193r1

sect193r2

public static final XECDHECryptography.SupportedGroup sect193r2

sect233k1

public static final XECDHECryptography.SupportedGroup sect233k1

sect233r1

public static final XECDHECryptography.SupportedGroup sect233r1

sect239k1

public static final XECDHECryptography.SupportedGroup sect239k1

sect283k1

public static final XECDHECryptography.SupportedGroup sect283k1

sect283r1

public static final XECDHECryptography.SupportedGroup sect283r1

sect409k1

public static final XECDHECryptography.SupportedGroup sect409k1

sect409r1

public static final XECDHECryptography.SupportedGroup sect409r1

sect571k1

public static final XECDHECryptography.SupportedGroup sect571k1

sect571r1

public static final XECDHECryptography.SupportedGroup sect571r1

secp160k1

public static final XECDHECryptography.SupportedGroup secp160k1

secp160r1

public static final XECDHECryptography.SupportedGroup secp160r1

secp160r2

public static final XECDHECryptography.SupportedGroup secp160r2

secp192k1

public static final XECDHECryptography.SupportedGroup secp192k1

secp192r1

public static final XECDHECryptography.SupportedGroup secp192r1

secp224k1

public static final XECDHECryptography.SupportedGroup secp224k1

secp224r1

public static final XECDHECryptography.SupportedGroup secp224r1

secp256k1

public static final XECDHECryptography.SupportedGroup secp256k1

secp256r1

public static final XECDHECryptography.SupportedGroup secp256r1

secp384r1

public static final XECDHECryptography.SupportedGroup secp384r1

secp521r1

public static final XECDHECryptography.SupportedGroup secp521r1

brainpoolP256r1

public static final XECDHECryptography.SupportedGroup brainpoolP256r1

brainpoolP384r1

public static final XECDHECryptography.SupportedGroup brainpoolP384r1

brainpoolP512r1

public static final XECDHECryptography.SupportedGroup brainpoolP512r1

ffdhe2048

public static final XECDHECryptography.SupportedGroup ffdhe2048

ffdhe3072

public static final XECDHECryptography.SupportedGroup ffdhe3072

ffdhe4096

public static final XECDHECryptography.SupportedGroup ffdhe4096

ffdhe6144

public static final XECDHECryptography.SupportedGroup ffdhe6144

ffdhe8192

public static final XECDHECryptography.SupportedGroup ffdhe8192

arbitrary_explicit_prime_curves

public static final XECDHECryptography.SupportedGroup arbitrary_explicit_prime_curves

arbitrary_explicit_char2_curves

public static final XECDHECryptography.SupportedGroup arbitrary_explicit_char2_curves

X25519

public static final XECDHECryptography.SupportedGroup X25519

X448

public static final XECDHECryptography.SupportedGroup X448

Method Detail

values

public static XECDHECryptography.SupportedGroup[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XECDHECryptography.SupportedGroup c : XECDHECryptography.SupportedGroup.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XECDHECryptography.SupportedGroup valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getId

public int getId()

Gets this group's official id as registered with IANA.

Returns:

the id

getAlgorithmName

public String getAlgorithmName()

fromId

public static XECDHECryptography.SupportedGroup fromId(int id)

Gets the group for a given id.

Parameters:

id - the id

Returns:

the group or null if no group with the given id is (currently) registered

fromPublicKey

public static XECDHECryptography.SupportedGroup fromPublicKey(PublicKey publicKey)

Gets the group for a given public key.

Parameters:

publicKey - the public key

Returns:

the group or null, if no group with the given id is (currently) registered

isEcPublicKey

public static boolean isEcPublicKey(PublicKey publicKey)

Checks, if provided public key is a EC or XEC key.

Parameters:

publicKey - the public key

Returns:

true, if it's a EC of XEC key, false, otherwise.

isSupported

public static boolean isSupported(List<XECDHECryptography.SupportedGroup> list,
                  List<X509Certificate> certificateChain)

Check, if all ECDSA certificates uses a supported group (curve) from the provided list.

Parameters:

list - list of supported groups

certificateChain - certificate chain

Returns:

true, if all ECDSA certificates uses supported group (curve) from the provided list, false, otherwise.

getKeySizeInBytes

public int getKeySizeInBytes()

Returns size of public key in bytes.

Returns:

key size in bytes

isUsable

public boolean isUsable()

Checks whether this group can be used on this platform.

Returns:

true if the group's domain params are known and the JRE's crypto provider supports it

isRecommended

public boolean isRecommended()

getUsableGroups

public static List<XECDHECryptography.SupportedGroup> getUsableGroups()

Gets all SupportedGroups that can be used on this platform.

Returns:

the supported groups as unmodifiable list.

See Also:

isUsable()

getPreferredGroups

public static List<XECDHECryptography.SupportedGroup> getPreferredGroups()

Gets the preferred supported groups.

Returns:

the groups in order of preference as unmodifiable list.