net.sf.sshapi.identity

Interface SshPrivateKeyFile

public interface SshPrivateKeyFile

Represent a persisted SshPrivateKey. Provider implementations are capable of reading some known private key format, and presenting as an instance of this interface.

The formatted key may be encrypted if the format/provider supports.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_DSA DSA
static int	TYPE_RSA RSA
static int	TYPE_UNKNOWN Unknown
static int	VENDOR_FSECURE FSecure
static int	VENDOR_OPENSSH OpenSSH
static int	VENDOR_PUTTY Putty.
static int	VENDOR_SSH1 SSH1.
static int	VENDOR_SSHCOM SSH Communications Security
static int	VENDOR_SSHTOOLS SSHTools
static int	VENDOR_UNKNOWN Unknown

Method Summary

Modifier and Type	Method and Description
void	changePassphrase(char[] newPassphrase) Change the passphrase of this key.
void	decrypt(char[] passphrase) Decrypt a formatted key.
int	getFormat() Get the format of the key.
byte[]	getFormattedKey() Format the key so it can be written.
boolean	isEncrypted() Get if this key is currently encrypted.
boolean	supportsPassphraseChange() Get whether changing of the key passphrase is supported.
SshKeyPair	toKeyPair() Get the actual key pair.

Field Detail

TYPE_RSA

static final int TYPE_RSA

RSA

See Also:

Constant Field Values

TYPE_DSA

static final int TYPE_DSA

DSA

See Also:

Constant Field Values

TYPE_UNKNOWN

static final int TYPE_UNKNOWN

Unknown

See Also:

Constant Field Values

VENDOR_OPENSSH

static final int VENDOR_OPENSSH

OpenSSH

See Also:

Constant Field Values

VENDOR_FSECURE

static final int VENDOR_FSECURE

FSecure

See Also:

Constant Field Values

VENDOR_UNKNOWN

static final int VENDOR_UNKNOWN

Unknown

See Also:

Constant Field Values

VENDOR_SSHTOOLS

static final int VENDOR_SSHTOOLS

SSHTools

See Also:

Constant Field Values

VENDOR_SSH1

static final int VENDOR_SSH1

SSH1. Not truely a vendor, but has its own key format

See Also:

Constant Field Values

VENDOR_PUTTY

static final int VENDOR_PUTTY

Putty.

See Also:

Constant Field Values

VENDOR_SSHCOM

static final int VENDOR_SSHCOM

SSH Communications Security

See Also:

Constant Field Values

Method Detail

getFormattedKey

byte[] getFormattedKey()
                throws SshException

Format the key so it can be written.

Returns:

formatted key

Throws:

SshException

decrypt

void decrypt(char[] passphrase)
      throws SshException

Decrypt a formatted key.

Parameters:

passphrase -

Throws:

SshException

See Also:

#isEncrypted()}

changePassphrase

void changePassphrase(char[] newPassphrase)
               throws SshException

Change the passphrase of this key. The key must be decrypted using decrypt(char[]) first if it is encrypted.

Parameters:

newPassphrase - new passphrase

Throws:

SshException

isEncrypted

boolean isEncrypted()
             throws SshException

Get if this key is currently encrypted.

Returns:

encrypted

Throws:

SshException

supportsPassphraseChange

boolean supportsPassphraseChange()

Get whether changing of the key passphrase is supported.

Returns:

supports passphrase change

getFormat

int getFormat()

Get the format of the key. This will be one of the VENDOR_ constants from this interface.

Returns:

format

toKeyPair

SshKeyPair toKeyPair()
              throws SshException

Get the actual key pair. The key pair may have to be decrypted before it can be used.

Returns:

key pair

Throws:

SshException