Apache Mina SSHD 2.15.0 · org.apache.sshd.common.keyprovider.KeyPairProvider

Field Summary

Modifier and Type	Field and Description
public static final String	ECDSA_SHA2_NISTP256 SSH identifier for EC keys in NIST curve P-256
public static final String	ECDSA_SHA2_NISTP384 SSH identifier for EC keys in NIST curve P-384
public static final String	ECDSA_SHA2_NISTP521 SSH identifier for EC keys in NIST curve P-521
public static final KeyPairProvider	EMPTY_KEYPAIR_PROVIDER A `KeyPairProvider` that has no keys
public static final String	SSH_DSS SSH identifier for DSA keys
public static final String	SSH_DSS_CERT
public static final String	SSH_ECDSA_SHA2_NISTP256_CERT
public static final String	SSH_ECDSA_SHA2_NISTP384_CERT
public static final String	SSH_ECDSA_SHA2_NISTP521_CERT
public static final String	SSH_ED25519 SSH identifier for ED25519 elliptic curve keys
public static final String	SSH_ED25519_CERT
public static final String	SSH_RSA SSH identifier for RSA keys
public static final String	SSH_RSA_CERT SSH identifier for openssh cert keys

Inherited from org.apache.sshd.common.keyprovider.KeyIdentityProvider:: EMPTY_KEYS_PROVIDER

Method Summary

Modifier and Type	Method and Description
public default Iterable<String>	Returns: The available `Iterable` key types - never `null` getKeyTypes(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool). session)
public default KeyPair	Returns: a valid key pair or `null` if this type of key is not available loadKey(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool). session, String the type of key to load type) Load a key of the specified type which can be "ssh-rsa", "ssh-dss", or "ecdsa-sha2-nistp{256,384,521}".
public static KeyPairProvider	Returns: The provider wrapper wrap(KeyPair... The available pairs - ignored if `null`/empty (i.e., returns `EMPTY_KEYPAIR_PROVIDER`) pairs) Wrap the provided `KeyPair`s into a `KeyPairProvider`
public static KeyPairProvider	Returns: The provider wrapper wrap(Iterable<KeyPair> The available pairs `Iterable` - ignored if `null` (i.e., returns `EMPTY_KEYPAIR_PROVIDER`) pairs) Wrap the provided `KeyPair`s into a `KeyPairProvider`

Inherited from org.apache.sshd.common.keyprovider.KeyIdentityProvider:: exhaustCurrentIdentities isEmpty iterableOf loadKeys multiProvider multiProvider resolveKeyIdentityProvider wrapKeyPairs wrapKeyPairs

Field Detail

ECDSA_SHA2_NISTP256	back to summary
public static final String ECDSA_SHA2_NISTP256 SSH identifier for EC keys in NIST curve P-256

ECDSA_SHA2_NISTP384	back to summary
public static final String ECDSA_SHA2_NISTP384 SSH identifier for EC keys in NIST curve P-384

ECDSA_SHA2_NISTP521	back to summary
public static final String ECDSA_SHA2_NISTP521 SSH identifier for EC keys in NIST curve P-521

EMPTY_KEYPAIR_PROVIDER	back to summary
public static final KeyPairProvider EMPTY_KEYPAIR_PROVIDER A `KeyPairProvider` that has no keys

SSH_DSS	back to summary
public static final String SSH_DSS SSH identifier for DSA keys

SSH_DSS_CERT	back to summary
public static final String SSH_DSS_CERT

SSH_ECDSA_SHA2_NISTP256_CERT	back to summary
public static final String SSH_ECDSA_SHA2_NISTP256_CERT

SSH_ECDSA_SHA2_NISTP384_CERT	back to summary
public static final String SSH_ECDSA_SHA2_NISTP384_CERT

SSH_ECDSA_SHA2_NISTP521_CERT	back to summary
public static final String SSH_ECDSA_SHA2_NISTP521_CERT

SSH_ED25519	back to summary
public static final String SSH_ED25519 SSH identifier for ED25519 elliptic curve keys

SSH_ED25519_CERT	back to summary
public static final String SSH_ED25519_CERT

SSH_RSA	back to summary
public static final String SSH_RSA SSH identifier for RSA keys

SSH_RSA_CERT	back to summary
public static final String SSH_RSA_CERT SSH identifier for openssh cert keys

Method Detail

getKeyTypes back to summary

getKeyTypes	back to summary
public default Iterable<String> getKeyTypes(SessionContext session) throws IOException, GeneralSecurityException Parameters session:SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool). Returns:Iterable<String> The available `Iterable` key types - never `null` Exceptions IOException: If failed to read/parse the keys data GeneralSecurityException: If failed to generate the keys

public default Iterable<String> getKeyTypes(SessionContext session) throws IOException, GeneralSecurityException

Parameters

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

Returns:Iterable<String>

The available Iterable key types - never null

Exceptions

IOException:: If failed to read/parse the keys data
GeneralSecurityException:: If failed to generate the keys

loadKey back to summary

loadKey	back to summary
public default KeyPair loadKey(SessionContext session, String type) throws IOException, GeneralSecurityException 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` Parameters session:SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool). type:String the type of key to load Returns:KeyPair a valid key pair or `null` if this type of key is not available Exceptions IOException: If failed to read/parse the keys data GeneralSecurityException: If failed to generate the keys

public default KeyPair loadKey(SessionContext session, String type) throws IOException, GeneralSecurityException

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

Parameters

session:SessionContext: The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool).
type:String: the type of key to load

Returns:KeyPair

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

Exceptions

IOException:: If failed to read/parse the keys data
GeneralSecurityException:: If failed to generate the keys

wrap back to summary

wrap	back to summary
public static KeyPairProvider wrap(KeyPair... pairs) Wrap the provided `KeyPair`s into a `KeyPairProvider` Parameters pairs:KeyPair[] The available pairs - ignored if `null`/empty (i.e., returns `EMPTY_KEYPAIR_PROVIDER`) Returns:KeyPairProvider The provider wrapper See Also `wrap(Iterable)`

public static KeyPairProvider wrap(KeyPair... pairs)

Wrap the provided KeyPairs into a KeyPairProvider

Parameters

pairs:KeyPair[]: The available pairs - ignored if null/empty (i.e., returns EMPTY_KEYPAIR_PROVIDER)

Returns:KeyPairProvider

The provider wrapper

See Also

wrap(Iterable)

wrap back to summary

wrap	back to summary
public static KeyPairProvider wrap(Iterable<KeyPair> pairs) Wrap the provided `KeyPair`s into a `KeyPairProvider` Parameters pairs:Iterable<KeyPair> The available pairs `Iterable` - ignored if `null` (i.e., returns `EMPTY_KEYPAIR_PROVIDER`) Returns:KeyPairProvider The provider wrapper

public static KeyPairProvider wrap(Iterable<KeyPair> pairs)

Wrap the provided KeyPairs into a KeyPairProvider

Parameters

pairs:Iterable<KeyPair>: The available pairs Iterable - ignored if null (i.e., returns EMPTY_KEYPAIR_PROVIDER)

Returns:KeyPairProvider

The provider wrapper

public Interface KeyPairProvider

Field Summary

Method Summary

Field Detail

Method Detail