Modifier and Type	Class and Description
public static class	OpenSSHKeyPairResourceWriter.KeyEncryptor A key encryptor for modern-style OpenSSH private keys using the bcrypt KDF.

Modifier and Type	Field and Description
public static final String	DASHES
public static final OpenSSHKeyPairResourceWriter	INSTANCE
public static final int	LINE_LENGTH
private static final Pattern	VERTICALSPACE

Access	Constructor and Description
public	OpenSSHKeyPairResourceWriter()

Method Summary

Modifier and Type	Method and Description
public static OpenSSHKeyEncryptionContext	determineEncryption(OpenSSHKeyEncryptionContext options)
public static byte[]	encodePrivateKey(KeyPair key, String keyType, int blockSize, String comment)
public static byte[]	encodePublicKey(PublicKey key, String keyType)
public static String	firstLine(String text)
public static void	write(OutputStream out, byte[] bytes, int lineLength)
public static void	write(OutputStream out, String s)
public void	writePrivateKey(KeyPair to write the private key of key, String to write with the private key comment, OpenSSHKeyEncryptionContext for writing the key; may be `null` if no encryption is wanted. The caller is responsible for clearing the options when no longer needed. If the passphrase obtained from the context is `null` or an empty/blank string (length zero or containing only whitespace), the key is written unencrypted. options, OutputStream The `OutputStream` to write to - recommend using a `SecureByteArrayOutputStream` in order to reduce sensitive data exposure in memory out) Implements org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePrivateKey. Writes a serialization of a private key from a given `KeyPair` to a given `OutputStream`.
public void	writePublicKey(PublicKey to write key, String to write with the key comment, OutputStream The `OutputStream` to write to - recommend using a `SecureByteArrayOutputStream` in order to reduce sensitive data exposure in memory out) Implements org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePublicKey. Writes a serialization of a `PublicKey` to a given `OutputStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DASHES	back to summary
public static final String DASHES

INSTANCE	back to summary
public static final OpenSSHKeyPairResourceWriter INSTANCE

LINE_LENGTH	back to summary
public static final int LINE_LENGTH

VERTICALSPACE	back to summary
private static final Pattern VERTICALSPACE

Constructor Detail

OpenSSHKeyPairResourceWriter	back to summary
public OpenSSHKeyPairResourceWriter()

Method Detail

determineEncryption	back to summary
public static OpenSSHKeyEncryptionContext determineEncryption(OpenSSHKeyEncryptionContext options)

encodePrivateKey	back to summary
public static byte[] encodePrivateKey(KeyPair key, String keyType, int blockSize, String comment) throws IOException, GeneralSecurityException

encodePublicKey	back to summary
public static byte[] encodePublicKey(PublicKey key, String keyType) throws IOException, GeneralSecurityException

firstLine	back to summary
public static String firstLine(String text)

write	back to summary
public static void write(OutputStream out, byte[] bytes, int lineLength) throws IOException

write	back to summary
public static void write(OutputStream out, String s) throws IOException

writePrivateKey back to summary

writePrivateKey	back to summary
public void writePrivateKey(KeyPair key, String comment, OpenSSHKeyEncryptionContext options, OutputStream out) throws IOException, GeneralSecurityException Implements org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePrivateKey. Doc from org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePrivateKey. Writes a serialization of a private key from a given `KeyPair` to a given `OutputStream`. Parameters key:KeyPair to write the private key of comment:String to write with the private key options:OpenSSHKeyEncryptionContext for writing the key; may be `null` if no encryption is wanted. The caller is responsible for clearing the options when no longer needed. If the passphrase obtained from the context is `null` or an empty/blank string (length zero or containing only whitespace), the key is written unencrypted. out:OutputStream The `OutputStream` to write to - recommend using a `SecureByteArrayOutputStream` in order to reduce sensitive data exposure in memory Annotations @Override Exceptions IOException: if the key cannot be written GeneralSecurityException: if the key is inconsistent or unknown, or the encryption specified cannot be applied

public void writePrivateKey(KeyPair key, String comment, OpenSSHKeyEncryptionContext options, OutputStream out) throws IOException, GeneralSecurityException

Implements org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePrivateKey.

Doc from org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePrivateKey.

Writes a serialization of a private key from a given KeyPair to a given OutputStream.

Parameters

key:KeyPair: to write the private key of
comment:String: to write with the private key
options:OpenSSHKeyEncryptionContext: for writing the key; may be null if no encryption is wanted. The caller is responsible for clearing the options when no longer needed. If the passphrase obtained from the context is null or an empty/blank string (length zero or containing only whitespace), the key is written unencrypted.
out:OutputStream: The OutputStream to write to - recommend using a SecureByteArrayOutputStream in order to reduce sensitive data exposure in memory

Annotations

@Override

Exceptions

IOException:: if the key cannot be written
GeneralSecurityException:: if the key is inconsistent or unknown, or the encryption specified cannot be applied

writePublicKey back to summary

writePublicKey	back to summary
public void writePublicKey(PublicKey key, String comment, OutputStream out) throws IOException, GeneralSecurityException Implements org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePublicKey. Doc from org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePublicKey. Writes a serialization of a `PublicKey` to a given `OutputStream`. Writes the public key in the single-line OpenSSH format "key-type pub-key comment" without terminating line ending. If the comment has multiple lines, only the first line is written. Parameters key:PublicKey to write comment:String to write with the key out:OutputStream The `OutputStream` to write to - recommend using a `SecureByteArrayOutputStream` in order to reduce sensitive data exposure in memory Annotations @Override Exceptions IOException: if the key cannot be written GeneralSecurityException: if the key is unknown

public void writePublicKey(PublicKey key, String comment, OutputStream out) throws IOException, GeneralSecurityException

Implements org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePublicKey.

Doc from org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter.writePublicKey.

Writes a serialization of a PublicKey to a given OutputStream. Writes the public key in the single-line OpenSSH format "key-type pub-key comment" without terminating line ending. If the comment has multiple lines, only the first line is written.

Parameters

key:PublicKey: to write
comment:String: to write with the key
out:OutputStream: The OutputStream to write to - recommend using a SecureByteArrayOutputStream in order to reduce sensitive data exposure in memory

Annotations

@Override

Exceptions

IOException:: if the key cannot be written
GeneralSecurityException:: if the key is unknown

org.apache.sshd.common.config.keys.writer.openssh back to summary

public Class OpenSSHKeyPairResourceWriter.KeyEncryptor

Class Inheritance

extends AESPrivateKeyObfuscator

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

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

Field Summary

Modifier and Type	Field and Description
public static final int	BCRYPT_SALT_LENGTH
private byte[]	kdfOptions
protected final OpenSSHKeyEncryptionContext	options

Inherited from org.apache.sshd.common.config.keys.loader.AESPrivateKeyObfuscator:: CIPHER_NAME INSTANCE

Constructor Summary

Access	Constructor and Description
public	KeyEncryptor(OpenSSHKeyEncryptionContext options)

Method Summary

Modifier and Type	Method and Description
protected byte[]	convert(String password)
protected byte[]	Returns: `keyLength` bytes to use as encryption key deriveEncryptionKey(PrivateKeyEncryptionContext for the encryption, provides the passphrase and transports other encryption-related information including the IV context, int number of key bytes to generate keyLength) Overrides org.apache.sshd.common.config.keys.loader.AbstractPrivateKeyObfuscator.deriveEncryptionKey. Derives an encryption key and set the IV on the `context` from the passphase provided by the context using the OpenBSD `BCrypt` KDF.
public byte[]	Returns: the number of KDF rounds applied getKdfOptions() Retrieves the KDF options used.

Inherited from org.apache.sshd.common.config.keys.loader.AESPrivateKeyObfuscator:: applyPrivateKeyCipher createCipherSelector getAvailableKeyLengths getSupportedKeySizes resolveCipherInformation resolveInitializationVectorLength resolveKeyLength

Field Detail

BCRYPT_SALT_LENGTH	back to summary
public static final int BCRYPT_SALT_LENGTH

kdfOptions	back to summary
private byte[] kdfOptions

options	back to summary
protected final OpenSSHKeyEncryptionContext options

Constructor Detail

KeyEncryptor	back to summary
public KeyEncryptor(OpenSSHKeyEncryptionContext options)

Method Detail

convert	back to summary
protected byte[] convert(String password)

deriveEncryptionKey back to summary

deriveEncryptionKey	back to summary
protected byte[] deriveEncryptionKey(PrivateKeyEncryptionContext context, int keyLength) throws IOException, GeneralSecurityException Overrides org.apache.sshd.common.config.keys.loader.AbstractPrivateKeyObfuscator.deriveEncryptionKey. Derives an encryption key and set the IV on the `context` from the passphase provided by the context using the OpenBSD `BCrypt` KDF. Parameters context:PrivateKeyEncryptionContext for the encryption, provides the passphrase and transports other encryption-related information including the IV keyLength:int number of key bytes to generate Returns:byte[] `keyLength` bytes to use as encryption key Annotations @Override

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

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

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

Parameters

context:PrivateKeyEncryptionContext: for the encryption, provides the passphrase and transports other encryption-related information including the IV
keyLength:int: number of key bytes to generate

Returns:byte[]

keyLength bytes to use as encryption key

Annotations

@Override

getKdfOptions back to summary

getKdfOptions	back to summary
public byte[] getKdfOptions() Retrieves the KDF options used. Valid only after `deriveEncryptionKey(PrivateKeyEncryptionContext, int)` has been called. Returns:byte[] the number of KDF rounds applied

public byte[] getKdfOptions()

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

Returns:byte[]: the number of KDF rounds applied

public Class OpenSSHKeyPairResourceWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class OpenSSHKeyPairResourceWriter.KeyEncryptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail