de::softpro::doc::SignECDSA Class Reference

Interface for creating an ECDSA signature. More...

#include <SignDocSDK-cpp.h>

Public Types
enum	HashAlgorithm {   ha_sha1 = 1, ha_sha256 = 2, ha_sha384 = 3, ha_sha512 = 4,   ha_sha224 = 7 }
	Hash algorithm. More...
Public Member Functions
	SignECDSA ()
	Constructor.
virtual	~SignECDSA ()
	Destructor.
virtual bool	sign (Source &aSource, HashAlgorithm aHashAlgorithm, std::vector< unsigned char > &aOutput)=0
	Compute an ECDSA signature.
virtual int	getSignatureSize ()=0
	Get the size of the signature that will be computed by sign().
virtual bool	getSigningCertificate (std::vector< unsigned char > &aOutput) const =0
	Get the signing certificate.
virtual int	getCertificateCount () const =0
	Get the number of available intermediate certificates.
virtual bool	getCertificate (int aIndex, std::vector< unsigned char > &aOutput) const =0
	Get an intermediate certificate.
virtual const char *	getErrorMessage () const =0
	Get an error message for the last operation.
SIGNDOC_SignECDSA *	getImpl ()
	Internal.

---

Detailed Description

Interface for creating an ECDSA signature.

Selection of the certificate is up to the implementation.

---

Member Enumeration Documentation

enum de::softpro::doc::SignECDSA::HashAlgorithm

Hash algorithm.

Enumerator:

ha_sha1	SHA-1.
ha_sha256	SHA-256.
ha_sha384	SHA-384.
ha_sha512	SHA-512.
ha_sha224	SHA-224.

---

Constructor & Destructor Documentation

de::softpro::doc::SignECDSA::SignECDSA

(

)

[inline]

Constructor.

virtual de::softpro::doc::SignECDSA::~SignECDSA

(

)

[inline, virtual]

Destructor.

Should release the crypto provider context if one was acquired.

---

Member Function Documentation

virtual bool de::softpro::doc::SignECDSA::getCertificate	(	int	aIndex,
		std::vector< unsigned char > &	aOutput
	)		const [pure virtual]

Get an intermediate certificate.

This function must not throw any exception except for std::bad_alloc.

Parameters:

[in]	aIndex	The zero-based index of the intermediate certificate, see getCertificateCount().
[out]	aOutput	The requested intermediate certificate will be stored here (DER-encoded X.509).

Returns:

true iff successful.

virtual int de::softpro::doc::SignECDSA::getCertificateCount

(

)

const [pure virtual]

Get the number of available intermediate certificates.

Returns:

The number of available intermediate certificates.

virtual const char* de::softpro::doc::SignECDSA::getErrorMessage

(

)

const [pure virtual]

Get an error message for the last operation.

This function must not throw any exception except for std::bad_alloc.

After any member function of this object has been called, you can retrieve an error message by calling this function.

Returns:

A pointer to the error message. The pointer will become invalid as soon as any member function of this object is called or this object is destroyed.

SIGNDOC_SignECDSA* de::softpro::doc::SignECDSA::getImpl

(

)

[inline]

Internal.

virtual int de::softpro::doc::SignECDSA::getSignatureSize

(

)

[pure virtual]

Get the size of the signature that will be computed by sign().

Returns:

The size in octets of the signature that will be computed by sign() or a negative value on error.

virtual bool de::softpro::doc::SignECDSA::getSigningCertificate

(

std::vector< unsigned char > &

aOutput )

const [pure virtual]

Get the signing certificate.

This function must not throw any exception except for std::bad_alloc.

Parameters:

[out]

aOutput

The signing certificate will be stored here (DER-encoded X.509).

Returns:

true iff successful.

virtual bool de::softpro::doc::SignECDSA::sign	(	Source &	aSource,
		HashAlgorithm	aHashAlgorithm,
		std::vector< unsigned char > &	aOutput
	)		[pure virtual]

Compute an ECDSA signature.

This function must not throw any exception except for std::bad_alloc.

Parameters:

[in]	aSource	An object providing data to be hashed and signed.
[in]	aHashAlgorithm	Hash algorithm.
[out]	aOutput	The ECDSA signature (a DER-encoded SEQUENCE) shall be stored here. It shall not be wrapped in an OCTET STRING.

Returns:

true iff successful.

---

The documentation for this class was generated from the following file:

• SignDocSDK-cpp.h