com.sshtools.common.publickey

Class SshKeyPairGenerator

java.lang.Object

com.sshtools.common.publickey.SshKeyPairGenerator

public class SshKeyPairGenerator
extends java.lang.Object

Generate public/private key pairs.

To generate a new pair use the following code

 SshKeyPair pair = SshKeyPairGenerator.generateKeyPair(SshKeyPairGenerator.SSH2_RSA, 1024);
 

To create formatted key file for the public key use:

 SshPublicKeyFile pubfile = SshPublicKeyFileFactory.create(pair.getPublicKey(), "Some comment",
                SshPublicKeyFileFactory.OPENSSH_FORMAT);
 FileOutputStream fout = new FileOutputStream("mykey.pub");
 fout.write(pubfile.getFormattedKey());
 fout.close();
 

To create a formatted, encrypted private key file use:

 SshPrivateKeyFile prvfile = SshPrivateKeyFileFactory.create(pair, "my passphrase", "Some comment",
                SshPrivateKeyFileFactory.OPENSSH_FORMAT);
 FileOutputStream fout = new FileOutputStream("mykey");
 fout.write(prvfile.getFormattedKey());
 fout.close();
 

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ECDSA
static java.lang.String	ED25519
static java.lang.String	SSH2_RSA

Constructor Summary

Constructors

Constructor and Description
SshKeyPairGenerator()

Method Summary

Modifier and Type	Method and Description
static SshKeyPair	generateKeyPair(java.lang.String algorithm) Generate a new key pair using the default bit size.
static SshKeyPair	generateKeyPair(java.lang.String algorithm, int bits) Generates a new key pair.

Methods inherited from class java.lang.Object

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

Field Detail

SSH2_RSA

public static final java.lang.String SSH2_RSA

See Also:

Constant Field Values

ECDSA

public static final java.lang.String ECDSA

See Also:

Constant Field Values

ED25519

public static final java.lang.String ED25519

See Also:

Constant Field Values

Constructor Detail

SshKeyPairGenerator

public SshKeyPairGenerator()

Method Detail

generateKeyPair

public static SshKeyPair generateKeyPair(java.lang.String algorithm)
                                  throws java.io.IOException,
                                         SshException

Generate a new key pair using the default bit size.

Parameters:

algorithm -

Returns:

Throws:

java.io.IOException

SshException

generateKeyPair

public static SshKeyPair generateKeyPair(java.lang.String algorithm,
                                         int bits)
                                  throws java.io.IOException,
                                         SshException

Generates a new key pair.

Parameters:

algorithm -

bits -

Returns:

SshKeyPair

Throws:

java.io.IOException

SshException