Interface PublicKeyEntryDecoder

All Superinterfaces:

KeyEntryResolver, KeyTypeNamesSupport, PublicKeyEntryResolver, PublicKeyRawDataDecoder

All Known Implementing Classes:

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

public interface PublicKeyEntryDecoder
extends KeyEntryResolver, PublicKeyRawDataDecoder, PublicKeyEntryResolver

Represents a decoder of an OpenSSH encoded key data

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from interface KeyEntryResolver

MAX_BIGINT_OCTETS_COUNT

Fields inherited from interface PublicKeyEntryResolver

FAILING, IGNORING, UNSUPPORTED

Method Summary

Modifier and Type	Method	Description
default PublicKey	decodePublicKeyByType(SessionContext session, String keyType, InputStream keyData, Map<String,String> headers)
String	encodePublicKey(OutputStream s, PublicKey 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 KeyEntryResolver

generateKeyPair, getKeyFactoryInstance, getKeyPairGenerator

Methods inherited from interface KeyTypeNamesSupport

getSupportedKeyTypes

Methods inherited from interface PublicKeyRawDataDecoder

decodePublicKey, decodePublicKey, decodePublicKey

Method Details

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 PublicKey decodePublicKeyByType(SessionContext session,
 String keyType,
 InputStream keyData,
 Map<String,String> headers)
                                 throws IOException,
GeneralSecurityException

Specified by:

decodePublicKeyByType in interface PublicKeyRawDataDecoder

Throws:

IOException

GeneralSecurityException

encodePublicKey

String encodePublicKey(OutputStream s,
 PublicKey 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