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)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_MAGIC
private static byte[]	AUTH_MAGIC_BYTES
static java.lang.String	BEGIN_MARKER
static java.util.List<java.lang.String>	BEGINNERS
private static java.util.Map<java.lang.Class<?>,PrivateKeyEntryDecoder<?,?>>	BY_KEY_CLASS_DECODERS_MAP
private static java.util.Map<java.lang.String,PrivateKeyEntryDecoder<?,?>>	BY_KEY_TYPE_DECODERS_MAP
static java.lang.String	END_MARKER
static java.util.List<java.lang.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
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, java.util.Map<java.lang.String,java.lang.String> headers)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(java.lang.Class<?> keyType)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(java.security.Key key)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(java.security.KeyPair kp)
static PrivateKeyEntryDecoder<?,?>	getPrivateKeyEntryDecoder(java.lang.String keyType)
protected java.util.Map.Entry<java.security.PrivateKey,java.lang.String>	readPrivateKey(SessionContext session, NamedResource resourceKey, OpenSSHParserContext context, java.lang.String keyType, FilePasswordProvider passwordProvider, java.io.InputStream stream)
protected java.util.List<java.security.KeyPair>	readPrivateKeys(SessionContext session, NamedResource resourceKey, OpenSSHParserContext context, java.util.Collection<? extends java.security.PublicKey> publicKeys, FilePasswordProvider passwordProvider, java.io.InputStream stream)
protected java.security.PublicKey	readPublicKey(SessionContext session, NamedResource resourceKey, OpenSSHParserContext context, java.io.InputStream stream, java.util.Map<java.lang.String,java.lang.String> headers)
static void	registerPrivateKeyEntryDecoder(PrivateKeyEntryDecoder<?,?> decoder)
protected OpenSSHKdfOptions	resolveKdfOptions(SessionContext session, NamedResource resourceKey, java.lang.String beginMarker, java.lang.String endMarker, java.io.InputStream stream, java.util.Map<java.lang.String,java.lang.String> headers)
protected <S extends java.io.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, separateDataLinesFromHeaders

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

AUTH_MAGIC

public static final java.lang.String AUTH_MAGIC

See Also:

Constant Field Values

INSTANCE

public static final OpenSSHKeyPairResourceParser INSTANCE

AUTH_MAGIC_BYTES

private static final byte[] AUTH_MAGIC_BYTES

BY_KEY_TYPE_DECODERS_MAP

private static final java.util.Map<java.lang.String,PrivateKeyEntryDecoder<?,?>> BY_KEY_TYPE_DECODERS_MAP

BY_KEY_CLASS_DECODERS_MAP

private static final java.util.Map<java.lang.Class<?>,PrivateKeyEntryDecoder<?,?>> BY_KEY_CLASS_DECODERS_MAP

Constructor Detail

OpenSSHKeyPairResourceParser

public OpenSSHKeyPairResourceParser()

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,
                                                                   java.util.Map<java.lang.String,java.lang.String> headers)
                                                            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

headers - Any headers that may have been available when data was read

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

resolveKdfOptions

protected OpenSSHKdfOptions resolveKdfOptions(SessionContext session,
                                              NamedResource resourceKey,
                                              java.lang.String beginMarker,
                                              java.lang.String endMarker,
                                              java.io.InputStream stream,
                                              java.util.Map<java.lang.String,java.lang.String> headers)
                                       throws java.io.IOException,
                                              java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

readPublicKey

protected java.security.PublicKey readPublicKey(SessionContext session,
                                                NamedResource resourceKey,
                                                OpenSSHParserContext context,
                                                java.io.InputStream stream,
                                                java.util.Map<java.lang.String,java.lang.String> headers)
                                         throws java.io.IOException,
                                                java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

readPrivateKeys

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

Throws:

java.io.IOException

java.security.GeneralSecurityException

readPrivateKey

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

Throws:

java.io.IOException

java.security.GeneralSecurityException

validateStreamMagicMarker

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

Throws:

java.io.IOException

registerPrivateKeyEntryDecoder

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

Parameters:

decoder - The decoder to register

Throws:

java.lang.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(java.lang.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(java.security.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(java.security.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(java.lang.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