Modifier and Type	Class and Description
public static class	ECCurves.Constants
public static enum	ECCurves.ECPointCompression The various `ECPoint` representation compression indicators

Field Summary

Modifier and Type	Field and Description
public static final Comparator<ECCurves>	BY_KEY_SIZE
private final DigestFactory	digestFactory
public static final NavigableSet<String>	KEY_TYPES A `Set` of all the known curves key types
private final int	keySize
private final String	keyType
private final String	name Hides java.lang.Enum.name.
public static final NavigableSet<String>	NAMES A `Set` of all the known curves names
public static final ECCurves	nistp256
public static final ECCurves	nistp384
public static final ECCurves	nistp521
private final int	numOctets
private final String	oidString
private final List<Integer>	oidValue
private final ECParameterSpec	params
public static final List<ECCurves>	SORTED_KEY_SIZE
public static final Set<ECCurves>	VALUES A `Set` of all the known curves

Constructor Summary

Access	Constructor and Description
private	ECCurves(String name, int[] oid, ECParameterSpec params, int numOctets, DigestFactory digestFactory)

Method Summary

Modifier and Type	Method and Description
public static byte[]	encodeECPoint(ECPoint group, ECParameterSpec params)
public static byte[]	encodeECPoint(ECPoint group, EllipticCurve curve)
private static int	findFirstNonZeroIndex(byte... octets)
public static ECCurves	Returns: The matching `ECCurves` instance - `null` if no match found fromCurveName(String The curve name (case insensitive - ignored if `null`/empty name)
public static ECCurves	Returns: The matching `ECCurves` value - `null` if no match found fromCurveParameters(ECParameterSpec The curve's `ECParameterSpec` - ignored if `null` params)
public static ECCurves	Returns: The matching `ECCurves` value - `null` if no match found fromCurveSize(int The key size (in bits) keySize)
public static ECCurves	Returns: The matching `ECCurves` instance - `null` if no match found fromECKey(ECKey The `ECKey` - ignored if `null` key)
public static ECCurves	Returns: The matching `ECCurves` constant - `null` if no match found case insensitive fromKeyType(String The key type value - ignored if `null`/empty type)
public static ECCurves	fromOID(String oid)
public static ECCurves	fromOIDValue(List<? extends Number> oid)
public static int	Returns: The curve's key size in bits getCurveSize(ECParameterSpec The curve's `ECParameterSpec` params)
public final Digest	Returns: The `Digest` to use when hashing the curve's parameters getDigestForParams()
public final int	getKeySize() Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.
public final String	getKeyType() Implements org.apache.sshd.common.keyprovider.KeyTypeIndicator.getKeyType.
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public final int	Returns: The number of octets used to represent the point(s) for the curve getNumPointOctets()
public final String	getOID()
public final List<Integer>	getOIDValue()
public final ECParameterSpec	getParameters()
public final boolean	isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported.
public static ECPoint	octetStringToEcPoint(byte... octets)
public static BigInteger	Returns: The `BigInteger` representation of the octet string octetStringToInteger(byte... - octet string bytes to be converted octets) Converts the given octet string (defined by ASN.1 specifications) to a `BigInteger` As 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
private static byte[]	removeLeadingZeroes(byte[] input)
public static ECCurves	valueOf(String name)
public static ECCurves[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BY_KEY_SIZE	back to summary
public static final Comparator<ECCurves> BY_KEY_SIZE

digestFactory	back to summary
private final DigestFactory digestFactory

KEY_TYPES	back to summary
public static final NavigableSet<String> KEY_TYPES A `Set` of all the known curves key types

keySize	back to summary
private final int keySize

keyType	back to summary
private final String keyType

name	back to summary
private final String name Hides java.lang.Enum.name.

NAMES	back to summary
public static final NavigableSet<String> NAMES A `Set` of all the known curves names

nistp256	back to summary
public static final ECCurves nistp256

nistp384	back to summary
public static final ECCurves nistp384

nistp521	back to summary
public static final ECCurves nistp521

numOctets	back to summary
private final int numOctets

oidString	back to summary
private final String oidString

oidValue	back to summary
private final List<Integer> oidValue

params	back to summary
private final ECParameterSpec params

SORTED_KEY_SIZE	back to summary
public static final List<ECCurves> SORTED_KEY_SIZE

VALUES	back to summary
public static final Set<ECCurves> VALUES A `Set` of all the known curves

Constructor Detail

ECCurves	back to summary
private ECCurves(String name, int[] oid, ECParameterSpec params, int numOctets, DigestFactory digestFactory)

Method Detail

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

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

findFirstNonZeroIndex	back to summary
private static int findFirstNonZeroIndex(byte... octets)

fromCurveName	back to summary
public static ECCurves fromCurveName(String name) Parameters name:String The curve name (case insensitive - ignored if `null`/empty Returns:ECCurves The matching `ECCurves` instance - `null` if no match found

fromCurveParameters	back to summary
public static ECCurves fromCurveParameters(ECParameterSpec params) Parameters params:ECParameterSpec The curve's `ECParameterSpec` - ignored if `null` Returns:ECCurves The matching `ECCurves` value - `null` if no match found See Also `getCurveSize(ECParameterSpec)`, `fromCurveSize(int)`

fromCurveSize	back to summary
public static ECCurves fromCurveSize(int keySize) Parameters keySize:int The key size (in bits) Returns:ECCurves The matching `ECCurves` value - `null` if no match found

fromECKey	back to summary
public static ECCurves fromECKey(ECKey key) Parameters key:ECKey The `ECKey` - ignored if `null` Returns:ECCurves The matching `ECCurves` instance - `null` if no match found

fromKeyType	back to summary
public static ECCurves fromKeyType(String type) Parameters type:String The key type value - ignored if `null`/empty Returns:ECCurves The matching `ECCurves` constant - `null` if no match found case insensitive

fromOID	back to summary
public static ECCurves fromOID(String oid)

fromOIDValue	back to summary
public static ECCurves fromOIDValue(List<? extends Number> oid)

getCurveSize	back to summary
public static int getCurveSize(ECParameterSpec params) Parameters params:ECParameterSpec The curve's `ECParameterSpec` Returns:int The curve's key size in bits Exceptions IllegalArgumentException: if invalid parameters provided

getDigestForParams	back to summary
public final Digest getDigestForParams() Returns:Digest The `Digest` to use when hashing the curve's parameters

getKeySize	back to summary
public final int getKeySize() Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize. Returns:int Doc from org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize. The number of bits used in the key Annotations @Override

getKeySize

back to summary

public final int getKeySize()

Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.

Returns:int

Doc from org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.

The number of bits used in the key

Annotations

@Override

getKeyType	back to summary
public final String getKeyType() Implements org.apache.sshd.common.keyprovider.KeyTypeIndicator.getKeyType. Returns:String Doc from org.apache.sshd.common.keyprovider.KeyTypeIndicator.getKeyType. The SSH key type name - e.g., "ssh-rsa", "sshd-dss" etc. Annotations @Override

getKeyType

back to summary

public final String getKeyType()

Implements org.apache.sshd.common.keyprovider.KeyTypeIndicator.getKeyType.

Returns:String

Doc from org.apache.sshd.common.keyprovider.KeyTypeIndicator.getKeyType.

The SSH key type name - e.g., "ssh-rsa", "sshd-dss" etc.

Annotations

@Override

getName	back 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

getName

back 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

getNumPointOctets	back to summary
public final int getNumPointOctets() Returns:int The number of octets used to represent the point(s) for the curve

getOID	back to summary
public final String getOID()

getOIDValue	back to summary
public final List<Integer> getOIDValue()

getParameters	back to summary
public final ECParameterSpec getParameters()

isSupported	back to summary
public final boolean isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported. Annotations @Override

isSupported

back to summary

public final boolean isSupported()

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

Annotations

@Override

octetStringToEcPoint	back to summary
public static ECPoint octetStringToEcPoint(byte... octets)

octetStringToInteger back to summary

octetStringToInteger	back to summary
public static BigInteger octetStringToInteger(byte... octets) Converts the given octet string (defined by ASN.1 specifications) to a `BigInteger` As 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:byte[] - octet string bytes to be converted Returns:BigInteger The `BigInteger` representation of the octet string

public static BigInteger octetStringToInteger(byte... octets)

Converts the given octet string (defined by ASN.1 specifications) to a BigInteger As 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:byte[]: - octet string bytes to be converted

Returns:BigInteger

The BigInteger representation of the octet string

removeLeadingZeroes	back to summary
private static byte[] removeLeadingZeroes(byte[] input)

valueOf	back to summary
public static ECCurves valueOf(String name)

values	back to summary
public static ECCurves[] values()

org.apache.sshd.common.cipher back to summary

public final Class ECCurves.Constants

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.common.cipher.ECCurves.Constants

Field Summary

Modifier and Type	Field and Description
public static final String	ECDSA_SHA2_PREFIX Standard prefix of NISTP key types when encoded
public static final String	NISTP256
public static final String	NISTP384
public static final String	NISTP521

Constructor Summary

Access	Constructor and Description
private	Constants()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ECDSA_SHA2_PREFIX	back to summary
public static final String ECDSA_SHA2_PREFIX Standard prefix of NISTP key types when encoded

NISTP256	back to summary
public static final String NISTP256

NISTP384	back to summary
public static final String NISTP384

NISTP521	back to summary
public static final String NISTP521

Constructor Detail

Constants	back to summary
private Constants()

org.apache.sshd.common.cipher back to summary

public sealed Enum ECCurves.ECPointCompression

Class Inheritance

extends Enum<ECCurves.ECPointCompression>

java.lang.Object
java.lang.Enum
org.apache.sshd.common.cipher.ECCurves.ECPointCompression

The various ECPoint representation compression indicators

Author: Apache MINA SSHD Project
See Also: RFC-5480 - section 2.2

Field Summary

Modifier and Type	Field and Description
private final byte	indicatorValue
public static final ECCurves.ECPointCompression	UNCOMPRESSED
public static final Set<ECCurves.ECPointCompression>	VALUES
public static final ECCurves.ECPointCompression	VARIANT2
public static final ECCurves.ECPointCompression	VARIANT3

Constructor Summary

Access	Constructor and Description
private	ECPointCompression(byte indicator)

Method Summary

Modifier and Type	Method and Description
public byte[]	ecPointToOctetString(String curveName, ECPoint p)
public static ECCurves.ECPointCompression	fromIndicatorValue(int value)
public final byte	getIndicatorValue()
public abstract ECPoint	octetStringToEcPoint(byte[] octets, int startIndex, int len)
public static ECCurves.ECPointCompression	valueOf(String name)
public static ECCurves.ECPointCompression[]	values()
protected void	writeCoordinate(OutputStream s, String n, BigInteger v, int numElements)
public void	writeECPoint(OutputStream s, String curveName, ECPoint p)

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

indicatorValue	back to summary
private final byte indicatorValue

UNCOMPRESSED	back to summary
public static final ECCurves.ECPointCompression UNCOMPRESSED

VALUES	back to summary
public static final Set<ECCurves.ECPointCompression> VALUES

VARIANT2	back to summary
public static final ECCurves.ECPointCompression VARIANT2

VARIANT3	back to summary
public static final ECCurves.ECPointCompression VARIANT3

Constructor Detail

ECPointCompression	back to summary
private ECPointCompression(byte indicator)

Method Detail

ecPointToOctetString	back to summary
public byte[] ecPointToOctetString(String curveName, ECPoint p)

fromIndicatorValue	back to summary
public static ECCurves.ECPointCompression fromIndicatorValue(int value)

getIndicatorValue	back to summary
public final byte getIndicatorValue()

octetStringToEcPoint	back to summary
public abstract ECPoint octetStringToEcPoint(byte[] octets, int startIndex, int len)

valueOf	back to summary
public static ECCurves.ECPointCompression valueOf(String name)

values	back to summary
public static ECCurves.ECPointCompression[] values()

writeCoordinate	back to summary
protected void writeCoordinate(OutputStream s, String n, BigInteger v, int numElements) throws IOException

writeECPoint	back to summary
public void writeECPoint(OutputStream s, String curveName, ECPoint p) throws IOException

public final Enum ECCurves

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ECCurves.Constants

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public sealed Enum ECCurves.ECPointCompression

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail