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

Class OpenSSHKeyPairResourceWriter

java.lang.Object

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

All Implemented Interfaces:

KeyPairResourceWriter<OpenSSHKeyEncryptionContext>

public class OpenSSHKeyPairResourceWriter
extends java.lang.Object
implements KeyPairResourceWriter<OpenSSHKeyEncryptionContext>

A KeyPairResourceWriter for writing keys in the modern OpenSSH format, using the OpenBSD bcrypt KDF for passphrase-protected encrypted private keys.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DASHES
static OpenSSHKeyPairResourceWriter	INSTANCE
static int	LINE_LENGTH
private static java.util.regex.Pattern	VERTICALSPACE

Constructor Summary

Constructors

Constructor and Description
OpenSSHKeyPairResourceWriter()

Method Summary

Modifier and Type	Method and Description
static OpenSSHKeyEncryptionContext	determineEncryption(OpenSSHKeyEncryptionContext options)
static byte[]	encodePrivateKey(java.security.KeyPair key, java.lang.String keyType, int blockSize, java.lang.String comment)
static byte[]	encodePublicKey(java.security.PublicKey key, java.lang.String keyType)
static java.lang.String	firstLine(java.lang.String text)
static void	write(java.io.OutputStream out, byte[] bytes, int lineLength)
static void	write(java.io.OutputStream out, java.lang.String s)
void	writePrivateKey(java.security.KeyPair key, java.lang.String comment, OpenSSHKeyEncryptionContext options, java.io.OutputStream out) Writes a serialization of a private key from a given KeyPair to a given OutputStream.
void	writePublicKey(java.security.PublicKey key, java.lang.String comment, java.io.OutputStream out) Writes a serialization of a PublicKey to a given OutputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.config.keys.writer.KeyPairResourceWriter

writePublicKey

Field Detail

DASHES

public static final java.lang.String DASHES

See Also:

Constant Field Values

LINE_LENGTH

public static final int LINE_LENGTH

See Also:

Constant Field Values

INSTANCE

public static final OpenSSHKeyPairResourceWriter INSTANCE

VERTICALSPACE

private static final java.util.regex.Pattern VERTICALSPACE

Constructor Detail

OpenSSHKeyPairResourceWriter

public OpenSSHKeyPairResourceWriter()

Method Detail

writePrivateKey

public void writePrivateKey(java.security.KeyPair key,
                            java.lang.String comment,
                            OpenSSHKeyEncryptionContext options,
                            java.io.OutputStream out)
                     throws java.io.IOException,
                            java.security.GeneralSecurityException

Description copied from interface: KeyPairResourceWriter

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

Specified by:

writePrivateKey in interface KeyPairResourceWriter<OpenSSHKeyEncryptionContext>

Parameters:

key - to write the private key of

comment - to write with the private key

options - 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 - The OutputStream to write to - recommend using a SecureByteArrayOutputStream in order to reduce sensitive data exposure in memory

Throws:

java.io.IOException - if the key cannot be written

java.security.GeneralSecurityException - if the key is inconsistent or unknown, or the encryption specified cannot be applied

determineEncryption

public static OpenSSHKeyEncryptionContext determineEncryption(OpenSSHKeyEncryptionContext options)

encodePrivateKey

public static byte[] encodePrivateKey(java.security.KeyPair key,
                                      java.lang.String keyType,
                                      int blockSize,
                                      java.lang.String comment)
                               throws java.io.IOException,
                                      java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

encodePublicKey

public static byte[] encodePublicKey(java.security.PublicKey key,
                                     java.lang.String keyType)
                              throws java.io.IOException,
                                     java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

write

public static void write(java.io.OutputStream out,
                         byte[] bytes,
                         int lineLength)
                  throws java.io.IOException

Throws:

java.io.IOException

writePublicKey

public void writePublicKey(java.security.PublicKey key,
                           java.lang.String comment,
                           java.io.OutputStream out)
                    throws java.io.IOException,
                           java.security.GeneralSecurityException

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.

Specified by:

writePublicKey in interface KeyPairResourceWriter<OpenSSHKeyEncryptionContext>

Parameters:

key - to write

comment - to write with the key

out - The OutputStream to write to - recommend using a SecureByteArrayOutputStream in order to reduce sensitive data exposure in memory

Throws:

java.io.IOException - if the key cannot be written

java.security.GeneralSecurityException - if the key is unknown

firstLine

public static java.lang.String firstLine(java.lang.String text)

write

public static void write(java.io.OutputStream out,
                         java.lang.String s)
                  throws java.io.IOException

Throws:

java.io.IOException