org.apache.sshd.common.config.keys.writer.openssh

Class OpenSSHKeyPairResourceWriter.KeyEncryptor

java.lang.Object

org.apache.sshd.common.config.keys.loader.AbstractPrivateKeyObfuscator

org.apache.sshd.common.config.keys.loader.AESPrivateKeyObfuscator

org.apache.sshd.common.config.keys.writer.openssh.OpenSSHKeyPairResourceWriter.KeyEncryptor

All Implemented Interfaces:

PrivateKeyObfuscator

Enclosing class:

OpenSSHKeyPairResourceWriter

public static class OpenSSHKeyPairResourceWriter.KeyEncryptor
extends AESPrivateKeyObfuscator

A key encryptor for modern-style OpenSSH private keys using the bcrypt KDF.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BCRYPT_SALT_LENGTH
protected OpenSSHKeyEncryptionContext	options

Fields inherited from class org.apache.sshd.common.config.keys.loader.AESPrivateKeyObfuscator

CIPHER_NAME, INSTANCE

Constructor Summary

Constructors

Constructor and Description
KeyEncryptor(OpenSSHKeyEncryptionContext options)

Method Summary

Modifier and Type	Method and Description
protected byte[]	convert(String password)
protected byte[]	deriveEncryptionKey(PrivateKeyEncryptionContext context, int keyLength) Derives an encryption key and set the IV on the context from the passphase provided by the context using the OpenBSD BCrypt KDF.
byte[]	getKdfOptions() Retrieves the KDF options used.

Methods inherited from class org.apache.sshd.common.config.keys.loader.AESPrivateKeyObfuscator

applyPrivateKeyCipher, createCipherSelector, getAvailableKeyLengths, getSupportedKeySizes, resolveCipherInformation, resolveInitializationVectorLength, resolveKeyLength

Methods inherited from class org.apache.sshd.common.config.keys.loader.AbstractPrivateKeyObfuscator

appendPrivateKeyEncryptionContext, applyPrivateKeyCipher, generateInitializationVector, getCipherName

Methods inherited from class java.lang.Object

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

Field Detail

BCRYPT_SALT_LENGTH

public static final int BCRYPT_SALT_LENGTH

See Also:

Constant Field Values

options

protected final OpenSSHKeyEncryptionContext options

Constructor Detail

KeyEncryptor

public KeyEncryptor(OpenSSHKeyEncryptionContext options)

Method Detail

getKdfOptions

public byte[] getKdfOptions()

Retrieves the KDF options used. Valid only after deriveEncryptionKey(PrivateKeyEncryptionContext, int) has been called.

Returns:

the number of KDF rounds applied

deriveEncryptionKey

protected byte[] deriveEncryptionKey(PrivateKeyEncryptionContext context,
                                     int keyLength)
                              throws IOException,
                                     GeneralSecurityException

Derives an encryption key and set the IV on the context from the passphase provided by the context using the OpenBSD BCrypt KDF.

Overrides:

deriveEncryptionKey in class AbstractPrivateKeyObfuscator

Parameters:

context - for the encryption, provides the passphrase and transports other encryption-related information including the IV

keyLength - number of key bytes to generate

Returns:

keyLength bytes to use as encryption key

Throws:

IOException

GeneralSecurityException

convert

protected byte[] convert(String password)