Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oPkcs11
LOCAL cPin
LOCAL nUserType
LOCAL oCert
LOCAL oPdf
LOCAL oJson
LOCAL i

nSuccess := 0

//  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.

oPkcs11 := CreateObject("Chilkat.Pkcs11")

oPkcs11:SharedLibPath := "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"
cPin := "0000"
nUserType := 1

//  Establish a PKCS11 logged-on session using the driver (.so, .dylib, or .dll) as specified in the SharedLibPath above.
nSuccess := oPkcs11:QuickSession(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    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.
oCert := CreateObject("Chilkat.Cert")
nSuccess := oPkcs11:FindCert("privateKey", "", oCert)
IF (nSuccess == 1)
    ? "Cert with private key: " + oCert:SubjectCN
ELSE
    ? "No certificates having a private key were found."
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    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..

oPdf := CreateObject("Chilkat.Pdf")

//  Load a PDF to be signed.
nSuccess := oPdf:LoadFile("qa_data/pdf/hello.pdf")
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oPdf:destroy()
    RETURN
ENDIF

oJson := CreateObject("Chilkat.JsonObject")

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

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

//  The certificate is internally linked to the Pkcs11 object, which is currently in an authenticated session.
nSuccess := oPdf:SetSigningCert(oCert)

nSuccess := oPdf:SignPdf(oJson, "qa_output/out.pdf")
IF (nSuccess == 0)
    ? oPdf:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oPdf:destroy()
    oJson:destroy()
    RETURN
ENDIF

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

//  Revert to an unauthenticated session by calling Logout.
nSuccess := oPkcs11:Logout()
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oPdf:destroy()
    oJson:destroy()
    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).
nSuccess := oPkcs11:CloseSession()
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    oCert:destroy()
    oPdf:destroy()
    oJson:destroy()
    RETURN
ENDIF

? "Success."

oPkcs11:destroy()
oCert:destroy()
oPdf:destroy()
oJson:destroy()