org.apache.sshd.common.config.keys

Class AbstractPublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

java.lang.Object

org.apache.sshd.common.config.keys.AbstractPublicKeyEntryDecoder<PUB,PRV>

All Implemented Interfaces:

PublicKeyEntryDecoder<PUB,PRV>

Direct Known Subclasses:

DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, RSAPublicKeyDecoder

public abstract class AbstractPublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>
extends Object
implements PublicKeyEntryDecoder<PUB,PRV>

Author:

Apache MINA SSHD Project

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPublicKeyEntryDecoder(Class<PUB> pubType, Class<PRV> prvType, Collection<String> names)

Method Summary

Modifier and Type	Method and Description
KeyPair	cloneKeyPair(KeyPair kp)
static BigInteger	decodeBigInt(InputStream s)
static int	decodeInt(InputStream s)
PUB	decodePublicKey(byte... keyData)
PUB	decodePublicKey(byte[] keyData, int offset, int length)
PUB	decodePublicKey(InputStream keyData)
abstract PUB	decodePublicKey(String keyType, InputStream keyData)
static String	decodeString(InputStream s)
static String	decodeString(InputStream s, Charset cs)
static String	decodeString(InputStream s, String charset)
static int	encodeBigInt(OutputStream s, BigInteger v)
static byte[]	encodeInt(OutputStream s, int v)
static int	encodeString(OutputStream s, String v)
static int	encodeString(OutputStream s, String v, Charset cs)
static int	encodeString(OutputStream s, String v, String charset)
KeyPair	generateKeyPair(int keySize)
PRV	generatePrivateKey(KeySpec keySpec)
PUB	generatePublicKey(KeySpec keySpec)
Class<PRV>	getPrivateKeyType()
Class<PUB>	getPublicKeyType()
Collection<String>	getSupportedTypeNames()
static byte[]	readRLEBytes(InputStream s)
String	toString()
static int	writeRLEBytes(OutputStream s, byte... bytes)
static int	writeRLEBytes(OutputStream s, byte[] bytes, int off, int len)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.config.keys.PublicKeyEntryDecoder

clonePrivateKey, clonePublicKey, encodePublicKey, getKeyFactoryInstance, getKeyPairGenerator

Constructor Detail

AbstractPublicKeyEntryDecoder

protected AbstractPublicKeyEntryDecoder(Class<PUB> pubType,
                                        Class<PRV> prvType,
                                        Collection<String> names)

Method Detail

getPublicKeyType

public final Class<PUB> getPublicKeyType()

Specified by:

getPublicKeyType in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Returns:

The Class of the PublicKey that is the result of decoding

getPrivateKeyType

public final Class<PRV> getPrivateKeyType()

Specified by:

getPrivateKeyType in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Returns:

The Class of the PrivateKey that matches the public one

cloneKeyPair

public KeyPair cloneKeyPair(KeyPair kp)
                     throws GeneralSecurityException

Specified by:

cloneKeyPair in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Parameters:

kp - The KeyPair to be cloned - ignored if null

Returns:

A cloned pair (or null if no original pair)

Throws:

GeneralSecurityException - If failed to clone - e.g., provided key pair does not contain keys of the expected type

See Also:

PublicKeyEntryDecoder.getPublicKeyType(), PublicKeyEntryDecoder.getPrivateKeyType()

getSupportedTypeNames

public Collection<String> getSupportedTypeNames()

Specified by:

getSupportedTypeNames in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Returns:

The Collection of OpenSSH key type names that are supported by this decoder - e.g., ECDSA keys have several curve names. Caveat: this collection may be un-modifiable...

decodePublicKey

public PUB decodePublicKey(byte... keyData)
                    throws IOException,
                           GeneralSecurityException

Specified by:

decodePublicKey in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Parameters:

keyData - The key data bytes in OpenSSH format (after BASE64 decoding) - ignored if null/empty

Returns:

The decoded PublicKey - or null if no data

Throws:

IOException - If failed to decode the key

GeneralSecurityException - If failed to generate the key

decodePublicKey

public PUB decodePublicKey(byte[] keyData,
                           int offset,
                           int length)
                    throws IOException,
                           GeneralSecurityException

Specified by:

decodePublicKey in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Throws:

IOException

GeneralSecurityException

decodePublicKey

public PUB decodePublicKey(InputStream keyData)
                    throws IOException,
                           GeneralSecurityException

Specified by:

decodePublicKey in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Throws:

IOException

GeneralSecurityException

generatePublicKey

public PUB generatePublicKey(KeySpec keySpec)
                      throws GeneralSecurityException

Throws:

GeneralSecurityException

generatePrivateKey

public PRV generatePrivateKey(KeySpec keySpec)
                       throws GeneralSecurityException

Throws:

GeneralSecurityException

decodePublicKey

public abstract PUB decodePublicKey(String keyType,
                                    InputStream keyData)
                             throws IOException,
                                    GeneralSecurityException

Parameters:

keyType - The reported / encode key type

keyData - The key data bytes stream positioned after the key type decoding and making sure it is one of the supported types

Returns:

The decoded PublicKey

Throws:

IOException - If failed to read from the data stream

GeneralSecurityException - If failed to generate the key

generateKeyPair

public KeyPair generateKeyPair(int keySize)
                        throws GeneralSecurityException

Specified by:

generateKeyPair in interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Parameters:

keySize - Key size in bits

Returns:

A KeyPair with the specified key size

Throws:

GeneralSecurityException - if unable to generate the pair

toString

public String toString()

Overrides:

toString in class Object

encodeString

public static int encodeString(OutputStream s,
                               String v)
                        throws IOException

Throws:

IOException

encodeString

public static int encodeString(OutputStream s,
                               String v,
                               String charset)
                        throws IOException

Throws:

IOException

encodeString

public static int encodeString(OutputStream s,
                               String v,
                               Charset cs)
                        throws IOException

Throws:

IOException

encodeBigInt

public static int encodeBigInt(OutputStream s,
                               BigInteger v)
                        throws IOException

Throws:

IOException

writeRLEBytes

public static int writeRLEBytes(OutputStream s,
                                byte... bytes)
                         throws IOException

Throws:

IOException

writeRLEBytes

public static int writeRLEBytes(OutputStream s,
                                byte[] bytes,
                                int off,
                                int len)
                         throws IOException

Throws:

IOException

encodeInt

public static byte[] encodeInt(OutputStream s,
                               int v)
                        throws IOException

Throws:

IOException

decodeString

public static String decodeString(InputStream s)
                           throws IOException

Throws:

IOException

decodeString

public static String decodeString(InputStream s,
                                  String charset)
                           throws IOException

Throws:

IOException

decodeString

public static String decodeString(InputStream s,
                                  Charset cs)
                           throws IOException

Throws:

IOException

decodeBigInt

public static BigInteger decodeBigInt(InputStream s)
                               throws IOException

Throws:

IOException

readRLEBytes

public static byte[] readRLEBytes(InputStream s)
                           throws IOException

Throws:

IOException

decodeInt

public static int decodeInt(InputStream s)
                     throws IOException

Throws:

IOException