Class ECDSAPublicKeyEntryDecoder

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.config.keys.impl.AbstractIdentityResourceLoader<ECPublicKey, ECPrivateKey>

org.apache.sshd.common.config.keys.impl.AbstractKeyEntryResolver<ECPublicKey, ECPrivateKey>

org.apache.sshd.common.config.keys.impl.AbstractPublicKeyEntryDecoder<ECPublicKey, ECPrivateKey>

org.apache.sshd.common.config.keys.impl.ECDSAPublicKeyEntryDecoder

All Implemented Interfaces:

IdentityResourceLoader<ECPublicKey, ECPrivateKey>, KeyEntryResolver<ECPublicKey, ECPrivateKey>, KeyTypeNamesSupport, PublicKeyEntryDecoder<ECPublicKey, ECPrivateKey>, PublicKeyEntryResolver, PublicKeyRawDataDecoder<ECPublicKey>

public class ECDSAPublicKeyEntryDecoder
extends AbstractPublicKeyEntryDecoder<ECPublicKey, ECPrivateKey>

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	ECPOINT_COMPRESSED_VARIANT_2
static final byte	ECPOINT_COMPRESSED_VARIANT_3
static final byte	ECPOINT_UNCOMPRESSED_FORM_INDICATOR
static final ECDSAPublicKeyEntryDecoder	INSTANCE
static final int	MAX_ALLOWED_POINT_SIZE
static final int	MAX_CURVE_NAME_LENGTH

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface IdentityResourceLoader

MAX_BIGINT_OCTETS_COUNT

Fields inherited from interface PublicKeyEntryResolver

FAILING, IGNORING, UNSUPPORTED

Constructor Summary

Constructors

Constructor	Description
ECDSAPublicKeyEntryDecoder()

Method Summary

Modifier and Type	Method	Description
ECPrivateKey	clonePrivateKey(ECPrivateKey key)
ECPublicKey	clonePublicKey(ECPublicKey key)
(package private) ECPublicKey	decodePublicKey(ECCurves curve, InputStream keyData)
ECPublicKey	decodePublicKey(SessionContext session, String keyType, InputStream keyData, Map<String,String> headers)
(package private) static void	encodePublicKey(OutputStream s, String keyType, ECCurves curve, ECPoint w)
String	encodePublicKey(OutputStream s, ECPublicKey key)	Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
KeyPair	generateKeyPair(int keySize)
KeyFactory	getKeyFactoryInstance()
KeyPairGenerator	getKeyPairGenerator()

Methods inherited from class AbstractPublicKeyEntryDecoder

parseBooleanHeader

Methods inherited from class AbstractKeyEntryResolver

generatePrivateKey, generatePublicKey, toString

Methods inherited from class AbstractIdentityResourceLoader

getPrivateKeyType, getPublicKeyType, getSupportedKeyTypes

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface IdentityResourceLoader

getPrivateKeyType, getPublicKeyType

Methods inherited from interface KeyEntryResolver

cloneKeyPair

Methods inherited from interface KeyTypeNamesSupport

getSupportedKeyTypes

Methods inherited from interface PublicKeyEntryDecoder

decodePublicKeyByType, resolve

Methods inherited from interface PublicKeyRawDataDecoder

decodePublicKey, decodePublicKey

Field Details

MAX_ALLOWED_POINT_SIZE

public static final int MAX_ALLOWED_POINT_SIZE

See Also:

• Constant Field Values

MAX_CURVE_NAME_LENGTH

public static final int MAX_CURVE_NAME_LENGTH

See Also:

• Constant Field Values

INSTANCE

public static final ECDSAPublicKeyEntryDecoder INSTANCE

ECPOINT_UNCOMPRESSED_FORM_INDICATOR

public static final byte ECPOINT_UNCOMPRESSED_FORM_INDICATOR

See Also:

• Constant Field Values

ECPOINT_COMPRESSED_VARIANT_2

public static final byte ECPOINT_COMPRESSED_VARIANT_2

See Also:

• Constant Field Values

ECPOINT_COMPRESSED_VARIANT_3

public static final byte ECPOINT_COMPRESSED_VARIANT_3

See Also:

• Constant Field Values

Constructor Details

ECDSAPublicKeyEntryDecoder

public ECDSAPublicKeyEntryDecoder()

Method Details

decodePublicKey

public ECPublicKey decodePublicKey(SessionContext session,
 String keyType,
 InputStream keyData,
 Map<String,String> headers)
                            throws IOException,
GeneralSecurityException

Parameters:

session - The SessionContext for invoking this command - may be null if not invoked within a session context (e.g., offline tool or session unknown).

keyType - The reported / encode key type

keyData - The key data bytes stream positioned after the key type decoding and making sure it is one of the supported types

headers - Any headers that may have been available when data was read

Returns:

The decoded PublicKey

Throws:

IOException - If failed to read from the data stream

GeneralSecurityException - If failed to generate the key

decodePublicKey

ECPublicKey decodePublicKey(ECCurves curve,
 InputStream keyData)
                     throws IOException,
GeneralSecurityException

Throws:

IOException

GeneralSecurityException

clonePublicKey

public ECPublicKey clonePublicKey(ECPublicKey key)
                           throws GeneralSecurityException

Parameters:

key - The PublicKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

GeneralSecurityException - If failed to clone the key

clonePrivateKey

public ECPrivateKey clonePrivateKey(ECPrivateKey key)
                             throws GeneralSecurityException

Parameters:

key - The PrivateKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

GeneralSecurityException - If failed to clone the key

encodePublicKey

public String encodePublicKey(OutputStream s,
 ECPublicKey key)
                       throws IOException

Description copied from interface: PublicKeyEntryDecoder

Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)

Parameters:

s - The OutputStream to write the data to

key - The PublicKey - may not be null

Returns:

The key type value - one of the KeyTypeNamesSupport.getSupportedKeyTypes()

Throws:

IOException - If failed to generate the encoding

encodePublicKey

static void encodePublicKey(OutputStream s,
 String keyType,
 ECCurves curve,
 ECPoint w)
                     throws IOException

Throws:

IOException

getKeyFactoryInstance

public KeyFactory getKeyFactoryInstance()
                                 throws GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

GeneralSecurityException - If failed to create one

generateKeyPair

public KeyPair generateKeyPair(int keySize)
                        throws GeneralSecurityException

Parameters:

keySize - Key size in bits

Returns:

A KeyPair with the specified key size

Throws:

GeneralSecurityException - if unable to generate the pair

getKeyPairGenerator

public KeyPairGenerator getKeyPairGenerator()
                                     throws GeneralSecurityException

Returns:

A KeyPairGenerator suitable for this decoder

Throws:

GeneralSecurityException - If failed to create the generator