(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkCert.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPdf.pb"

Procedure ChilkatExample()

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

    pdf.i = CkPdf::ckCreate()
    If pdf.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Load a PDF to be signed.
    ; The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
    success.i = CkPdf::ckLoadFile(pdf,"qa_data/pdf/hello.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        ProcedureReturn
    EndIf

    ; Options for signing are specified in JSON.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; In most cases, the signingCertificateV2 and signingTime attributes are required.
    CkJsonObject::ckUpdateInt(json,"signingCertificateV2",1)
    CkJsonObject::ckUpdateInt(json,"signingTime",1)

    ; Put the signature on page 1, top left
    CkJsonObject::ckUpdateInt(json,"page",1)
    CkJsonObject::ckUpdateString(json,"appearance.y","top")
    CkJsonObject::ckUpdateString(json,"appearance.x","left")

    ; Use a font scale of 10.0
    CkJsonObject::ckUpdateString(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::ckUpdateString(json,"appearance.text[0]","Digitally signed by: cert_cn")
    CkJsonObject::ckUpdateString(json,"appearance.text[1]","current_dt")
    CkJsonObject::ckUpdateString(json,"appearance.text[2]","The crazy brown fox jumps over the lazy dog.")

    ; Use a certificate on a smartcard or USB token.
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkSmartCardPin(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::ckLoadFromSmartcard(cert,"")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Tell the pdf object to use the certificate for signing.
    success = CkPdf::ckSetSigningCert(pdf,cert)
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkPdf::ckSignPdf(pdf,json,"qa_output/hello_signed_hsm.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    Debug "The PDF has been successfully cryptographically signed using an HSM."


    CkPdf::ckDispose(pdf)
    CkJsonObject::ckDispose(json)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure