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

Class AbstractPEMResourceKeyPairParser

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

All Implemented Interfaces:

KeyPairResourceLoader, KeyPairResourceParser, KeyPairPEMResourceParser

Direct Known Subclasses:

DSSPEMResourceKeyPairParser, ECDSAPEMResourceKeyPairParser, PKCS8PEMResourceKeyPairParser, RSAPEMResourceKeyPairParser

public abstract class AbstractPEMResourceKeyPairParser
extends AbstractKeyPairResourceParser
implements KeyPairPEMResourceParser

Base class for PEM file key-pair loaders

Author:

Apache MINA SSHD Project

Field Summary

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

Modifier	Constructor and Description
protected	AbstractPEMResourceKeyPairParser(String algo, String algId, List<String> beginners, List<String> enders)

Method Summary

Modifier and Type	Method and Description
protected byte[]	applyPrivateKeyCipher(byte[] bytes, PrivateKeyEncryptionContext encContext, boolean encryptIt)
Collection<KeyPair>	extractKeyPairs(String resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, List<String> lines) Extracts the key pairs within a single delimited by markers block of lines.
String	getAlgorithm()
String	getAlgorithmIdentifier()

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

canExtractKeyPairs, extractKeyPairs, 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

Constructor Detail

AbstractPEMResourceKeyPairParser

protected AbstractPEMResourceKeyPairParser(String algo,
                                           String algId,
                                           List<String> beginners,
                                           List<String> enders)

Method Detail

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface KeyPairPEMResourceParser

Returns:

The encryption algorithm name - e.g., "RSA", "DSA"

getAlgorithmIdentifier

public String getAlgorithmIdentifier()

Specified by:

getAlgorithmIdentifier in interface KeyPairPEMResourceParser

Returns:

The OID used to identify this algorithm in DER encodings - e.g., RSA=1.2.840.113549.1.1.1

extractKeyPairs

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

Description copied from class: AbstractKeyPairResourceParser

Extracts the key pairs within a single delimited by markers block of lines. By default cleans up the empty lines, joins them and converts them from BASE64

Overrides:

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

lines - The block of lines between the markers

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

See Also:

AbstractKeyPairResourceParser.extractKeyPairs(String, String, String, FilePasswordProvider, byte[])

applyPrivateKeyCipher

protected byte[] applyPrivateKeyCipher(byte[] bytes,
                                       PrivateKeyEncryptionContext encContext,
                                       boolean encryptIt)
                                throws GeneralSecurityException

Throws:

GeneralSecurityException