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:

AlgorithmNameProvider, KeyPairResourceLoader, KeyPairResourceParser, KeyPairPEMResourceParser

public class PKCS8PEMResourceKeyPairParser
extends AbstractPEMResourceKeyPairParser

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEGIN_MARKER
static java.util.List<java.lang.String>	BEGINNERS
static java.lang.String	END_MARKER
static java.util.List<java.lang.String>	ENDERS
static PKCS8PEMResourceKeyPairParser	INSTANCE
static java.lang.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

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

MAX_CIPHER_NAME_LENGTH, MAX_KEY_COMMENT_LENGTH, MAX_KEY_TYPE_NAME_LENGTH, MAX_PRIVATE_KEY_DATA_SIZE, MAX_PUBLIC_KEY_DATA_SIZE

Constructor Summary

Constructors

Constructor and Description
PKCS8PEMResourceKeyPairParser()

Method Summary

Modifier and Type	Method and Description
static java.security.PrivateKey	decodePEMPrivateKeyPKCS8(java.util.List<java.lang.Integer> oidAlgorithm, byte[] keyBytes)
static java.security.PrivateKey	decodePEMPrivateKeyPKCS8(java.lang.String oid, byte[] keyBytes)
java.util.Collection<java.security.KeyPair>	extractKeyPairs(SessionContext session, NamedResource resourceKey, java.lang.String beginMarker, java.lang.String endMarker, FilePasswordProvider passwordProvider, java.io.InputStream stream)
static java.util.List<java.lang.Integer>	getPKCS8AlgorithmIdentifier(ASN1Object privateKeyInfo)
static java.util.List<java.lang.Integer>	getPKCS8AlgorithmIdentifier(byte[] input)
static java.util.List<java.lang.Integer>	getPKCS8AlgorithmIdentifier(DERParser parser) According to the standard:

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, loadKeyPairs, loadKeyPairs

Field Detail

BEGIN_MARKER

public static final java.lang.String BEGIN_MARKER

See Also:

Constant Field Values

BEGINNERS

public static final java.util.List<java.lang.String> BEGINNERS

END_MARKER

public static final java.lang.String END_MARKER

See Also:

Constant Field Values

ENDERS

public static final java.util.List<java.lang.String> ENDERS

PKCS8_FORMAT

public static final java.lang.String PKCS8_FORMAT

See Also:

Constant Field Values

INSTANCE

public static final PKCS8PEMResourceKeyPairParser INSTANCE

Constructor Detail

PKCS8PEMResourceKeyPairParser

public PKCS8PEMResourceKeyPairParser()

Method Detail

extractKeyPairs

public java.util.Collection<java.security.KeyPair> extractKeyPairs(SessionContext session,
                                                                   NamedResource resourceKey,
                                                                   java.lang.String beginMarker,
                                                                   java.lang.String endMarker,
                                                                   FilePasswordProvider passwordProvider,
                                                                   java.io.InputStream stream)
                                                            throws java.io.IOException,
                                                                   java.security.GeneralSecurityException

Specified by:

extractKeyPairs in class AbstractKeyPairResourceParser

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

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:

java.io.IOException - If failed to parse the data

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

decodePEMPrivateKeyPKCS8

public static java.security.PrivateKey decodePEMPrivateKeyPKCS8(java.util.List<java.lang.Integer> oidAlgorithm,
                                                                byte[] keyBytes)
                                                         throws java.security.GeneralSecurityException

Throws:

java.security.GeneralSecurityException

decodePEMPrivateKeyPKCS8

public static java.security.PrivateKey decodePEMPrivateKeyPKCS8(java.lang.String oid,
                                                                byte[] keyBytes)
                                                         throws java.security.GeneralSecurityException

Throws:

java.security.GeneralSecurityException

getPKCS8AlgorithmIdentifier

public static java.util.List<java.lang.Integer> getPKCS8AlgorithmIdentifier(byte[] input)
                                                                     throws java.io.IOException

Throws:

java.io.IOException

getPKCS8AlgorithmIdentifier

public static java.util.List<java.lang.Integer> getPKCS8AlgorithmIdentifier(DERParser parser)
                                                                     throws java.io.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:

java.io.IOException - If malformed data

See Also:

getPKCS8AlgorithmIdentifier(ASN1Object)

getPKCS8AlgorithmIdentifier

public static java.util.List<java.lang.Integer> getPKCS8AlgorithmIdentifier(ASN1Object privateKeyInfo)
                                                                     throws java.io.IOException

Throws:

java.io.IOException