(C) Sign a PDF using SmartCard or HSM (Hardware Security Module)

See more PDF Signatures Examples

This example demonstrates how to a sign a PDF using a smartcard or HSM (hardware security module).

Note: This example requires Chilkat v9.5.0.88 or greater.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkPdf.h>
#include <C_CkJsonObject.h>
#include <C_CkCert.h>

void ChilkatSample(void)
    {
    HCkPdf pdf;
    BOOL success;
    HCkJsonObject json;
    HCkCert cert;

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    pdf = CkPdf_Create();

    // Load a PDF to be signed.
    // The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
    success = CkPdf_LoadFile(pdf,"qa_data/pdf/hello.pdf");
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        return;
    }

    // Options for signing are specified in JSON.
    json = CkJsonObject_Create();

    // In most cases, the signingCertificateV2 and signingTime attributes are required.
    CkJsonObject_UpdateInt(json,"signingCertificateV2",1);
    CkJsonObject_UpdateInt(json,"signingTime",1);

    // Put the signature on page 1, top left
    CkJsonObject_UpdateInt(json,"page",1);
    CkJsonObject_UpdateString(json,"appearance.y","top");
    CkJsonObject_UpdateString(json,"appearance.x","left");

    // Use a font scale of 10.0
    CkJsonObject_UpdateString(json,"appearance.fontScale","10.0");

    // In this example, the appearance of the digital signature will contain three lines:
    // 1) The signing certificate's common name
    // 2) The current date/time
    // 3) Some arbitrary text.
    // The keyword "cert_cn" is replaced with the Certificate's Subject Common Name.
    // The keyword "current_dt" is replaced with the current date/time.
    // Any number of appearance text lines can be added.
    CkJsonObject_UpdateString(json,"appearance.text[0]","Digitally signed by: cert_cn");
    CkJsonObject_UpdateString(json,"appearance.text[1]","current_dt");
    CkJsonObject_UpdateString(json,"appearance.text[2]","The crazy brown fox jumps over the lazy dog.");

    // Use a certificate on a smartcard or USB token.
    cert = CkCert_Create();

    // Provide the smartcard PIN.
    // Set the smartcard PIN prior to calling LoadFromSmartcard.
    // If the PIN is not explicitly provided here, the Windows OS should
    // display a dialog for the PIN.
    CkCert_putSmartCardPin(cert,"123456");

    // Load the certificate on the smartcard currently in the reader (or on the USB token).
    // Pass an empty string to allow Chilkat to automatically choose the CSP (Cryptographi Service Provider).
    // See Load Certificate on Smartcard for information about explicitly selecting a particular CSP.
    success = CkCert_LoadFromSmartcard(cert,"");
    if (success == FALSE) {
        printf("%s\n",CkCert_lastErrorText(cert));
        CkPdf_Dispose(pdf);
        CkJsonObject_Dispose(json);
        CkCert_Dispose(cert);
        return;
    }

    // Tell the pdf object to use the certificate for signing.
    success = CkPdf_SetSigningCert(pdf,cert);
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        CkJsonObject_Dispose(json);
        CkCert_Dispose(cert);
        return;
    }

    success = CkPdf_SignPdf(pdf,json,"qa_output/hello_signed_hsm.pdf");
    if (success == FALSE) {
        printf("%s\n",CkPdf_lastErrorText(pdf));
        CkPdf_Dispose(pdf);
        CkJsonObject_Dispose(json);
        CkCert_Dispose(cert);
        return;
    }

    printf("The PDF has been successfully cryptographically signed using an HSM.\n");


    CkPdf_Dispose(pdf);
    CkJsonObject_Dispose(json);
    CkCert_Dispose(cert);

    }