Xbase++

PKCS11 Certificate Chain

See more PKCS11 Examples

Demonstrates how to make CA certs available for the certificate chain to be included when creating a signature (using a PKCS11 compatible smart card / USB token) such as for PDF, XMLDSig, etc.

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

Xbase++

LOCAL nSuccess
LOCAL oPkcs11
LOCAL nSlotID
LOCAL nReadWrite
LOCAL nUserType
LOCAL cPin
LOCAL oCert
LOCAL oCertVault

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")

//  You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
//  On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
//  Otherwise provide the full path.
oPkcs11:SharedLibPath := "bit4xpki.dll"

nSuccess := oPkcs11:Initialize()
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    RETURN
ENDIF

//  Pass -1 for the slotID to open a session on the first non-empty slot.
nSlotID := -1

//  Open a session.
nReadWrite := 1
nSuccess := oPkcs11:OpenSession(nSlotID, nReadWrite)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    RETURN
ENDIF

//  Make it an authenticated session by calling Login.
nUserType := 1
//  Make sure to use the correct PIN for your smart card..
cPin := "0000"
nSuccess := oPkcs11:Login(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    RETURN
ENDIF

//  Get the certificate (on the smart card) that has a 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

//  If the certificates in the chain of authentication were contained on the smart card,
//  then Chilkat would already have them (via the FindCert function) and the certs in the chain will be automatically used
//  as needed when signing occurs.

//  If you have CA certs located elsewhere, such as in .cer files, you can make them available to Chilkat in the following way:

oCertVault := CreateObject("Chilkat.XmlCertVault")
//  Please review the methods available in the XML certificate vault class.  Different methods exist for adding certificates
//  from various sources, such as PEM, PFX, or in-memory sources..
nSuccess := oCertVault:AddCertFile("someDir/caIntermediateCert.cer")
//  ...
nSuccess := oCertVault:AddCertFile("someDir/caCert.cer")
//  (Your code should check the return value to make sure it succeeded.)

nSuccess := oCert:UseCertVault(oCertVault)
IF (nSuccess == 0)
    ? oCert:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oCertVault:destroy()
    RETURN
ENDIF

//  --------------------------------------------------------------------------
//  At this point, we have the cert (and certs in the chain of authentication) to be used for signing.
//  The code for using the certificate in creating the digital signature, such as for a PDF, XML, etc., go here...

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

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

? "Success."

oPkcs11:destroy()
oCert:destroy()
oCertVault:destroy()