Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.keys.PublicKeyEntryDecoder

Method Summary

Modifier and Type	Method and Description
public default PUB	decodePublicKeyByType(SessionContext session, String keyType, InputStream keyData, Map<String, String> headers) Implements org.apache.sshd.common.config.keys.PublicKeyRawDataDecoder.decodePublicKeyByType.
public String	Returns: The key type value - one of the `getSupportedKeyTypes()` encodePublicKey(OutputStream The `OutputStream` to write the data to s, PUB The `PublicKey` - may not be `null` key) Encodes the `PublicKey` using the `OpenSSH` format - same one used by the `decodePublicKey` method(s)
public default PublicKey	resolve(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). session, String The `OpenSSH` reported key type keyType, byte[] The `OpenSSH` encoded key data keyData, Map<String, String> Any headers that may have been available when data was read headers) Implements org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve.

Modifier and Type

Method and Description

public default PUB

public String

Returns:

The key type value - one of the getSupportedKeyTypes()

The OutputStream to write the data to

s, PUB

The PublicKey - may not be null

key)

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

public default PublicKey

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

session, String

The OpenSSH reported key type

keyType, byte[]

The OpenSSH encoded key data

Any headers that may have been available when data was read

headers)

Method Detail

decodePublicKeyByType	back to summary
public default PUB decodePublicKeyByType(SessionContext session, String keyType, InputStream keyData, Map<String, String> headers) throws IOException, GeneralSecurityException Implements org.apache.sshd.common.config.keys.PublicKeyRawDataDecoder.decodePublicKeyByType. Annotations @Override

decodePublicKeyByType

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

Annotations

encodePublicKey back to summary

encodePublicKey	back to summary
public 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:OutputStream The `OutputStream` to write the data to key:PUB The `PublicKey` - may not be `null` Returns:String The key type value - one of the `getSupportedKeyTypes()` Exceptions IOException: If failed to generate the encoding

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

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

Parameters

Returns:String

The key type value - one of the getSupportedKeyTypes()

Exceptions

resolve back to summary

resolve	back to summary
public default PublicKey resolve(SessionContext session, String keyType, byte[] keyData, Map<String, String> headers) throws IOException, GeneralSecurityException Implements org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. Parameters session:SessionContext Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. 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:String Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. The `OpenSSH` reported key type keyData:byte[] Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. The `OpenSSH` encoded key data headers:Map<String, String> Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. Any headers that may have been available when data was read Returns:PublicKey Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. The extracted `PublicKey` - ignored if `null` Annotations @Override Exceptions IOException: Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. If failed to parse the key data GeneralSecurityException: Doc from org.apache.sshd.common.config.keys.PublicKeyEntryResolver.resolve. If failed to generate the key