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<java.security.interfaces.RSAPublicKey,java.security.interfaces.RSAPrivateKey>

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

All Implemented Interfaces:

IdentityResourceLoader<java.security.interfaces.RSAPublicKey,java.security.interfaces.RSAPrivateKey>, KeyEntryResolver<java.security.interfaces.RSAPublicKey,java.security.interfaces.RSAPrivateKey>, KeyTypeNamesSupport, PrivateKeyEntryDecoder<java.security.interfaces.RSAPublicKey,java.security.interfaces.RSAPrivateKey>, PrivateKeyEntryResolver

public class OpenSSHRSAPrivateKeyDecoder
extends AbstractPrivateKeyEntryDecoder<java.security.interfaces.RSAPublicKey,java.security.interfaces.RSAPrivateKey>

Field Summary

Fields

Modifier and Type	Field and Description
static java.math.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 and Description
OpenSSHRSAPrivateKeyDecoder()

Method Summary

Modifier and Type	Method and Description
java.security.interfaces.RSAPrivateKey	clonePrivateKey(java.security.interfaces.RSAPrivateKey key)
java.security.interfaces.RSAPublicKey	clonePublicKey(java.security.interfaces.RSAPublicKey key)
java.security.interfaces.RSAPrivateKey	decodePrivateKey(SessionContext session, java.lang.String keyType, FilePasswordProvider passwordProvider, java.io.InputStream keyData)
java.security.KeyFactory	getKeyFactoryInstance()
java.security.KeyPairGenerator	getKeyPairGenerator()
boolean	isPublicKeyRecoverySupported()
java.security.interfaces.RSAPublicKey	recoverPublicKey(java.security.interfaces.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

getSimplifiedLogger

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

decodePrivateKey, decodePrivateKey, decodePrivateKey, encodePrivateKey, resolve

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

cloneKeyPair, decodeBigInt, decodeInt, decodeString, decodeString, decodeString, encodeBigInt, encodeInt, encodeString, encodeString, encodeString, generateKeyPair, readRLEBytes, writeRLEBytes, writeRLEBytes

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

getPrivateKeyType, getPublicKeyType

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

findSupporterByKeyTypeName, getSupportedKeyTypes

Field Detail

DEFAULT_PUBLIC_EXPONENT

public static final java.math.BigInteger DEFAULT_PUBLIC_EXPONENT

INSTANCE

public static final OpenSSHRSAPrivateKeyDecoder INSTANCE

Constructor Detail

OpenSSHRSAPrivateKeyDecoder

public OpenSSHRSAPrivateKeyDecoder()

Method Detail

decodePrivateKey

public java.security.interfaces.RSAPrivateKey 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

isPublicKeyRecoverySupported

public boolean isPublicKeyRecoverySupported()

recoverPublicKey

public java.security.interfaces.RSAPublicKey recoverPublicKey(java.security.interfaces.RSAPrivateKey privateKey)
                                                       throws java.security.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:

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

clonePublicKey

public java.security.interfaces.RSAPublicKey clonePublicKey(java.security.interfaces.RSAPublicKey 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 java.security.interfaces.RSAPrivateKey clonePrivateKey(java.security.interfaces.RSAPrivateKey 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