Signing
Digitally Sign PDF Files - DigitalSignatures
Sample code to use Apryse SDK's high-level digital signature API for digitally signing and/or certifying PDF files; provided in Python, C++, C#, Java, Node.js (JavaScript), PHP, Ruby and VB.
Learn more about our Server SDK and PDF Digital Signature Library.
Implementation steps
To apply and validate digital signatures with Apryse Server SDK:
Step 1: Follow get started with Server SDK in your preferred language or framework Step 2: Add the sample code provided in this guide. Make note of directions at top of code samples.
To use this feature in production, your license key will need the Digital Signature Package. Trial keys already include all packages.
//
// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
//
//----------------------------------------------------------------------------------------------------------------------
// This sample demonstrates the basic usage of the high-level digital signatures API in PDFNet.
//
// The following steps reflect typical intended usage of the digital signatures API:
//
// 0. Start with a PDF with or without form fields in it that one would like to lock (or, one can add a field, see (1)).
//
// 1. EITHER:
// (a) Call doc.CreateDigitalSignatureField, optionally providing a name. You receive a DigitalSignatureField.
// -OR-
// (b) If you didn't just create the digital signature field that you want to sign/certify, find the existing one within the
// document by using PDFDoc.DigitalSignatureFieldIterator or by using PDFDoc.GetField to get it by its fully qualified name.
//
// 2. Create a signature widget annotation, and pass the DigitalSignatureField that you just created or found.
// If you want it to be visible, provide a Rect argument with a non-zero width or height, and don't set the
// NoView and Hidden flags. [Optionally, add an appearance to the annotation when you wish to sign/certify.]
//
// [3. (OPTIONAL) Add digital signature restrictions to the document using the field modification permissions (SetFieldPermissions)
// or document modification permissions functions (SetDocumentPermissions) of DigitalSignatureField. These features disallow
// certain types of changes to be made to the document without invalidating the cryptographic digital signature once it
// is signed.]
//
// 4. Call either CertifyOnNextSave or SignOnNextSave. There are three overloads for each one (six total):
// a. Taking a PKCS #12 keyfile path and its password
// b. Taking a buffer containing a PKCS #12 private keyfile and its password
// c. Taking a unique identifier of a signature handler registered with the PDFDoc. This overload is to be used
// in the following fashion:
// i) Extend and implement a new SignatureHandler. The SignatureHandler will be used to add or
// validate/check a digital signature.
// ii) Create an instance of the implemented SignatureHandler and register it with PDFDoc with
// pdfdoc.AddSignatureHandler(). The method returns a SignatureHandlerId.
// iii) Call SignOnNextSaveWithCustomHandler/CertifyOnNextSaveWithCustomHandler with the SignatureHandlerId.
// NOTE: It is only possible to sign/certify one signature per call to the Save function.
//
// 5. Call pdfdoc.Save(). This will also create the digital signature dictionary and write a cryptographic signature to it.
// IMPORTANT: If there are already signed/certified digital signature(s) in the document, you must save incrementally
// so as to not invalidate the other signature(s).
//
// Additional processing can be done before document is signed. For example, UseSignatureHandler() returns an instance
// of SDF dictionary which represents the signature dictionary (or the /V entry of the form field). This can be used to
// add additional information to the signature dictionary (e.g. Name, Reason, Location, etc.).
//
// Although the steps above describes extending the SignatureHandler class, this sample demonstrates the use of
// StdSignatureHandler (a built-in SignatureHandler in PDFNet) to sign a PDF file.
//----------------------------------------------------------------------------------------------------------------------
// In order to use .NET Framework's Cryptography library, define "USE_DOTNET_CRYPTO" and then add System.Security to
// references list.
using System;
using System.Collections.Generic;
using System.IO;
#if USE_DOTNET_CRYPTO
using System.Security.Cryptography;
using System.Security.Cryptography.Pkcs;
using System.Security.Cryptography.X509Certificates;
#endif // USE_DOTNET_CRYPTO
using pdftron;
using pdftron.Common;
using pdftron.PDF;
using pdftron.PDF.Annots;
using pdftron.SDF;
using pdftron.Crypto;
namespace DigitalSignaturesTestCS
{
//////////////////// Here follows an example of how to implement a custom signature handler. //////////
#if USE_DOTNET_CRYPTO
class DotNetCryptoSignatureHandler : SignatureHandler
{
private List<byte> m_data;
private string m_signingCert;
private string m_certPassword;
public DotNetCryptoSignatureHandler(string signingCert, string password)
{
m_signingCert = signingCert;
m_certPassword = password;
m_data = new List<byte>();
}
public override void AppendData(byte[] data)
{
m_data.AddRange(data);
}
public override bool Reset()
{
m_data.Clear();
return (true);
}
public override byte[] CreateSignature()
{
try {
ContentInfo ci = new ContentInfo(m_data.ToArray());
SignedCms sc = new SignedCms(ci, true);
X509Certificate2 cert = new X509Certificate2(m_signingCert, m_certPassword);
CmsSigner cs = new CmsSigner();
cs.Certificate = cert;
cs.DigestAlgorithm = new Oid("2.16.840.1.101.3.4.2.1");//SHA256
sc.ComputeSignature(cs);
byte[] sig = sc.Encode();
return (sig);
}
catch (Exception e) {
Console.Error.WriteLine(e);
}
return (null);
}
public override string GetName()
{
return ("Adobe.PPKLite");
}
}
#endif // USE_DOTNET_CRYPTO
////////// End of the DotNetCryptoSignatureHandler custom handler code. ////////////////////
class Class1
{
static string input_path = "../../../../TestFiles/";
static string output_path = "../../../../TestFiles/Output/";
static bool VerifySimple (string in_docpath, string in_public_key_file_path)
{
using (PDFDoc doc = new PDFDoc(in_docpath))
{
Console.WriteLine("==========");
VerificationOptions opts = new VerificationOptions(VerificationOptions.SignatureVerificationSecurityLevel.e_compatibility_and_archiving);
// Add trust root to store of trusted certificates contained in VerificationOptions.
opts.AddTrustedCertificate(in_public_key_file_path,
(ushort)(VerificationOptions.CertificateTrustFlag.e_default_trust | VerificationOptions.CertificateTrustFlag.e_certification_trust));
PDFDoc.SignaturesVerificationStatus result = doc.VerifySignedDigitalSignatures(opts);
switch (result)
{
case PDFDoc.SignaturesVerificationStatus.e_unsigned:
Console.WriteLine("Document has no signed signature fields.");
return false;
/* e_failure == bad doc status, digest status, or permissions status
(i.e. does not include trust issues, because those are flaky due to being network/config-related) */
case PDFDoc.SignaturesVerificationStatus.e_failure:
Console.WriteLine("Hard failure in verification on at least one signature.");
return false;
case PDFDoc.SignaturesVerificationStatus.e_untrusted:
Console.WriteLine("Could not verify trust for at least one signature.");
return false;
case PDFDoc.SignaturesVerificationStatus.e_unsupported:
/* If necessary, call GetUnsupportedFeatures on VerificationResult to check which
unsupported features were encountered (requires verification using 'detailed' APIs) */
Console.WriteLine("At least one signature contains unsupported features.");
return false;
// unsigned sigs skipped; parts of document may be unsigned (check GetByteRanges on signed sigs to find out)
case PDFDoc.SignaturesVerificationStatus.e_verified:
Console.WriteLine("All signed signatures in document verified.");
return true;
default:
throw new Exception("unrecognized document verification status");
}
}
}
static bool VerifyAllAndPrint(string in_docpath, string in_public_key_file_path)
{
using (PDFDoc doc = new PDFDoc(in_docpath))
{
Console.WriteLine("==========");
VerificationOptions opts = new VerificationOptions(VerificationOptions.SignatureVerificationSecurityLevel.e_compatibility_and_archiving);
// Add trust root to store of trusted certificates contained in VerificationOptions.
opts.AddTrustedCertificate(in_public_key_file_path,
(ushort) (VerificationOptions.CertificateTrustFlag.e_default_trust | VerificationOptions.CertificateTrustFlag.e_certification_trust));
// Iterate over the signatures and verify all of them.
DigitalSignatureFieldIterator digsig_fitr = doc.GetDigitalSignatureFieldIterator();
bool verification_status = true;
for (; digsig_fitr.HasNext(); digsig_fitr.Next())
{
DigitalSignatureField curr = digsig_fitr.Current();
VerificationResult result = curr.Verify(opts);
if (result.GetVerificationStatus())
{
Console.Write("Signature verified, ");
}
else
{
Console.Write("Signature verification failed, ");
verification_status = false;
}
Console.WriteLine("objnum: {0}", curr.GetSDFObj().GetObjNum());
switch (result.GetDigestAlgorithm())
{
case DigestAlgorithm.Type.e_sha1:
Console.WriteLine("Digest algorithm: SHA-1");
break;
case DigestAlgorithm.Type.e_sha256:
Console.WriteLine("Digest algorithm: SHA-256");
break;
case DigestAlgorithm.Type.e_sha384:
Console.WriteLine("Digest algorithm: SHA-384");
break;
case DigestAlgorithm.Type.e_sha512:
Console.WriteLine("Digest algorithm: SHA-512");
break;
case DigestAlgorithm.Type.e_ripemd160:
Console.WriteLine("Digest algorithm: RIPEMD-160");
break;
case DigestAlgorithm.Type.e_unknown_digest_algorithm:
Console.WriteLine("Digest algorithm: unknown");
break;
default:
throw new Exception("unrecognized digest algorithm");
}
Console.WriteLine("Detailed verification result: \n\t{0}\n\t{1}\n\t{2}\n\t{3}",
result.GetDocumentStatusAsString(),
result.GetDigestStatusAsString(),
result.GetTrustStatusAsString(),
result.GetPermissionsStatusAsString());
DisallowedChange[] changes = result.GetDisallowedChanges();
foreach (DisallowedChange it2 in changes)
{
Console.WriteLine("\tDisallowed change: {0}, objnum: {1}", it2.GetTypeAsString(), it2.GetObjNum());
}
// Get and print all the detailed trust-related results, if they are available.
if (result.HasTrustVerificationResult())
{
TrustVerificationResult trust_verification_result = result.GetTrustVerificationResult();
Console.WriteLine(trust_verification_result.WasSuccessful() ? "Trust verified." : "Trust not verifiable.");
Console.WriteLine(trust_verification_result.GetResultString());
long time_of_verification = trust_verification_result.GetTimeOfTrustVerification();
switch (trust_verification_result.GetTimeOfTrustVerificationEnum())
{
case VerificationOptions.TimeMode.e_current:
Console.WriteLine("Trust verification attempted with respect to current time (as epoch time): {0}", time_of_verification);
break;
case VerificationOptions.TimeMode.e_signing:
Console.WriteLine("Trust verification attempted with respect to signing time (as epoch time): {0}", time_of_verification);
break;
case VerificationOptions.TimeMode.e_timestamp:
Console.WriteLine("Trust verification attempted with respect to secure embedded timestamp (as epoch time): {0}", time_of_verification);
break;
default:
throw new Exception("unrecognized time enum value");
}
if (trust_verification_result.GetCertPath().Length == 0)
{
Console.WriteLine("Could not print certificate path.");
}
else
{
Console.WriteLine("Certificate path:");
X509Certificate[] cert_path = trust_verification_result.GetCertPath();
for (int j = 0; j < cert_path.Length; j++)
{
Console.WriteLine("\tCertificate:");
X509Certificate full_cert = cert_path[j];
Console.WriteLine("\t\tIssuer names:");
X501AttributeTypeAndValue[] issuer_dn = full_cert.GetIssuerField().GetAllAttributesAndValues();
for (int i = 0; i < issuer_dn.Length; i++)
{
Console.WriteLine("\t\t\t" + issuer_dn[i].GetStringValue());
}
Console.WriteLine("\t\tSubject names:");
X501AttributeTypeAndValue[] subject_dn = full_cert.GetSubjectField().GetAllAttributesAndValues();
for (int i = 0; i < subject_dn.Length; i++)
{
Console.WriteLine("\t\t\t" + subject_dn[i].GetStringValue());
}
Console.WriteLine("\t\tExtensions:");
for (int i = 0; i < full_cert.GetExtensions().Length; i++)
{
Console.WriteLine("\t\t\t" + full_cert.GetExtensions()[i].ToString());
}
}
}
}
else
{
Console.WriteLine("No detailed trust verification result available.");
}
string[] unsupported_features = result.GetUnsupportedFeatures();
if (unsupported_features.Length > 0)
{
Console.WriteLine("Unsupported features:");
for (int i = 0; i < unsupported_features.Length; i++)
{
Console.WriteLine("\t" + unsupported_features[i]);
}
}
Console.WriteLine("==========");
}
return verification_status;
}
}
static void CertifyPDF(string in_docpath,
string in_cert_field_name,
string in_private_key_file_path,
string in_keyfile_password,
string in_appearance_image_path,
string in_outpath)
{
Console.Out.WriteLine("================================================================================");
Console.Out.WriteLine("Certifying PDF document");
// Open an existing PDF
using (PDFDoc doc = new PDFDoc(in_docpath))
{
Console.Out.WriteLine("PDFDoc has " + (doc.HasSignatures() ? "signatures" : "no signatures"));
Page page1 = doc.GetPage(1);
// Create a text field that we can lock using the field permissions feature.
TextWidget annot1 = TextWidget.Create(doc, new Rect(143, 440, 350, 460), "asdf_test_field");
page1.AnnotPushBack(annot1);
/* Create a new signature form field in the PDFDoc. The name argument is optional;
leaving it empty causes it to be auto-generated. However, you may need the name for later.
Acrobat doesn't show digsigfield in side panel if it's without a widget. Using a
Rect with 0 width and 0 height, or setting the NoPrint/Invisible flags makes it invisible. */
DigitalSignatureField certification_sig_field = doc.CreateDigitalSignatureField(in_cert_field_name);
SignatureWidget widgetAnnot = SignatureWidget.Create(doc, new Rect(143, 287, 219, 306), certification_sig_field);
page1.AnnotPushBack(widgetAnnot);
// (OPTIONAL) Add an appearance to the signature field.
Image img = Image.Create(doc, in_appearance_image_path);
widgetAnnot.CreateSignatureAppearance(img);
// Prepare the document locking permission level. It will be applied upon document certification.
Console.Out.WriteLine("Adding document permissions.");
certification_sig_field.SetDocumentPermissions(DigitalSignatureField.DocumentPermissions.e_annotating_formfilling_signing_allowed);
// Prepare to lock the text field that we created earlier.
Console.Out.WriteLine("Adding field permissions.");
string[] fields_to_lock = new string[1];
fields_to_lock[0] = "asdf_test_field";
certification_sig_field.SetFieldPermissions(DigitalSignatureField.FieldPermissions.e_include, fields_to_lock);
#if USE_DOTNET_CRYPTO
DotNetCryptoSignatureHandler sigHandler = new DotNetCryptoSignatureHandler(in_private_key_file_path, in_keyfile_password);
SignatureHandlerId sigHandlerId = doc.AddSignatureHandler(sigHandler);
certification_sig_field.CertifyOnNextSaveWithCustomHandler(sigHandlerId);
/* Add to the digital signature dictionary a SubFilter name that uniquely identifies the signature format
for verification tools. As an example, the custom handler defined in this file uses the CMS/PKCS #7 detached format,
so we embed one of the standard predefined SubFilter values: "adbe.pkcs7.detached". It is not necessary to do this
when using the StdSignatureHandler. */
Obj f_obj = certification_sig_field.GetSDFObj();
f_obj.FindObj("V").PutName("SubFilter", "adbe.pkcs7.detached");
#else
certification_sig_field.CertifyOnNextSave(in_private_key_file_path, in_keyfile_password);
#endif
// (OPTIONAL) Add more information to the signature dictionary.
certification_sig_field.SetLocation("Vancouver, BC");
certification_sig_field.SetReason("Document certification.");
certification_sig_field.SetContactInfo("www.pdftron.com");
// Save the PDFDoc. Once the method below is called, PDFNet will also sign the document using the information provided.
doc.Save(in_outpath, 0);
}
Console.Out.WriteLine("================================================================================");
}
static void SignPDF(string in_docpath,
string in_approval_field_name,
string in_private_key_file_path,
string in_keyfile_password,
string in_appearance_img_path,
string in_outpath)
{
Console.Out.WriteLine("================================================================================");
Console.Out.WriteLine("Signing PDF document");
// Open an existing PDF
using (PDFDoc doc = new PDFDoc(in_docpath))
{
// Retrieve the unsigned approval signature field.
Field found_approval_field = doc.GetField(in_approval_field_name);
DigitalSignatureField found_approval_signature_digsig_field = new DigitalSignatureField(found_approval_field);
// (OPTIONAL) Add an appearance to the signature field.
Image img = Image.Create(doc, in_appearance_img_path);
SignatureWidget found_approval_signature_widget = new SignatureWidget(found_approval_field.GetSDFObj());
found_approval_signature_widget.CreateSignatureAppearance(img);
// Prepare the signature and signature handler for signing.
#if USE_DOTNET_CRYPTO
DotNetCryptoSignatureHandler sigHandler = new DotNetCryptoSignatureHandler(in_private_key_file_path, in_keyfile_password);
SignatureHandlerId sigHandlerId = doc.AddSignatureHandler(sigHandler);
found_approval_signature_digsig_field.SignOnNextSaveWithCustomHandler(sigHandlerId);
/* Add a SubFilter name that uniquely identifies the signature format for verification tools. As an
example, the custom handler defined in this file uses the CMS/PKCS #7 detached format, so we embed
one of the standard predefined SubFilter values: "adbe.pkcs7.detached". It is not necessary to do this
when using the StdSignatureHandler.*/
Obj f_obj = found_approval_signature_digsig_field.GetSDFObj();
f_obj.FindObj("V").PutName("SubFilter", "adbe.pkcs7.detached");
#else
found_approval_signature_digsig_field.SignOnNextSave(in_private_key_file_path, in_keyfile_password);
#endif
// The actual approval signing will be done during the following incremental save operation.
doc.Save(in_outpath, SDFDoc.SaveOptions.e_incremental);
}
Console.Out.WriteLine("================================================================================");
}
static void ClearSignature(string in_docpath,
string in_digsig_field_name,
string in_outpath)
{
Console.Out.WriteLine("================================================================================");
Console.Out.WriteLine("Clearing certification signature");
using (PDFDoc doc = new PDFDoc(in_docpath))
{
DigitalSignatureField digsig = new DigitalSignatureField(doc.GetField(in_digsig_field_name));
Console.Out.WriteLine("Clearing signature: " + in_digsig_field_name);
digsig.ClearSignature();
if (!digsig.HasCryptographicSignature())
{
Console.Out.WriteLine("Cryptographic signature cleared properly.");
}
// Save incrementally so as to not invalidate other signatures from previous saves.
doc.Save(in_outpath, SDFDoc.SaveOptions.e_incremental);
}
Console.Out.WriteLine("================================================================================");
}
static void PrintSignaturesInfo(string in_docpath)
{
Console.Out.WriteLine("================================================================================");
Console.Out.WriteLine("Reading and printing digital signature information");
using (PDFDoc doc = new PDFDoc(in_docpath))
{
if (!doc.HasSignatures())
{
Console.Out.WriteLine("Doc has no signatures.");
Console.Out.WriteLine("================================================================================");
return;
}
else
{
Console.Out.WriteLine("Doc has signatures.");
}
for (FieldIterator fitr = doc.GetFieldIterator(); fitr.HasNext(); fitr.Next())
{
if (fitr.Current().IsLockedByDigitalSignature())
{
Console.Out.WriteLine("==========\nField locked by a digital signature");
}
else
{
Console.Out.WriteLine("==========\nField not locked by a digital signature");
}
Console.Out.WriteLine("Field name: " + fitr.Current().GetName());
Console.Out.WriteLine("==========");
}
Console.Out.WriteLine("====================\nNow iterating over digital signatures only.\n====================");
DigitalSignatureFieldIterator digsig_fitr = doc.GetDigitalSignatureFieldIterator();
for (; digsig_fitr.HasNext(); digsig_fitr.Next())
{
Console.Out.WriteLine("==========");
Console.Out.WriteLine("Field name of digital signature: " + new Field(digsig_fitr.Current().GetSDFObj()).GetName());
DigitalSignatureField digsigfield = digsig_fitr.Current();
if (!digsigfield.HasCryptographicSignature())
{
Console.Out.WriteLine("Either digital signature field lacks a digital signature dictionary, " +
"or digital signature dictionary lacks a cryptographic Contents entry. " +
"Digital signature field is not presently considered signed.\n" +
"==========");
continue;
}
int cert_count = digsigfield.GetCertCount();
Console.Out.WriteLine("Cert count: " + cert_count);
for (int i = 0; i < cert_count; ++i)
{
byte[] cert = digsigfield.GetCert(i);
Console.Out.WriteLine("Cert #" + i + " size: " + cert.Length);
}
DigitalSignatureField.SubFilterType subfilter = digsigfield.GetSubFilter();
Console.Out.WriteLine("Subfilter type: " + (int)subfilter);
if (subfilter != DigitalSignatureField.SubFilterType.e_ETSI_RFC3161)
{
Console.Out.WriteLine("Signature's signer: " + digsigfield.GetSignatureName());
Date signing_time = digsigfield.GetSigningTime();
if (signing_time.IsValid())
{
Console.Out.WriteLine("Signing time is valid.");
}
Console.Out.WriteLine("Location: " + digsigfield.GetLocation());
Console.Out.WriteLine("Reason: " + digsigfield.GetReason());
Console.Out.WriteLine("Contact info: " + digsigfield.GetContactInfo());
}
else
{
Console.Out.WriteLine("SubFilter == e_ETSI_RFC3161 (DocTimeStamp; no signing info)\n");
}
Console.Out.WriteLine(((digsigfield.HasVisibleAppearance()) ? "Visible" : "Not visible"));
DigitalSignatureField.DocumentPermissions digsig_doc_perms = digsigfield.GetDocumentPermissions();
string[] locked_fields = digsigfield.GetLockedFields();
foreach (string field_name in locked_fields)
{
Console.Out.WriteLine("This digital signature locks a field named: " + field_name);
}
switch (digsig_doc_perms)
{
case DigitalSignatureField.DocumentPermissions.e_no_changes_allowed:
Console.Out.WriteLine("No changes to the document can be made without invalidating this digital signature.");
break;
case DigitalSignatureField.DocumentPermissions.e_formfilling_signing_allowed:
Console.Out.WriteLine("Page template instantiation, form filling, and signing digital signatures are allowed without invalidating this digital signature.");
break;
case DigitalSignatureField.DocumentPermissions.e_annotating_formfilling_signing_allowed:
Console.Out.WriteLine("Annotating, page template instantiation, form filling, and signing digital signatures are allowed without invalidating this digital signature.");
break;
case DigitalSignatureField.DocumentPermissions.e_unrestricted:
Console.Out.WriteLine("Document not restricted by this digital signature.");
break;
default:
throw new Exception("Unrecognized digital signature document permission level.");
}
Console.Out.WriteLine("==========");
}
}
Console.Out.WriteLine("================================================================================");
}
static void CustomSigningAPI(string doc_path,
string cert_field_name,
string private_key_file_path,
string keyfile_password,
string public_key_file_path,
string appearance_image_path,
DigestAlgorithm.Type digest_algorithm_type,
bool PAdES_signing_mode,
string output_path)
{
Console.Out.WriteLine("================================================================================");
Console.Out.WriteLine("Custom signing PDF document");
using (PDFDoc doc = new PDFDoc(doc_path))
{
Page page1 = doc.GetPage(1);
DigitalSignatureField digsig_field = doc.CreateDigitalSignatureField(cert_field_name);
SignatureWidget widgetAnnot = SignatureWidget.Create(doc, new Rect(143, 287, 219, 306), digsig_field);
page1.AnnotPushBack(widgetAnnot);
// (OPTIONAL) Add an appearance to the signature field.
Image img = Image.Create(doc, appearance_image_path);
widgetAnnot.CreateSignatureAppearance(img);
// Create a digital signature dictionary inside the digital signature field, in preparation for signing.
digsig_field.CreateSigDictForCustomSigning("Adobe.PPKLite",
PAdES_signing_mode ? DigitalSignatureField.SubFilterType.e_ETSI_CAdES_detached : DigitalSignatureField.SubFilterType.e_adbe_pkcs7_detached,
7500); // For security reasons, set the contents size to a value greater than but as close as possible to the size you expect your final signature to be, in bytes.
// ... or, if you want to apply a certification signature, use CreateSigDictForCustomCertification instead.
// (OPTIONAL) Set the signing time in the signature dictionary, if no secure embedded timestamping support is available from your signing provider.
Date current_date = new Date();
current_date.SetCurrentTime();
digsig_field.SetSigDictTimeOfSigning(current_date);
doc.Save(output_path, SDFDoc.SaveOptions.e_incremental);
// Digest the relevant bytes of the document in accordance with ByteRanges surrounding the signature.
byte[] pdf_digest = digsig_field.CalculateDigest(digest_algorithm_type);
X509Certificate signer_cert = new X509Certificate(public_key_file_path);
// Optionally, you can add a custom signed attribute at this point, such as one of the PAdES ESS attributes.
// The function we provide takes care of generating the correct PAdES ESS attribute depending on your digest algorithm.
byte[] pades_versioned_ess_signing_cert_attribute = DigitalSignatureField.GenerateESSSigningCertPAdESAttribute(signer_cert, digest_algorithm_type);
// Generate the signedAttrs component of CMS, passing any optional custom signedAttrs (e.g. PAdES ESS).
// The signedAttrs are certain attributes that become protected by their inclusion in the signature.
byte[] signedAttrs = DigitalSignatureField.GenerateCMSSignedAttributes(pdf_digest, pades_versioned_ess_signing_cert_attribute);
// Calculate the digest of the signedAttrs (i.e. not the PDF digest, this time).
byte[] signedAttrs_digest = DigestAlgorithm.CalculateDigest(digest_algorithm_type, signedAttrs);
//////////////////////////// custom digest signing starts ////////////////////////////
// At this point, you can sign the digest (for example, with HSM). We use our own SignDigest function instead here as an example,
// which you can also use for your purposes if necessary as an alternative to the handler/callback APIs (i.e. Certify/SignOnNextSave).
byte[] signature_value = DigestAlgorithm.SignDigest(
signedAttrs_digest,
digest_algorithm_type,
private_key_file_path,
keyfile_password);
//////////////////////////// custom digest signing ends //////////////////////////////
// Then, load all your chain certificates into a container of X509Certificate.
X509Certificate[] chain_certs = {};
// Then, create ObjectIdentifiers for the algorithms you have used.
// Here we use digest_algorithm_type (usually SHA256) for hashing, and RSAES-PKCS1-v1_5 (specified in the private key) for signing.
ObjectIdentifier digest_algorithm_oid = new ObjectIdentifier(digest_algorithm_type);
ObjectIdentifier signature_algorithm_oid = new ObjectIdentifier(ObjectIdentifier.Predefined.e_RSA_encryption_PKCS1);
// Then, put the CMS signature components together.
byte[] cms_signature = DigitalSignatureField.GenerateCMSSignature(
signer_cert, chain_certs, digest_algorithm_oid, signature_algorithm_oid,
signature_value, signedAttrs);
// Write the signature to the document.
doc.SaveCustomSignature(cms_signature, digsig_field, output_path);
}
Console.Out.WriteLine("================================================================================");
}
static bool TimestampAndEnableLTV(string doc_path,
string tsa_url,
string trusted_cert_path,
string appearance_img_path,
string output_path)
{
using (PDFDoc doc = new PDFDoc(doc_path))
{
DigitalSignatureField doctimestamp_signature_field = doc.CreateDigitalSignatureField();
TimestampingConfiguration tst_config = new TimestampingConfiguration(tsa_url);
VerificationOptions opts = new VerificationOptions(VerificationOptions.SignatureVerificationSecurityLevel.e_compatibility_and_archiving);
/* It is necessary to add to the VerificationOptions a trusted root certificate corresponding to
the chain used by the timestamp authority to sign the timestamp token, in order for the timestamp
response to be verifiable during DocTimeStamp signing. It is also necessary in the context of this
function to do this for the later LTV section, because one needs to be able to verify the DocTimeStamp
in order to enable LTV for it, and we re-use the VerificationOptions opts object in that part. */
opts.AddTrustedCertificate(trusted_cert_path);
/* By default, we only check online for revocation of certificates using the newer and lighter
OCSP protocol as opposed to CRL, due to lower resource usage and greater reliability. However,
it may be necessary to enable online CRL revocation checking in order to verify some timestamps
(i.e. those that do not have an OCSP responder URL for all non-trusted certificates). */
opts.EnableOnlineCRLRevocationChecking(true);
SignatureWidget widgetAnnot = SignatureWidget.Create(doc, new Rect(0, 100, 200, 150), doctimestamp_signature_field);
doc.GetPage(1).AnnotPushBack(widgetAnnot);
Obj widgetObj = widgetAnnot.GetSDFObj();
// (OPTIONAL) Add an appearance to the signature field.
Image img = Image.Create(doc, appearance_img_path);
widgetAnnot.CreateSignatureAppearance(img);
Console.WriteLine("Testing timestamping configuration.");
TimestampingResult config_result = tst_config.TestConfiguration(opts);
if (config_result.GetStatus())
{
Console.WriteLine("Success: timestamping configuration usable. Attempting to timestamp.");
}
else
{
// Print details of timestamping failure.
Console.WriteLine(config_result.GetString());
if (config_result.HasResponseVerificationResult())
{
EmbeddedTimestampVerificationResult tst_result = config_result.GetResponseVerificationResult();
Console.WriteLine("CMS digest status: {0}\n", tst_result.GetCMSDigestStatusAsString());
Console.WriteLine("Message digest status:{0}\n", tst_result.GetMessageImprintDigestStatusAsString());
Console.WriteLine("Trust status: {0}\n", tst_result.GetTrustStatusAsString());
}
return false;
}
doctimestamp_signature_field.TimestampOnNextSave(tst_config, opts);
// Save/signing throws if timestamping fails.
doc.Save(output_path, SDFDoc.SaveOptions.e_incremental);
Console.WriteLine("Timestamping successful. Adding LTV information for DocTimeStamp signature.");
// Add LTV information for timestamp signature to document.
VerificationResult timestamp_verification_result = doctimestamp_signature_field.Verify(opts);
if (!doctimestamp_signature_field.EnableLTVOfflineVerification(timestamp_verification_result))
{
Console.WriteLine("Could not enable LTV for DocTimeStamp.");
return false;
}
doc.Save(output_path, SDFDoc.SaveOptions.e_incremental);
Console.WriteLine("Added LTV information for DocTimeStamp signature successfully.");
return true;
}
}
private static pdftron.PDFNetLoader pdfNetLoader = pdftron.PDFNetLoader.Instance();
static Class1() {}
/// <summary>
/// The main entry point for the application.
/// </summary>
[STAThread]
static void Main(string[] args)
{
// Initialize PDFNetC
PDFNet.Initialize(PDFTronLicense.Key);
bool result = true;
//////////////////// TEST 0:
/* Create an approval signature field that we can sign after certifying.
(Must be done before calling CertifyOnNextSave/SignOnNextSave/WithCustomHandler.) */
try
{
using (PDFDoc doc = new PDFDoc(input_path + "waiver.pdf"))
{
DigitalSignatureField approval_signature_field = doc.CreateDigitalSignatureField("PDFTronApprovalSig");
SignatureWidget widgetAnnotApproval = SignatureWidget.Create(doc, new Rect(300, 287, 376, 306), approval_signature_field);
Page page1 = doc.GetPage(1);
page1.AnnotPushBack(widgetAnnotApproval);
doc.Save(output_path + "waiver_withApprovalField_output.pdf", SDFDoc.SaveOptions.e_remove_unused);
}
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 1: certify a PDF.
try
{
CertifyPDF(input_path + "waiver_withApprovalField.pdf",
"PDFTronCertificationSig",
input_path + "pdftron.pfx",
"password",
input_path + "pdftron.bmp",
output_path + "waiver_withApprovalField_certified_output.pdf");
PrintSignaturesInfo(output_path + "waiver_withApprovalField_certified_output.pdf");
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 2: approval-sign an existing, unsigned signature field in a PDF that already has a certified signature field.
try
{
SignPDF(input_path + "waiver_withApprovalField_certified.pdf",
"PDFTronApprovalSig",
input_path + "pdftron.pfx",
"password",
input_path + "signature.jpg",
output_path + "waiver_withApprovalField_certified_approved_output.pdf");
PrintSignaturesInfo(output_path + "waiver_withApprovalField_certified_approved_output.pdf");
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 3: Clear a certification from a document that is certified and has an approval signature.
try
{
ClearSignature(input_path + "waiver_withApprovalField_certified_approved.pdf",
"PDFTronCertificationSig",
output_path + "waiver_withApprovalField_certified_approved_certcleared_output.pdf");
PrintSignaturesInfo(output_path + "waiver_withApprovalField_certified_approved_certcleared_output.pdf");
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 4: Verify a document's digital signatures.
try
{
if (!VerifyAllAndPrint(input_path + "waiver_withApprovalField_certified_approved.pdf",
input_path + "pdftron.cer"))
{
result = false;
}
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 5: Verify a document's digital signatures in a simple fashion using the document API.
try
{
if (!VerifySimple(input_path + "waiver_withApprovalField_certified_approved.pdf",
input_path + "pdftron.cer"))
{
result = false;
}
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 6: Custom signing API.
// The Apryse custom signing API is a set of APIs related to cryptographic digital signatures
// which allows users to customize the process of signing documents. Among other things, this
// includes the capability to allow for easy integration of PDF-specific signing-related operations
// with access to Hardware Security Module (HSM) tokens/devices, access to cloud keystores, access
// to system keystores, etc.
try
{
CustomSigningAPI(input_path + "waiver.pdf",
"PDFTronApprovalSig",
input_path + "pdftron.pfx",
"password",
input_path + "pdftron.cer",
input_path + "signature.jpg",
DigestAlgorithm.Type.e_sha256,
true,
output_path + "waiver_custom_signed.pdf");
}
catch (Exception e)
{
Console.Error.WriteLine(e);
result = false;
}
//////////////////// TEST 7: Timestamp a document, then add Long Term Validation (LTV) information for the DocTimeStamp.
// try
// {
// // Replace YOUR_URL_OF_TSA with the timestamp authority (TSA) URL to use during timestamping.
// // For example, as of July 2024, http://timestamp.globalsign.com/tsa/r6advanced1 was usable.
// // Note that this url may not work in the future. A reliable solution requires using your own TSA.
// string tsa_url = "YOUR_URL_OF_TSA";
// if (tsa_url == "YOUR_URL_OF_TSA")
// {
// throw new Exception("Error: The URL of your timestamp authority was not specified.");
// }
//
// // Replace YOUR_CERTIFICATE with the trusted root certificate corresponding to the chain used by the timestamp authority.
// // For example, as of July 2024, https://secure.globalsign.com/cacert/gstsacasha384g4.crt was usable.
// // Note that this certificate may not work in the future. A reliable solution requires using your own TSA certificate.
// string trusted_cert_path = "YOUR_CERTIFICATE";
// if (trusted_cert_path == "YOUR_CERTIFICATE")
// {
// throw new Exception("Error: The path to your timestamp authority trusted root certificate was not specified.");
// }
//
// if (!TimestampAndEnableLTV(input_path + "waiver.pdf",
// tsa_url,
// trusted_cert_path,
// input_path + "signature.jpg",
// output_path+ "waiver_DocTimeStamp_LTV.pdf"))
// {
// result = false;
// }
// }
// catch (Exception e)
// {
// Console.Error.WriteLine(e);
// result = false;
// }
//////////////////// End of tests. ////////////////////
PDFNet.Terminate();
if (result)
{
Console.Out.WriteLine("Tests successful.\n==========");
}
else
{
Console.Out.WriteLine("Tests FAILED!!!\n==========");
}
}
}
}