KeyPair (JSch API)

java.lang.Object
- com.jcraft.jsch.KeyPair

Direct Known Subclasses:

KeyPairDSA, KeyPairECDSA, KeyPairPKCS8, KeyPairRSA
```
public abstract class KeyPair
extends Object
```
Base class for a pair of public and private key. This class is used internally by the library and not necessary for normal use by the application.
An application may use this class to generate new keys with genKeyPair, and then write the KeyPair to files, which then might be used with JSch.addIdentity.

Another possible use would be to load a key pair in order to change the passphrase.

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`data`
`static int`	`DSA` Key type constant: DSA.
`static int`	`ECDSA`
`protected boolean`	`encrypted`
`static int`	`ERROR` Key type constant: some error occured, or the keypair was not initialized.
`protected String`	`publicKeyComment`
`static int`	`RSA` Key type constant: RSA.
`static int`	`UNKNOWN` Key type constant: unknown key type.

Constructor Summary

Constructors
Constructor and Description

KeyPair(JSch jsch)
Creates a new KeyPair.

Constructors
Constructor and Description
`KeyPair(JSch jsch)` Creates a new KeyPair.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`decrypt(byte[] _passphrase)` decrypts the private key, using a passphrase.
`boolean`	`decrypt(String _passphrase)` decrypts the private key, using a passphrase.
`void`	`dispose()` Disposes this key pair.
`void`	`finalize()` Called by the garbage collector when the object is not reachable anymore.
`abstract byte[]`	`forSSHAgent()`
`static KeyPair`	`genKeyPair(JSch jsch, int type)` Creates a new key pair with default key size of 1024 bits.
`static KeyPair`	`genKeyPair(JSch jsch, int type, int key_size)` Creates a new key pair.
`String`	`getFingerPrint()` Creates and returns a fingerprint of the public key, i.e. the hexadecimal representation of the MD5 hash of the public key.
`abstract int`	`getKeyType()` returns the type of the keys in this keypair, which is one of `RSA` and `DSA`.
`byte[]`	`getPublicKeyBlob()` Returns the blob of the public key.
`String`	`getPublicKeyComment()`
`abstract byte[]`	`getSignature(byte[] data)`
`abstract Signature`	`getVerifier()`
`boolean`	`isEncrypted()` checks whether the private key currently is encrypted.
`static KeyPair`	`load(JSch jsch, byte[] prvkey, byte[] pubkey)`
`static KeyPair`	`load(JSch jsch, String prvkey)` Loads a key pair from a pair of files.
`static KeyPair`	`load(JSch jsch, String prvfile, String pubfile)` Loads a key pair from a pair of files.
`void`	`setPassphrase(byte[] passphrase)` Deprecated. use #writePrivateKey(String name, byte[] passphrase)
`void`	`setPassphrase(String passphrase)` Deprecated. use #writePrivateKey(java.io.OutputStream out, byte[] passphrase)
`void`	`setPublicKeyComment(String publicKeyComment)`
`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 RFC 4716, The Secure Shell (SSH) Public Key File Format.
`void`	`writeSECSHPublicKey(String name, String comment)` Writes the public key with the specified comment to the output stream in the format defined in RFC 4716, The Secure Shell (SSH) Public Key File Format

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ERROR
```
public static final int ERROR
```
    Key type constant: some error occured, or the keypair was not initialized.
    
    See Also:
    
    Constant Field Values
  - DSA
```
public static final int DSA
```
    Key type constant: DSA.
    
    See Also:
    
    Constant Field Values
  - RSA
```
public static final int RSA
```
    Key type constant: RSA.
    
    See Also:
    
    Constant Field Values
  - ECDSA
```
public static final int ECDSA
```
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final int UNKNOWN
```
    Key type constant: unknown key type. This should not be used by the application.
    
    See Also:
    
    Constant Field Values
  - publicKeyComment
```
protected String publicKeyComment
```
  - encrypted
```
protected boolean encrypted
```
  - data
```
protected byte[] data
```
- Constructor Detail
  - KeyPair
```
public KeyPair(JSch jsch)
```
    Creates a new KeyPair.
    As this class is abstract, this constructor can actually only be called by subclasses, and should be protected instead of public. Actually, a default-access constructor would be enough, since this class already contains some abstract default-access methods and as such cannot be implemented outside the package.
- Method Detail
  - genKeyPair
```
public static KeyPair genKeyPair(JSch jsch,
                                 int type)
                          throws JSchException
```
    Creates a new key pair with default key size of 1024 bits.
    
    Parameters:
    
    jsch - the JSch object used for configuration purposes.
    
    type - one of DSA and RSA.
    
    Returns:
    
    null if a unknown type constant is given, else the new key pair.
    
    Throws:
    
    JSchException
  - genKeyPair
```
public static KeyPair genKeyPair(JSch jsch,
                                 int type,
                                 int key_size)
                          throws JSchException
```
    Creates a new key pair.
    
    Parameters:
    
    jsch - the JSch object used for configuration purposes.
    
    type - one of DSA and RSA.
    
    key_size - the size of the keys, in bits.
    
    Returns:
    
    null if a unknown type constant is given, else the new key pair.
    
    Throws:
    
    JSchException
  - getSignature
```
public abstract byte[] getSignature(byte[] data)
```
  - getVerifier
```
public abstract Signature getVerifier()
```
  - 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(java.io.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
  - getKeyType
```
public abstract int getKeyType()
```
    returns the type of the keys in this keypair, which is one of RSA and DSA.
  - 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(java.io.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 RFC 4716, The Secure Shell (SSH) Public Key File Format.
    
    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 RFC 4716, The Secure Shell (SSH) Public Key File Format
    
    Parameters:
    
    name - file name
    
    comment - comment
    
    Throws:
    
    FileNotFoundException
    
    IOException
    
    See Also:
    
    writeSECSHPublicKey(java.io.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(java.io.OutputStream out, byte[] passphrase)
  - getFingerPrint
```
public String getFingerPrint()
```
    Creates and returns a fingerprint of the public key, i.e. the hexadecimal representation of the MD5 hash of the public key.
  - setPassphrase
```
public void setPassphrase(String passphrase)
```
    Deprecated. use #writePrivateKey(java.io.OutputStream out, byte[] passphrase)
    
    Sets a passphrase for the private key. This will be used for encrypting the private key before writing it out.
  - setPassphrase
```
public void setPassphrase(byte[] passphrase)
```
    Deprecated. use #writePrivateKey(String name, byte[] passphrase)
    
    Sets a passphrase for the private key. This will be used for encrypting the private key before writing it out.
  - isEncrypted
```
public boolean isEncrypted()
```
    checks whether the private key currently is encrypted.
    
    Returns:
    
    true if the private key is encrypted, false if it is available in plain text.
  - decrypt
```
public boolean decrypt(String _passphrase)
```
    decrypts the private key, using a passphrase.
    
    Returns:
    
    true if the private key was successfully decrypted, i.e. is now usable, else false.
  - decrypt
```
public boolean decrypt(byte[] _passphrase)
```
    decrypts the private key, using a passphrase.
    
    Returns:
    
    true if the private key was successfully decrypted, i.e. is now usable, else false.
  - load
```
public static KeyPair load(JSch jsch,
                           String prvkey)
                    throws JSchException
```
    Loads a key pair from a pair of files.
    
    Parameters:
    
    jsch - the JSch object used to obtain configuration.
    
    prvkey - the file name of the private key file. The public key is expected in a file with same name and suffix .pub.
    
    Returns:
    
    the new KeyPair.
    
    Throws:
    
    JSchException
  - load
```
public static KeyPair load(JSch jsch,
                           String prvfile,
                           String pubfile)
                    throws JSchException
```
    Loads a key pair from a pair of files.
    
    Parameters:
    
    jsch - the JSch object used to obtain configuration.
    
    prvfile - the file name of the private key file.
    
    pubfile - the file name of the public key file.
    
    Returns:
    
    the new KeyPair.
    
    Throws:
    
    JSchException
  - load
```
public static KeyPair load(JSch jsch,
                           byte[] prvkey,
                           byte[] pubkey)
                    throws JSchException
```
    Throws:
    
    JSchException
  - dispose
```
public void dispose()
```
    Disposes this key pair. This throws away all private key material and the passphrase. (This method will be overwritten in subclasses.)
  - finalize
```
public void finalize()
```
    Called by the garbage collector when the object is not reachable anymore. We then call dispose(). There is no reason for this method to be public, it should be protected like in Object.
    
    Overrides:
    
    finalize in class Object

This is an inofficial Javadoc created by Paŭlo Ebermann. Have a look at the official homepage.

Class KeyPair

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR

DSA

RSA

ECDSA

UNKNOWN

publicKeyComment

encrypted

data

Constructor Detail

KeyPair

Method Detail

genKeyPair

genKeyPair

getSignature

getVerifier

forSSHAgent

getPublicKeyComment

setPublicKeyComment

writePrivateKey

writePrivateKey

getKeyType

getPublicKeyBlob

writePublicKey

writePublicKey

writeSECSHPublicKey

writeSECSHPublicKey

writePrivateKey

writePrivateKey

getFingerPrint

setPassphrase

setPassphrase

isEncrypted

decrypt

decrypt

load

load

load

dispose

finalize