org.apache.sshd.common.config.keys

Interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

All Known Implementing Classes:

AbstractPublicKeyEntryDecoder, DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, RSAPublicKeyDecoder

public interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Represents a decoder of an OpenSSH encoded key data

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
KeyPair	cloneKeyPair(KeyPair kp)
PRV	clonePrivateKey(PRV key)
PUB	clonePublicKey(PUB key)
PUB	decodePublicKey(byte... keyData)
PUB	decodePublicKey(byte[] keyData, int offset, int length)
PUB	decodePublicKey(InputStream keyData)
String	encodePublicKey(OutputStream s, PUB key) Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
KeyPair	generateKeyPair(int keySize)
KeyFactory	getKeyFactoryInstance()
KeyPairGenerator	getKeyPairGenerator()
Class<PRV>	getPrivateKeyType()
Class<PUB>	getPublicKeyType()
Collection<String>	getSupportedTypeNames()

Method Detail

getPublicKeyType

Class<PUB> getPublicKeyType()

Returns:

The Class of the PublicKey that is the result of decoding

getPrivateKeyType

Class<PRV> getPrivateKeyType()

Returns:

The Class of the PrivateKey that matches the public one

getSupportedTypeNames

Collection<String> getSupportedTypeNames()

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...

generateKeyPair

KeyPair generateKeyPair(int keySize)
                 throws GeneralSecurityException

Parameters:

keySize - Key size in bits

Returns:

A KeyPair with the specified key size

Throws:

GeneralSecurityException - if unable to generate the pair

cloneKeyPair

KeyPair cloneKeyPair(KeyPair kp)
              throws GeneralSecurityException

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:

getPublicKeyType(), getPrivateKeyType()

clonePublicKey

PUB clonePublicKey(PUB key)
            throws GeneralSecurityException

Parameters:

key - The PublicKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

GeneralSecurityException - If failed to clone the key

clonePrivateKey

PRV clonePrivateKey(PRV key)
             throws GeneralSecurityException

Parameters:

key - The PrivateKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

GeneralSecurityException - If failed to clone the key

getKeyPairGenerator

KeyPairGenerator getKeyPairGenerator()
                              throws GeneralSecurityException

Returns:

A KeyPairGenerator suitable for this decoder

Throws:

GeneralSecurityException - If failed to create the generator

decodePublicKey

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

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

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

Throws:

IOException

GeneralSecurityException

decodePublicKey

PUB decodePublicKey(InputStream keyData)
             throws IOException,
                    GeneralSecurityException

Throws:

IOException

GeneralSecurityException

encodePublicKey

String encodePublicKey(OutputStream s,
                       PUB key)
                throws IOException

Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)

Parameters:

s - The OutputStream to write the data to

key - The PublicKey - may not be null

Returns:

The key type value - one of the getSupportedTypeNames()

Throws:

IOException - If failed to generate the encoding

getKeyFactoryInstance

KeyFactory getKeyFactoryInstance()
                          throws GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

GeneralSecurityException - If failed to create one