org.apache.sshd.common.config.keys

Interface KeyEntryResolver<PUB extends PublicKey,PRV extends PrivateKey>

Type Parameters:

PUB - Type of PublicKey

PRV - Type of PrivateKey

All Known Subinterfaces:

PrivateKeyEntryDecoder<PUB,PRV>, PublicKeyEntryDecoder<PUB,PRV>

All Known Implementing Classes:

AbstractKeyEntryResolver, AbstractPrivateKeyEntryDecoder, AbstractPublicKeyEntryDecoder, DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, Ed25519PublicKeyDecoder, OpenSSHDSSPrivateKeyEntryDecoder, OpenSSHECDSAPrivateKeyEntryDecoder, OpenSSHEd25519PrivateKeyEntryDecoder, OpenSSHRSAPrivateKeyDecoder, RSAPublicKeyDecoder

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

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
default KeyPair	cloneKeyPair(KeyPair kp)
PRV	clonePrivateKey(PRV key)
PUB	clonePublicKey(PUB key)
static BigInteger	decodeBigInt(InputStream s)
static int	decodeInt(InputStream s)
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)
default KeyPair	generateKeyPair(int keySize)
KeyFactory	getKeyFactoryInstance()
KeyPairGenerator	getKeyPairGenerator()
Class<PRV>	getPrivateKeyType()
Class<PUB>	getPublicKeyType()
Collection<String>	getSupportedTypeNames()
static byte[]	readRLEBytes(InputStream s)
static int	writeRLEBytes(OutputStream s, byte... bytes)
static int	writeRLEBytes(OutputStream s, byte[] bytes, int off, int len)

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

default 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

default 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

getKeyFactoryInstance

KeyFactory getKeyFactoryInstance()
                          throws GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

GeneralSecurityException - If failed to create one

encodeString

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

Throws:

IOException

encodeString

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

Throws:

IOException

encodeString

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

Throws:

IOException

encodeBigInt

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

Throws:

IOException

writeRLEBytes

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

Throws:

IOException

writeRLEBytes

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

Throws:

IOException

encodeInt

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

Throws:

IOException

decodeString

static String decodeString(InputStream s)
                    throws IOException

Throws:

IOException

decodeString

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

Throws:

IOException

decodeString

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

Throws:

IOException

decodeBigInt

static BigInteger decodeBigInt(InputStream s)
                        throws IOException

Throws:

IOException

readRLEBytes

static byte[] readRLEBytes(InputStream s)
                    throws IOException

Throws:

IOException

decodeInt

static int decodeInt(InputStream s)
              throws IOException

Throws:

IOException