org.apache.sshd.common.config.keys.loader.pem

Class ECDSAPEMResourceKeyPairParser

java.lang.Object

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

org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser

org.apache.sshd.common.config.keys.loader.pem.AbstractPEMResourceKeyPairParser

org.apache.sshd.common.config.keys.loader.pem.ECDSAPEMResourceKeyPairParser

All Implemented Interfaces:

AlgorithmNameProvider, KeyPairResourceLoader, KeyPairResourceParser, KeyPairPEMResourceParser

public class ECDSAPEMResourceKeyPairParser
extends AbstractPEMResourceKeyPairParser

Author:

Apache MINA SSHD Project

See Also:

RFC 5915

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEGIN_MARKER
static List<String>	BEGINNERS
static String	ECDSA_OID
static String	END_MARKER
static List<String>	ENDERS
static ECDSAPEMResourceKeyPairParser	INSTANCE

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceParser

EMPTY

Fields inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader

MAX_CIPHER_NAME_LENGTH, MAX_KEY_COMMENT_LENGTH, MAX_KEY_TYPE_NAME_LENGTH, MAX_PRIVATE_KEY_DATA_SIZE, MAX_PUBLIC_KEY_DATA_SIZE

Constructor Summary

Constructors

Constructor and Description
ECDSAPEMResourceKeyPairParser()

Method Summary

Modifier and Type	Method and Description
static ECPoint	decodeECPointData(ASN1Object pointData)
static Map.Entry<ECPublicKeySpec,ECPrivateKeySpec>	decodeECPrivateKeySpec(ECCurves curve, ASN1Object sequence) ASN.1 syntax according to RFC 5915 is:
static Map.Entry<ECPrivateKeySpec,ASN1Object>	decodeECPrivateKeySpec(ECCurves curve, DERParser parser)
static ECPoint	decodeECPublicKeyValue(ASN1Object dataObject)
static ECPoint	decodeECPublicKeyValue(DERParser parser) ASN.1 syntax according to rfc5915 is:
Collection<KeyPair>	extractKeyPairs(SessionContext session, NamedResource resourceKey, String beginMarker, String endMarker, FilePasswordProvider passwordProvider, InputStream stream, Map<String,String> headers)
static Map.Entry<ECCurves,ASN1Object>	parseCurveParameter(ASN1Object paramsObject)
static Map.Entry<ECCurves,ASN1Object>	parseCurveParameter(DERParser parser)
static KeyPair	parseECKeyPair(ECCurves curve, DERParser parser)
static KeyPair	parseECKeyPair(InputStream inputStream, boolean okToClose)

Methods inherited from class org.apache.sshd.common.config.keys.loader.pem.AbstractPEMResourceKeyPairParser

applyPrivateKeyCipher, extractKeyPairs, getAlgorithm, getAlgorithmIdentifier

Methods inherited from class org.apache.sshd.common.config.keys.loader.AbstractKeyPairResourceParser

canExtractKeyPairs, extractKeyPairs, getBeginners, getEnders, getEndingMarkers, loadKeyPairs, separateDataLinesFromHeaders

Methods inherited from class org.apache.sshd.common.util.logging.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 java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceParser

aggregate, aggregate, canExtractKeyPairs, containsMarkerLine, containsMarkerLine, extractDataBytes, findMarkerLine, findMarkerLine, joinDataLines

Methods inherited from interface org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader

loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs, loadKeyPairs

Field Detail

BEGIN_MARKER

public static final String BEGIN_MARKER

See Also:

Constant Field Values

BEGINNERS

public static final List<String> BEGINNERS

END_MARKER

public static final String END_MARKER

See Also:

Constant Field Values

ENDERS

public static final List<String> ENDERS

ECDSA_OID

public static final String ECDSA_OID

See Also:

RFC-3279 section 2.3.5, Constant Field Values

INSTANCE

public static final ECDSAPEMResourceKeyPairParser INSTANCE

Constructor Detail

ECDSAPEMResourceKeyPairParser

public ECDSAPEMResourceKeyPairParser()

Method Detail

extractKeyPairs

public Collection<KeyPair> extractKeyPairs(SessionContext session,
                                           NamedResource resourceKey,
                                           String beginMarker,
                                           String endMarker,
                                           FilePasswordProvider passwordProvider,
                                           InputStream stream,
                                           Map<String,String> headers)
                                    throws IOException,
                                           GeneralSecurityException

Specified by:

extractKeyPairs in class AbstractKeyPairResourceParser

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

resourceKey - A hint as to the origin of the text lines

beginMarker - The line containing the begin marker

endMarker - The line containing the end marker

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

stream - The decoded data InputStream

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

Returns:

The extracted KeyPairs - may be null/empty if none.

Throws:

IOException - If failed to parse the data

GeneralSecurityException - If failed to generate the keys

parseECKeyPair

public static KeyPair parseECKeyPair(InputStream inputStream,
                                     boolean okToClose)
                              throws IOException,
                                     GeneralSecurityException

Throws:

IOException

GeneralSecurityException

parseECKeyPair

public static KeyPair parseECKeyPair(ECCurves curve,
                                     DERParser parser)
                              throws IOException,
                                     GeneralSecurityException

Parameters:

curve - The curve represented by this data (in case it was optional and somehow known externally) if null then it is assumed to be part of the parsed data. then it is assumed to be part of the data.

parser - The DERParser for the data

Returns:

The parsed KeyPair

Throws:

IOException - If failed to parse the data

GeneralSecurityException - If failed to generate the keys

decodeECPrivateKeySpec

public static Map.Entry<ECPublicKeySpec,ECPrivateKeySpec> decodeECPrivateKeySpec(ECCurves curve,
                                                                                 ASN1Object sequence)
                                                                          throws IOException

ASN.1 syntax according to RFC 5915 is:

 
 ECPrivateKey ::= SEQUENCE {
      version        INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1),
      privateKey     OCTET STRING,
      parameters [0] ECParameters {{ NamedCurve }} OPTIONAL,
      publicKey  [1] BIT STRING OPTIONAL
 }
 
 

ECParameters syntax according to RFC5480:

 
 ECParameters ::= CHOICE {
      namedCurve         OBJECT IDENTIFIER
      -- implicitCurve   NULL
      -- specifiedCurve  SpecifiedECDomain
 }
 
 

Parameters:

curve - The curve represented by this data (in case it was optional and somehow known externally) if null then it is assumed to be part of the parsed data.

sequence - The ASN1Object sequence containing the DER encoded data

Returns:

The decoded AbstractMap.SimpleImmutableEntry of ECPublicKeySpec and ECPrivateKeySpec

Throws:

IOException - If failed to to decode the DER stream

decodeECPrivateKeySpec

public static Map.Entry<ECPrivateKeySpec,ASN1Object> decodeECPrivateKeySpec(ECCurves curve,
                                                                            DERParser parser)
                                                                     throws IOException

Throws:

IOException

parseCurveParameter

public static Map.Entry<ECCurves,ASN1Object> parseCurveParameter(DERParser parser)
                                                          throws IOException

Throws:

IOException

parseCurveParameter

public static Map.Entry<ECCurves,ASN1Object> parseCurveParameter(ASN1Object paramsObject)
                                                          throws IOException

Throws:

IOException

decodeECPublicKeyValue

public static final ECPoint decodeECPublicKeyValue(DERParser parser)
                                            throws IOException

ASN.1 syntax according to rfc5915 is:

 
      publicKey  [1] BIT STRING OPTIONAL
 
 

Parameters:

parser - The DERParser assumed to be positioned at the start of the data

Returns:

The encoded ECPoint

Throws:

IOException - If failed to create the point

decodeECPublicKeyValue

public static final ECPoint decodeECPublicKeyValue(ASN1Object dataObject)
                                            throws IOException

Throws:

IOException

decodeECPointData

public static final ECPoint decodeECPointData(ASN1Object pointData)
                                       throws IOException

Throws:

IOException