Package org.apache.sshd.common.config.keys

Interface PrivateKeyEntryDecoder<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, PrivateKeyEntryResolver

All Known Implementing Classes:

AbstractPrivateKeyEntryDecoder, OpenSSHDSSPrivateKeyEntryDecoder, OpenSSHECDSAPrivateKeyEntryDecoder, OpenSSHEd25519PrivateKeyEntryDecoder, OpenSSHRSAPrivateKeyDecoder

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

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.PrivateKeyEntryResolver

FAILING, IGNORING

Method Summary

Modifier and Type	Method	Description
PRV	decodePrivateKey(SessionContext session, String keyType, FilePasswordProvider passwordProvider, InputStream keyData)
default PRV	decodePrivateKey(SessionContext session, FilePasswordProvider passwordProvider, byte... keyData)
default PRV	decodePrivateKey(SessionContext session, FilePasswordProvider passwordProvider, byte[] keyData, int offset, int length)
default PRV	decodePrivateKey(SessionContext session, FilePasswordProvider passwordProvider, InputStream keyData)
default String	encodePrivateKey(SecureByteArrayOutputStream s, PRV key, PUB pubKey)	Encodes the PrivateKey using the OpenSSH format - same one used by the decodePublicKey method(s)
default boolean	isPublicKeyRecoverySupported()
default PUB	recoverPublicKey(PRV prvKey)	Attempts to recover the public key given the private one
default PrivateKey	resolve(SessionContext session, String keyType, byte[] keyData)

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

getPrivateKeyType, getPublicKeyType

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

cloneKeyPair, clonePrivateKey, clonePublicKey, generateKeyPair, getKeyFactoryInstance, getKeyPairGenerator

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

getSupportedKeyTypes

Method Detail

resolve

default PrivateKey resolve(SessionContext session,
                           String keyType,
                           byte[] keyData)
                    throws IOException,
                           GeneralSecurityException

Specified by:

resolve in interface PrivateKeyEntryResolver

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 PrivateKey - ignored if null

Throws:

IOException - If failed to parse the key data

GeneralSecurityException - If failed to generate the key

decodePrivateKey

default PRV decodePrivateKey(SessionContext session,
                             FilePasswordProvider passwordProvider,
                             byte... keyData)
                      throws IOException,
                             GeneralSecurityException

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).

passwordProvider - The FilePasswordProvider to use in case the data is encrypted - may be null if no encrypted data is expected

keyData - The key data bytes in OpenSSH format (after BASE64 decoding) - ignored if null/empty

Returns:

The decoded PrivateKey - or null if no data

Throws:

IOException - If failed to decode the key

GeneralSecurityException - If failed to generate the key

decodePrivateKey

default PRV decodePrivateKey(SessionContext session,
                             FilePasswordProvider passwordProvider,
                             byte[] keyData,
                             int offset,
                             int length)
                      throws IOException,
                             GeneralSecurityException

Throws:

IOException

GeneralSecurityException

decodePrivateKey

default PRV decodePrivateKey(SessionContext session,
                             FilePasswordProvider passwordProvider,
                             InputStream keyData)
                      throws IOException,
                             GeneralSecurityException

Throws:

IOException

GeneralSecurityException

decodePrivateKey

PRV decodePrivateKey(SessionContext session,
                     String keyType,
                     FilePasswordProvider passwordProvider,
                     InputStream keyData)
              throws IOException,
                     GeneralSecurityException

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 reported / encode key type

passwordProvider - The FilePasswordProvider to use in case the data is encrypted - may be null if no encrypted data is expected

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 PrivateKey

Throws:

IOException - If failed to read from the data stream

GeneralSecurityException - If failed to generate the key

encodePrivateKey

default String encodePrivateKey(SecureByteArrayOutputStream s,
                                PRV key,
                                PUB pubKey)
                         throws IOException

Encodes the PrivateKey using the OpenSSH format - same one used by the decodePublicKey method(s)

Parameters:

s - The SecureByteArrayOutputStream to write the data to.

key - The PrivateKey - may not be null

pubKey - The PublicKey belonging to the private key - must be non-null if public key recovery is not supported

Returns:

The key type value - one of the KeyTypeNamesSupport.getSupportedKeyTypes() or null if encoding not supported

Throws:

IOException - If failed to generate the encoding

isPublicKeyRecoverySupported

default boolean isPublicKeyRecoverySupported()

recoverPublicKey

default PUB recoverPublicKey(PRV prvKey)
                      throws GeneralSecurityException

Attempts to recover the public key given the private one

Parameters:

prvKey - The PrivateKey

Returns:

The recovered PublicKey - null if cannot recover it

Throws:

GeneralSecurityException - If failed to generate the public key