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

Class PKCS8PEMResourceKeyPairParser

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

All Implemented Interfaces:

KeyPairResourceLoader, KeyPairResourceParser, KeyPairPEMResourceParser

public class PKCS8PEMResourceKeyPairParser
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 PKCS8PEMResourceKeyPairParser	INSTANCE
static String	PKCS8_FORMAT

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

Method Summary

Modifier and Type	Method and Description
static PrivateKey	decodePEMPrivateKeyPKCS8(List<Integer> oidAlgorithm, byte[] keyBytes, FilePasswordProvider passwordProvider)
static PrivateKey	decodePEMPrivateKeyPKCS8(String oid, byte[] keyBytes, FilePasswordProvider passwordProvider)
Collection<KeyPair>	extractKeyPairs(String resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, InputStream stream)
static List<Integer>	getPKCS8AlgorithmIdentifier(ASN1Object privateKeyInfo)
static List<Integer>	getPKCS8AlgorithmIdentifier(DERParser parser) According to the standard: PrivateKeyInfo ::= SEQUENCE { version Version, privateKeyAlgorithm PrivateKeyAlgorithmIdentifier, privateKey PrivateKey, attributes [0] IMPLICIT Attributes OPTIONAL } Version ::= INTEGER PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier PrivateKey ::= OCTET STRING Attributes ::= SET OF Attribute AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL }
static List<Integer>	getPKCS8AlgorithmIdentifier(InputStream input, boolean okToClose)

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

PKCS8_FORMAT

public static final String PKCS8_FORMAT

See Also:

Constant Field Values

INSTANCE

public static final PKCS8PEMResourceKeyPairParser INSTANCE

Constructor Detail

PKCS8PEMResourceKeyPairParser

public PKCS8PEMResourceKeyPairParser()

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

decodePEMPrivateKeyPKCS8

public static PrivateKey decodePEMPrivateKeyPKCS8(List<Integer> oidAlgorithm,
                                                  byte[] keyBytes,
                                                  FilePasswordProvider passwordProvider)
                                           throws GeneralSecurityException

Throws:

GeneralSecurityException

decodePEMPrivateKeyPKCS8

public static final PrivateKey decodePEMPrivateKeyPKCS8(String oid,
                                                        byte[] keyBytes,
                                                        FilePasswordProvider passwordProvider)
                                                 throws GeneralSecurityException

Throws:

GeneralSecurityException

getPKCS8AlgorithmIdentifier

public static List<Integer> getPKCS8AlgorithmIdentifier(InputStream input,
                                                        boolean okToClose)
                                                 throws IOException

Throws:

IOException

getPKCS8AlgorithmIdentifier

public static List<Integer> getPKCS8AlgorithmIdentifier(DERParser parser)
                                                 throws IOException

According to the standard:

 PrivateKeyInfo ::= SEQUENCE {
          version Version,
          privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,
          privateKey PrivateKey,
          attributes [0] IMPLICIT Attributes OPTIONAL
  }

 Version ::= INTEGER
 PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
 PrivateKey ::= OCTET STRING
 Attributes ::= SET OF Attribute
 AlgorithmIdentifier ::= SEQUENCE {
      algorithm       OBJECT IDENTIFIER,
      parameters      ANY DEFINED BY algorithm OPTIONAL
 }
 

Parameters:

parser - The DERParser to use

Returns:

The PKCS8 algorithm OID

Throws:

IOException - If malformed data

See Also:

getPKCS8AlgorithmIdentifier(ASN1Object)

getPKCS8AlgorithmIdentifier

public static List<Integer> getPKCS8AlgorithmIdentifier(ASN1Object privateKeyInfo)
                                                 throws IOException

Throws:

IOException