com.sshtools.common.publickey

Interface SshPrivateKeyFile

All Known Implementing Classes:

OpenSSHPrivateKeyFile

public interface SshPrivateKeyFile

Interface which all private key formats must implement to provide decoding and decryption of the private key into a suitable format for the API.

Author:

Lee David Painter

Method Summary

Modifier and Type	Method and Description
void	changePassphrase(java.lang.String oldpassphrase, java.lang.String newpassprase) Change the passphrase of the key file.
java.lang.String	getComment() The private key comment (if any).
byte[]	getFormattedKey() Get the formatted key
java.lang.String	getType() Get a description of the format type e.g.
boolean	isPassphraseProtected() Determine if the private key file is protected by a passphrase.
boolean	supportsPassphraseChange() Method to determine whether the format supports changing of passphrases.
SshKeyPair	toKeyPair(java.lang.String passphrase) Decode the private key using the users passphrase.

Method Detail

isPassphraseProtected

boolean isPassphraseProtected()

Determine if the private key file is protected by a passphrase.

Returns:

true if the key file is encrypted with a passphrase, otherwise false

Throws:

java.io.IOException

toKeyPair

SshKeyPair toKeyPair(java.lang.String passphrase)
              throws java.io.IOException,
                     InvalidPassphraseException

Decode the private key using the users passphrase.

Parameters:

passphrase - the users passphrase

Returns:

the key pair stored in this private key file.

Throws:

java.io.IOException

InvalidPassphraseException

supportsPassphraseChange

boolean supportsPassphraseChange()

Method to determine whether the format supports changing of passphrases. This typically would indicate that the format is read-only and that keys cannot be saved into this format.

Returns:

boolean

getType

java.lang.String getType()

Get a description of the format type e.g. "OpenSSH"

Returns:

String

changePassphrase

void changePassphrase(java.lang.String oldpassphrase,
                      java.lang.String newpassprase)
               throws java.io.IOException,
                      InvalidPassphraseException

Change the passphrase of the key file.

Parameters:

oldpassphrase - the old passphrase

newpassprase - the new passphrase

Throws:

java.io.IOException

InvalidPassphraseException

getFormattedKey

byte[] getFormattedKey()
                throws java.io.IOException

Get the formatted key

Returns:

byte[]

Throws:

java.io.IOException

getComment

java.lang.String getComment()

The private key comment (if any).

Returns: