Class KeyPair

java.lang.Object

com.jcraft.jsch.KeyPair

public abstract class KeyPair
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Cipher	cipher
protected byte[]	data
static final int	DEFERRED	DEFERRED should not be be used.
static final int	DSA
static final int	ECDSA
static final int	ED25519
static final int	ED448
protected boolean	encrypted
static final int	ERROR
protected String	publicKeyComment
static final int	RSA
static final int	UNKNOWN

Method Summary

Modifier and Type	Method	Description
boolean	decrypt(byte[] _passphrase)
boolean	decrypt(String _passphrase)
void	dispose()
static byte[]	extractX509SubjectPublicKeyInfo(byte[] x509SubjectPublicKeyInfo, byte[] algorithmIdentifier, int keyLen)
void	finalize()
abstract byte[]	forSSHAgent()
static KeyPair	genKeyPair(JSch jsch, int type)
static KeyPair	genKeyPair(JSch jsch, int type, int key_size)
String	getFingerPrint()	Returns the finger-print of the public key.
abstract int	getKeySize()
abstract int	getKeyType()
String	getKeyTypeString()	Wrapper to provide the String representation of #getKeyTypeName().
byte[]	getPublicKeyBlob()	Returns the blob of the public key.
String	getPublicKeyComment()
abstract byte[]	getSignature(byte[] data)
abstract byte[]	getSignature(byte[] data, String alg)
abstract Signature	getVerifier()
abstract Signature	getVerifier(String alg)
boolean	isEncrypted()
static KeyPair	load(JSch jsch, byte[] prvkey, byte[] pubkey)
static KeyPair	load(JSch jsch, String prvkey)
static KeyPair	load(JSch jsch, String prvfile, String pubfile)
void	setPassphrase(byte[] passphrase)	Deprecated. use #writePrivateKey(String name, byte[] passphrase)
void	setPassphrase(String passphrase)	Deprecated. use #writePrivateKey(OutputStream out, byte[] passphrase)
void	setPublicKeyComment(String publicKeyComment)
void	writeOpenSSHv1PrivateKey(OutputStream out, byte[] passphrase)	Writes the cyphered private key to the given output stream.
void	writeOpenSSHv1PrivateKey(OutputStream out, byte[] passphrase, int rounds)	Writes the cyphered private key to the given output stream.
void	writeOpenSSHv1PrivateKey(OutputStream out, byte[] passphrase, String cipher)	Writes the cyphered private key to the given output stream.
void	writeOpenSSHv1PrivateKey(OutputStream out, byte[] passphrase, String cipher, int rounds)	Writes the cyphered private key to the given output stream.
void	writeOpenSSHv1PrivateKey(String name)	Writes the plain private key to the file.
void	writeOpenSSHv1PrivateKey(String name, byte[] passphrase)	Writes the cyphered private key to the file.
void	writeOpenSSHv1PrivateKey(String name, byte[] passphrase, int rounds)	Writes the cyphered private key to the file.
void	writeOpenSSHv1PrivateKey(String name, byte[] passphrase, String cipher)	Writes the cyphered private key to the file.
void	writeOpenSSHv1PrivateKey(String name, byte[] passphrase, String cipher, int rounds)	Writes the cyphered private key to the file.
void	writePrivateKey(OutputStream out)	Writes the plain private key to the given output stream.
void	writePrivateKey(OutputStream out, byte[] passphrase)	Writes the cyphered private key to the given output stream.
void	writePrivateKey(String name)	Writes the plain private key to the file.
void	writePrivateKey(String name, byte[] passphrase)	Writes the cyphered private key to the file.
void	writePublicKey(OutputStream out, String comment)	Writes the public key with the specified comment to the output stream.
void	writePublicKey(String name, String comment)	Writes the public key with the specified comment to the file.
void	writeSECSHPublicKey(OutputStream out, String comment)	Writes the public key with the specified comment to the output stream in the format defined in http://www.ietf.org/rfc/rfc4716.txt
void	writeSECSHPublicKey(String name, String comment)	Writes the public key with the specified comment to the output stream in the format defined in http://www.ietf.org/rfc/rfc4716.txt

Methods inherited from class java.lang.Object

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

Field Details

DEFERRED

public static final int DEFERRED

DEFERRED should not be be used.

See Also:

• Constant Field Values

ERROR

public static final int ERROR

See Also:

• Constant Field Values

DSA

public static final int DSA

See Also:

• Constant Field Values

RSA

public static final int RSA

See Also:

• Constant Field Values

ECDSA

public static final int ECDSA

See Also:

• Constant Field Values

UNKNOWN

public static final int UNKNOWN

See Also:

• Constant Field Values

ED25519

public static final int ED25519

See Also:

• Constant Field Values

ED448

public static final int ED448

See Also:

• Constant Field Values

publicKeyComment

protected String publicKeyComment

cipher

protected Cipher cipher

encrypted

protected boolean encrypted

data

protected byte[] data

Method Details

genKeyPair

public static KeyPair genKeyPair(JSch jsch,
 int type)
                          throws JSchException

Throws:

JSchException

genKeyPair

public static KeyPair genKeyPair(JSch jsch,
 int type,
 int key_size)
                          throws JSchException

Throws:

JSchException

getKeySize

public abstract int getKeySize()

getSignature

public abstract byte[] getSignature(byte[] data)

getSignature

public abstract byte[] getSignature(byte[] data,
 String alg)

getVerifier

public abstract Signature getVerifier()

getVerifier

public abstract Signature getVerifier(String alg)

forSSHAgent

public abstract byte[] forSSHAgent()
                            throws JSchException

Throws:

JSchException

getPublicKeyComment

public String getPublicKeyComment()

setPublicKeyComment

public void setPublicKeyComment(String publicKeyComment)

writePrivateKey

public void writePrivateKey(OutputStream out)

Writes the plain private key to the given output stream.

Parameters:

out - output stream

See Also:

• writePrivateKey(OutputStream out, byte[] passphrase)

writePrivateKey

public void writePrivateKey(OutputStream out,
 byte[] passphrase)

Writes the cyphered private key to the given output stream.

Parameters:

out - output stream

passphrase - a passphrase to encrypt the private key

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(OutputStream out,
 byte[] passphrase)
                              throws JSchException

Writes the cyphered private key to the given output stream.

Parameters:

out - output stream

passphrase - a passphrase to encrypt the private key

Throws:

JSchException

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(OutputStream out,
 byte[] passphrase,
 String cipher)
                              throws JSchException

Writes the cyphered private key to the given output stream.

Parameters:

out - output stream

passphrase - a passphrase to encrypt the private key

cipher - the cipher to use

Throws:

JSchException

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(OutputStream out,
 byte[] passphrase,
 int rounds)
                              throws JSchException

Writes the cyphered private key to the given output stream.

Parameters:

out - output stream

passphrase - a passphrase to encrypt the private key

rounds - the number of KDF rounds to use

Throws:

JSchException

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(OutputStream out,
 byte[] passphrase,
 String cipher,
 int rounds)
                              throws JSchException

Writes the cyphered private key to the given output stream.

Parameters:

out - output stream

passphrase - a passphrase to encrypt the private key

cipher - the cipher to use

rounds - the number of KDF rounds to use

Throws:

JSchException

getKeyType

public abstract int getKeyType()

getKeyTypeString

public String getKeyTypeString()

Wrapper to provide the String representation of #getKeyTypeName().

Returns:

the standard SSH key type string

getPublicKeyBlob

public byte[] getPublicKeyBlob()

Returns the blob of the public key.

Returns:

blob of the public key

writePublicKey

public void writePublicKey(OutputStream out,
 String comment)

Writes the public key with the specified comment to the output stream.

Parameters:

out - output stream

comment - comment

writePublicKey

public void writePublicKey(String name,
 String comment)
                    throws FileNotFoundException,
IOException

Writes the public key with the specified comment to the file.

Parameters:

name - file name

comment - comment

Throws:

FileNotFoundException

IOException

See Also:

• writePublicKey(OutputStream out, String comment)

writeSECSHPublicKey

public void writeSECSHPublicKey(OutputStream out,
 String comment)

Writes the public key with the specified comment to the output stream in the format defined in http://www.ietf.org/rfc/rfc4716.txt

Parameters:

out - output stream

comment - comment

writeSECSHPublicKey

public void writeSECSHPublicKey(String name,
 String comment)
                         throws FileNotFoundException,
IOException

Writes the public key with the specified comment to the output stream in the format defined in http://www.ietf.org/rfc/rfc4716.txt

Parameters:

name - file name

comment - comment

Throws:

FileNotFoundException

IOException

See Also:

• writeSECSHPublicKey(OutputStream out, String comment)

writePrivateKey

public void writePrivateKey(String name)
                     throws FileNotFoundException,
IOException

Writes the plain private key to the file.

Parameters:

name - file name

Throws:

FileNotFoundException

IOException

See Also:

• writePrivateKey(String name, byte[] passphrase)

writePrivateKey

public void writePrivateKey(String name,
 byte[] passphrase)
                     throws FileNotFoundException,
IOException

Writes the cyphered private key to the file.

Parameters:

name - file name

passphrase - a passphrase to encrypt the private key

Throws:

FileNotFoundException

IOException

See Also:

• writePrivateKey(OutputStream out, byte[] passphrase)

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(String name)
                              throws FileNotFoundException,
IOException,
JSchException

Writes the plain private key to the file.

Parameters:

name - file name

Throws:

FileNotFoundException

IOException

JSchException

See Also:

• writePrivateKey(String name, byte[] passphrase)

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(String name,
 byte[] passphrase)
                              throws FileNotFoundException,
IOException,
JSchException

Writes the cyphered private key to the file.

Parameters:

name - file name

passphrase - a passphrase to encrypt the private key

Throws:

FileNotFoundException

IOException

JSchException

See Also:

• writePrivateKey(OutputStream out, byte[] passphrase)

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(String name,
 byte[] passphrase,
 int rounds)
                              throws FileNotFoundException,
IOException,
JSchException

Writes the cyphered private key to the file.

Parameters:

name - file name

passphrase - a passphrase to encrypt the private key

rounds - the number of KDF rounds to use

Throws:

FileNotFoundException

IOException

JSchException

See Also:

• writePrivateKey(OutputStream out, byte[] passphrase)

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(String name,
 byte[] passphrase,
 String cipher)
                              throws FileNotFoundException,
IOException,
JSchException

Writes the cyphered private key to the file.

Parameters:

name - file name

passphrase - a passphrase to encrypt the private key

cipher - the cipher to use

Throws:

FileNotFoundException

IOException

JSchException

See Also:

• writePrivateKey(OutputStream out, byte[] passphrase)

writeOpenSSHv1PrivateKey

public void writeOpenSSHv1PrivateKey(String name,
 byte[] passphrase,
 String cipher,
 int rounds)
                              throws FileNotFoundException,
IOException,
JSchException

Writes the cyphered private key to the file.

Parameters:

name - file name

passphrase - a passphrase to encrypt the private key

cipher - the cipher to use

rounds - the number of KDF rounds to use

Throws:

FileNotFoundException

IOException

JSchException

See Also:

• writePrivateKey(OutputStream out, byte[] passphrase)

getFingerPrint

public String getFingerPrint()

Returns the finger-print of the public key.

Returns:

finger print

setPassphrase

@Deprecated
public void setPassphrase(String passphrase)

Deprecated.

use #writePrivateKey(OutputStream out, byte[] passphrase)

setPassphrase

@Deprecated
public void setPassphrase(byte[] passphrase)

Deprecated.

use #writePrivateKey(String name, byte[] passphrase)

isEncrypted

public boolean isEncrypted()

decrypt

public boolean decrypt(String _passphrase)

decrypt

public boolean decrypt(byte[] _passphrase)

load

public static KeyPair load(JSch jsch,
 String prvkey)
                    throws JSchException

Throws:

JSchException

load

public static KeyPair load(JSch jsch,
 String prvfile,
 String pubfile)
                    throws JSchException

Throws:

JSchException

load

public static KeyPair load(JSch jsch,
 byte[] prvkey,
 byte[] pubkey)
                    throws JSchException

Throws:

JSchException

dispose

public void dispose()

finalize

public void finalize()

Overrides:

finalize in class Object

extractX509SubjectPublicKeyInfo

public static byte[] extractX509SubjectPublicKeyInfo(byte[] x509SubjectPublicKeyInfo,
 byte[] algorithmIdentifier,
 int keyLen)
                                              throws JSchException

Throws:

JSchException