PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Pdf
oleobject loo_Json
oleobject loo_Cert

li_Success = 0

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

loo_Pdf = create oleobject
li_rc = loo_Pdf.ConnectToNewObject("Chilkat.Pdf")
if li_rc < 0 then
    destroy loo_Pdf
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Load a PDF to be signed.
// The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
li_Success = loo_Pdf.LoadFile("qa_data/pdf/hello.pdf")
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    return
end if

// Options for signing are specified in JSON.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

// In most cases, the signingCertificateV2 and signingTime attributes are required.
loo_Json.UpdateInt("signingCertificateV2",1)
loo_Json.UpdateInt("signingTime",1)

// Put the signature on page 1, top left
loo_Json.UpdateInt("page",1)
loo_Json.UpdateString("appearance.y","top")
loo_Json.UpdateString("appearance.x","left")

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

// Use a certificate on a smartcard or USB token.
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

// 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.
loo_Cert.SmartCardPin = "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.
li_Success = loo_Cert.LoadFromSmartcard("")
if li_Success = 0 then
    Write-Debug loo_Cert.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_Cert
    return
end if

// Tell the pdf object to use the certificate for signing.
li_Success = loo_Pdf.SetSigningCert(loo_Cert)
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_Cert
    return
end if

li_Success = loo_Pdf.SignPdf(loo_Json,"qa_output/hello_signed_hsm.pdf")
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_Cert
    return
end if

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


destroy loo_Pdf
destroy loo_Json
destroy loo_Cert