Class OpenSSHCertificateDecoder

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.config.keys.impl.AbstractIdentityResourceLoader<OpenSshCertificate, OpenSshCertificate>

org.apache.sshd.common.config.keys.impl.AbstractKeyEntryResolver<OpenSshCertificate, OpenSshCertificate>

org.apache.sshd.common.config.keys.impl.AbstractPublicKeyEntryDecoder<OpenSshCertificate, OpenSshCertificate>

org.apache.sshd.common.config.keys.impl.OpenSSHCertificateDecoder

All Implemented Interfaces:

IdentityResourceLoader<OpenSshCertificate, OpenSshCertificate>, KeyEntryResolver<OpenSshCertificate, OpenSshCertificate>, KeyTypeNamesSupport, PublicKeyEntryDecoder<OpenSshCertificate, OpenSshCertificate>, PublicKeyEntryResolver, PublicKeyRawDataDecoder<OpenSshCertificate>

public class OpenSSHCertificateDecoder
extends AbstractPublicKeyEntryDecoder<OpenSshCertificate, OpenSshCertificate>

Field Summary

Fields

Modifier and Type	Field	Description
static final OpenSSHCertificateDecoder	INSTANCE

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface IdentityResourceLoader

MAX_BIGINT_OCTETS_COUNT

Fields inherited from interface PublicKeyEntryResolver

FAILING, IGNORING, UNSUPPORTED

Constructor Summary

Constructors

Constructor	Description
OpenSSHCertificateDecoder()

Method Summary

Modifier and Type	Method	Description
OpenSshCertificate	clonePrivateKey(OpenSshCertificate key)
OpenSshCertificate	clonePublicKey(OpenSshCertificate key)
OpenSshCertificate	decodePublicKey(SessionContext session, String keyType, InputStream keyData, Map<String,String> headers)
String	encodePublicKey(OutputStream s, OpenSshCertificate key)	Encodes the PublicKey using the OpenSSH format - same one used by the decodePublicKey method(s)
KeyFactory	getKeyFactoryInstance()
KeyPairGenerator	getKeyPairGenerator()

Methods inherited from class AbstractPublicKeyEntryDecoder

parseBooleanHeader

Methods inherited from class AbstractKeyEntryResolver

generatePrivateKey, generatePublicKey, toString

Methods inherited from class AbstractIdentityResourceLoader

getPrivateKeyType, getPublicKeyType, getSupportedKeyTypes

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface IdentityResourceLoader

getPrivateKeyType, getPublicKeyType

Methods inherited from interface KeyEntryResolver

cloneKeyPair, generateKeyPair

Methods inherited from interface KeyTypeNamesSupport

getSupportedKeyTypes

Methods inherited from interface PublicKeyEntryDecoder

decodePublicKeyByType, resolve

Methods inherited from interface PublicKeyRawDataDecoder

decodePublicKey, decodePublicKey

Field Details

INSTANCE

public static final OpenSSHCertificateDecoder INSTANCE

Constructor Details

OpenSSHCertificateDecoder

public OpenSSHCertificateDecoder()

Method Details

decodePublicKey

public OpenSshCertificate decodePublicKey(SessionContext session,
 String keyType,
 InputStream keyData,
 Map<String,String> headers)
                                   throws IOException,
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

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

Returns:

The decoded PublicKey

Throws:

IOException - If failed to read from the data stream

GeneralSecurityException - If failed to generate the key

encodePublicKey

public String encodePublicKey(OutputStream s,
 OpenSshCertificate key)
                       throws IOException

Description copied from interface: PublicKeyEntryDecoder

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

clonePublicKey

public OpenSshCertificate clonePublicKey(OpenSshCertificate key)
                                  throws GeneralSecurityException

Parameters:

key - The PublicKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

GeneralSecurityException - If failed to clone the key

clonePrivateKey

public OpenSshCertificate clonePrivateKey(OpenSshCertificate key)
                                   throws GeneralSecurityException

Parameters:

key - The PrivateKey to clone - ignored if null

Returns:

The cloned key (or null if no original key)

Throws:

GeneralSecurityException - If failed to clone the key

getKeyPairGenerator

public KeyPairGenerator getKeyPairGenerator()
                                     throws GeneralSecurityException

Returns:

A KeyPairGenerator suitable for this decoder

Throws:

GeneralSecurityException - If failed to create the generator

getKeyFactoryInstance

public KeyFactory getKeyFactoryInstance()
                                 throws GeneralSecurityException

Returns:

A KeyFactory suitable for the specific decoder type

Throws:

GeneralSecurityException - If failed to create one