net.sf.sshapi.identity

Interface SshIdentityManager

All Known Implementing Classes:

MaverickIdentityManager, MaverickIdentityManager

public interface SshIdentityManager

Identity manager implementations are responsible for generating and parsing various different formats of Public and Private keys.

To be able to store a SshPublicKey or SshPrivateKey, they must first be turned into SshPublicKeyFile or SshPrivateKeyFile objects respectively.

From these, a byte array that is formatted in the appropriate way can then be obtained and persisted however you wish.

Method Summary

Modifier and Type	Method and Description
SshPrivateKeyFile	create(SshKeyPair pair, int format, char[] passphrase, java.lang.String comment) Create a SshPrivateKeyFile that will allow you obtain a formatted version of a SshPrivateKey for storage.
SshPublicKeyFile	create(SshPublicKey key, java.lang.String options, java.lang.String comment, int format) Create a Public Key File that may be used to write authorized_keys files or other public key storage systems.
SshPrivateKeyFile	createPrivateKeyFromStream(java.io.InputStream in) Parse a stream that provides a private key in some supported format.
SshPublicKeyFile	createPublicKeyFromStream(java.io.InputStream in) Parse a stream that provides a public key in some supported format.
SshKeyPair	generateKeyPair(java.lang.String keyType, int keyBits) Generate a new key pair.
java.util.List	getSupportedKeyLengths() Get a list of all the supported key lengths.
java.util.List	getSupportedKeyTypes() Get a list of all the supported key types.
java.util.List	getSupportedPrivateKeyFileFormats() Get a list of all the supported private key file formats that may be created.
java.util.List	getSupportedPublicKeyFileFormats() Get a list of all the supported public key file formats that may be created.

Method Detail

createPublicKeyFromStream

SshPublicKeyFile createPublicKeyFromStream(java.io.InputStream in)
                                    throws SshException

Parse a stream that provides a public key in some supported format. The implementation will detect the format and construct the key object appropriately. The returned object is a SshPublicKeyFile so may then be persisted elsewhere if you wish, or you can just obtain the SshPublicKey.

Parameters:

in - stream to read key from

Returns:

public key file

Throws:

SshException - if the raw data cannot be parsed into a public key

createPrivateKeyFromStream

SshPrivateKeyFile createPrivateKeyFromStream(java.io.InputStream in)
                                      throws SshException

Parse a stream that provides a private key in some supported format. The implementation will detect the format and construct the key object appropriately. The returned object is a SshPrivateKeyFile so may then be persisted elsewhere if you wish, or you can just obtain the SshPrivateKeyFile.

Parameters:

in - stream to read key from

Returns:

private key file

Throws:

SshException - if the raw data cannot be parsed into a private key

generateKeyPair

SshKeyPair generateKeyPair(java.lang.String keyType,
                           int keyBits)
                    throws SshException

Generate a new key pair. Type must be one of the supported types, and key bits must be a supported key length. It is recommended you seed the random number generate before calling this method using SshProvider.seed(long).

Parameters:

keyType - key type.

keyBits - key length

Returns:

key pair

Throws:

SshException - if pair cannot be generated.

create

SshPrivateKeyFile create(SshKeyPair pair,
                         int format,
                         char[] passphrase,
                         java.lang.String comment)
                  throws SshException

Create a SshPrivateKeyFile that will allow you obtain a formatted version of a SshPrivateKey for storage. The public key is required for this, so SshKeyPair containing the private key is required. See SshPrivateKeyFile for possible format codes.

Note, not all key formats support the optional comment field.

Parameters:

pair - key pair

format - format

passphrase - passphrase if you want the key encrypted, null if not

comment - comment if supported by format

Returns:

private key file

Throws:

SshException

getSupportedKeyTypes

java.util.List getSupportedKeyTypes()

Get a list of all the supported key types. Each element is a String which will be one of SshConfiguration.PUBLIC_KEY_SSHDSA, SshConfiguration.PUBLIC_KEY_SSHRSA or SshConfiguration.PUBLIC_KEY_SSHDSA.

Returns:

supported key types

getSupportedKeyLengths

java.util.List getSupportedKeyLengths()

Get a list of all the supported key lengths. Each element is an Integer whose value is the key size in bits.

Returns:

listed of supprted key lengths

getSupportedPublicKeyFileFormats

java.util.List getSupportedPublicKeyFileFormats()

Get a list of all the supported public key file formats that may be created. Each element in the list is an Integer whose value corresponds to one of the format codes in SshPublicKeyFile

Returns:

supported public key file formats

See Also:

SshPublicKeyFile

getSupportedPrivateKeyFileFormats

java.util.List getSupportedPrivateKeyFileFormats()

Get a list of all the supported private key file formats that may be created. Each element in the list is an Integer whose value corresponds to one of the format codes in SshPrivateKeyFile

Returns:

supported public key file formats

See Also:

SshPublicKeyFile

create

SshPublicKeyFile create(SshPublicKey key,
                        java.lang.String options,
                        java.lang.String comment,
                        int format)
                 throws SshException

Create a Public Key File that may be used to write authorized_keys files or other public key storage systems.

Parameters:

key - public key to use

options - additional options when supported by the format

comment - comment when supported by the format

format - key format. See SshPublicKeyFile for format types.

Returns:

public key file object

Throws:

SshException - if public key file may not be created