SigningKeyHandle Class Reference

Used for document signing. More...

Inheritance diagram for SigningKeyHandle:

typedef error_type(CALLING_CONVENTION *	SigningKey_Initialize_Function) (void *user_data, MessageDigestAlgorithmType algorithm)
	Initialize signing engine using selected digest algorithm.
typedef error_type(CALLING_CONVENTION *	SigningKey_Update_Function) (void *user_data, const BufferHandle *data)
	Insert data into engine for digest calculation.
typedef error_type(CALLING_CONVENTION *	SigningKey_Final_Function) (void *user_data, BufferHandle **result)
	Finish the digest calculation and return signed hash.
typedef error_type(CALLING_CONVENTION *	SigningKey_Cleanup_Function) (void *user_data)
	Cleanup all dependencies after the signing process has finished.
error_type CALLING_CONVENTION	SigningKey_CreateCustom (SigningKey_Initialize_Function sign_init, SigningKey_Update_Function sign_update, SigningKey_Final_Function sign_final, SigningKey_Cleanup_Function sign_cleanup, void *user_data, SigningKeyHandle **result)
	Creates a custom SigningKeyHandle to provide custom sign operation.
error_type CALLING_CONVENTION	SigningKey_ToUnknown (SigningKeyHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	SigningKey_FromUnknown (IUnknownHandle *handle, SigningKeyHandle **result)
	Convert IUnknownHandle to BufferHandle.
error_type CALLING_CONVENTION	SigningKey_SignInitialize (SigningKeyHandle *handle, MessageDigestAlgorithmType algorithm)
	Initialize signing operation with specified digest algorithm.
error_type CALLING_CONVENTION	SigningKey_SignUpdate (SigningKeyHandle *handle, const BufferHandle *data)
	Update signing operation with data to be signed.
error_type CALLING_CONVENTION	SigningKey_SignFinal (SigningKeyHandle *handle, BufferHandle **result)
	Finalize signing operation and return signature.
error_type CALLING_CONVENTION	SigningKey_SignCleanup (SigningKeyHandle *handle)
	Cleanup signing operation resources.
error_type CALLING_CONVENTION	SigningKey_Release (SigningKeyHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

Used for document signing.

Standard routine for message signing is Initialize, (single or multiple) Update, Final.

See also

DocumentSignatureSettingsHandle

Examples

sign.c, and sign_custom.c.

Member Typedef Documentation

SigningKey_Initialize_Function

typedef error_type(CALLING_CONVENTION * SigningKey_Initialize_Function) (void *user_data, MessageDigestAlgorithmType algorithm)

Initialize signing engine using selected digest algorithm.

This function should reset all previous settings and prepare for future SigningKey_Update_Function to be called.

Friends And Related Symbol Documentation

SigningKey_Update_Function

typedef error_type(CALLING_CONVENTION * SigningKey_Update_Function) (void *user_data, const BufferHandle *data)

related

Insert data into engine for digest calculation.

This function can be called multiple times, if there are more data for signing that would fit in a single buffer.

SigningKey_Final_Function

typedef error_type(CALLING_CONVENTION * SigningKey_Final_Function) (void *user_data, BufferHandle **result)

related

Finish the digest calculation and return signed hash.

This function should allocate buffer, filled with data. The data should be hash value according to algorithm in SigningKey_Initialize_Function.

Hash should be signed and the result should be either a DER-encoded PKCS#1 binary data object or a DER-encoded PKCS#7 binary data object.

SigningKey_Cleanup_Function

typedef error_type(CALLING_CONVENTION * SigningKey_Cleanup_Function) (void *user_data)

related

Cleanup all dependencies after the signing process has finished.

This function is called when the signing of a file has been finished

SigningKey_SignInitialize()

error_type CALLING_CONVENTION SigningKey_SignInitialize ( SigningKeyHandle *  handle, MessageDigestAlgorithmType  algorithm  )

related

Initialize signing operation with specified digest algorithm.

Parameters

handle	The signing key
algorithm	Message digest algorithm to use for signing

SigningKey_SignUpdate()

error_type CALLING_CONVENTION SigningKey_SignUpdate ( SigningKeyHandle *  handle, const BufferHandle *  data  )

related

Update signing operation with data to be signed.

Parameters

handle	The signing key
data	Data to include in signature

SigningKey_SignFinal()

error_type CALLING_CONVENTION SigningKey_SignFinal ( SigningKeyHandle *  handle, BufferHandle **  result  )

related

Finalize signing operation and return signature.

Parameters

handle	The signing key
result	Output buffer containing PKCS#7 signature

SigningKey_SignCleanup()

error_type CALLING_CONVENTION SigningKey_SignCleanup ( SigningKeyHandle *  handle )

related

Cleanup signing operation resources.

Parameters

handle

The signing key

SigningKey_Release()

error_type CALLING_CONVENTION SigningKey_Release ( SigningKeyHandle *  handle )

related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

IUnknown_Release

---

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

• c_signing_key.h