Package org.apache.sshd.common.util.security.eddsa.generic

Class GenericEd25519PublicKeyDecoder<PUB extends java.security.PublicKey,PRV extends java.security.PrivateKey>

java.lang.Object

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

org.apache.sshd.common.config.keys.impl.AbstractIdentityResourceLoader<PUB,PRV>

org.apache.sshd.common.config.keys.impl.AbstractKeyEntryResolver<PUB,PRV>

org.apache.sshd.common.config.keys.impl.AbstractPublicKeyEntryDecoder<PUB,PRV>

org.apache.sshd.common.util.security.eddsa.generic.GenericEd25519PublicKeyDecoder<PUB,PRV>

All Implemented Interfaces:

IdentityResourceLoader<PUB,PRV>, KeyEntryResolver<PUB,PRV>, KeyTypeNamesSupport, PublicKeyEntryDecoder<PUB,PRV>, PublicKeyEntryResolver, PublicKeyRawDataDecoder<PUB>

Direct Known Subclasses:

Ed25519PublicKeyDecoder

public class GenericEd25519PublicKeyDecoder<PUB extends java.security.PublicKey,PRV extends java.security.PrivateKey>
extends AbstractPublicKeyEntryDecoder<PUB,PRV>

Field Summary

Fields

Modifier and Type	Field	Description
protected EdDSASupport<PUB,PRV>	edDSASupport
static int	MAX_ALLOWED_SEED_LEN

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.config.keys.IdentityResourceLoader

MAX_BIGINT_OCTETS_COUNT

Fields inherited from interface org.apache.sshd.common.config.keys.PublicKeyEntryResolver

FAILING, IGNORING, UNSUPPORTED

Constructor Summary

Constructors

Constructor	Description
GenericEd25519PublicKeyDecoder(java.lang.Class<PUB> pubType, java.lang.Class<PRV> prvType, EdDSASupport<PUB,PRV> edDSASupport)

Method Summary

Modifier and Type	Method	Description
PRV	clonePrivateKey(PRV key)
PUB	clonePublicKey(PUB key)
PUB	decodePublicKey(SessionContext session, java.lang.String keyType, java.io.InputStream keyData, java.util.Map<java.lang.String,java.lang.String> headers)
java.lang.String	encodePublicKey(java.io.OutputStream s, PUB key)	Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
java.security.KeyFactory	getKeyFactoryInstance()
java.security.KeyPairGenerator	getKeyPairGenerator()

Methods inherited from class org.apache.sshd.common.config.keys.impl.AbstractPublicKeyEntryDecoder

parseBooleanHeader

Methods inherited from class org.apache.sshd.common.config.keys.impl.AbstractKeyEntryResolver

generatePrivateKey, generatePublicKey, toString

Methods inherited from class org.apache.sshd.common.config.keys.impl.AbstractIdentityResourceLoader

getPrivateKeyType, getPublicKeyType, getSupportedKeyTypes

Methods inherited from class org.apache.sshd.common.util.logging.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 java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.config.keys.IdentityResourceLoader

getPrivateKeyType, getPublicKeyType

Methods inherited from interface org.apache.sshd.common.config.keys.KeyEntryResolver

cloneKeyPair, generateKeyPair

Methods inherited from interface org.apache.sshd.common.config.keys.KeyTypeNamesSupport

getSupportedKeyTypes

Methods inherited from interface org.apache.sshd.common.config.keys.PublicKeyEntryDecoder

decodePublicKeyByType, resolve

Methods inherited from interface org.apache.sshd.common.config.keys.PublicKeyRawDataDecoder

decodePublicKey, decodePublicKey

Field Detail

MAX_ALLOWED_SEED_LEN

public static final int MAX_ALLOWED_SEED_LEN

See Also:

Constant Field Values

edDSASupport

protected final EdDSASupport<PUB extends java.security.PublicKey,PRV extends java.security.PrivateKey> edDSASupport

Constructor Detail

GenericEd25519PublicKeyDecoder

public GenericEd25519PublicKeyDecoder(java.lang.Class<PUB> pubType,
                                      java.lang.Class<PRV> prvType,
                                      EdDSASupport<PUB,PRV> edDSASupport)

Method Detail

clonePublicKey

public PUB clonePublicKey(PUB key)
                   throws java.security.GeneralSecurityException

Parameters:

key - The PublicKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

java.security.GeneralSecurityException - If failed to clone the key

clonePrivateKey

public PRV clonePrivateKey(PRV key)
                    throws java.security.GeneralSecurityException

Parameters:

key - The PrivateKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

java.security.GeneralSecurityException - If failed to clone the key

getKeyPairGenerator

public java.security.KeyPairGenerator getKeyPairGenerator()
                                                   throws java.security.GeneralSecurityException

Returns:

A KeyPairGenerator suitable for this decoder

Throws:

java.security.GeneralSecurityException - If failed to create the generator

encodePublicKey

public java.lang.String encodePublicKey(java.io.OutputStream s,
                                        PUB key)
                                 throws java.io.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:

java.io.IOException - If failed to generate the encoding

getKeyFactoryInstance

public java.security.KeyFactory getKeyFactoryInstance()
                                               throws java.security.GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

java.security.GeneralSecurityException - If failed to create one

decodePublicKey

public PUB decodePublicKey(SessionContext session,
                           java.lang.String keyType,
                           java.io.InputStream keyData,
                           java.util.Map<java.lang.String,java.lang.String> headers)
                    throws java.io.IOException,
                           java.security.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:

java.io.IOException - If failed to read from the data stream

java.security.GeneralSecurityException - If failed to generate the key