Class PuTTYKeyFile

java.lang.Object

net.schmizz.sshj.userauth.keyprovider.BaseFileKeyProvider

net.schmizz.sshj.userauth.keyprovider.PuTTYKeyFile

All Implemented Interfaces:

FileKeyProvider, KeyProvider

public class PuTTYKeyFile
extends BaseFileKeyProvider

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

Version:

$Id:$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PuTTYKeyFile.Factory

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	headers	For each line that looks like "Xyz: vvv", it will be stored in this map.
private static final String	KEY_DERIVATION_HEADER
private Integer	keyFileVersion
private final Map<String,String>	payload
private byte[]	privateKey
private byte[]	publicKey
private byte[]	verifyHmac

Fields inherited from class BaseFileKeyProvider

kp, pwdf, resource, type

Constructor Summary

Constructors

Constructor	Description
PuTTYKeyFile()

Method Summary

Modifier and Type	Method	Description
private byte[]	decrypt(byte[] privateKey, char[] passphrase)	Decrypt private key
int	getKeyFileVersion()
KeyType	getType()	Key type
private void	initCipher(char[] passphrase, Cipher cipher)	Initialize Java Cipher for decryption using Secret Key derived from passphrase according to PuTTY Key Version
boolean	isEncrypted()
protected void	parseKeyPair()
private Mac	prepareVerifyMacV2(char[] passphrase)
private Mac	prepareVerifyMacV3()
protected KeyPair	readKeyPair()
private void	verify(Mac mac)	Verify the MAC (only required for v1/v2 keys.

Methods inherited from class BaseFileKeyProvider

getPrivate, getPublic, init, init, init, init, init, init, init, init

Methods inherited from class Object

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

Field Details

KEY_DERIVATION_HEADER

private static final String KEY_DERIVATION_HEADER

See Also:

• Constant Field Values

keyFileVersion

private Integer keyFileVersion

privateKey

private byte[] privateKey

publicKey

private byte[] publicKey

verifyHmac

private byte[] verifyHmac

payload

private final Map<String,String> payload

headers

private final Map<String,String> headers

For each line that looks like "Xyz: vvv", it will be stored in this map.

Constructor Details

PuTTYKeyFile

public PuTTYKeyFile()

Method Details

getType

public KeyType getType()
                throws IOException

Key type

Specified by:

getType in interface KeyProvider

Overrides:

getType in class BaseFileKeyProvider

Returns:

the KeyType.

Throws:

IOException - if there is an I/O error retrieving the key type

isEncrypted

public boolean isEncrypted()
                    throws IOException

Throws:

IOException

readKeyPair

protected KeyPair readKeyPair()
                       throws IOException

Specified by:

readKeyPair in class BaseFileKeyProvider

Throws:

IOException

parseKeyPair

protected void parseKeyPair()
                     throws IOException

Throws:

IOException

initCipher

private void initCipher(char[] passphrase,
 Cipher cipher)
                 throws InvalidAlgorithmParameterException,
InvalidKeyException

Initialize Java Cipher for decryption using Secret Key derived from passphrase according to PuTTY Key Version

Throws:

InvalidAlgorithmParameterException

InvalidKeyException

verify

private void verify(Mac mac)
             throws IOException

Verify the MAC (only required for v1/v2 keys. v3 keys are automatically verified as part of the decryption process.

Throws:

IOException

prepareVerifyMacV2

private Mac prepareVerifyMacV2(char[] passphrase)
                        throws IOException

Throws:

IOException

prepareVerifyMacV3

private Mac prepareVerifyMacV3()
                        throws IOException

Throws:

IOException

decrypt

private byte[] decrypt(byte[] privateKey,
 char[] passphrase)
                throws IOException

Decrypt private key

Parameters:

privateKey - the SSH private key to be decrypted

passphrase - To decrypt

Throws:

IOException

getKeyFileVersion

public int getKeyFileVersion()