org.apache.sshd.common.config.keys.loader.pem

Class RSAPEMResourceKeyPairParser

java.lang.Object

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

org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser

org.apache.sshd.common.config.keys.loader.pem.AbstractPEMResourceKeyPairParser

org.apache.sshd.common.config.keys.loader.pem.RSAPEMResourceKeyPairParser

All Implemented Interfaces:

KeyPairResourceLoader, KeyPairResourceParser, KeyPairPEMResourceParser

public class RSAPEMResourceKeyPairParser
extends AbstractPEMResourceKeyPairParser

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEGIN_MARKER
static List<String>	BEGINNERS
static String	END_MARKER
static List<String>	ENDERS
static RSAPEMResourceKeyPairParser	INSTANCE
static String	RSA_OID

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

log

Fields inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceParser

EMPTY

Constructor Summary

Constructors

Constructor and Description
RSAPEMResourceKeyPairParser()

Method Summary

Modifier and Type	Method and Description
static KeyPair	decodeRSAKeyPair(KeyFactory kf, InputStream s, boolean okToClose) The ASN.1 syntax for the private key as per RFC-3447 section A.1.2: RSAPrivateKey ::= SEQUENCE { version Version, modulus INTEGER, -- n publicExponent INTEGER, -- e privateExponent INTEGER, -- d prime1 INTEGER, -- p prime2 INTEGER, -- q exponent1 INTEGER, -- d mod (p-1) exponent2 INTEGER, -- d mod (q-1) coefficient INTEGER, -- (inverse of q) mod p otherPrimeInfos OtherPrimeInfos OPTIONAL }
Collection<KeyPair>	extractKeyPairs(String resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, InputStream stream)

Methods inherited from class org.apache.sshd.common.config.keys.loader.pem.AbstractPEMResourceKeyPairParser

applyPrivateKeyCipher, extractKeyPairs, getAlgorithm, getAlgorithmIdentifier

Methods inherited from class org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser

canExtractKeyPairs, extractKeyPairs, getBeginners, getEnders, getEndingMarkers, loadKeyPairs

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, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceParser

aggregate, aggregate, canExtractKeyPairs, containsMarkerLine, containsMarkerLine, extractDataBytes, findMarkerLine, findMarkerLine, joinDataLines

Methods inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader

loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs

Field Detail

BEGIN_MARKER

public static final String BEGIN_MARKER

See Also:

Constant Field Values

BEGINNERS

public static final List<String> BEGINNERS

END_MARKER

public static final String END_MARKER

See Also:

Constant Field Values

ENDERS

public static final List<String> ENDERS

RSA_OID

public static final String RSA_OID

See Also:

RFC-3279 section 2.3.1, Constant Field Values

INSTANCE

public static final RSAPEMResourceKeyPairParser INSTANCE

Constructor Detail

RSAPEMResourceKeyPairParser

public RSAPEMResourceKeyPairParser()

Method Detail

extractKeyPairs

public Collection<KeyPair> extractKeyPairs(String resourceKey,
                                           String beginMarker,
                                           String endMarker,
                                           FilePasswordProvider passwordProvider,
                                           InputStream stream)
                                    throws IOException,
                                           GeneralSecurityException

Specified by:

extractKeyPairs in class AbstractKeyPairResourceParser

Parameters:

resourceKey - A hint as to the origin of the text lines

beginMarker - The line containing the begin marker

endMarker - The line containing the end marker

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

stream - The decoded data InputStream

Returns:

The extracted KeyPairs - may be null/empty if none.

Throws:

IOException - If failed to parse the data

GeneralSecurityException - If failed to generate the keys

decodeRSAKeyPair

public static KeyPair decodeRSAKeyPair(KeyFactory kf,
                                       InputStream s,
                                       boolean okToClose)
                                throws IOException,
                                       GeneralSecurityException

The ASN.1 syntax for the private key as per RFC-3447 section A.1.2:

 RSAPrivateKey ::= SEQUENCE {
   version           Version,
   modulus           INTEGER,  -- n
   publicExponent    INTEGER,  -- e
   privateExponent   INTEGER,  -- d
   prime1            INTEGER,  -- p
   prime2            INTEGER,  -- q
   exponent1         INTEGER,  -- d mod (p-1)
   exponent2         INTEGER,  -- d mod (q-1)
   coefficient       INTEGER,  -- (inverse of q) mod p
   otherPrimeInfos   OtherPrimeInfos OPTIONAL
 }
 

Parameters:

kf - The KeyFactory To use to generate the keys

s - The InputStream containing the encoded bytes

okToClose - true if the method may close the input stream regardless of success or failure

Returns:

The recovered KeyPair

Throws:

IOException - If failed to read or decode the bytes

GeneralSecurityException - If failed to generate the keys