org.apache.sshd.common.cipher

Enum ECCurves

java.lang.Object

java.lang.Enum<ECCurves>

org.apache.sshd.common.cipher.ECCurves

All Implemented Interfaces:

Serializable, Comparable<ECCurves>, NamedResource, OptionalFeature

public enum ECCurves
extends Enum<ECCurves>
implements NamedResource, OptionalFeature

Utilities for working with elliptic curves.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ECCurves.Constants

Nested classes/interfaces inherited from interface org.apache.sshd.common.NamedResource

NamedResource.Utils

Enum Constant Summary

Enum Constants

Enum Constant and Description
nistp256
nistp384
nistp521

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	KEY_TYPES A Set of all the known curves key types
static Set<String>	NAMES A Set of all the known curves names
static Set<ECCurves>	VALUES A Set of all the known curves

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

Modifier and Type	Method and Description
static byte[]	encodeECPoint(ECPoint group, ECParameterSpec params)
static byte[]	encodeECPoint(ECPoint group, EllipticCurve curve)
static ECCurves	fromCurveName(String name)
static ECCurves	fromCurveParameters(ECParameterSpec params)
static ECCurves	fromCurveSize(int keySize)
static ECCurves	fromKeyType(String type)
static int	getCurveSize(ECParameterSpec params)
abstract Digest	getDigestForParams()
int	getKeySize()
String	getKeyType()
String	getName()
int	getNumPointOctets()
ECParameterSpec	getParameters()
boolean	isSupported()
static ECCurves	valueOf(String name) Returns the enum constant of this type with the specified name.
static ECCurves[]	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

nistp256

public static final ECCurves nistp256

nistp384

public static final ECCurves nistp384

nistp521

public static final ECCurves nistp521

Field Detail

VALUES

public static final Set<ECCurves> VALUES

A Set of all the known curves

NAMES

public static final Set<String> NAMES

A Set of all the known curves names

KEY_TYPES

public static final Set<String> KEY_TYPES

A Set of all the known curves key types

Method Detail

values

public static ECCurves[] 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 (ECCurves c : ECCurves.values())
    System.out.println(c);

Returns:

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

valueOf

public static ECCurves 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

getName

public final String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getKeyType

public final String getKeyType()

Returns:

The standard key type used to represent this curve

isSupported

public final boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

getParameters

public final ECParameterSpec getParameters()

getKeySize

public final int getKeySize()

Returns:

The size (in bits) of the key

getNumPointOctets

public final int getNumPointOctets()

Returns:

The number of octets used to represent the point(s) for the curve

getDigestForParams

public abstract Digest getDigestForParams()

Returns:

The Digest to use when hashing the curve's parameters

fromKeyType

public static ECCurves fromKeyType(String type)

Parameters:

type - The key type value - ignored if null/empty

Returns:

The matching ECCurves constant - null if no match found case insensitive

fromCurveName

public static ECCurves fromCurveName(String name)

Parameters:

name - The curve name (case insensitive - ignored if null/empty

Returns:

The matching ECCurves instance - null if no match found

fromCurveParameters

public static ECCurves fromCurveParameters(ECParameterSpec params)

Parameters:

params - The curve's ECParameterSpec - ignored if null

Returns:

The matching ECCurves value - null if no match found

See Also:

getCurveSize(ECParameterSpec), fromCurveSize(int)

fromCurveSize

public static ECCurves fromCurveSize(int keySize)

Parameters:

keySize - The key size (in bits)

Returns:

The matching ECCurves value - null if no match found

getCurveSize

public static int getCurveSize(ECParameterSpec params)

Parameters:

params - The curve's ECParameterSpec

Returns:

The curve's key size in bits

Throws:

IllegalArgumentException - if invalid parameters provided

encodeECPoint

public static byte[] encodeECPoint(ECPoint group,
                                   ECParameterSpec params)

encodeECPoint

public static byte[] encodeECPoint(ECPoint group,
                                   EllipticCurve curve)