org.apache.sshd.common.config.keys

Interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>

Type Parameters:

PUB - Type of PublicKey

PRV - Type of PrivateKey

All Superinterfaces:

KeyEntryResolver<PUB,PRV>, PublicKeyEntryResolver

All Known Implementing Classes:

AbstractPublicKeyEntryDecoder, DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, Ed25519PublicKeyDecoder, RSAPublicKeyDecoder

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

Represents a decoder of an OpenSSH encoded key data

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from interface org.apache.sshd.common.config.keys.PublicKeyEntryResolver

FAILING, IGNORING

Method Summary

Modifier and Type	Method and Description
default PUB	decodePublicKey(byte... keyData)
default PUB	decodePublicKey(byte[] keyData, int offset, int length)
default PUB	decodePublicKey(InputStream keyData)
PUB	decodePublicKey(String keyType, InputStream keyData)
String	encodePublicKey(OutputStream s, PUB key) Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
default PublicKey	resolve(String keyType, byte[] keyData)

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

cloneKeyPair, clonePrivateKey, clonePublicKey, decodeBigInt, decodeInt, decodeString, decodeString, decodeString, encodeBigInt, encodeInt, encodeString, encodeString, encodeString, generateKeyPair, getKeyFactoryInstance, getKeyPairGenerator, getPrivateKeyType, getPublicKeyType, getSupportedTypeNames, readRLEBytes, writeRLEBytes, writeRLEBytes

Method Detail

resolve

default PublicKey resolve(String keyType,
                          byte[] keyData)
                   throws IOException,
                          GeneralSecurityException

Specified by:

resolve in interface PublicKeyEntryResolver

Parameters:

keyType - The OpenSSH reported key type

keyData - The OpenSSH encoded key data

Returns:

The extracted PublicKey - ignored if null

Throws:

IOException - If failed to parse the key data

GeneralSecurityException - If failed to generate the key

decodePublicKey

default 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

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

Throws:

IOException

GeneralSecurityException

decodePublicKey

default PUB decodePublicKey(InputStream keyData)
                     throws IOException,
                            GeneralSecurityException

Throws:

IOException

GeneralSecurityException

decodePublicKey

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

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 KeyEntryResolver.getSupportedTypeNames()

Throws:

IOException - If failed to generate the encoding