org.apache.sshd.common.keyprovider

Class MappedKeyPairProvider

java.lang.Object

org.apache.sshd.common.keyprovider.MappedKeyPairProvider

All Implemented Interfaces:

KeyIdentityProvider, KeyPairProvider

public class MappedKeyPairProvider
extends java.lang.Object
implements KeyPairProvider

Holds a Map of String->KeyPair where the map key is the type and value is the associated KeyPair

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Function<java.util.Map<java.lang.String,java.security.KeyPair>,KeyPairProvider>	MAP_TO_KEY_PAIR_PROVIDER Transforms a Map of String->KeyPair to a KeyPairProvider where map key is the type and value is the associated KeyPair
private java.util.Map<java.lang.String,java.security.KeyPair>	pairsMap

Fields inherited from interface org.apache.sshd.common.keyprovider.KeyPairProvider

ECDSA_SHA2_NISTP256, ECDSA_SHA2_NISTP384, ECDSA_SHA2_NISTP521, EMPTY_KEYPAIR_PROVIDER, SSH_DSS, SSH_ED25519, SSH_RSA

Fields inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProvider

EMPTY_KEYS_PROVIDER

Constructor Summary

Constructors

Constructor and Description
MappedKeyPairProvider(java.util.Collection<? extends java.security.KeyPair> pairs)
MappedKeyPairProvider(java.security.KeyPair... pairs)
MappedKeyPairProvider(java.util.Map<java.lang.String,java.security.KeyPair> pairsMap)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.String>	getKeyTypes(SessionContext session)
java.security.KeyPair	loadKey(SessionContext session, java.lang.String type) Load a key of the specified type which can be "ssh-rsa", "ssh-dss", or "ecdsa-sha2-nistp{256,384,521}".
java.lang.Iterable<java.security.KeyPair>	loadKeys(SessionContext session) Load available keys.
static java.util.Map<java.lang.String,java.security.KeyPair>	mapUniquePairs(java.util.Collection<? extends java.security.KeyPair> pairs)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyPairProvider

wrap, wrap

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProvider

exhaustCurrentIdentities, isEmpty, iterableOf, multiProvider, multiProvider, resolveKeyIdentityProvider, wrapKeyPairs, wrapKeyPairs

Field Detail

MAP_TO_KEY_PAIR_PROVIDER

public static final java.util.function.Function<java.util.Map<java.lang.String,java.security.KeyPair>,KeyPairProvider> MAP_TO_KEY_PAIR_PROVIDER

Transforms a Map of String->KeyPair to a KeyPairProvider where map key is the type and value is the associated KeyPair

pairsMap

private final java.util.Map<java.lang.String,java.security.KeyPair> pairsMap

Constructor Detail

MappedKeyPairProvider

public MappedKeyPairProvider(java.security.KeyPair... pairs)

MappedKeyPairProvider

public MappedKeyPairProvider(java.util.Collection<? extends java.security.KeyPair> pairs)

MappedKeyPairProvider

public MappedKeyPairProvider(java.util.Map<java.lang.String,java.security.KeyPair> pairsMap)

Method Detail

loadKeys

public java.lang.Iterable<java.security.KeyPair> loadKeys(SessionContext session)

Description copied from interface: KeyIdentityProvider

Load available keys.

Specified by:

loadKeys in interface KeyIdentityProvider

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

Returns:

an Iterable instance of available keys - ignored if null

loadKey

public java.security.KeyPair loadKey(SessionContext session,
                                     java.lang.String type)

Description copied from interface: KeyPairProvider

Load a key of the specified type which can be "ssh-rsa", "ssh-dss", or "ecdsa-sha2-nistp{256,384,521}". If there is no key of this type, return null

Specified by:

loadKey in interface KeyPairProvider

Parameters:

session - The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool).

type - the type of key to load

Returns:

a valid key pair or null if this type of key is not available

getKeyTypes

public java.lang.Iterable<java.lang.String> getKeyTypes(SessionContext session)

Specified by:

getKeyTypes in interface KeyPairProvider

Parameters:

session - The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool).

Returns:

The available Iterable key types in preferred order - never null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

mapUniquePairs

public static java.util.Map<java.lang.String,java.security.KeyPair> mapUniquePairs(java.util.Collection<? extends java.security.KeyPair> pairs)