Package org.apache.sshd.common.config.keys.loader.openssh

Class OpenSSHRSAPrivateKeyDecoder

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<RSAPublicKey,RSAPrivateKey>

org.apache.sshd.common.config.keys.loader.openssh.OpenSSHRSAPrivateKeyDecoder

All Implemented Interfaces:

IdentityResourceLoader<RSAPublicKey,RSAPrivateKey>, KeyEntryResolver<RSAPublicKey,RSAPrivateKey>, KeyTypeNamesSupport, PrivateKeyEntryDecoder<RSAPublicKey,RSAPrivateKey>, PrivateKeyEntryResolver

public class OpenSSHRSAPrivateKeyDecoder
extends AbstractPrivateKeyEntryDecoder<RSAPublicKey,RSAPrivateKey>

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
static BigInteger	DEFAULT_PUBLIC_EXPONENT
static OpenSSHRSAPrivateKeyDecoder	INSTANCE

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
OpenSSHRSAPrivateKeyDecoder()

Method Summary

Modifier and Type	Method	Description
RSAPrivateKey	clonePrivateKey(RSAPrivateKey key)
RSAPublicKey	clonePublicKey(RSAPublicKey key)
RSAPrivateKey	decodePrivateKey(SessionContext session, String keyType, FilePasswordProvider passwordProvider, InputStream keyData)
String	encodePrivateKey(SecureByteArrayOutputStream s, RSAPrivateKey key, RSAPublicKey pubKey)	Encodes the PrivateKey using the OpenSSH format - same one used by the decodePublicKey method(s)
KeyFactory	getKeyFactoryInstance()
KeyPairGenerator	getKeyPairGenerator()
boolean	isPublicKeyRecoverySupported()
RSAPublicKey	recoverPublicKey(RSAPrivateKey privateKey)	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

DEFAULT_PUBLIC_EXPONENT

public static final BigInteger DEFAULT_PUBLIC_EXPONENT

INSTANCE

public static final OpenSSHRSAPrivateKeyDecoder INSTANCE

Constructor Detail

OpenSSHRSAPrivateKeyDecoder

public OpenSSHRSAPrivateKeyDecoder()

Method Detail

decodePrivateKey

public RSAPrivateKey decodePrivateKey(SessionContext session,
                                      String keyType,
                                      FilePasswordProvider passwordProvider,
                                      InputStream keyData)
                               throws IOException,
                                      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:

IOException - If failed to read from the data stream

GeneralSecurityException - If failed to generate the key

encodePrivateKey

public String encodePrivateKey(SecureByteArrayOutputStream s,
                               RSAPrivateKey key,
                               RSAPublicKey pubKey)
                        throws 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:

IOException - If failed to generate the encoding

isPublicKeyRecoverySupported

public boolean isPublicKeyRecoverySupported()

recoverPublicKey

public RSAPublicKey recoverPublicKey(RSAPrivateKey privateKey)
                              throws GeneralSecurityException

Description copied from interface: PrivateKeyEntryDecoder

Attempts to recover the public key given the private one

Parameters:

privateKey - The PrivateKey

Returns:

The recovered PublicKey - null if cannot recover it

Throws:

GeneralSecurityException - If failed to generate the public key

clonePublicKey

public RSAPublicKey clonePublicKey(RSAPublicKey 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 RSAPrivateKey clonePrivateKey(RSAPrivateKey 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

getKeyPairGenerator

public KeyPairGenerator getKeyPairGenerator()
                                     throws GeneralSecurityException

Returns:

A KeyPairGenerator suitable for this decoder

Throws:

GeneralSecurityException - If failed to create the generator

getKeyFactoryInstance

public KeyFactory getKeyFactoryInstance()
                                 throws GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

GeneralSecurityException - If failed to create one