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

Class AbstractKeyPairResourceParser

java.lang.Object

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

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

All Implemented Interfaces:

KeyPairResourceLoader, KeyPairResourceParser

Direct Known Subclasses:

AbstractPEMResourceKeyPairParser, BouncyCastleKeyPairResourceParser, OpenSSHKeyPairResourceParser

public abstract class AbstractKeyPairResourceParser
extends AbstractLoggingBean
implements KeyPairResourceParser

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

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

Modifier	Constructor and Description
protected	AbstractKeyPairResourceParser(List<String> beginners, List<String> enders)

Method Summary

Modifier and Type	Method and Description
boolean	canExtractKeyPairs(NamedResource resourceKey, List<String> lines)
Collection<KeyPair>	extractKeyPairs(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, byte[] bytes)
abstract Collection<KeyPair>	extractKeyPairs(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, InputStream stream)
Collection<KeyPair>	extractKeyPairs(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, List<String> lines) Extracts the key pairs within a single delimited by markers block of lines.
List<String>	getBeginners()
List<String>	getEnders()
List<List<String>>	getEndingMarkers()
Collection<KeyPair>	loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, List<String> lines) Loads key pairs from the given resource text lines

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

Constructor Detail

AbstractKeyPairResourceParser

protected AbstractKeyPairResourceParser(List<String> beginners,
                                        List<String> enders)

Parameters:

beginners - The markers that indicate the beginning of a parsing block

enders - The matching (by position) markers that indicate the end of a parsing block

Method Detail

getBeginners

public List<String> getBeginners()

getEnders

public List<String> getEnders()

getEndingMarkers

public List<List<String>> getEndingMarkers()

Returns:

A List of same size as the ending markers, where each ending marker is encapsulated inside a singleton list and resides as the same index as the marker it encapsulates

canExtractKeyPairs

public boolean canExtractKeyPairs(NamedResource resourceKey,
                                  List<String> lines)
                           throws IOException,
                                  GeneralSecurityException

Specified by:

canExtractKeyPairs in interface KeyPairResourceParser

Parameters:

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

lines - The resource lines

Returns:

true if the parser can extract some key pairs from the lines

Throws:

IOException - If failed to process the lines

GeneralSecurityException - If failed to extract information regarding the possibility to extract the key pairs

loadKeyPairs

public Collection<KeyPair> loadKeyPairs(SessionContext session,
                                        NamedResource resourceKey,
                                        FilePasswordProvider passwordProvider,
                                        List<String> lines)
                                 throws IOException,
                                        GeneralSecurityException

Description copied from interface: KeyPairResourceLoader

Loads key pairs from the given resource text lines

Specified by:

loadKeyPairs in interface KeyPairResourceLoader

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

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

lines - The List of lines as read from the resource

Returns:

The extracted KeyPairs - may be null/empty if none. Note: the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it

Throws:

IOException - If failed to process the lines

GeneralSecurityException - If failed to generate the keys from the parsed data

extractKeyPairs

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

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

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

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

extractKeyPairs

public Collection<KeyPair> extractKeyPairs(SessionContext session,
                                           NamedResource resourceKey,
                                           String beginMarker,
                                           String endMarker,
                                           FilePasswordProvider passwordProvider,
                                           byte[] bytes)
                                    throws IOException,
                                           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).

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

bytes - The decoded bytes from the lines containing the data

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

extractKeyPairs

public abstract Collection<KeyPair> extractKeyPairs(SessionContext session,
                                                    NamedResource resourceKey,
                                                    String beginMarker,
                                                    String endMarker,
                                                    FilePasswordProvider passwordProvider,
                                                    InputStream stream)
                                             throws IOException,
                                                    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).

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