org.apache.sshd.common.config.keys

Interface PublicKeyEntryDecoder<PUB extends java.security.PublicKey,PRV extends java.security.PrivateKey>

Type Parameters:

PUB - Type of PublicKey

PRV - Type of PrivateKey

All Superinterfaces:

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

All Known Implementing Classes:

AbstractPublicKeyEntryDecoder, DSSPublicKeyEntryDecoder, ECDSAPublicKeyEntryDecoder, Ed25519PublicKeyDecoder, RSAPublicKeyDecoder

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

Represents a decoder of an OpenSSH encoded key data

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	decodePublicKey(SessionContext session, java.lang.String keyType, byte... keyData)
default PUB	decodePublicKey(SessionContext session, java.lang.String keyType, byte[] keyData, int offset, int length)
PUB	decodePublicKey(SessionContext session, java.lang.String keyType, java.io.InputStream keyData)
default PUB	decodePublicKeyByType(SessionContext session, java.lang.String keyType, java.io.InputStream keyData)
java.lang.String	encodePublicKey(java.io.OutputStream s, PUB key) Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
default java.security.PublicKey	resolve(SessionContext session, java.lang.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, 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

Method Detail

resolve

default java.security.PublicKey resolve(SessionContext session,
                                        java.lang.String keyType,
                                        byte[] keyData)
                                 throws java.io.IOException,
                                        java.security.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

Returns:

The extracted PublicKey - ignored if null

Throws:

java.io.IOException - If failed to parse the key data

java.security.GeneralSecurityException - If failed to generate the key

decodePublicKey

default PUB decodePublicKey(SessionContext session,
                            java.lang.String keyType,
                            byte... keyData)
                     throws java.io.IOException,
                            java.security.GeneralSecurityException

Parameters:

session - The SessionContext for invoking this 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 key data bytes in OpenSSH format (after BASE64 decoding) - ignored if null/empty

Returns:

The decoded PublicKey - or null if no data

Throws:

java.io.IOException - If failed to decode the key

java.security.GeneralSecurityException - If failed to generate the key

decodePublicKey

default PUB decodePublicKey(SessionContext session,
                            java.lang.String keyType,
                            byte[] keyData,
                            int offset,
                            int length)
                     throws java.io.IOException,
                            java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

decodePublicKeyByType

default PUB decodePublicKeyByType(SessionContext session,
                                  java.lang.String keyType,
                                  java.io.InputStream keyData)
                           throws java.io.IOException,
                                  java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

decodePublicKey

PUB decodePublicKey(SessionContext session,
                    java.lang.String keyType,
                    java.io.InputStream keyData)
             throws java.io.IOException,
                    java.security.GeneralSecurityException

Parameters:

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

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:

java.io.IOException - If failed to read from the data stream

java.security.GeneralSecurityException - If failed to generate the key

encodePublicKey

java.lang.String encodePublicKey(java.io.OutputStream s,
                                 PUB key)
                          throws java.io.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:

java.io.IOException - If failed to generate the encoding