Package com.sshtools.common.publickey

Class SshPrivateKeyFileFactory

java.lang.Object

com.sshtools.common.publickey.SshPrivateKeyFileFactory

public class SshPrivateKeyFileFactory
extends Object

Private key format factory used to decode private key files. This factory currently supports SSHTools, OpenSSH and SSH1 encrypted private keys.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field	Description
static final int	OPENSSH_FORMAT
static final int	OPENSSL_FORMAT

Constructor Summary

Constructors

Constructor	Description
SshPrivateKeyFileFactory()

Method Summary

Modifier and Type	Method	Description
static void	changePassphrase(File keyFile, String passphrase, String newPassphrase)	Take a file in any of the supported public key formats and convert to the requested format.
static void	convertFile(File keyFile, String passphrase, int toFormat, File toFile)	Take a file in any of the supported public key formats and convert to the requested format.
static SshPrivateKeyFile	create(SshKeyPair pair)
static SshPrivateKeyFile	create(SshKeyPair pair, String passphrase)
static SshPrivateKeyFile	create(SshKeyPair pair, String passphrase, int format)
static SshPrivateKeyFile	create(SshKeyPair pair, String passphrase, String comment)
static SshPrivateKeyFile	create(SshKeyPair pair, String passphrase, String comment, int format)
static void	createFile(SshKeyPair key, String passphrase, int format, File toFile)	Take a SshPrivateKey and write it to a file.
static void	createFile(SshKeyPair key, String passphrase, File toFile)
static SshPrivateKeyFile	parse(byte[] formattedkey)	Parse formatted data and return a suitable SshPrivateKeyFile implementation.
static SshPrivateKeyFile	parse(File identityFile)
static SshPrivateKeyFile	parse(InputStream in)	Parse an InputStream and return a suitable SshPrivateKeyFile implementation.
static SshPrivateKeyFile	parse(Path path)

Methods inherited from class java.lang.Object

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

Field Details

OPENSSH_FORMAT

public static final int OPENSSH_FORMAT

See Also:

• Constant Field Values

OPENSSL_FORMAT

public static final int OPENSSL_FORMAT

See Also:

• Constant Field Values

Constructor Details

SshPrivateKeyFileFactory

public SshPrivateKeyFileFactory()

Method Details

parse

public static SshPrivateKeyFile parse(byte[] formattedkey)
                               throws IOException

Parse formatted data and return a suitable SshPrivateKeyFile implementation.

Parameters:

formattedkey -

Returns:

SshPrivateKeyFile

Throws:

IOException

parse

public static SshPrivateKeyFile parse(InputStream in)
                               throws IOException

Parse an InputStream and return a suitable SshPrivateKeyFile implementation.

Parameters:

in -

Returns:

SshPrivateKeyFile

Throws:

IOException

create

public static SshPrivateKeyFile create(SshKeyPair pair)
                                throws IOException

Throws:

IOException

create

public static SshPrivateKeyFile create(SshKeyPair pair,
 String passphrase)
                                throws IOException

Throws:

IOException

create

public static SshPrivateKeyFile create(SshKeyPair pair,
 String passphrase,
 int format)
                                throws IOException

Throws:

IOException

create

public static SshPrivateKeyFile create(SshKeyPair pair,
 String passphrase,
 String comment)
                                throws IOException

Throws:

IOException

create

public static SshPrivateKeyFile create(SshKeyPair pair,
 String passphrase,
 String comment,
 int format)
                                throws IOException

Throws:

IOException

createFile

public static void createFile(SshKeyPair key,
 String passphrase,
 File toFile)
                       throws IOException

Throws:

IOException

createFile

public static void createFile(SshKeyPair key,
 String passphrase,
 int format,
 File toFile)
                       throws IOException

Take a SshPrivateKey and write it to a file.

Parameters:

key -

comment -

format -

toFile -

Throws:

IOException

convertFile

public static void convertFile(File keyFile,
 String passphrase,
 int toFormat,
 File toFile)
                        throws IOException,
InvalidPassphraseException

Take a file in any of the supported public key formats and convert to the requested format.

Parameters:

keyFile -

toFormat -

toFile -

Throws:

IOException

InvalidPassphraseException

changePassphrase

public static void changePassphrase(File keyFile,
 String passphrase,
 String newPassphrase)
                             throws IOException,
InvalidPassphraseException

Take a file in any of the supported public key formats and convert to the requested format.

Parameters:

keyFile -

toFormat -

toFile -

Throws:

IOException

InvalidPassphraseException

parse

public static SshPrivateKeyFile parse(Path path)
                               throws IOException

Throws:

IOException

parse

public static SshPrivateKeyFile parse(File identityFile)
                               throws IOException

Throws:

IOException