Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.keys.loader.pem.DSSPEMResourceKeyPairParser

Modifier and Type	Field and Description
public static final String	BEGIN_MARKER
public static final List<String>	BEGINNERS
public static final String	DSS_OID
public static final String	END_MARKER
public static final List<String>	ENDERS
public static final DSSPEMResourceKeyPairParser	INSTANCE

Access	Constructor and Description
public	DSSPEMResourceKeyPairParser()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static KeyPair	Returns: The recovered `KeyPair` decodeDSSKeyPair(KeyFactory The `KeyFactory` To use to generate the keys kf, InputStream The `InputStream` containing the encoded bytes s, boolean `true` if the method may close the input stream regardless of success or failure okToClose) The ASN.1 syntax for the private key: `DSAPrivateKey ::= SEQUENCE { version Version, p INTEGER, q INTEGER, g INTEGER, y INTEGER, x INTEGER }`
public Collection<KeyPair>	extractKeyPairs(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, NamedResource A hint as to the origin of the text lines resourceKey, String The line containing the begin marker beginMarker, String The line containing the end marker endMarker, FilePasswordProvider The `FilePasswordProvider` to use in case the data is encrypted - may be `null` if no encrypted passwordProvider, InputStream The decoded data `InputStream` stream, Map<String, String> Any headers that may have been available when data was read headers) Implements abstract org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs.

public static KeyPair

Returns:

The recovered KeyPair

decodeDSSKeyPair(KeyFactory

The KeyFactory To use to generate the keys

kf, InputStream

The InputStream containing the encoded bytes

s, boolean

true if the method may close the input stream regardless of success or failure

okToClose)

The ASN.1 syntax for the private key:


DSAPrivateKey ::= SEQUENCE {
     version Version,
     p       INTEGER,
     q       INTEGER,
     g       INTEGER,
     y       INTEGER,
     x       INTEGER
}

public Collection<KeyPair>

extractKeyPairs(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, NamedResource

A hint as to the origin of the text lines

resourceKey, String

The line containing the begin marker

beginMarker, String

The line containing the end marker

endMarker, FilePasswordProvider

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

passwordProvider, InputStream

The decoded data InputStream

stream, Map<String, String>

Any headers that may have been available when data was read

headers)

Implements abstract org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs.

Inherited from org.apache.sshd.common.config.keys.loader.pem.AbstractPEMResourceKeyPairParser:: applyPrivateKeyCipher extractKeyPairs getAlgorithm getAlgorithmIdentifier

BEGIN_MARKER	back to summary
public static final String BEGIN_MARKER

BEGINNERS	back to summary
public static final List<String> BEGINNERS

DSS_OID	back to summary
public static final String DSS_OID

END_MARKER	back to summary
public static final String END_MARKER

ENDERS	back to summary
public static final List<String> ENDERS

INSTANCE	back to summary
public static final DSSPEMResourceKeyPairParser INSTANCE

DSSPEMResourceKeyPairParser	back to summary
public DSSPEMResourceKeyPairParser()

Method Detail

decodeDSSKeyPair back to summary

decodeDSSKeyPair	back to summary
public static KeyPair decodeDSSKeyPair(KeyFactory kf, InputStream s, boolean okToClose) throws IOException, GeneralSecurityException The ASN.1 syntax for the private key: `DSAPrivateKey ::= SEQUENCE { version Version, p INTEGER, q INTEGER, g INTEGER, y INTEGER, x INTEGER }` Parameters kf:KeyFactory The `KeyFactory` To use to generate the keys s:InputStream The `InputStream` containing the encoded bytes okToClose:boolean `true` if the method may close the input stream regardless of success or failure Returns:KeyPair The recovered `KeyPair` Exceptions IOException: If failed to read or decode the bytes GeneralSecurityException: If failed to generate the keys

public static KeyPair decodeDSSKeyPair(KeyFactory kf, InputStream s, boolean okToClose) throws IOException, GeneralSecurityException

The ASN.1 syntax for the private key:


DSAPrivateKey ::= SEQUENCE {
     version Version,
     p       INTEGER,
     q       INTEGER,
     g       INTEGER,
     y       INTEGER,
     x       INTEGER
}

Parameters

kf:KeyFactory: The KeyFactory To use to generate the keys
s:InputStream: The InputStream containing the encoded bytes
okToClose:boolean: true if the method may close the input stream regardless of success or failure

Returns:KeyPair

The recovered KeyPair

Exceptions

IOException:: If failed to read or decode the bytes
GeneralSecurityException:: If failed to generate the keys

extractKeyPairs back to summary

extractKeyPairs	back to summary
public Collection<KeyPair> extractKeyPairs(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, InputStream stream, Map<String, String> headers) throws IOException, GeneralSecurityException Implements abstract org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. Parameters session:SessionContext Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). resourceKey:NamedResource Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. A hint as to the origin of the text lines beginMarker:String Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. The line containing the begin marker endMarker:String Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. The line containing the end marker passwordProvider:FilePasswordProvider Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. The `FilePasswordProvider` to use in case the data is encrypted - may be `null` if no encrypted stream:InputStream Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. The decoded data `InputStream` headers:Map<String, String> Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. Any headers that may have been available when data was read Returns:Collection<KeyPair> Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. The extracted `KeyPair`s - may be `null`/empty if none. Annotations @Override Exceptions IOException: Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. If failed to parse the data GeneralSecurityException: Doc from org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser.extractKeyPairs. If failed to generate the keys