PDFSign Class

Properties   Methods   Events   Config Settings   Errors  

The PDFSign class signs PDF documents.

Syntax

PDFSign

Remarks

The PDFSign class can sign PDF documents in accordance with a selection of PDF and PAdES signature standards, including basic Adobe signatures (ISO 32000) and PAdES signatures (ETSI EN 319 142-1).

Preparing the Signature

Optionally specify the Signature* properties and the TimestampServer property, and adjust any chain validation parameters as necessary (please see the Chain Validation Setup section for more details). Finally, call the Sign method.

PDFSign also provides means to customize the appearance of the signature widget to be shown on the document page. You can create your very own signatures (e.g., in the form of your company's logo) by adjusting the widget properties available in the SetWidgetProperty method. Alternatively, you can choose not to associate any widget with your signature by setting the Invisible widget property to true.

The Signing Process

If an external TSA server was provided via the TimestampServer property, the class will also contact it to timestamp the new signature.

During signing, PDFSign may fire events to notify your code about certain conditions. For example, if the input document is encrypted but no decryption parameters were found in the Password or DecryptionCert properties, the class will fire either the Password or RecipientInfo event to tell your code that it needs decryption information to be able to continue with the signing. Additionally, the SSLServerAuthentication event will fire if one of the HTTP endpoints involved during the operation (which may be a TSA, CRL, OCSP, or Trusted List service) operates over TLS and needs its certificate to be validated.

Basic Adobe Signatures

PAdES Signatures and Profiles

PAdES B-B

The PAdES B-B profile is the baseline profile that uses the PAdES-BES signature level by default, meaning the signature only contains the signing time and signer information.

Use the following code to create a B-B signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineB; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES-EPES

To instead create a PAdES-EPES signature that includes the signature-policy-identifier attribute, set the PolicyHash, PolicyHashAlgorithm, and PolicyId configuration settings before calling the Sign method.

This profile, in both the BES and EPES settings, creates a basic signature that remains valid as long as the signing certificate has not expired or been revoked. Signatures at this level need not contain any validation material.

PAdES B-T

The PAdES B-T profile extends the basic BES or EPES signature by adding a signature timestamp. This timestamp certifies that the signature was created at a specific moment in time. Similar to the B-B profile, signatures at this level need not contain any validation material.

Use the following code to create a B-T signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES B-LTA

The PAdES B-LTA profile is used to achieve signatures that are equipped with long-term archival (LTA) or long-term validation (LTV) capabilities. It incorporates into the signature all the material required to validate the signature, including signing certificates, timestamping certificates, and revocation information. It also adds a document timestamp, which certifies the integrity of both the document and the complete validation material at a specific moment in time. This guarantees that no relevant certificates were expired or revoked at the signature creation time, and enables the signature to be verified offline.

Creating a B-LTA signature with PDFSign is a two-step process. First Sign the document and add a signature timestamp, setting SignatureProfile appropriately. Then Update the signature to take care of the rest (collect and embed the validation material, and add a document timestamp): pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); // Update the signature to LTV - this will retrieve the necessary revocation // elements, embed them into the document, and add a document timestamp pdfsign.Reset(); pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "updated.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.Update(); Note that validation material "completeness" can be subjective and depends on several factors, including:

• The working environment. For example, your organization may explicitly trust its own self-signed TSA certificate. Signatures timestamped with this certificate will be considered B-LTA by your organization, but for any external bodies, those signatures would be rendered as B-LT or even B-B, as they do not know or trust the custom TSA certificate.
• The time that has passed since the last document timestamp. If an archived (B-LTA) document is not re-timestamped before its last timestamp expires, it will drop back to a lower signature level.

Chain Validation Setup

Note that these parameters apply to the Sign and Update methods in PDFSign as well as the Verify method in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled).

Validation Policy

The ValidationPolicy property dictates how thoroughly the chain will be validated. It includes options to control which checks the class will perform, allowing you to tailor the validation process to meet your specific security needs. For example, if it is not essential to check each certificate's revocation status, set this property to vpFullNoRevocation.

Revocation

The revocation aspect of chain validation is controlled by the RevocationCheck property, which allows you to choose between and prioritize revocation origins. Note that OCSP sources are often preferred to CRL endpoints because of their real-time capability and the smaller size of the responses they produce.

Trust

The trust aspect of chain validation is controlled by the TrustSources property, which allows you to specify the locations in which the class will search for trust anchors. Local system stores, your own trusted root certificates (via the TrustedCerts property), and Trusted Lists (via the TrustedLists property) are all supported.

Offline Mode

The OfflineMode property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the class will only use KnownCerts, TrustedCerts, data structures within the document itself, and revocation and Trusted List data that it previously saved to its internal cache when looking for missing validation material.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Attachments Property (PDFSign Class)

A collection of all attached files found in the PDF document.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFPDFAttachment>* GetAttachments();
int SetAttachments(SecurePDFList<SecurePDFPDFAttachment>* val);

int securepdf_pdfsign_getattachmentcount(void* lpObj);
int securepdf_pdfsign_setattachmentcount(void* lpObj, int iAttachmentCount);

char* securepdf_pdfsign_getattachmentcontenttype(void* lpObj, int attachmentindex);
int securepdf_pdfsign_setattachmentcontenttype(void* lpObj, int attachmentindex, const char* lpszAttachmentContentType);

char* securepdf_pdfsign_getattachmentcreationdate(void* lpObj, int attachmentindex);
int securepdf_pdfsign_setattachmentcreationdate(void* lpObj, int attachmentindex, const char* lpszAttachmentCreationDate);

int securepdf_pdfsign_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int securepdf_pdfsign_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);

char* securepdf_pdfsign_getattachmentdescription(void* lpObj, int attachmentindex);
int securepdf_pdfsign_setattachmentdescription(void* lpObj, int attachmentindex, const char* lpszAttachmentDescription);

char* securepdf_pdfsign_getattachmentfilename(void* lpObj, int attachmentindex);
int securepdf_pdfsign_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);

int securepdf_pdfsign_setattachmentinputstream(void* lpObj, int attachmentindex, SecurePDFStream* sAttachmentInputStream);

char* securepdf_pdfsign_getattachmentmodificationdate(void* lpObj, int attachmentindex);
int securepdf_pdfsign_setattachmentmodificationdate(void* lpObj, int attachmentindex, const char* lpszAttachmentModificationDate);

char* securepdf_pdfsign_getattachmentname(void* lpObj, int attachmentindex);
int securepdf_pdfsign_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

int securepdf_pdfsign_setattachmentoutputstream(void* lpObj, int attachmentindex, SecurePDFStream* sAttachmentOutputStream);

int64 securepdf_pdfsign_getattachmentsize(void* lpObj, int attachmentindex);

int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);

QString GetAttachmentContentType(int iAttachmentIndex);
int SetAttachmentContentType(int iAttachmentIndex, QString qsAttachmentContentType);

QString GetAttachmentCreationDate(int iAttachmentIndex);
int SetAttachmentCreationDate(int iAttachmentIndex, QString qsAttachmentCreationDate);

QByteArray GetAttachmentData(int iAttachmentIndex);
int SetAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData);

QString GetAttachmentDescription(int iAttachmentIndex);
int SetAttachmentDescription(int iAttachmentIndex, QString qsAttachmentDescription);

QString GetAttachmentFileName(int iAttachmentIndex);
int SetAttachmentFileName(int iAttachmentIndex, QString qsAttachmentFileName);

int SetAttachmentInputStream(int iAttachmentIndex, SecurePDFStream* sAttachmentInputStream);

QString GetAttachmentModificationDate(int iAttachmentIndex);
int SetAttachmentModificationDate(int iAttachmentIndex, QString qsAttachmentModificationDate);

QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

int SetAttachmentOutputStream(int iAttachmentIndex, SecurePDFStream* sAttachmentOutputStream);

qint64 GetAttachmentSize(int iAttachmentIndex);

Remarks

This property is used to access the details of all the attached files identified in the document. Use the AddAttachment, RemoveAttachment, and SaveAttachment methods to add, remove, and save attachments to/from this properties respectively.

This property is not available at design time.

Data Type

SecurePDFPDFAttachment

BlockedCerts Property (PDFSign Class)

The certificates that must be rejected as trust anchors.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFCertificate>* GetBlockedCerts();
int SetBlockedCerts(SecurePDFList<SecurePDFCertificate>* val);

int securepdf_pdfsign_getblockedcertcount(void* lpObj);
int securepdf_pdfsign_setblockedcertcount(void* lpObj, int iBlockedCertCount);

char* securepdf_pdfsign_getblockedcerteffectivedate(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertexpirationdate(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertextendedkeyusage(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertfingerprint(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertfingerprintsha1(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertfingerprintsha256(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertissuer(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertprivatekey(void* lpObj, int blockedcertindex);

int securepdf_pdfsign_getblockedcertprivatekeyavailable(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertprivatekeycontainer(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertpublickey(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertpublickeyalgorithm(void* lpObj, int blockedcertindex);

int securepdf_pdfsign_getblockedcertpublickeylength(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertserialnumber(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertsignaturealgorithm(void* lpObj, int blockedcertindex);

int securepdf_pdfsign_getblockedcertstore(void* lpObj, int blockedcertindex, char** lpBlockedCertStore, int* lenBlockedCertStore);
int securepdf_pdfsign_setblockedcertstore(void* lpObj, int blockedcertindex, const char* lpBlockedCertStore, int lenBlockedCertStore);

char* securepdf_pdfsign_getblockedcertstorepassword(void* lpObj, int blockedcertindex);
int securepdf_pdfsign_setblockedcertstorepassword(void* lpObj, int blockedcertindex, const char* lpszBlockedCertStorePassword);

int securepdf_pdfsign_getblockedcertstoretype(void* lpObj, int blockedcertindex);
int securepdf_pdfsign_setblockedcertstoretype(void* lpObj, int blockedcertindex, int iBlockedCertStoreType);

char* securepdf_pdfsign_getblockedcertsubjectaltnames(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertthumbprintmd5(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertthumbprintsha1(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertthumbprintsha256(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertusage(void* lpObj, int blockedcertindex);

int securepdf_pdfsign_getblockedcertusageflags(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertversion(void* lpObj, int blockedcertindex);

char* securepdf_pdfsign_getblockedcertsubject(void* lpObj, int blockedcertindex);
int securepdf_pdfsign_setblockedcertsubject(void* lpObj, int blockedcertindex, const char* lpszBlockedCertSubject);

int securepdf_pdfsign_getblockedcertencoded(void* lpObj, int blockedcertindex, char** lpBlockedCertEncoded, int* lenBlockedCertEncoded);
int securepdf_pdfsign_setblockedcertencoded(void* lpObj, int blockedcertindex, const char* lpBlockedCertEncoded, int lenBlockedCertEncoded);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

QString GetBlockedCertEffectiveDate(int iBlockedCertIndex);

QString GetBlockedCertExpirationDate(int iBlockedCertIndex);

QString GetBlockedCertExtendedKeyUsage(int iBlockedCertIndex);

QString GetBlockedCertFingerprint(int iBlockedCertIndex);

QString GetBlockedCertFingerprintSHA1(int iBlockedCertIndex);

QString GetBlockedCertFingerprintSHA256(int iBlockedCertIndex);

QString GetBlockedCertIssuer(int iBlockedCertIndex);

QString GetBlockedCertPrivateKey(int iBlockedCertIndex);

bool GetBlockedCertPrivateKeyAvailable(int iBlockedCertIndex);

QString GetBlockedCertPrivateKeyContainer(int iBlockedCertIndex);

QString GetBlockedCertPublicKey(int iBlockedCertIndex);

QString GetBlockedCertPublicKeyAlgorithm(int iBlockedCertIndex);

int GetBlockedCertPublicKeyLength(int iBlockedCertIndex);

QString GetBlockedCertSerialNumber(int iBlockedCertIndex);

QString GetBlockedCertSignatureAlgorithm(int iBlockedCertIndex);

QByteArray GetBlockedCertStore(int iBlockedCertIndex);
int SetBlockedCertStore(int iBlockedCertIndex, QByteArray qbaBlockedCertStore);

QString GetBlockedCertStorePassword(int iBlockedCertIndex);
int SetBlockedCertStorePassword(int iBlockedCertIndex, QString qsBlockedCertStorePassword);

int GetBlockedCertStoreType(int iBlockedCertIndex);
int SetBlockedCertStoreType(int iBlockedCertIndex, int iBlockedCertStoreType);

QString GetBlockedCertSubjectAltNames(int iBlockedCertIndex);

QString GetBlockedCertThumbprintMD5(int iBlockedCertIndex);

QString GetBlockedCertThumbprintSHA1(int iBlockedCertIndex);

QString GetBlockedCertThumbprintSHA256(int iBlockedCertIndex);

QString GetBlockedCertUsage(int iBlockedCertIndex);

int GetBlockedCertUsageFlags(int iBlockedCertIndex);

QString GetBlockedCertVersion(int iBlockedCertIndex);

QString GetBlockedCertSubject(int iBlockedCertIndex);
int SetBlockedCertSubject(int iBlockedCertIndex, QString qsBlockedCertSubject);

QByteArray GetBlockedCertEncoded(int iBlockedCertIndex);
int SetBlockedCertEncoded(int iBlockedCertIndex, QByteArray qbaBlockedCertEncoded);

Remarks

This property is used to supply a list of compromised or blocked certificates to the class. Note that any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Data Type

SecurePDFCertificate

DecryptionCert Property (PDFSign Class)

The decryption certificate.

Syntax

• C++
• C
• Qt

SecurePDFCertificate* GetDecryptionCert();
int SetDecryptionCert(SecurePDFCertificate* val);

char* securepdf_pdfsign_getdecryptioncerteffectivedate(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertexpirationdate(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertextendedkeyusage(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertfingerprint(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertfingerprintsha1(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertfingerprintsha256(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertissuer(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertprivatekey(void* lpObj);

int securepdf_pdfsign_getdecryptioncertprivatekeyavailable(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertprivatekeycontainer(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertpublickey(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertpublickeyalgorithm(void* lpObj);

int securepdf_pdfsign_getdecryptioncertpublickeylength(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertserialnumber(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertsignaturealgorithm(void* lpObj);

int securepdf_pdfsign_getdecryptioncertstore(void* lpObj, char** lpDecryptionCertStore, int* lenDecryptionCertStore);
int securepdf_pdfsign_setdecryptioncertstore(void* lpObj, const char* lpDecryptionCertStore, int lenDecryptionCertStore);

char* securepdf_pdfsign_getdecryptioncertstorepassword(void* lpObj);
int securepdf_pdfsign_setdecryptioncertstorepassword(void* lpObj, const char* lpszDecryptionCertStorePassword);

int securepdf_pdfsign_getdecryptioncertstoretype(void* lpObj);
int securepdf_pdfsign_setdecryptioncertstoretype(void* lpObj, int iDecryptionCertStoreType);

char* securepdf_pdfsign_getdecryptioncertsubjectaltnames(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertthumbprintmd5(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertthumbprintsha1(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertthumbprintsha256(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertusage(void* lpObj);

int securepdf_pdfsign_getdecryptioncertusageflags(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertversion(void* lpObj);

char* securepdf_pdfsign_getdecryptioncertsubject(void* lpObj);
int securepdf_pdfsign_setdecryptioncertsubject(void* lpObj, const char* lpszDecryptionCertSubject);

int securepdf_pdfsign_getdecryptioncertencoded(void* lpObj, char** lpDecryptionCertEncoded, int* lenDecryptionCertEncoded);
int securepdf_pdfsign_setdecryptioncertencoded(void* lpObj, const char* lpDecryptionCertEncoded, int lenDecryptionCertEncoded);

QString GetDecryptionCertEffectiveDate();

QString GetDecryptionCertExpirationDate();

QString GetDecryptionCertExtendedKeyUsage();

QString GetDecryptionCertFingerprint();

QString GetDecryptionCertFingerprintSHA1();

QString GetDecryptionCertFingerprintSHA256();

QString GetDecryptionCertIssuer();

QString GetDecryptionCertPrivateKey();

bool GetDecryptionCertPrivateKeyAvailable();

QString GetDecryptionCertPrivateKeyContainer();

QString GetDecryptionCertPublicKey();

QString GetDecryptionCertPublicKeyAlgorithm();

int GetDecryptionCertPublicKeyLength();

QString GetDecryptionCertSerialNumber();

QString GetDecryptionCertSignatureAlgorithm();

QByteArray GetDecryptionCertStore();
int SetDecryptionCertStore(QByteArray qbaDecryptionCertStore);

QString GetDecryptionCertStorePassword();
int SetDecryptionCertStorePassword(QString qsDecryptionCertStorePassword);

int GetDecryptionCertStoreType();
int SetDecryptionCertStoreType(int iDecryptionCertStoreType);

QString GetDecryptionCertSubjectAltNames();

QString GetDecryptionCertThumbprintMD5();

QString GetDecryptionCertThumbprintSHA1();

QString GetDecryptionCertThumbprintSHA256();

QString GetDecryptionCertUsage();

int GetDecryptionCertUsageFlags();

QString GetDecryptionCertVersion();

QString GetDecryptionCertSubject();
int SetDecryptionCertSubject(QString qsDecryptionCertSubject);

QByteArray GetDecryptionCertEncoded();
int SetDecryptionCertEncoded(QByteArray qbaDecryptionCertEncoded);

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Data Type

SecurePDFCertificate

DocumentCerts Property (PDFSign Class)

A collection of certificates read from the document during processing.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFCertificate>* GetDocumentCerts();

int securepdf_pdfsign_getdocumentcertcount(void* lpObj);

char* securepdf_pdfsign_getdocumentcerteffectivedate(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertexpirationdate(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertextendedkeyusage(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertfingerprint(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertfingerprintsha1(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertfingerprintsha256(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertissuer(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertprivatekey(void* lpObj, int documentcertindex);

int securepdf_pdfsign_getdocumentcertprivatekeyavailable(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertprivatekeycontainer(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertpublickey(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertpublickeyalgorithm(void* lpObj, int documentcertindex);

int securepdf_pdfsign_getdocumentcertpublickeylength(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertserialnumber(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertsignaturealgorithm(void* lpObj, int documentcertindex);

int securepdf_pdfsign_getdocumentcertstore(void* lpObj, int documentcertindex, char** lpDocumentCertStore, int* lenDocumentCertStore);

char* securepdf_pdfsign_getdocumentcertstorepassword(void* lpObj, int documentcertindex);

int securepdf_pdfsign_getdocumentcertstoretype(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertsubjectaltnames(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertthumbprintmd5(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertthumbprintsha1(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertthumbprintsha256(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertusage(void* lpObj, int documentcertindex);

int securepdf_pdfsign_getdocumentcertusageflags(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertversion(void* lpObj, int documentcertindex);

char* securepdf_pdfsign_getdocumentcertsubject(void* lpObj, int documentcertindex);

int securepdf_pdfsign_getdocumentcertencoded(void* lpObj, int documentcertindex, char** lpDocumentCertEncoded, int* lenDocumentCertEncoded);

int GetDocumentCertCount();

QString GetDocumentCertEffectiveDate(int iDocumentCertIndex);

QString GetDocumentCertExpirationDate(int iDocumentCertIndex);

QString GetDocumentCertExtendedKeyUsage(int iDocumentCertIndex);

QString GetDocumentCertFingerprint(int iDocumentCertIndex);

QString GetDocumentCertFingerprintSHA1(int iDocumentCertIndex);

QString GetDocumentCertFingerprintSHA256(int iDocumentCertIndex);

QString GetDocumentCertIssuer(int iDocumentCertIndex);

QString GetDocumentCertPrivateKey(int iDocumentCertIndex);

bool GetDocumentCertPrivateKeyAvailable(int iDocumentCertIndex);

QString GetDocumentCertPrivateKeyContainer(int iDocumentCertIndex);

QString GetDocumentCertPublicKey(int iDocumentCertIndex);

QString GetDocumentCertPublicKeyAlgorithm(int iDocumentCertIndex);

int GetDocumentCertPublicKeyLength(int iDocumentCertIndex);

QString GetDocumentCertSerialNumber(int iDocumentCertIndex);

QString GetDocumentCertSignatureAlgorithm(int iDocumentCertIndex);

QByteArray GetDocumentCertStore(int iDocumentCertIndex);

QString GetDocumentCertStorePassword(int iDocumentCertIndex);

int GetDocumentCertStoreType(int iDocumentCertIndex);

QString GetDocumentCertSubjectAltNames(int iDocumentCertIndex);

QString GetDocumentCertThumbprintMD5(int iDocumentCertIndex);

QString GetDocumentCertThumbprintSHA1(int iDocumentCertIndex);

QString GetDocumentCertThumbprintSHA256(int iDocumentCertIndex);

QString GetDocumentCertUsage(int iDocumentCertIndex);

int GetDocumentCertUsageFlags(int iDocumentCertIndex);

QString GetDocumentCertVersion(int iDocumentCertIndex);

QString GetDocumentCertSubject(int iDocumentCertIndex);

QByteArray GetDocumentCertEncoded(int iDocumentCertIndex);

Remarks

This property is used to access all certificates encountered during document processing and embedded into the signature(s). When signing or verifying, this properties will be populated automatically during chain validation.

This property is read-only and not available at design time.

Data Type

SecurePDFCertificate

Firewall Property (PDFSign Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

SecurePDFFirewall* GetFirewall();
int SetFirewall(SecurePDFFirewall* val);

int securepdf_pdfsign_getfirewallautodetect(void* lpObj);
int securepdf_pdfsign_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int securepdf_pdfsign_getfirewalltype(void* lpObj);
int securepdf_pdfsign_setfirewalltype(void* lpObj, int iFirewallType);

char* securepdf_pdfsign_getfirewallhost(void* lpObj);
int securepdf_pdfsign_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* securepdf_pdfsign_getfirewallpassword(void* lpObj);
int securepdf_pdfsign_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int securepdf_pdfsign_getfirewallport(void* lpObj);
int securepdf_pdfsign_setfirewallport(void* lpObj, int iFirewallPort);

char* securepdf_pdfsign_getfirewalluser(void* lpObj);
int securepdf_pdfsign_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

SecurePDFFirewall

InputData Property (PDFSign Class)

A byte array containing the PDF document to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputData(char* &lpInputData, int &lenInputData);
int SetInputData(const char* lpInputData, int lenInputData);

Unicode (Windows)
INT GetInputData(LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(LPCSTR lpInputData, INT lenInputData);

int securepdf_pdfsign_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int securepdf_pdfsign_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);

QByteArray GetInputData();
int SetInputData(QByteArray qbaInputData);

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFSign Class)

The PDF file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* securepdf_pdfsign_getinputfile(void* lpObj);
int securepdf_pdfsign_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

Data Type

String

KnownCerts Property (PDFSign Class)

A collection of additional certificates for chain validation.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFCertificate>* GetKnownCerts();
int SetKnownCerts(SecurePDFList<SecurePDFCertificate>* val);

int securepdf_pdfsign_getknowncertcount(void* lpObj);
int securepdf_pdfsign_setknowncertcount(void* lpObj, int iKnownCertCount);

char* securepdf_pdfsign_getknowncerteffectivedate(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertexpirationdate(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertextendedkeyusage(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertfingerprint(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertfingerprintsha1(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertfingerprintsha256(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertissuer(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertprivatekey(void* lpObj, int knowncertindex);

int securepdf_pdfsign_getknowncertprivatekeyavailable(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertprivatekeycontainer(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertpublickey(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertpublickeyalgorithm(void* lpObj, int knowncertindex);

int securepdf_pdfsign_getknowncertpublickeylength(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertserialnumber(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertsignaturealgorithm(void* lpObj, int knowncertindex);

int securepdf_pdfsign_getknowncertstore(void* lpObj, int knowncertindex, char** lpKnownCertStore, int* lenKnownCertStore);
int securepdf_pdfsign_setknowncertstore(void* lpObj, int knowncertindex, const char* lpKnownCertStore, int lenKnownCertStore);

char* securepdf_pdfsign_getknowncertstorepassword(void* lpObj, int knowncertindex);
int securepdf_pdfsign_setknowncertstorepassword(void* lpObj, int knowncertindex, const char* lpszKnownCertStorePassword);

int securepdf_pdfsign_getknowncertstoretype(void* lpObj, int knowncertindex);
int securepdf_pdfsign_setknowncertstoretype(void* lpObj, int knowncertindex, int iKnownCertStoreType);

char* securepdf_pdfsign_getknowncertsubjectaltnames(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertthumbprintmd5(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertthumbprintsha1(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertthumbprintsha256(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertusage(void* lpObj, int knowncertindex);

int securepdf_pdfsign_getknowncertusageflags(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertversion(void* lpObj, int knowncertindex);

char* securepdf_pdfsign_getknowncertsubject(void* lpObj, int knowncertindex);
int securepdf_pdfsign_setknowncertsubject(void* lpObj, int knowncertindex, const char* lpszKnownCertSubject);

int securepdf_pdfsign_getknowncertencoded(void* lpObj, int knowncertindex, char** lpKnownCertEncoded, int* lenKnownCertEncoded);
int securepdf_pdfsign_setknowncertencoded(void* lpObj, int knowncertindex, const char* lpKnownCertEncoded, int lenKnownCertEncoded);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

QString GetKnownCertEffectiveDate(int iKnownCertIndex);

QString GetKnownCertExpirationDate(int iKnownCertIndex);

QString GetKnownCertExtendedKeyUsage(int iKnownCertIndex);

QString GetKnownCertFingerprint(int iKnownCertIndex);

QString GetKnownCertFingerprintSHA1(int iKnownCertIndex);

QString GetKnownCertFingerprintSHA256(int iKnownCertIndex);

QString GetKnownCertIssuer(int iKnownCertIndex);

QString GetKnownCertPrivateKey(int iKnownCertIndex);

bool GetKnownCertPrivateKeyAvailable(int iKnownCertIndex);

QString GetKnownCertPrivateKeyContainer(int iKnownCertIndex);

QString GetKnownCertPublicKey(int iKnownCertIndex);

QString GetKnownCertPublicKeyAlgorithm(int iKnownCertIndex);

int GetKnownCertPublicKeyLength(int iKnownCertIndex);

QString GetKnownCertSerialNumber(int iKnownCertIndex);

QString GetKnownCertSignatureAlgorithm(int iKnownCertIndex);

QByteArray GetKnownCertStore(int iKnownCertIndex);
int SetKnownCertStore(int iKnownCertIndex, QByteArray qbaKnownCertStore);

QString GetKnownCertStorePassword(int iKnownCertIndex);
int SetKnownCertStorePassword(int iKnownCertIndex, QString qsKnownCertStorePassword);

int GetKnownCertStoreType(int iKnownCertIndex);
int SetKnownCertStoreType(int iKnownCertIndex, int iKnownCertStoreType);

QString GetKnownCertSubjectAltNames(int iKnownCertIndex);

QString GetKnownCertThumbprintMD5(int iKnownCertIndex);

QString GetKnownCertThumbprintSHA1(int iKnownCertIndex);

QString GetKnownCertThumbprintSHA256(int iKnownCertIndex);

QString GetKnownCertUsage(int iKnownCertIndex);

int GetKnownCertUsageFlags(int iKnownCertIndex);

QString GetKnownCertVersion(int iKnownCertIndex);

QString GetKnownCertSubject(int iKnownCertIndex);
int SetKnownCertSubject(int iKnownCertIndex, QString qsKnownCertSubject);

QByteArray GetKnownCertEncoded(int iKnownCertIndex);
int SetKnownCertEncoded(int iKnownCertIndex, QByteArray qbaKnownCertEncoded);

Remarks

This property is used to supply a list of additional certificates to the class that might be needed for chain validation. For instance, intermediary CA certificates may be absent from the standard system locations (or there may be no standard system locations) and therefore should be supplied to the class manually.

The purpose of this certificate properties is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Note: Do not add trust anchors or root certificates to this properties; add them to TrustedCerts instead.

This property is not available at design time.

Data Type

SecurePDFCertificate

OfflineMode Property (PDFSign Class)

Whether the class is operating in offline mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOfflineMode();
int SetOfflineMode(int bOfflineMode);

Unicode (Windows)
BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);

int securepdf_pdfsign_getofflinemode(void* lpObj);
int securepdf_pdfsign_setofflinemode(void* lpObj, int bOfflineMode);

bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);

Default Value

FALSE

Remarks

This property indicates whether the class should operate in offline mode.

In offline mode, the class restricts itself from accessing online Trusted Lists and revocation information sources such as CRLs or OCSP responders. It may be useful to set this property to true if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCerts.

Data Type

Boolean

OutputData Property (PDFSign Class)

A byte array containing the PDF document after processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);

int securepdf_pdfsign_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);

QByteArray GetOutputData();

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (PDFSign Class)

The path to a local file where the output will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* securepdf_pdfsign_getoutputfile(void* lpObj);
int securepdf_pdfsign_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

Data Type

String

Overwrite Property (PDFSign Class)

Whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int securepdf_pdfsign_getoverwrite(void* lpObj);
int securepdf_pdfsign_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to false, an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Data Type

Boolean

Password Property (PDFSign Class)

The password to decrypt the document with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* securepdf_pdfsign_getpassword(void* lpObj);
int securepdf_pdfsign_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

Proxy Property (PDFSign Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

SecurePDFProxy* GetProxy();
int SetProxy(SecurePDFProxy* val);

int securepdf_pdfsign_getproxyauthscheme(void* lpObj);
int securepdf_pdfsign_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int securepdf_pdfsign_getproxyautodetect(void* lpObj);
int securepdf_pdfsign_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* securepdf_pdfsign_getproxypassword(void* lpObj);
int securepdf_pdfsign_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int securepdf_pdfsign_getproxyport(void* lpObj);
int securepdf_pdfsign_setproxyport(void* lpObj, int iProxyPort);

char* securepdf_pdfsign_getproxyserver(void* lpObj);
int securepdf_pdfsign_setproxyserver(void* lpObj, const char* lpszProxyServer);

int securepdf_pdfsign_getproxyssl(void* lpObj);
int securepdf_pdfsign_setproxyssl(void* lpObj, int iProxySSL);

char* securepdf_pdfsign_getproxyuser(void* lpObj);
int securepdf_pdfsign_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

SecurePDFProxy

RevocationCheck Property (PDFSign Class)

The kind(s) of revocation check to perform for all chain certificates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);

Unicode (Windows)
INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);

RC_ALL_CRL(0), 
RC_ALL_OCSP(1), 
RC_ALL_CRLAND_OCSP(2), 
RC_ANY_CRL(3), 
RC_ANY_OCSP(4), 
RC_ANY_CRLOR_OCSP(5), 
RC_ANY_OCSPOR_CRL(6)

int securepdf_pdfsign_getrevocationcheck(void* lpObj);
int securepdf_pdfsign_setrevocationcheck(void* lpObj, int iRevocationCheck);

int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);

Default Value

6

Remarks

This property is used to specify the revocation sources and preferences the class will use during chain validation. Revocation checking is necessary to ensure the integrity of the chain and to obtain up-to-date certificate validity and trust information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate has not been revoked by the Certificate Authority (CA) at the time of use. Depending on the circumstances and security policy requirements, either one or both of the revocation information source types may be used.

Possible values are:

This property controls the way revocation checks are performed for every certificate in the chain. Typically, certificates come with two types of revocation information sources: CRLs (Certificate Revocation Lists) and OCSP responses. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally a delay between the time at which a certificate was revoked and the time at which the subsequent CRL mentioning that revocation is published. The benefits of CRLs are that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This property allows the validation course to be adjusted by including or excluding certain types of revocation sources from the validation process. The rcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The rcAll* modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

Integer

SignatureAuthorName Property (PDFSign Class)

The human-readable name of the signer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureAuthorName();
int SetSignatureAuthorName(const char* lpszSignatureAuthorName);

Unicode (Windows)
LPWSTR GetSignatureAuthorName();
INT SetSignatureAuthorName(LPCWSTR lpszSignatureAuthorName);

char* securepdf_pdfsign_getsignatureauthorname(void* lpObj);
int securepdf_pdfsign_setsignatureauthorname(void* lpObj, const char* lpszSignatureAuthorName);

QString GetSignatureAuthorName();
int SetSignatureAuthorName(QString qsSignatureAuthorName);

Default Value

""

Remarks

This property is used to specify the human-readable name of the signer.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureClaimedSigningTime Property (PDFSign Class)

The signature's creation time.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureClaimedSigningTime();
int SetSignatureClaimedSigningTime(const char* lpszSignatureClaimedSigningTime);

Unicode (Windows)
LPWSTR GetSignatureClaimedSigningTime();
INT SetSignatureClaimedSigningTime(LPCWSTR lpszSignatureClaimedSigningTime);

char* securepdf_pdfsign_getsignatureclaimedsigningtime(void* lpObj);
int securepdf_pdfsign_setsignatureclaimedsigningtime(void* lpObj, const char* lpszSignatureClaimedSigningTime);

QString GetSignatureClaimedSigningTime();
int SetSignatureClaimedSigningTime(QString qsSignatureClaimedSigningTime);

Default Value

""

Remarks

This property is used to specify the signature creation time from the signer's computer. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureField Property (PDFSign Class)

The index of the empty signature field to sign.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureField();
int SetSignatureField(int iSignatureField);

Unicode (Windows)
INT GetSignatureField();
INT SetSignatureField(INT iSignatureField);

int securepdf_pdfsign_getsignaturefield(void* lpObj);
int securepdf_pdfsign_setsignaturefield(void* lpObj, int iSignatureField);

int GetSignatureField();
int SetSignatureField(int iSignatureField);

Default Value

-1

Remarks

This property is used to specify the empty signature field that should be signed. If the default value of -1 is assigned to this property, a new signature field will be created.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "emptyfield.pdf"; pdfsign.SignatureType = PDFSignSignatureTypes.stEmptyField; pdfsign.Sign(); // Later pdfsign.Reset(); pdfsign.InputFile = "emptyfield.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureField = 0; // Configure signature properties as desired pdfsign.Sign();

Data Type

Integer

SignatureHashAlgorithm Property (PDFSign Class)

The hash algorithm to be used for signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureHashAlgorithm();
int SetSignatureHashAlgorithm(const char* lpszSignatureHashAlgorithm);

Unicode (Windows)
LPWSTR GetSignatureHashAlgorithm();
INT SetSignatureHashAlgorithm(LPCWSTR lpszSignatureHashAlgorithm);

char* securepdf_pdfsign_getsignaturehashalgorithm(void* lpObj);
int securepdf_pdfsign_setsignaturehashalgorithm(void* lpObj, const char* lpszSignatureHashAlgorithm);

QString GetSignatureHashAlgorithm();
int SetSignatureHashAlgorithm(QString qsSignatureHashAlgorithm);

Default Value

"SHA256"

Remarks

This property is used to specify the hash algorithm to be used for signing.

Possible values are:

• SHA1
• SHA224
• SHA256
• SHA384
• SHA512
• MD5

Data Type

String

SignatureProfile Property (PDFSign Class)

The PAdES profile to apply when creating the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureProfile();
int SetSignatureProfile(int iSignatureProfile);

Unicode (Windows)
INT GetSignatureProfile();
INT SetSignatureProfile(INT iSignatureProfile);

PF_NONE(0), 
PF_BASELINE_B(1), 
PF_BASELINE_T(2), 
PF_BASELINE_LT(3), 
PF_BASELINE_LTA(4)

int securepdf_pdfsign_getsignatureprofile(void* lpObj);
int securepdf_pdfsign_setsignatureprofile(void* lpObj, int iSignatureProfile);

int GetSignatureProfile();
int SetSignatureProfile(int iSignatureProfile);

Default Value

0

Remarks

This property is used to specify a pre-defined PAdES profile to apply when creating the signature, as defined by ETSI.

Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants. Specifying a profile pre-configures the class to make it produce the signature that matches the configuration corresponding to that profile.

Possible values are:

To apply a custom profile that is not defined by ETSI, set the CustomProfile configuration setting.

Note: This property only applies when creating a new signature.

Data Type

Integer

SignatureReason Property (PDFSign Class)

The reason for signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureReason();
int SetSignatureReason(const char* lpszSignatureReason);

Unicode (Windows)
LPWSTR GetSignatureReason();
INT SetSignatureReason(LPCWSTR lpszSignatureReason);

char* securepdf_pdfsign_getsignaturereason(void* lpObj);
int securepdf_pdfsign_setsignaturereason(void* lpObj, const char* lpszSignatureReason);

QString GetSignatureReason();
int SetSignatureReason(QString qsSignatureReason);

Default Value

""

Remarks

This property is used to specify the reason for signing.

Note: This property only applies when creating a new signature.

Data Type

String

Signatures Property (PDFSign Class)

A collection of all the signatures and empty fields found in the PDF document.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFPDFSignature>* GetSignatures();

int securepdf_pdfsign_getpdfsignaturecount(void* lpObj);

char* securepdf_pdfsign_getpdfsignatureauthorname(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturechainvalidationdetails(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturechainvalidationresult(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignatureclaimedsigningtime(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturecoverageendsat(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturehashalgorithm(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignatureprofile(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturereason(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturetype(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturesignercertindex(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturetimestampcertindex(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturetimestamped(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturevalidatedsigningtime(void* lpObj, int pdfsignatureindex);

int securepdf_pdfsign_getpdfsignaturevalidationresult(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturewidgetheight(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturewidgetoffsetx(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturewidgetoffsety(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturewidgetpages(void* lpObj, int pdfsignatureindex);

char* securepdf_pdfsign_getpdfsignaturewidgetwidth(void* lpObj, int pdfsignatureindex);

int GetPDFSignatureCount();

QString GetPDFSignatureAuthorName(int iPDFSignatureIndex);

int GetPDFSignatureChainValidationDetails(int iPDFSignatureIndex);

int GetPDFSignatureChainValidationResult(int iPDFSignatureIndex);

QString GetPDFSignatureClaimedSigningTime(int iPDFSignatureIndex);

int GetPDFSignatureCoverageEndsAt(int iPDFSignatureIndex);

QString GetPDFSignatureHashAlgorithm(int iPDFSignatureIndex);

int GetPDFSignatureProfile(int iPDFSignatureIndex);

QString GetPDFSignatureReason(int iPDFSignatureIndex);

int GetPDFSignatureType(int iPDFSignatureIndex);

int GetPDFSignatureSignerCertIndex(int iPDFSignatureIndex);

int GetPDFSignatureTimestampCertIndex(int iPDFSignatureIndex);

bool GetPDFSignatureTimestamped(int iPDFSignatureIndex);

QString GetPDFSignatureValidatedSigningTime(int iPDFSignatureIndex);

int GetPDFSignatureValidationResult(int iPDFSignatureIndex);

QString GetPDFSignatureWidgetHeight(int iPDFSignatureIndex);

QString GetPDFSignatureWidgetOffsetX(int iPDFSignatureIndex);

QString GetPDFSignatureWidgetOffsetY(int iPDFSignatureIndex);

QString GetPDFSignatureWidgetPages(int iPDFSignatureIndex);

QString GetPDFSignatureWidgetWidth(int iPDFSignatureIndex);

Remarks

This property is used to access the details of all the signatures and empty signature fields identified in the document.

This property is read-only and not available at design time.

Data Type

SecurePDFPDFSignature

SignatureType Property (PDFSign Class)

The type of signature to create.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureType();
int SetSignatureType(int iSignatureType);

Unicode (Windows)
INT GetSignatureType();
INT SetSignatureType(INT iSignatureType);

ST_LEGACY(0), 
ST_ADVANCED(1), 
ST_DTS(2), 
ST_EMPTY_FIELD(3)

int securepdf_pdfsign_getsignaturetype(void* lpObj);
int securepdf_pdfsign_setsignaturetype(void* lpObj, int iSignatureType);

int GetSignatureType();
int SetSignatureType(int iSignatureType);

Default Value

0

Remarks

This property is used to specify the type of the signature.

Possible values are:

Note: This property only applies when creating a new signature.

Data Type

Integer

SignatureWidgetHeight Property (PDFSign Class)

The height of the signature widget.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureWidgetHeight();
int SetSignatureWidgetHeight(const char* lpszSignatureWidgetHeight);

Unicode (Windows)
LPWSTR GetSignatureWidgetHeight();
INT SetSignatureWidgetHeight(LPCWSTR lpszSignatureWidgetHeight);

char* securepdf_pdfsign_getsignaturewidgetheight(void* lpObj);
int securepdf_pdfsign_setsignaturewidgetheight(void* lpObj, const char* lpszSignatureWidgetHeight);

QString GetSignatureWidgetHeight();
int SetSignatureWidgetHeight(QString qsSignatureWidgetHeight);

Default Value

"70"

Remarks

This property is used to specify the height of the signature widget in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetOffsetX Property (PDFSign Class)

The signature widget offset from the left-hand page border.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureWidgetOffsetX();
int SetSignatureWidgetOffsetX(const char* lpszSignatureWidgetOffsetX);

Unicode (Windows)
LPWSTR GetSignatureWidgetOffsetX();
INT SetSignatureWidgetOffsetX(LPCWSTR lpszSignatureWidgetOffsetX);

char* securepdf_pdfsign_getsignaturewidgetoffsetx(void* lpObj);
int securepdf_pdfsign_setsignaturewidgetoffsetx(void* lpObj, const char* lpszSignatureWidgetOffsetX);

QString GetSignatureWidgetOffsetX();
int SetSignatureWidgetOffsetX(QString qsSignatureWidgetOffsetX);

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the left-hand page border in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetOffsetY Property (PDFSign Class)

The signature widget offset from the bottom page border.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureWidgetOffsetY();
int SetSignatureWidgetOffsetY(const char* lpszSignatureWidgetOffsetY);

Unicode (Windows)
LPWSTR GetSignatureWidgetOffsetY();
INT SetSignatureWidgetOffsetY(LPCWSTR lpszSignatureWidgetOffsetY);

char* securepdf_pdfsign_getsignaturewidgetoffsety(void* lpObj);
int securepdf_pdfsign_setsignaturewidgetoffsety(void* lpObj, const char* lpszSignatureWidgetOffsetY);

QString GetSignatureWidgetOffsetY();
int SetSignatureWidgetOffsetY(QString qsSignatureWidgetOffsetY);

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the bottom page border in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SignatureWidgetPages Property (PDFSign Class)

The pages to place the signature and its widget on.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureWidgetPages();
int SetSignatureWidgetPages(const char* lpszSignatureWidgetPages);

Unicode (Windows)
LPWSTR GetSignatureWidgetPages();
INT SetSignatureWidgetPages(LPCWSTR lpszSignatureWidgetPages);

char* securepdf_pdfsign_getsignaturewidgetpages(void* lpObj);
int securepdf_pdfsign_setsignaturewidgetpages(void* lpObj, const char* lpszSignatureWidgetPages);

QString GetSignatureWidgetPages();
int SetSignatureWidgetPages(QString qsSignatureWidgetPages);

Default Value

""

Remarks

This property is used to specify the pages on which the signature and its widget will be placed.

A variety of syntaxes are supported:

• A single page number: 3
• A comma-separated list of page numbers: 1,2,5,7
• The asterisk character (*) indicates that the widget should be placed on all pages in the document.
• The first and last placeholders specify that the signature should be placed on the respective page, independently of its number.

Data Type

String

SignatureWidgetWidth Property (PDFSign Class)

The width of the signature widget.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureWidgetWidth();
int SetSignatureWidgetWidth(const char* lpszSignatureWidgetWidth);

Unicode (Windows)
LPWSTR GetSignatureWidgetWidth();
INT SetSignatureWidgetWidth(LPCWSTR lpszSignatureWidgetWidth);

char* securepdf_pdfsign_getsignaturewidgetwidth(void* lpObj);
int securepdf_pdfsign_setsignaturewidgetwidth(void* lpObj, const char* lpszSignatureWidgetWidth);

QString GetSignatureWidgetWidth();
int SetSignatureWidgetWidth(QString qsSignatureWidgetWidth);

Default Value

"70"

Remarks

This property is used to specify the width of the signature widget in points. Both integer and decimal values are supported.

Note: This property only applies when creating a new signature.

Data Type

String

SigningCert Property (PDFSign Class)

The certificate to be used for signing.

Syntax

• C++
• C
• Qt

SecurePDFCertificate* GetSigningCert();
int SetSigningCert(SecurePDFCertificate* val);

char* securepdf_pdfsign_getsigningcerteffectivedate(void* lpObj);

char* securepdf_pdfsign_getsigningcertexpirationdate(void* lpObj);

char* securepdf_pdfsign_getsigningcertextendedkeyusage(void* lpObj);

char* securepdf_pdfsign_getsigningcertfingerprint(void* lpObj);

char* securepdf_pdfsign_getsigningcertfingerprintsha1(void* lpObj);

char* securepdf_pdfsign_getsigningcertfingerprintsha256(void* lpObj);

char* securepdf_pdfsign_getsigningcertissuer(void* lpObj);

char* securepdf_pdfsign_getsigningcertprivatekey(void* lpObj);

int securepdf_pdfsign_getsigningcertprivatekeyavailable(void* lpObj);

char* securepdf_pdfsign_getsigningcertprivatekeycontainer(void* lpObj);

char* securepdf_pdfsign_getsigningcertpublickey(void* lpObj);

char* securepdf_pdfsign_getsigningcertpublickeyalgorithm(void* lpObj);

int securepdf_pdfsign_getsigningcertpublickeylength(void* lpObj);

char* securepdf_pdfsign_getsigningcertserialnumber(void* lpObj);

char* securepdf_pdfsign_getsigningcertsignaturealgorithm(void* lpObj);

int securepdf_pdfsign_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int securepdf_pdfsign_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);

char* securepdf_pdfsign_getsigningcertstorepassword(void* lpObj);
int securepdf_pdfsign_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);

int securepdf_pdfsign_getsigningcertstoretype(void* lpObj);
int securepdf_pdfsign_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);

char* securepdf_pdfsign_getsigningcertsubjectaltnames(void* lpObj);

char* securepdf_pdfsign_getsigningcertthumbprintmd5(void* lpObj);

char* securepdf_pdfsign_getsigningcertthumbprintsha1(void* lpObj);

char* securepdf_pdfsign_getsigningcertthumbprintsha256(void* lpObj);

char* securepdf_pdfsign_getsigningcertusage(void* lpObj);

int securepdf_pdfsign_getsigningcertusageflags(void* lpObj);

char* securepdf_pdfsign_getsigningcertversion(void* lpObj);

char* securepdf_pdfsign_getsigningcertsubject(void* lpObj);
int securepdf_pdfsign_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);

int securepdf_pdfsign_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int securepdf_pdfsign_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);

QString GetSigningCertEffectiveDate();

QString GetSigningCertExpirationDate();

QString GetSigningCertExtendedKeyUsage();

QString GetSigningCertFingerprint();

QString GetSigningCertFingerprintSHA1();

QString GetSigningCertFingerprintSHA256();

QString GetSigningCertIssuer();

QString GetSigningCertPrivateKey();

bool GetSigningCertPrivateKeyAvailable();

QString GetSigningCertPrivateKeyContainer();

QString GetSigningCertPublicKey();

QString GetSigningCertPublicKeyAlgorithm();

int GetSigningCertPublicKeyLength();

QString GetSigningCertSerialNumber();

QString GetSigningCertSignatureAlgorithm();

QByteArray GetSigningCertStore();
int SetSigningCertStore(QByteArray qbaSigningCertStore);

QString GetSigningCertStorePassword();
int SetSigningCertStorePassword(QString qsSigningCertStorePassword);

int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

QString GetSigningCertSubjectAltNames();

QString GetSigningCertThumbprintMD5();

QString GetSigningCertThumbprintSHA1();

QString GetSigningCertThumbprintSHA256();

QString GetSigningCertUsage();

int GetSigningCertUsageFlags();

QString GetSigningCertVersion();

QString GetSigningCertSubject();
int SetSigningCertSubject(QString qsSigningCertSubject);

QByteArray GetSigningCertEncoded();
int SetSigningCertEncoded(QByteArray qbaSigningCertEncoded);

Remarks

This property is used to provide the certificate used for signing the document. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Data Type

SecurePDFCertificate

TimestampServer Property (PDFSign Class)

The address of the timestamping server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTimestampServer();
int SetTimestampServer(const char* lpszTimestampServer);

Unicode (Windows)
LPWSTR GetTimestampServer();
INT SetTimestampServer(LPCWSTR lpszTimestampServer);

char* securepdf_pdfsign_gettimestampserver(void* lpObj);
int securepdf_pdfsign_settimestampserver(void* lpObj, const char* lpszTimestampServer);

QString GetTimestampServer();
int SetTimestampServer(QString qsTimestampServer);

Default Value

""

Remarks

This property is used to specify the address of the TSA (Timestamping Authority) server to use for timestamping the signature (normal signing) or the document (LTV update).

If the timestamping service enforces credential-based user authentication (basic or digest), the credentials can be provided in the same URL. For example: pdfsign.TimestampServer = "http://user:password@timestamp.server.com/TsaService"; If the TSA requires TLS client authentication, provide the client certificate via the TSATLSClientCertStoreType, TSATLSClientCertStore, TSATLSClientCertSubject, and TSATLSClientCertStorePassword configuration settings.

Data Type

String

TrustedCerts Property (PDFSign Class)

A collection of trusted certificates for chain validation.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFCertificate>* GetTrustedCerts();
int SetTrustedCerts(SecurePDFList<SecurePDFCertificate>* val);

int securepdf_pdfsign_gettrustedcertcount(void* lpObj);
int securepdf_pdfsign_settrustedcertcount(void* lpObj, int iTrustedCertCount);

char* securepdf_pdfsign_gettrustedcerteffectivedate(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertexpirationdate(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertextendedkeyusage(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertfingerprint(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertfingerprintsha1(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertfingerprintsha256(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertissuer(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertprivatekey(void* lpObj, int trustedcertindex);

int securepdf_pdfsign_gettrustedcertprivatekeyavailable(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertprivatekeycontainer(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertpublickey(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertpublickeyalgorithm(void* lpObj, int trustedcertindex);

int securepdf_pdfsign_gettrustedcertpublickeylength(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertserialnumber(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertsignaturealgorithm(void* lpObj, int trustedcertindex);

int securepdf_pdfsign_gettrustedcertstore(void* lpObj, int trustedcertindex, char** lpTrustedCertStore, int* lenTrustedCertStore);
int securepdf_pdfsign_settrustedcertstore(void* lpObj, int trustedcertindex, const char* lpTrustedCertStore, int lenTrustedCertStore);

char* securepdf_pdfsign_gettrustedcertstorepassword(void* lpObj, int trustedcertindex);
int securepdf_pdfsign_settrustedcertstorepassword(void* lpObj, int trustedcertindex, const char* lpszTrustedCertStorePassword);

int securepdf_pdfsign_gettrustedcertstoretype(void* lpObj, int trustedcertindex);
int securepdf_pdfsign_settrustedcertstoretype(void* lpObj, int trustedcertindex, int iTrustedCertStoreType);

char* securepdf_pdfsign_gettrustedcertsubjectaltnames(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertthumbprintmd5(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertthumbprintsha1(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertthumbprintsha256(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertusage(void* lpObj, int trustedcertindex);

int securepdf_pdfsign_gettrustedcertusageflags(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertversion(void* lpObj, int trustedcertindex);

char* securepdf_pdfsign_gettrustedcertsubject(void* lpObj, int trustedcertindex);
int securepdf_pdfsign_settrustedcertsubject(void* lpObj, int trustedcertindex, const char* lpszTrustedCertSubject);

int securepdf_pdfsign_gettrustedcertencoded(void* lpObj, int trustedcertindex, char** lpTrustedCertEncoded, int* lenTrustedCertEncoded);
int securepdf_pdfsign_settrustedcertencoded(void* lpObj, int trustedcertindex, const char* lpTrustedCertEncoded, int lenTrustedCertEncoded);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

QString GetTrustedCertEffectiveDate(int iTrustedCertIndex);

QString GetTrustedCertExpirationDate(int iTrustedCertIndex);

QString GetTrustedCertExtendedKeyUsage(int iTrustedCertIndex);

QString GetTrustedCertFingerprint(int iTrustedCertIndex);

QString GetTrustedCertFingerprintSHA1(int iTrustedCertIndex);

QString GetTrustedCertFingerprintSHA256(int iTrustedCertIndex);

QString GetTrustedCertIssuer(int iTrustedCertIndex);

QString GetTrustedCertPrivateKey(int iTrustedCertIndex);

bool GetTrustedCertPrivateKeyAvailable(int iTrustedCertIndex);

QString GetTrustedCertPrivateKeyContainer(int iTrustedCertIndex);

QString GetTrustedCertPublicKey(int iTrustedCertIndex);

QString GetTrustedCertPublicKeyAlgorithm(int iTrustedCertIndex);

int GetTrustedCertPublicKeyLength(int iTrustedCertIndex);

QString GetTrustedCertSerialNumber(int iTrustedCertIndex);

QString GetTrustedCertSignatureAlgorithm(int iTrustedCertIndex);

QByteArray GetTrustedCertStore(int iTrustedCertIndex);
int SetTrustedCertStore(int iTrustedCertIndex, QByteArray qbaTrustedCertStore);

QString GetTrustedCertStorePassword(int iTrustedCertIndex);
int SetTrustedCertStorePassword(int iTrustedCertIndex, QString qsTrustedCertStorePassword);

int GetTrustedCertStoreType(int iTrustedCertIndex);
int SetTrustedCertStoreType(int iTrustedCertIndex, int iTrustedCertStoreType);

QString GetTrustedCertSubjectAltNames(int iTrustedCertIndex);

QString GetTrustedCertThumbprintMD5(int iTrustedCertIndex);

QString GetTrustedCertThumbprintSHA1(int iTrustedCertIndex);

QString GetTrustedCertThumbprintSHA256(int iTrustedCertIndex);

QString GetTrustedCertUsage(int iTrustedCertIndex);

int GetTrustedCertUsageFlags(int iTrustedCertIndex);

QString GetTrustedCertVersion(int iTrustedCertIndex);

QString GetTrustedCertSubject(int iTrustedCertIndex);
int SetTrustedCertSubject(int iTrustedCertIndex, QString qsTrustedCertSubject);

QByteArray GetTrustedCertEncoded(int iTrustedCertIndex);
int SetTrustedCertEncoded(int iTrustedCertIndex, QByteArray qbaTrustedCertEncoded);

Remarks

This property is used to supply a list of trusted certificates to the class that might be needed for chain validation. For instance, root CA certificates may be absent from the standard system locations (or there may be no standard system locations) and therefore should be supplied to the class manually.

The purpose of this certificate properties is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the list of trusted certificates may result in bad chains being accepted and forfeited signatures being recognized as genuine. Only add certificates that originate from parties that are known and trusted.

This property is not available at design time.

Data Type

SecurePDFCertificate

TrustedLists Property (PDFSign Class)

A list of known Trusted Lists for chain validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrustedLists();
int SetTrustedLists(const char* lpszTrustedLists);

Unicode (Windows)
LPWSTR GetTrustedLists();
INT SetTrustedLists(LPCWSTR lpszTrustedLists);

char* securepdf_pdfsign_gettrustedlists(void* lpObj);
int securepdf_pdfsign_settrustedlists(void* lpObj, const char* lpszTrustedLists);

QString GetTrustedLists();
int SetTrustedLists(QString qsTrustedLists);

Default Value

"%EUTL%"

Remarks

This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the class for chain validation.

A Trusted List is an XML document that contains a government-issued list of CAs that have passed regulated compliance checks. When validating the chain, the class will consult the Trusted List to establish certificate trust, ensuring that the CA is legitimate and entitled to issue certificates of the kind being checked.

The default value is the special %EUTL% macro, which, if applicable, instructs the class to check the root certificate against up-to-date versions of the primary EU Trusted Lists from the EU LOTL. Custom values can be appended: component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; Note: The class will cache all Trusted Lists it downloads and uses during chain validation. This cache is shared between class instances within the same process. If this property contains a URL that is also present in the cache, the class will retrieve the cached data and reuse them in the current validation. If the data are invalid, the class will download a fresh Trusted List and add it to the cache.

Data Type

String

TrustSources Property (PDFSign Class)

The trust sources to use during chain validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustSources();
int SetTrustSources(int iTrustSources);

Unicode (Windows)
INT GetTrustSources();
INT SetTrustSources(INT iTrustSources);

TS_MANUAL(0), 
TS_LOCAL(1), 
TS_TRUSTED_LISTS(2), 
TS_LOCAL_AND_TRUSTED_LISTS(3)

int securepdf_pdfsign_gettrustsources(void* lpObj);
int securepdf_pdfsign_settrustsources(void* lpObj, int iTrustSources);

int GetTrustSources();
int SetTrustSources(int iTrustSources);

Default Value

3

Remarks

This property is used to specify the sources the class will use to establish certificate trust during chain validation.

Establishing trust for a particular certificate, when either signing or verifying, involves building a chain up to a valid trust anchor. This trust anchor is a root certificate that typically resides on the local system. If the certificate does not eventually chain up to a valid trust anchor, the chain is considered untrusted and therefore invalid.

Possible values are:

Data Type

Integer

ValidationFlags Property (PDFSign Class)

Additional chain validation settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetValidationFlags();
int SetValidationFlags(int iValidationFlags);

Unicode (Windows)
INT GetValidationFlags();
INT SetValidationFlags(INT iValidationFlags);

int securepdf_pdfsign_getvalidationflags(void* lpObj);
int securepdf_pdfsign_setvalidationflags(void* lpObj, int iValidationFlags);

int GetValidationFlags();
int SetValidationFlags(int iValidationFlags);

Default Value

0

Remarks

This property is used to specify additional settings that affect the overall flow of the chain validation.

Its value should be provided as a bitmask of the following flags:

Data Type

Integer

ValidationPolicy Property (PDFSign Class)

The level at which to perform chain validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetValidationPolicy();
int SetValidationPolicy(int iValidationPolicy);

Unicode (Windows)
INT GetValidationPolicy();
INT SetValidationPolicy(INT iValidationPolicy);

VP_NONE(0), 
VP_FULL(1), 
VP_FULL_NO_TRUST(2), 
VP_FULL_NO_REVOCATION(3), 
VP_BEST_EFFORT(4)

int securepdf_pdfsign_getvalidationpolicy(void* lpObj);
int securepdf_pdfsign_setvalidationpolicy(void* lpObj, int iValidationPolicy);

int GetValidationPolicy();
int SetValidationPolicy(int iValidationPolicy);

Default Value

1

Remarks

This property is used to specify the overall validation policy the class will follow.

Possible values are:

Validation Policy Heuristics

Creating a new signature:

• For a basic signature with or without a timestamp, chain validation is not required, so it is recommended to use vpNone. This policy may also be used in test environments or on offline systems.
• For an LTV signature, use vpFull or vpFullNoTrust depending on whether trust checks are necessary in the current environment. If the signature is being created in an environment that does not match the prospective validation environment, consider vpFullNoTrust to validate the chain properly and fully without expecting good trust.

Updating or extending an existing signature:

• When updating a basic signature to LTV, similarly use vpFull or vpFullNoTrust as above.
• When extending an LTV signature, similarly use vpFull or vpFullNoTrust as above.

Validating an existing signature:

• For basic signature validation, use vpFullNoRevocation if trust checks, but not revocation checks, are necessary in the current environment. This policy may also be used on offline systems if the trust anchor is already available to the class.
• For archival validation, use vpFull to validate the chain properly and fully. This policy expects the trust anchor and all the revocation material to be available.

Data Type

Integer

ValidationTime Property (PDFSign Class)

The time point at which the signature should be validated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetValidationTime();
int SetValidationTime(const char* lpszValidationTime);

Unicode (Windows)
LPWSTR GetValidationTime();
INT SetValidationTime(LPCWSTR lpszValidationTime);

char* securepdf_pdfsign_getvalidationtime(void* lpObj);
int securepdf_pdfsign_setvalidationtime(void* lpObj, const char* lpszValidationTime);

QString GetValidationTime();
int SetValidationTime(QString qsValidationTime);

Default Value

""

Remarks

This property is used to specify the moment in time at which the signature validity should be established. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Leave this property empty to stick to the default time point. The class will then prioritize:

• The signature creation time if the signature contains a signature timestamp (ValidatedSigningTime), or
• The local time included in the signature by the signer (ClaimedSigningTime).

Data Type

String

AddAttachment Method (PDFSign Class)

Adds an attachment to a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddAttachment(const char* lpszFileName, const char* lpszDescription);

Unicode (Windows)
INT AddAttachment(LPCWSTR lpszFileName, LPCWSTR lpszDescription);

int securepdf_pdfsign_addattachment(void* lpObj, const char* lpszFileName, const char* lpszDescription);

int AddAttachment(const QString& qsFileName, const QString& qsDescription);

Remarks

This method is used to add an attachment (embedded file) to the document specified in InputFile, InputData, or SetInputStream and to the Attachments properties.

The document containing the newly added attachment will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

The FileName and Description parameters specify the filename and description of the attachment respectively.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "input_with_attachment.pdf"; pdfsign.Open(); pdfsign.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; pdfsign.Attachments.Add(attachment); // Or using one of the constructors: pdfsign.Attachments.Add(new PDFAttachment("foo.txt", "desc")); pdfsign.Close(); The full list of attachments is contained in the Attachments property.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddTimestamp Method (PDFSign Class)

Adds a document timestamp to a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddTimestamp();

Unicode (Windows)
INT AddTimestamp();

int securepdf_pdfsign_addtimestamp(void* lpObj);

int AddTimestamp();

Remarks

This method is used to obtain a document timestamp and embed it into the document specified in InputFile, InputData, or SetInputStream. The document containing the newly added document timestamp will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

A document timestamp is a fully independent signature that is added to the PDF document after the initial signature. Unlike the main signature, the document timestamp is made by a TSA, and its purpose is to preserve the document's long-term validity. Typically, adding a document timestamp is done close to the expiration date of the certificate that produced the last timestamp (which is either embedded in the main signature, or is a previous document timestamp). An LTV document therefore contains a chain of document timestamps updated periodically to keep its long-term status.

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "signed_with_dts.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.AddTimestamp(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Close Method (PDFSign Class)

Closes an opened PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int securepdf_pdfsign_close(void* lpObj);

int Close();

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. It should always be preceded by a call to the Open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (PDFSign Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* securepdf_pdfsign_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Encrypted Method (PDFSign Class)

Checks whether a PDF document is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();

bool securepdf_pdfsign_encrypted(void* lpObj);

bool Encrypted();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetPageProperty Method (PDFSign Class)

Retrieves the value of a page property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPageProperty(int iPage, const char* lpszPageProperty);

Unicode (Windows)
LPWSTR GetPageProperty(INT iPage, LPCWSTR lpszPageProperty);

char* securepdf_pdfsign_getpageproperty(void* lpObj, int iPage, const char* lpszPageProperty);

QString GetPageProperty(int iPage, const QString& qsPageProperty);

Remarks

This method is used to read general information about the pages of the document specified in InputFile, InputData, or SetInputStream, such as their dimensions and content positioning details.

The Page parameter specifies the page to read information about (with a valid range from 1 to PageCount), and the PageProperty parameter specifies the page property to read. The latter can take one of the following values:

Note: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 1; i <= pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(1, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(1, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetWidgetProperty Method (PDFSign Class)

Retrieves the value of a signature widget property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWidgetProperty(int iSignatureIndex, const char* lpszWidgetProperty);

Unicode (Windows)
LPWSTR GetWidgetProperty(INT iSignatureIndex, LPCWSTR lpszWidgetProperty);

char* securepdf_pdfsign_getwidgetproperty(void* lpObj, int iSignatureIndex, const char* lpszWidgetProperty);

QString GetWidgetProperty(int iSignatureIndex, const QString& qsWidgetProperty);

Remarks

This method is used to retrieve the value of a signature widget property. Together with SetWidgetProperty, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the class. The list of settings below may be extended in the future.

The SignatureIndex parameter is the index of the signature of interest in the Signatures properties, and the WidgetProperty parameter specifies the widget property to read. The latter can take one of the following values:

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.Open(); bool invisible = bool.Parse(pdfsign.GetWidgetProperty(0, "Invisible")); pdfsign.Close(); Note: Each widget property is only populated after the document has been signed and the signature widget has been generated.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (PDFSign Class)

Interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int securepdf_pdfsign_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts the current action. It can be used, for example, within the ChainCert event to abort the chain validation procedure.

If there is no action in progress, this method simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Open Method (PDFSign Class)

Opens a PDF document for processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int securepdf_pdfsign_open(void* lpObj);

int Open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as signing or updating. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Note: This method will populate the Attachments, DocumentCerts, and Signatures collections with any corresponding objects found in the document.

Automatic Decryption Functionality

Once the correct decryption material is supplied, the class will then attempt to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use the Decrypt method to save a decrypted copy of the document instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveAttachment Method (PDFSign Class)

Removes an attachment from a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveAttachment(int iIndex);

Unicode (Windows)
INT RemoveAttachment(INT iIndex);

int securepdf_pdfsign_removeattachment(void* lpObj, int iIndex);

int RemoveAttachment(int iIndex);

Remarks

This method is used to remove an attachment from the document specified in InputFile, InputData, or SetInputStream and from the Attachments properties.

The document without the attachment will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

The Index parameter is the index of the attachment in the Attachments properties to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (PDFSign Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int securepdf_pdfsign_reset(void* lpObj);

int Reset();

Remarks

This method is used to reset the class's properties and configuration settings to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveAttachment Method (PDFSign Class)

Saves a PDF attachment to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveAttachment(int iIndex, const char* lpszFileName);

Unicode (Windows)
INT SaveAttachment(INT iIndex, LPCWSTR lpszFileName);

int securepdf_pdfsign_saveattachment(void* lpObj, int iIndex, const char* lpszFileName);

int SaveAttachment(int iIndex, const QString& qsFileName);

Remarks

This method is used to retrieve the contents of an attachment from the document specified in InputFile, InputData, or SetInputStream and save it to the file specified by FileName. It does not modify the existence of the Attachments properties's contents.

The Index parameter is the index of the attachment in the Attachments properties to be saved.

The FileName parameter specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream field if it's set Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (PDFSign Class)

Sets the stream containing the PDF document to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(SecurePDFStream* sInputStream);

Unicode (Windows)
INT SetInputStream(SecurePDFStream* sInputStream);

int securepdf_pdfsign_setinputstream(void* lpObj, SecurePDFStream* sInputStream);

int SetInputStream(SecurePDFStream* sInputStream);

Remarks

This method is used to set the stream from which the class will read the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class will read the data from the input stream instead of from the InputFile or InputData properties.

Note: It may be useful to additionally set the CloseInputStreamAfterProcessing configuration setting to true when using input streams.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetOutputStream Method (PDFSign Class)

Sets the stream to write the processed document to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(SecurePDFStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(SecurePDFStream* sOutputStream);

int securepdf_pdfsign_setoutputstream(void* lpObj, SecurePDFStream* sOutputStream);

int SetOutputStream(SecurePDFStream* sOutputStream);

Remarks

This method is used to set the stream to which the class will write the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class will write the data to the output stream instead of writing to OutputFile or populating OutputData.

Note: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to true when using output streams.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetWidgetProperty Method (PDFSign Class)

Sets the value of a signature widget property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetWidgetProperty(const char* lpszWidgetProperty, const char* lpszValue);

Unicode (Windows)
INT SetWidgetProperty(LPCWSTR lpszWidgetProperty, LPCWSTR lpszValue);

int securepdf_pdfsign_setwidgetproperty(void* lpObj, const char* lpszWidgetProperty, const char* lpszValue);

int SetWidgetProperty(const QString& qsWidgetProperty, const QString& qsValue);

Remarks

This method is used to adjust the look of the signature widget when creating a signature. Together with GetWidgetProperty, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the class. The list of settings below may be extended in the future.

The WidgetProperty and Value parameters specify the widget property and value to set respectively. The former can take one of the following values:

Example: pdfsign.SetWidgetProperty("Width", "100"); pdfsign.SetWidgetProperty("Height", "100"); pdfsign.SetWidgetProperty("ShowDate", "false"); pdfsign.SetWidgetProperty("SignerInfo", "Hello\r\nworld!"); pdfsign.SetWidgetProperty("TitleFontSize", "11"); pdfsign.Sign();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (PDFSign Class)

Signs a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int securepdf_pdfsign_sign(void* lpObj);

int Sign();

Remarks

This method is used to sign the document specified in InputFile, InputData, or SetInputStream. The document will be signed with SigningCert and saved in OutputFile, OutputData, or the stream set in SetOutputStream.

Use the following properties to adjust new signature settings:

• SignatureAuthorName
• SignatureClaimedSigningTime
• SignatureHashAlgorithm
• SignatureProfile
• SignatureReason
• SignatureType
• SignatureWidgetHeight
• SignatureWidgetOffsetX
• SignatureWidgetOffsetY
• SignatureWidgetPages
• SignatureWidgetWidth

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Signed Method (PDFSign Class)

Checks whether a PDF document is signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Signed();

Unicode (Windows)
bool Signed();

bool securepdf_pdfsign_signed(void* lpObj);

bool Signed();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is signed. It will return false if the document contains only empty signature fields.

Example: pdfverify.InputFile = "input.pdf"; if (pdfverify.Signed()) { // Configure validation-related properties as desired pdfverify.Verify(); } Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Update Method (PDFSign Class)

Updates the most recent signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int securepdf_pdfsign_update(void* lpObj);

int Update();

Remarks

This method is used to update the most recent signature by embedding newer or missing revocation information into the signed document specified in InputFile, InputData, or SetInputStream. The updated document will be saved to OutputFile, OutputData, or the stream set in SetOutputStream.

Updating a signature starts with its cryptographic validation. Before any new validation material is inserted, the signature's integrity must be validated. If the signature is found to be correct, the class will proceed with chain validation and the retrieval of any missing chain elements. If the signature is cryptographically wrong, the class will throw an exception.

The update approach is typically used to extend the validity of an LTV signature. For LTA signatures, updating is typically accompanied with a document timestamping operation. Set TimestampServer to have the class obtain and embed a document timestamp automatically.

Further validation material and document timestamps may be added to a document over time to maintain its authenticity and integrity.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

Note: To choose a different signature to update, set the UpdateIndex configuration setting.

Note: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChainCert Event (PDFSign Class)

Fired when the class encounters a chain certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireChainCert(PDFSignChainCertEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *ValidationTime;
  int ValidationResult;
  int ValidationDetails;
  int reserved;
} PDFSignChainCertEventParams;


Unicode (Windows)
virtual INT FireChainCert(PDFSignChainCertEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR ValidationTime;
  INT ValidationResult;
  INT ValidationDetails;
  INT reserved;
} PDFSignChainCertEventParams;

#define EID_PDFSIGN_CHAINCERT 1

virtual INT SECUREPDF_CALL FireChainCert(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszValidationTime, INT &iValidationResult, INT &iValidationDetails);

class PDFSignChainCertEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &ValidationTime();

  int ValidationResult();
  void SetValidationResult(int iValidationResult);

  int ValidationDetails();
  void SetValidationDetails(int iValidationDetails);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ChainCert(PDFSignChainCertEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireChainCert(PDFSignChainCertEventParams *e) {...}

Remarks

This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The class will try to retrieve all required chain certificates automatically.

The CertEncoded parameter specifies the PEM (Base64-encoded) public certificate.

The CertSubject and CertIssuer parameters specify the distinguished names of the certificate owner and issuer respectively.

The ValidationTime parameter specifies the time point (in UTC) at which the certificate validity was established.

The ValidationResult parameter reports the outcome of the individual certificate validation and can be one of the following values:

In the case of a failure, the ValidationDetails parameter provides more details on its reasons. Its value is a bitmask of the following flags:

Overridable Chain Validation

For example, set ValidationResult to cvrValid and ValidationDetails to 0 in order to:

• Ignore CA or TLS key usage requirements
• Ignore the AuthorityKeyId extension in certificate-issuing CAs (helps with incorrectly renewed certificates)
• Ignore the Basic Constraints or Name Constraints extensions of CA certificates
• Tolerate some weaker algorithms
• Implicitly trust self-signed certificates
• Skip validity period checks for trusted certificates (helps with older devices that have expired root certificates)
• Ignore chain loops (helps with buggy CAs that include subchains that sign themselves)

Note: The user code is ultimately responsible for certificate validity decisions made via these two parameters. If their values are modified within this event, the resulting chain validation procedure may deviate from the standard.

DocumentInfo Event (PDFSign Class)

Fired when the document has been loaded into memory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDocumentInfo(PDFSignDocumentInfoEventParams *e);

typedef struct {
  int PageCount;
  int SignatureCount;
  int reserved;
} PDFSignDocumentInfoEventParams;


Unicode (Windows)
virtual INT FireDocumentInfo(PDFSignDocumentInfoEventParams *e);

typedef struct {
  INT PageCount;
  INT SignatureCount;
  INT reserved;
} PDFSignDocumentInfoEventParams;

#define EID_PDFSIGN_DOCUMENTINFO 2

virtual INT SECUREPDF_CALL FireDocumentInfo(INT &iPageCount, INT &iSignatureCount);

class PDFSignDocumentInfoEventParams {
public:
  int PageCount();

  int SignatureCount();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DocumentInfo(PDFSignDocumentInfoEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireDocumentInfo(PDFSignDocumentInfoEventParams *e) {...}

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, the GetPageProperty method can be used to find the optimal position for the signature widget.

The PageCount parameter reports the number of pages in the document.

The SignatureCount parameter reports the number of signatures in the document.

This event is fired when the Open method is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFSign Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PDFSignErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PDFSignErrorEventParams;


Unicode (Windows)
virtual INT FireError(PDFSignErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PDFSignErrorEventParams;

#define EID_PDFSIGN_ERROR 3

virtual INT SECUREPDF_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PDFSignErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PDFSignErrorEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireError(PDFSignErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFSign Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(PDFSignLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} PDFSignLogEventParams;


Unicode (Windows)
virtual INT FireLog(PDFSignLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} PDFSignLogEventParams;

#define EID_PDFSIGN_LOG 4

virtual INT SECUREPDF_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class PDFSignLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(PDFSignLogEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireLog(PDFSignLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration setting.

The LogLevel parameter indicates the detail level of the message. Possible values are:

The Message parameter is the log message.

The LogType parameter identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFSign Class)

Fired when the class detects that the PDF document is encrypted with a password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePassword(PDFSignPasswordEventParams *e);

typedef struct {
  int Available;
  int Cancel;
  int reserved;
} PDFSignPasswordEventParams;


Unicode (Windows)
virtual INT FirePassword(PDFSignPasswordEventParams *e);

typedef struct {
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFSignPasswordEventParams;

#define EID_PDFSIGN_PASSWORD 5

virtual INT SECUREPDF_CALL FirePassword(BOOL &bAvailable, BOOL &bCancel);

class PDFSignPasswordEventParams {
public:
  bool Available();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Password(PDFSignPasswordEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FirePassword(PDFSignPasswordEventParams *e) {...}

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to the Password property.

The Available parameter indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is set to false, the correct password must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a password.

RecipientInfo Event (PDFSign Class)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientInfo(PDFSignRecipientInfoEventParams *e);

typedef struct {
  const char *Issuer;
  const char *SerialNumber;
  const char *SubjectKeyIdentifier;
  int Available;
  int Cancel;
  int reserved;
} PDFSignRecipientInfoEventParams;


Unicode (Windows)
virtual INT FireRecipientInfo(PDFSignRecipientInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFSignRecipientInfoEventParams;

#define EID_PDFSIGN_RECIPIENTINFO 6

virtual INT SECUREPDF_CALL FireRecipientInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, BOOL &bAvailable, BOOL &bCancel);

class PDFSignRecipientInfoEventParams {
public:
  const QString &Issuer();

  const QString &SerialNumber();

  const QString &SubjectKeyIdentifier();

  bool Available();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RecipientInfo(PDFSignRecipientInfoEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireRecipientInfo(PDFSignRecipientInfoEventParams *e) {...}

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

The SubjectKeyIdentifier parameter specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

The Available parameter indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is set to false, the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a certificate.

Note: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

SignatureInfo Event (PDFSign Class)

Fired when the class finds a signature in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureInfo(PDFSignSignatureInfoEventParams *e);

typedef struct {
  int SignatureIndex;
  int ValidateSignature;
  int ValidateChain;
  int reserved;
} PDFSignSignatureInfoEventParams;


Unicode (Windows)
virtual INT FireSignatureInfo(PDFSignSignatureInfoEventParams *e);

typedef struct {
  INT SignatureIndex;
  BOOL ValidateSignature;
  BOOL ValidateChain;
  INT reserved;
} PDFSignSignatureInfoEventParams;

#define EID_PDFSIGN_SIGNATUREINFO 7

virtual INT SECUREPDF_CALL FireSignatureInfo(INT &iSignatureIndex, BOOL &bValidateSignature, BOOL &bValidateChain);

class PDFSignSignatureInfoEventParams {
public:
  int SignatureIndex();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureInfo(PDFSignSignatureInfoEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireSignatureInfo(PDFSignSignatureInfoEventParams *e) {...}

Remarks

This event is fired once for each signature found in the document to report that the signature specified by SignatureIndex is about to be validated.

The SignatureIndex parameter is the index of the signature in the Signatures properties.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. The ValidateSignature and ValidateChain parameters determine whether each stage should be included in the validation. They can be overridden to modify the validation policy on a per-signature basis, allowing signatures to be verified individually instead of all at once (via Verify). To skip validation entirely, set both parameters to false.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

SignatureProcessed Event (PDFSign Class)

Fired after a signature has been processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureProcessed(PDFSignSignatureProcessedEventParams *e);

typedef struct {
  int SignatureIndex;
  int SignatureValidationResult;
  int ChainValidationResult;
  int ChainValidationDetails;
  int reserved;
} PDFSignSignatureProcessedEventParams;


Unicode (Windows)
virtual INT FireSignatureProcessed(PDFSignSignatureProcessedEventParams *e);

typedef struct {
  INT SignatureIndex;
  INT SignatureValidationResult;
  INT ChainValidationResult;
  INT ChainValidationDetails;
  INT reserved;
} PDFSignSignatureProcessedEventParams;

#define EID_PDFSIGN_SIGNATUREPROCESSED 8

virtual INT SECUREPDF_CALL FireSignatureProcessed(INT &iSignatureIndex, INT &iSignatureValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails);

class PDFSignSignatureProcessedEventParams {
public:
  int SignatureIndex();

  int SignatureValidationResult();

  int ChainValidationResult();

  int ChainValidationDetails();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureProcessed(PDFSignSignatureProcessedEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireSignatureProcessed(PDFSignSignatureProcessedEventParams *e) {...}

Remarks

This event is fired once for each signature found in the document to report that the signature specified by SignatureIndex has completed validation. It is fired after SignatureInfo if that event's ValidateSignature parameter is set to true.

The SignatureIndex parameter is the index of the signature in the Signatures properties.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in the SignatureValidationResult and ChainValidationResult parameters.

The former reports the validity of the signature and can be one of the following values:

The latter reports the validity of the chain and can be one of the following values:

In the case of a failure, the ChainValidationDetails parameter provides more details on its reasons. Its value is a bitmask of the following flags:

Note: SignatureValidationResult, ChainValidationResult, and ChainValidationDetails are also available as fields in the PDFSignature type.

SSLServerAuthentication Event (PDFSign Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(PDFSignSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} PDFSignSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(PDFSignSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} PDFSignSSLServerAuthenticationEventParams;

#define EID_PDFSIGN_SSLSERVERAUTHENTICATION 9

virtual INT SECUREPDF_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class PDFSignSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(PDFSignSSLServerAuthenticationEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireSSLServerAuthentication(PDFSignSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the class. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When the Accept parameter is false, the Status parameter shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to true.

SSLStatus Event (PDFSign Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(PDFSignSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} PDFSignSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(PDFSignSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} PDFSignSSLStatusEventParams;

#define EID_PDFSIGN_SSLSTATUS 10

virtual INT SECUREPDF_CALL FireSSLStatus(LPSTR &lpszMessage);

class PDFSignSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(PDFSignSSLStatusEventParams *e);

// Or, subclass PDFSign and override this emitter function.
virtual int FireSSLStatus(PDFSignSSLStatusEventParams *e) {...}

Remarks

This event is fired during timestamping or chain validation for informational and logging purposes only. This event tracks the progress of the SSL/TLS connection. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

Certificate Type

This is the digital certificate being used.

Syntax

SecurePDFCertificate (declared in securepdf.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

SecurePDFFirewall (declared in securepdf.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

PDFAttachment Type

This describes the file being attached to the PDF document.

Syntax

SecurePDFPDFAttachment (declared in securepdf.h)

Remarks

This type contains information about the file that is being attached to the document.

Fields

Constructors

PDFAttachment()

PDFAttachment(const char* lpszFileName)

PDFAttachment(const char* lpszFileName, const char* lpszDescription)

PDFAttachment(const char* lpData, int lenData, const char* lpszName, const char* lpszDescription)

PDFSignature Type

A container for PDF signature details.

Syntax

SecurePDFPDFSignature (declared in securepdf.h)

Remarks

This type contains details about the signature. Use it to read information about the signature when processing it.

Fields