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

Class OpenSSHKeyPairResourceParser

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.openssh.OpenSSHKeyPairResourceParser

All Implemented Interfaces:

KeyPairResourceLoader, KeyPairResourceParser

public class OpenSSHKeyPairResourceParser
extends AbstractKeyPairResourceParser

Basic support for OpenSSH key file(s)

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_MAGIC
static String	BEGIN_MARKER
static List<String>	BEGINNERS
static String	END_MARKER
static List<String>	ENDERS
static OpenSSHKeyPairResourceParser	INSTANCE

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

Method Summary

Modifier and Type	Method and Description
Collection<KeyPair>	extractKeyPairs(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, InputStream stream)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(Class<?> keyType)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(Key key)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(KeyPair kp)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(String keyType)
protected Map.Entry<PrivateKey,String>	readPrivateKey(SessionContext session, NamedResource resourceKey, OpenSSHParserContext context, String keyType, FilePasswordProvider passwordProvider, InputStream stream)
protected List<KeyPair>	readPrivateKeys(SessionContext session, NamedResource resourceKey, OpenSSHParserContext context, Collection<? extends PublicKey> publicKeys, FilePasswordProvider passwordProvider, InputStream stream)
protected PublicKey	readPublicKey(SessionContext session, NamedResource resourceKey, OpenSSHParserContext context, InputStream stream)
static void	registerPrivateKeyEntryDecoder(PrivateKeyEntryDecoder<?,?> decoder)
protected OpenSSHKdfOptions	resolveKdfOptions(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, InputStream stream)
protected <S extends InputStream> S	validateStreamMagicMarker(SessionContext session, NamedResource resourceKey, S stream)

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

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

AUTH_MAGIC

public static final String AUTH_MAGIC

See Also:

Constant Field Values

INSTANCE

public static final OpenSSHKeyPairResourceParser INSTANCE

Constructor Detail

OpenSSHKeyPairResourceParser

public OpenSSHKeyPairResourceParser()

Method Detail

extractKeyPairs

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

IOException - If failed to parse the data

GeneralSecurityException - If failed to generate the keys

resolveKdfOptions

protected OpenSSHKdfOptions resolveKdfOptions(SessionContext session,
                                              NamedResource resourceKey,
                                              String beginMarker,
                                              String endMarker,
                                              InputStream stream)
                                       throws IOException,
                                              GeneralSecurityException

Throws:

IOException

GeneralSecurityException

readPublicKey

protected PublicKey readPublicKey(SessionContext session,
                                  NamedResource resourceKey,
                                  OpenSSHParserContext context,
                                  InputStream stream)
                           throws IOException,
                                  GeneralSecurityException

Throws:

IOException

GeneralSecurityException

readPrivateKeys

protected List<KeyPair> readPrivateKeys(SessionContext session,
                                        NamedResource resourceKey,
                                        OpenSSHParserContext context,
                                        Collection<? extends PublicKey> publicKeys,
                                        FilePasswordProvider passwordProvider,
                                        InputStream stream)
                                 throws IOException,
                                        GeneralSecurityException

Throws:

IOException

GeneralSecurityException

readPrivateKey

protected Map.Entry<PrivateKey,String> readPrivateKey(SessionContext session,
                                                      NamedResource resourceKey,
                                                      OpenSSHParserContext context,
                                                      String keyType,
                                                      FilePasswordProvider passwordProvider,
                                                      InputStream stream)
                                               throws IOException,
                                                      GeneralSecurityException

Throws:

IOException

GeneralSecurityException

validateStreamMagicMarker

protected <S extends InputStream> S validateStreamMagicMarker(SessionContext session,
                                                              NamedResource resourceKey,
                                                              S stream)
                                                       throws IOException

Throws:

IOException

registerPrivateKeyEntryDecoder

public static void registerPrivateKeyEntryDecoder(PrivateKeyEntryDecoder<?,?> decoder)

Parameters:

decoder - The decoder to register

Throws:

IllegalArgumentException - if no decoder or not key type or no supported names for the decoder

See Also:

IdentityResourceLoader.getPublicKeyType(), KeyTypeNamesSupport.getSupportedKeyTypes()

getPrivateKeyEntryDecoder

public static PrivateKeyEntryDecoder<?,?> getPrivateKeyEntryDecoder(String keyType)

Parameters:

keyType - The OpenSSH key type string - e.g., ssh-rsa, ssh-dss - ignored if null/empty

Returns:

The registered PrivateKeyEntryDecoder or {code null} if not found

getPrivateKeyEntryDecoder

public static PrivateKeyEntryDecoder<?,?> getPrivateKeyEntryDecoder(KeyPair kp)

Parameters:

kp - The KeyPair to examine - ignored if null

Returns:

The matching PrivateKeyEntryDecoder provided both the public and private keys have the same decoder - null if no match found

See Also:

getPrivateKeyEntryDecoder(Key)

getPrivateKeyEntryDecoder

public static PrivateKeyEntryDecoder<?,?> getPrivateKeyEntryDecoder(Key key)

Parameters:

key - The Key (public or private) - ignored if null

Returns:

The registered PrivateKeyEntryDecoder for this key or {code null} if no match found

See Also:

getPrivateKeyEntryDecoder(Class)

getPrivateKeyEntryDecoder

public static PrivateKeyEntryDecoder<?,?> getPrivateKeyEntryDecoder(Class<?> keyType)

Parameters:

keyType - The key Class - ignored if null or not a Key compatible type

Returns:

The registered PrivateKeyEntryDecoder or {code null} if no match found