Package com.hierynomus.sshj.userauth.keyprovider

Class OpenSSHKeyV1KeyFile

java.lang.Object

net.schmizz.sshj.userauth.keyprovider.BaseFileKeyProvider

com.hierynomus.sshj.userauth.keyprovider.OpenSSHKeyV1KeyFile

All Implemented Interfaces:

FileKeyProvider, KeyProvider

public class OpenSSHKeyV1KeyFile
extends BaseFileKeyProvider

Reads a key file in the new OpenSSH format. The format is described in the following document: Key Protocol

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenSSHKeyV1KeyFile.Factory

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte[]	AUTH_MAGIC
static final String	BCRYPT
private static final String	BEGIN
private static final String	END
protected final org.slf4j.Logger	log
private static final String	NONE_CIPHER
static final String	OPENSSH_PRIVATE_KEY
private PublicKey	pubKey
private static final Map<String,Factory.Named<Cipher>>	SUPPORTED_CIPHERS

Fields inherited from class net.schmizz.sshj.userauth.keyprovider.BaseFileKeyProvider

kp, pwdf, resource, type

Constructor Summary

Constructors

Constructor	Description
OpenSSHKeyV1KeyFile()

Method Summary

Modifier and Type	Method	Description
private boolean	checkHeader(BufferedReader reader)
private Cipher	createCipher(String cipherName)
private PrivateKey	createECDSAPrivateKey(KeyType kt, Buffer.PlainBuffer buffer, ECDSACurve ecdsaCurve)
private Buffer.PlainBuffer	decryptPrivateKey(byte[] privateKey, int privateKeyLength, String cipherName, String kdfName, byte[] kdfOptions)
PublicKey	getPublic()
void	init(File location, PasswordFinder pwdf)
void	init(Reader privateKey, Reader publicKey, PasswordFinder pwdf)
void	init(String privateKey, String publicKey, PasswordFinder pwdf)
private void	initializeCipher(String kdfName, byte[] kdfOptions, Cipher cipher)
private void	initPubKey(Reader publicKey)
private KeyPair	readDecodedKeyPair(Buffer.PlainBuffer keyBuffer)
private String	readEncodedKey(BufferedReader reader)
private byte[]	readEncryptedPrivateKey(byte[] privateKeyEncoded, Buffer.PlainBuffer inputBuffer)
protected KeyPair	readKeyPair()
private PublicKey	readPublicKey(Buffer.PlainBuffer plainBuffer)
private RSAPrivateCrtKeySpec	readRsaPrivateKeySpec(Buffer.PlainBuffer buffer)	Read RSA Private CRT Key Spec according to OpenSSH sshkey_private_deserialize in sshkey.c
private KeyPair	readUnencrypted(Buffer.PlainBuffer keyBuffer, PublicKey publicKey)

Methods inherited from class net.schmizz.sshj.userauth.keyprovider.BaseFileKeyProvider

getPrivate, getType, init, init, init, init, init

Methods inherited from class java.lang.Object

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

Field Details

BEGIN

private static final String BEGIN

See Also:

• Constant Field Values

END

private static final String END

See Also:

• Constant Field Values

AUTH_MAGIC

private static final byte[] AUTH_MAGIC

OPENSSH_PRIVATE_KEY

public static final String OPENSSH_PRIVATE_KEY

See Also:

• Constant Field Values

BCRYPT

public static final String BCRYPT

See Also:

• Constant Field Values

NONE_CIPHER

private static final String NONE_CIPHER

See Also:

• Constant Field Values

SUPPORTED_CIPHERS

private static final Map<String,Factory.Named<Cipher>> SUPPORTED_CIPHERS

pubKey

private PublicKey pubKey

log

protected final org.slf4j.Logger log

Constructor Details

OpenSSHKeyV1KeyFile

public OpenSSHKeyV1KeyFile()

Method Details

getPublic

public PublicKey getPublic()
                    throws IOException

Specified by:

getPublic in interface KeyProvider

Overrides:

getPublic in class BaseFileKeyProvider

Returns:

the public key.

Throws:

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

init

public void init(File location,
 PasswordFinder pwdf)

Specified by:

init in interface FileKeyProvider

Overrides:

init in class BaseFileKeyProvider

init

public void init(String privateKey,
 String publicKey,
 PasswordFinder pwdf)

Specified by:

init in interface FileKeyProvider

Overrides:

init in class BaseFileKeyProvider

init

public void init(Reader privateKey,
 Reader publicKey,
 PasswordFinder pwdf)

Specified by:

init in interface FileKeyProvider

Overrides:

init in class BaseFileKeyProvider

readKeyPair

protected KeyPair readKeyPair()
                       throws IOException

Specified by:

readKeyPair in class BaseFileKeyProvider

Throws:

IOException

initPubKey

private void initPubKey(Reader publicKey)
                 throws IOException

Throws:

IOException

readDecodedKeyPair

private KeyPair readDecodedKeyPair(Buffer.PlainBuffer keyBuffer)
                            throws IOException,
GeneralSecurityException

Throws:

IOException

GeneralSecurityException

readEncryptedPrivateKey

private byte[] readEncryptedPrivateKey(byte[] privateKeyEncoded,
 Buffer.PlainBuffer inputBuffer)
                                throws Buffer.BufferException

Throws:

Buffer.BufferException

decryptPrivateKey

private Buffer.PlainBuffer decryptPrivateKey(byte[] privateKey,
 int privateKeyLength,
 String cipherName,
 String kdfName,
 byte[] kdfOptions)
                                      throws IOException

Throws:

IOException

initializeCipher

private void initializeCipher(String kdfName,
 byte[] kdfOptions,
 Cipher cipher)
                       throws Buffer.BufferException

Throws:

Buffer.BufferException

createCipher

private Cipher createCipher(String cipherName)

readPublicKey

private PublicKey readPublicKey(Buffer.PlainBuffer plainBuffer)
                         throws Buffer.BufferException,
GeneralSecurityException

Throws:

Buffer.BufferException

GeneralSecurityException

readEncodedKey

private String readEncodedKey(BufferedReader reader)
                       throws IOException

Throws:

IOException

checkHeader

private boolean checkHeader(BufferedReader reader)
                     throws IOException

Throws:

IOException

readUnencrypted

private KeyPair readUnencrypted(Buffer.PlainBuffer keyBuffer,
 PublicKey publicKey)
                         throws IOException,
GeneralSecurityException

Throws:

IOException

GeneralSecurityException

createECDSAPrivateKey

private PrivateKey createECDSAPrivateKey(KeyType kt,
 Buffer.PlainBuffer buffer,
 ECDSACurve ecdsaCurve)
                                  throws GeneralSecurityException,
Buffer.BufferException

Throws:

GeneralSecurityException

Buffer.BufferException

readRsaPrivateKeySpec

private RSAPrivateCrtKeySpec readRsaPrivateKeySpec(Buffer.PlainBuffer buffer)
                                            throws Buffer.BufferException

Read RSA Private CRT Key Spec according to OpenSSH sshkey_private_deserialize in sshkey.c

Parameters:

buffer - Buffer

Returns:

RSA Private CRT Key Specification

Throws:

Buffer.BufferException - Thrown on failure to read from buffer