Package com.sshtools.common.publickey

Class OpenSSHPrivateKeyFile

java.lang.Object

com.sshtools.common.publickey.OpenSSHPrivateKeyFile

All Implemented Interfaces:

SshPrivateKeyFile

public class OpenSSHPrivateKeyFile
extends Object
implements SshPrivateKeyFile

Constructor Summary

Constructors

Constructor	Description
OpenSSHPrivateKeyFile()
OpenSSHPrivateKeyFile(byte[] formattedkey)
OpenSSHPrivateKeyFile(SshKeyPair pair, String passphrase, String comment)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenSSHPrivateKeyFile

public OpenSSHPrivateKeyFile(byte[] formattedkey)
                      throws IOException

Throws:

IOException

OpenSSHPrivateKeyFile

public OpenSSHPrivateKeyFile(SshKeyPair pair,
 String passphrase,
 String comment)
                      throws IOException

Throws:

IOException

OpenSSHPrivateKeyFile

public OpenSSHPrivateKeyFile()

Method Details

getComment

public String getComment()

Description copied from interface: SshPrivateKeyFile

The private key comment (if any).

Specified by:

getComment in interface SshPrivateKeyFile

Returns:

isPassphraseProtected

public boolean isPassphraseProtected()

Description copied from interface: SshPrivateKeyFile

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

Specified by:

isPassphraseProtected in interface SshPrivateKeyFile

Returns:

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

getType

public String getType()

Description copied from interface: SshPrivateKeyFile

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

Specified by:

getType in interface SshPrivateKeyFile

Returns:

String

supportsPassphraseChange

public boolean supportsPassphraseChange()

Description copied from interface: SshPrivateKeyFile

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.

Specified by:

supportsPassphraseChange in interface SshPrivateKeyFile

Returns:

boolean

toKeyPair

public SshKeyPair toKeyPair(String passphrase)
                     throws IOException,
InvalidPassphraseException

Description copied from interface: SshPrivateKeyFile

Decode the private key using the users passphrase.

Specified by:

toKeyPair in interface SshPrivateKeyFile

Parameters:

passphrase - the users passphrase

Returns:

the key pair stored in this private key file.

Throws:

IOException

InvalidPassphraseException

oidByteArrayToString

public String oidByteArrayToString(byte[] o)

encryptKey

public byte[] encryptKey(SshKeyPair pair,
 String passphrase)
                  throws IOException

Throws:

IOException

changePassphrase

public void changePassphrase(String oldpassphrase,
 String newpassphrase)
                      throws IOException,
InvalidPassphraseException

Description copied from interface: SshPrivateKeyFile

Change the passphrase of the key file.

Specified by:

changePassphrase in interface SshPrivateKeyFile

Parameters:

oldpassphrase - the old passphrase

newpassphrase - the new passphrase

Throws:

IOException

InvalidPassphraseException

getFormattedKey

public byte[] getFormattedKey()

Description copied from interface: SshPrivateKeyFile

Get the formatted key

Specified by:

getFormattedKey in interface SshPrivateKeyFile

Returns:

byte[]

isFormatted

public static boolean isFormatted(byte[] formattedkey)