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:

IdentityResourceLoader<PUB,PRV>, KeyEntryResolver<PUB,PRV>, KeyTypeNamesSupport, PublicKeyEntryResolver, PublicKeyRawDataDecoder<PUB>

All Known Implementing Classes:

AbstractPublicKeyEntryDecoder, DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, Ed25519PublicKeyDecoder, OpenSSHCertificateDecoder, RSAPublicKeyDecoder, SkECDSAPublicKeyEntryDecoder, SkED25519PublicKeyEntryDecoder

public interface PublicKeyEntryDecoder<PUB extends PublicKey,PRV extends PrivateKey>
extends KeyEntryResolver<PUB,PRV>, PublicKeyRawDataDecoder<PUB>, 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.IdentityResourceLoader

MAX_BIGINT_OCTETS_COUNT

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

FAILING, IGNORING

Method Summary

Modifier and Type	Method and Description
default PUB	decodePublicKeyByType(SessionContext session, String keyType, InputStream keyData, Map<String,String> headers)
String	encodePublicKey(OutputStream s, PUB key) Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
default PublicKey	resolve(SessionContext session, String keyType, byte[] keyData, Map<String,String> headers)

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

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

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

getPrivateKeyType, getPublicKeyType

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

findSupporterByKeyTypeName, getSupportedKeyTypes

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

decodePublicKey, decodePublicKey, decodePublicKey

Method Detail

resolve

default PublicKey resolve(SessionContext session,
                          String keyType,
                          byte[] keyData,
                          Map<String,String> headers)
                   throws IOException,
                          GeneralSecurityException

Specified by:

resolve in interface PublicKeyEntryResolver

Parameters:

session - The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).

keyType - The OpenSSH reported key type

keyData - The OpenSSH encoded key data

headers - Any headers that may have been available when data was read

Returns:

The extracted PublicKey - ignored if null

Throws:

IOException - If failed to parse the key data

GeneralSecurityException - If failed to generate the key

decodePublicKeyByType

default PUB decodePublicKeyByType(SessionContext session,
                                  String keyType,
                                  InputStream keyData,
                                  Map<String,String> headers)
                           throws IOException,
                                  GeneralSecurityException

Specified by:

decodePublicKeyByType in interface PublicKeyRawDataDecoder<PUB extends PublicKey>

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 KeyTypeNamesSupport.getSupportedKeyTypes()

Throws:

IOException - If failed to generate the encoding