Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
DigitalSignatureHandle Class Reference

Represents document's authenticated digital signature. More...

Inheritance diagram for DigitalSignatureHandle:
IUnknownHandle
error_type CALLING_CONVENTION DigitalSignature_GetContactInfo (DigitalSignatureHandle *handle, StringObjectHandle **result)
 Information provided by the signer to enable a recipient to contact the signer to verify the signature.
 
error_type CALLING_CONVENTION DigitalSignature_GetReason (DigitalSignatureHandle *handle, StringObjectHandle **result)
 The reason for the signing, such as (I agree...).
 
error_type CALLING_CONVENTION DigitalSignature_GetLocation (DigitalSignatureHandle *handle, StringObjectHandle **result)
 The CPU host name or physical location of the signing.
 
error_type CALLING_CONVENTION DigitalSignature_GetSigningTime (DigitalSignatureHandle *handle, DateHandle **result)
 The time of signing.
 
error_type CALLING_CONVENTION DigitalSignature_GetName (DigitalSignatureHandle *handle, StringObjectHandle **result)
 The name of the person or authority signing the document.
 
error_type CALLING_CONVENTION DigitalSignature_GetRevision (DigitalSignatureHandle *handle, IntegerObjectHandle **result)
 The version of the signature handler that was used to create the signature.
 
error_type CALLING_CONVENTION DigitalSignature_GetCertificate (DigitalSignatureHandle *handle, StringObjectHandle **result)
 An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.
 
error_type CALLING_CONVENTION DigitalSignature_GetContents (DigitalSignatureHandle *handle, HexadecimalStringObjectHandle **result)
 The signature value.
 
error_type CALLING_CONVENTION DigitalSignature_GetByteRange (DigitalSignatureHandle *handle, ByteRangeCollectionHandle **result)
 Exact byte range for the digest calculation.
 
error_type CALLING_CONVENTION DigitalSignature_Release (DigitalSignatureHandle *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.
 

Detailed Description

Represents document's authenticated digital signature.

For more details please visit section 12.8 - Digital Signatures.

Friends And Related Symbol Documentation

◆ DigitalSignature_GetSigningTime()

error_type CALLING_CONVENTION DigitalSignature_GetSigningTime ( DigitalSignatureHandle * handle,
DateHandle ** result )
related

The time of signing.

Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server.

This value should be used only when the time of signing is not available in the signature.

◆ DigitalSignature_GetName()

error_type CALLING_CONVENTION DigitalSignature_GetName ( DigitalSignatureHandle * handle,
StringObjectHandle ** result )
related

The name of the person or authority signing the document.

This value should be used only when it is not possible to extract the name from the signature.

◆ DigitalSignature_GetCertificate()

error_type CALLING_CONVENTION DigitalSignature_GetCertificate ( DigitalSignatureHandle * handle,
StringObjectHandle ** result )
related

An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.

The signing certificate shall appear first in the array. It shall be used to verify the signature value in Contents, and the other certificates shall be used to verify the authenticity of the signing certificate.

◆ DigitalSignature_GetContents()

error_type CALLING_CONVENTION DigitalSignature_GetContents ( DigitalSignatureHandle * handle,
HexadecimalStringObjectHandle ** result )
related

The signature value.

When ByteRange is present, the value shall be a HexadecimalStringObjectHandle representing the value of the byte range digest.

For public-key signatures, Contents should be either a DER-encoded PKCS#1 binary data object or a DER-encoded PKCS#7 binary data object.

◆ DigitalSignature_GetByteRange()

error_type CALLING_CONVENTION DigitalSignature_GetByteRange ( DigitalSignatureHandle * handle,
ByteRangeCollectionHandle ** result )
related

Exact byte range for the digest calculation.

Multiple discontiguous byte ranges shall be used to describe a digest that does not include the signature value (DigitalSignature_GetContents) itself.

◆ DigitalSignature_Release()

error_type CALLING_CONVENTION DigitalSignature_Release ( DigitalSignatureHandle * 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: