org.kohsuke.putty

Class PuTTYKey

java.lang.Object

org.kohsuke.putty.PuTTYKey

public class PuTTYKey
extends Object

Interprets PuTTY's ".ppk" file.

Notes

1. The file appears to be a text file but it doesn't have the fixed encoding. So we just use the platform default encoding, which is what PuTTY seems to use. Fortunately, the important part is all ASCII, so this shouldn't really hurt the interpretation of the key.

Sample PuTTY file format

PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20080514
Public-Lines: 4
AAAAB3NzaC1yc2EAAAABJQAAAIEAiPVUpONjGeVrwgRPOqy3Ym6kF/f8bltnmjA2
BMdAtaOpiD8A2ooqtLS5zWYuc0xkW0ogoKvORN+RF4JI+uNUlkxWxnzJM9JLpnvA
HrMoVFaQ0cgDMIHtE1Ob1cGAhlNInPCRnGNJpBNcJ/OJye3yt7WqHP4SPCCLb6nL
nmBUrLM=
Private-Lines: 8
AAAAgGtYgJzpktzyFjBIkSAmgeVdozVhgKmF6WsDMUID9HKwtU8cn83h6h7ug8qA
hUWcvVxO201/vViTjWVz9ALph3uMnpJiuQaaNYIGztGJBRsBwmQW9738pUXcsUXZ
79KJP01oHn6Wkrgk26DIOsz04QOBI6C8RumBO4+F1WdfueM9AAAAQQDmA4hcK8Bx
nVtEpcF310mKD3nsbJqARdw5NV9kCxPnEsmy7Sy1L4Ob/nTIrynbc3MA9HQVJkUz
7V0va5Pjm/T7AAAAQQCYbnG0UEekwk0LG1Hkxh1OrKMxCw2KWMN8ac3L0LVBg/Tk
8EnB2oT45GGeJaw7KzdoOMFZz0iXLsVLNUjNn2mpAAAAQQCN6SEfWqiNzyc/w5n/
lFVDHExfVUJp0wXv+kzZzylnw4fs00lC3k4PZDSsb+jYCMesnfJjhDgkUA0XPyo8
Emdk
Private-MAC: 50c45751d18d74c00fca395deb7b7695e3ed6f77
 

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
PuTTYKey(File ppkFile, String passphrase)
PuTTYKey(InputStream in, String passphrase)
PuTTYKey(Reader in, String passphrase)

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm() Key type.
static boolean	isPuTTYKeyFile(File ppkFile) Checks if the given file is a PuTTY's ".ppk" file, by looking at the file contents.
static boolean	isPuTTYKeyFile(InputStream in)
static boolean	isPuTTYKeyFile(Reader _reader)
String	toOpenSSH() Converts this key into OpenSSH format.
void	toOpenSSH(File f) Converts the key to OpenSSH format, then write it to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PuTTYKey

public PuTTYKey(File ppkFile,
                String passphrase)
         throws IOException

Throws:

IOException

PuTTYKey

public PuTTYKey(InputStream in,
                String passphrase)
         throws IOException

Throws:

IOException

PuTTYKey

public PuTTYKey(Reader in,
                String passphrase)
         throws IOException

Throws:

IOException

Method Detail

getAlgorithm

public String getAlgorithm()

Key type. Either "ssh-rsa" for RSA key, or "ssh-dss" for DSA key.

toOpenSSH

public String toOpenSSH()
                 throws IOException

Converts this key into OpenSSH format.

Returns:

A multi-line string that can be written back to a file.

Throws:

IOException

toOpenSSH

public void toOpenSSH(File f)
               throws IOException

Converts the key to OpenSSH format, then write it to a file.

Throws:

IOException

isPuTTYKeyFile

public static boolean isPuTTYKeyFile(File ppkFile)
                              throws IOException

Checks if the given file is a PuTTY's ".ppk" file, by looking at the file contents.

Throws:

IOException

isPuTTYKeyFile

public static boolean isPuTTYKeyFile(InputStream in)
                              throws IOException

Throws:

IOException

isPuTTYKeyFile

public static boolean isPuTTYKeyFile(Reader _reader)
                              throws IOException

Throws:

IOException