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

Class GenericOpenSSHEd25519PrivateKeyEntryDecoder<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.AbstractPrivateKeyEntryDecoder<PUB,PRV>

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

All Implemented Interfaces:

IdentityResourceLoader<PUB,PRV>, KeyEntryResolver<PUB,PRV>, KeyTypeNamesSupport, PrivateKeyEntryDecoder<PUB,PRV>, PrivateKeyEntryResolver

Direct Known Subclasses:

OpenSSHEd25519PrivateKeyEntryDecoder

public class GenericOpenSSHEd25519PrivateKeyEntryDecoder<PUB extends java.security.PublicKey,PRV extends java.security.PrivateKey>
extends AbstractPrivateKeyEntryDecoder<PUB,PRV>

Field Summary

Fields

Modifier and Type	Field	Description
protected EdDSASupport<PUB,PRV>	edDSASupport
private static int	KEYPAIR_SIZE
private static int	PK_SIZE
private static int	SK_SIZE

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.PrivateKeyEntryResolver

FAILING, IGNORING

Constructor Summary

Constructors

Constructor	Description
GenericOpenSSHEd25519PrivateKeyEntryDecoder(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)
PRV	decodePrivateKey(SessionContext session, java.lang.String keyType, FilePasswordProvider passwordProvider, java.io.InputStream keyData)
java.lang.String	encodePrivateKey(SecureByteArrayOutputStream s, PRV key, PUB pubKey)	Encodes the PrivateKey using the OpenSSH format - same one used by the decodePublicKey method(s)
java.security.KeyFactory	getKeyFactoryInstance()
java.security.KeyPairGenerator	getKeyPairGenerator()
boolean	isPublicKeyRecoverySupported()
PUB	recoverPublicKey(PRV prvKey)	Attempts to recover the public key given the private one

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.PrivateKeyEntryDecoder

decodePrivateKey, decodePrivateKey, decodePrivateKey, resolve

Field Detail

PK_SIZE

private static final int PK_SIZE

See Also:

Constant Field Values

SK_SIZE

private static final int SK_SIZE

See Also:

Constant Field Values

KEYPAIR_SIZE

private static final int KEYPAIR_SIZE

See Also:

Constant Field Values

edDSASupport

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

Constructor Detail

GenericOpenSSHEd25519PrivateKeyEntryDecoder

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

Method Detail

decodePrivateKey

public PRV decodePrivateKey(SessionContext session,
                            java.lang.String keyType,
                            FilePasswordProvider passwordProvider,
                            java.io.InputStream keyData)
                     throws java.io.IOException,
                            java.security.GeneralSecurityException

Parameters:

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

keyType - The reported / encode key type

passwordProvider - The FilePasswordProvider to use in case the data is encrypted - may be null if no encrypted data is expected

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

Returns:

The decoded PrivateKey

Throws:

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

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

encodePrivateKey

public java.lang.String encodePrivateKey(SecureByteArrayOutputStream s,
                                         PRV key,
                                         PUB pubKey)
                                  throws java.io.IOException

Description copied from interface: PrivateKeyEntryDecoder

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

Parameters:

s - The SecureByteArrayOutputStream to write the data to.

key - The PrivateKey - may not be null

pubKey - The PublicKey belonging to the private key - must be non-null if public key recovery is not supported

Returns:

The key type value - one of the KeyTypeNamesSupport.getSupportedKeyTypes() or null if encoding not supported

Throws:

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

isPublicKeyRecoverySupported

public boolean isPublicKeyRecoverySupported()

recoverPublicKey

public PUB recoverPublicKey(PRV prvKey)
                     throws java.security.GeneralSecurityException

Description copied from interface: PrivateKeyEntryDecoder

Attempts to recover the public key given the private one

Parameters:

prvKey - The PrivateKey

Returns:

The recovered PublicKey - null if cannot recover it

Throws:

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

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

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