(Lianja) PKCS11 Sign PDF using Certificate and Private Key on Smart Card / USB Token

See more PKCS11 Examples

Sample code showing how to use PKCS11 to sign a PDF with a certificate and private key stored on a smart card or USB token.

Note: This example requires Chilkat v9.5.0.96 or later.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

// Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

loPkcs11 = createobject("CkPkcs11")

loPkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"
lcPin = "0000"
lnUserType = 1

// Establish a PKCS11 logged-on session using the driver (.so, .dylib, or .dll) as specified in the SharedLibPath above.
llSuccess = loPkcs11.QuickSession(lnUserType,lcPin)
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    return
endif

// Get the certificate (on the smart card) that has a private key.
// There are other ways to locate a certificate on the HSM.
// This example assumes there is a single certificate w/ private key.
loCert = createobject("CkCert")
llSuccess = loPkcs11.FindCert("privateKey","",loCert)
if (llSuccess = .T.) then
    ? "Cert with private key: " + loCert.SubjectCN
else
    ? "No certificates having a private key were found."
    llSuccess = loPkcs11.CloseSession()
    release loPkcs11
    release loCert
    return
endif

// --------------------------------------------------------------------------
// At this point, we have the cert to be used for signing.
// Our PDF signing code is the same as for a cert obtained from any other source..

loPdf = createobject("CkPdf")

// Load a PDF to be signed.
llSuccess = loPdf.LoadFile("qa_data/pdf/hello.pdf")
if (llSuccess = .F.) then
    ? loPdf.LastErrorText
    llSuccess = loPkcs11.CloseSession()
    release loPkcs11
    release loCert
    release loPdf
    return
endif

loJson = createobject("CkJsonObject")

loJson.UpdateInt("page",1)
loJson.UpdateString("appearance.y","top")
loJson.UpdateString("appearance.x","left")
loJson.UpdateString("appearance.fontScale","10.0")
loJson.UpdateString("signingAlgorithm","pss")
loJson.UpdateString("hashAlgorithm","sha256")

i = 0
loJson.I = i
loJson.UpdateString("appearance.text[i]","Digitaly signed by: Xyz Widgets, Inc.")
i = i + 1
loJson.I = i
loJson.UpdateString("appearance.text[i]","current_dt")
i = i + 1
loJson.I = i
loJson.UpdateString("appearance.text[i]","blah blah blah")

// The certificate is internally linked to the Pkcs11 object, which is currently in an authenticated session.
llSuccess = loPdf.SetSigningCert(loCert)

llSuccess = loPdf.SignPdf(loJson,"qa_output/out.pdf")
if (llSuccess = .F.) then
    ? loPdf.LastErrorText
    llSuccess = loPkcs11.CloseSession()
    release loPkcs11
    release loCert
    release loPdf
    release loJson
    return
endif

// --------------------------------------------------------------------------

// Revert to an unauthenticated session by calling Logout.
llSuccess = loPkcs11.Logout()
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    llSuccess = loPkcs11.CloseSession()
    release loPkcs11
    release loCert
    release loPdf
    release loJson
    return
endif

// When finished, close the session.
// It is important to close the session (memory leaks will occur if the session is not properly closed).
llSuccess = loPkcs11.CloseSession()
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    release loCert
    release loPdf
    release loJson
    return
endif

? "Success."


release loPkcs11
release loCert
release loPdf
release loJson