org.apache.sshd.common

Interface KeyPairProvider

All Known Implementing Classes:

AbstractGeneratorHostKeyProvider, AbstractKeyPairProvider, FileKeyPairProvider, PEMGeneratorHostKeyProvider, ResourceKeyPairProvider, SimpleGeneratorHostKeyProvider

public interface KeyPairProvider

Provider for key pairs. This provider is used on the server side to provide the host key, or on the client side to provide the user key.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ECDSA_SHA2_NISTP256 SSH identifier for EC keys in NIST curve P-256
static java.lang.String	ECDSA_SHA2_NISTP384 SSH identifier for EC keys in NIST curve P-384
static java.lang.String	ECDSA_SHA2_NISTP521 SSH identifier for EC keys in NIST curve P-521
static java.lang.String	SSH_DSS SSH identifier for DSA keys
static java.lang.String	SSH_RSA SSH identifier for RSA keys

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getKeyTypes() Return a comma separated list of the key types available
java.security.KeyPair	loadKey(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() Load available keys.

Field Detail

SSH_RSA

static final java.lang.String SSH_RSA

SSH identifier for RSA keys

See Also:

Constant Field Values

SSH_DSS

static final java.lang.String SSH_DSS

SSH identifier for DSA keys

See Also:

Constant Field Values

ECDSA_SHA2_NISTP256

static final java.lang.String ECDSA_SHA2_NISTP256

SSH identifier for EC keys in NIST curve P-256

See Also:

Constant Field Values

ECDSA_SHA2_NISTP384

static final java.lang.String ECDSA_SHA2_NISTP384

SSH identifier for EC keys in NIST curve P-384

See Also:

Constant Field Values

ECDSA_SHA2_NISTP521

static final java.lang.String ECDSA_SHA2_NISTP521

SSH identifier for EC keys in NIST curve P-521

See Also:

Constant Field Values

Method Detail

loadKeys

java.lang.Iterable<java.security.KeyPair> loadKeys()

Load available keys.

Returns:

an array of available keys, never null

loadKey

java.security.KeyPair loadKey(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}". If there is no key of this type, return null

Parameters:

type - the type of key to load

Returns:

a valid key pair or null

getKeyTypes

java.lang.String getKeyTypes()

Return a comma separated list of the key types available

Returns:

the list of key availables