Package org.apache.sshd.common.cipher
Enum ECCurves
- All Implemented Interfaces:
Serializable,Comparable<ECCurves>,KeySizeIndicator,KeyTypeIndicator,NamedResource,OptionalFeature
public enum ECCurves
extends Enum<ECCurves>
implements KeyTypeIndicator, KeySizeIndicator, NamedResource, OptionalFeature
Utilities for working with elliptic curves.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classstatic enumThe variousECPointrepresentation compression indicators -
Enum Constant Summary
Enum Constants -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Comparator<ECCurves> private final DigestFactorystatic final NavigableSet<String> ASetof all the known curves key typesprivate final intprivate final Stringprivate final Stringstatic final NavigableSet<String> ASetof all the known curves namesprivate final intprivate final Stringprivate final ECParameterSpecASetof all the known curvesFields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTORFields inherited from interface org.apache.sshd.common.OptionalFeature
FALSE, TRUE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateECCurves(String name, int[] oid, ECParameterSpec params, int numOctets, DigestFactory digestFactory) -
Method Summary
Modifier and TypeMethodDescriptionstatic byte[]encodeECPoint(ECPoint group, ECParameterSpec params) static byte[]encodeECPoint(ECPoint group, EllipticCurve curve) private static intfindFirstNonZeroIndex(byte... octets) static ECCurvesfromCurveName(String name) static ECCurvesfromCurveParameters(ECParameterSpec params) static ECCurvesfromCurveSize(int keySize) static ECCurvesstatic ECCurvesfromKeyType(String type) static ECCurvesstatic ECCurvesfromOIDValue(List<? extends Number> oid) static intgetCurveSize(ECParameterSpec params) final Digestfinal intfinal Stringfinal StringgetName()final intfinal StringgetOID()final ECParameterSpecfinal booleanstatic ECPointoctetStringToEcPoint(byte... octets) static BigIntegeroctetStringToInteger(byte... octets) Converts the given octet string (defined by ASN.1 specifications) to aBigIntegerAs octet strings always represent positive integers, a zero-byte is prepended to the given array if necessary (if is MSB equal to 1), then this is converted to BigInteger The conversion is defined in the Section 2.3.8private static byte[]removeLeadingZeroes(byte[] input) static ECCurvesReturns 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.
-
Enum Constant Details
-
nistp256
-
nistp384
-
nistp521
-
-
Field Details
-
Constructor Details
-
ECCurves
private ECCurves(String name, int[] oid, ECParameterSpec params, int numOctets, DigestFactory digestFactory)
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException- if the argument is null
-
getName
- Specified by:
getNamein interfaceNamedResource- Returns:
- The resource name
-
getOID
-
getOIDValue
-
getKeyType
- Specified by:
getKeyTypein interfaceKeyTypeIndicator- Returns:
- The SSH key type name - e.g., "ssh-rsa", "sshd-dss" etc.
-
isSupported
public final boolean isSupported()- Specified by:
isSupportedin interfaceOptionalFeature
-
getParameters
-
getKeySize
public final int getKeySize()- Specified by:
getKeySizein interfaceKeySizeIndicator- Returns:
- The number of bits used in the key
-
getNumPointOctets
public final int getNumPointOctets()- Returns:
- The number of octets used to represent the point(s) for the curve
-
getDigestForParams
- Returns:
- The
Digestto use when hashing the curve's parameters
-
fromKeyType
- Parameters:
type- The key type value - ignored ifnull/empty- Returns:
- The matching
ECCurvesconstant -nullif no match found case insensitive
-
fromCurveName
- Parameters:
name- The curve name (case insensitive - ignored ifnull/empty- Returns:
- The matching
ECCurvesinstance -nullif no match found
-
fromECKey
-
fromCurveParameters
- Parameters:
params- The curve'sECParameterSpec- ignored ifnull- Returns:
- The matching
ECCurvesvalue -nullif no match found - See Also:
-
fromCurveSize
- Parameters:
keySize- The key size (in bits)- Returns:
- The matching
ECCurvesvalue -nullif no match found
-
fromOIDValue
-
fromOID
-
getCurveSize
- Parameters:
params- The curve'sECParameterSpec- Returns:
- The curve's key size in bits
- Throws:
IllegalArgumentException- if invalid parameters provided
-
encodeECPoint
-
encodeECPoint
-
removeLeadingZeroes
private static byte[] removeLeadingZeroes(byte[] input) -
octetStringToInteger
Converts the given octet string (defined by ASN.1 specifications) to aBigIntegerAs octet strings always represent positive integers, a zero-byte is prepended to the given array if necessary (if is MSB equal to 1), then this is converted to BigInteger The conversion is defined in the Section 2.3.8- Parameters:
octets- - octet string bytes to be converted- Returns:
- The
BigIntegerrepresentation of the octet string
-
octetStringToEcPoint
-
findFirstNonZeroIndex
private static int findFirstNonZeroIndex(byte... octets)
-