Xbase++

PKCS11 Find Specific Certificate on Smart Card or USB Token

See more PKCS11 Examples

This example code shows how to find a particular certificate on a smart card or USB token.

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

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

//  Set your shared lib path -- either a full path to the DLL, .so, or .dylib,
//  or just the filename if the driver is in a location that can be automatically found. (Such as in C:\Windows\System32)
oPkcs11:SharedLibPath := "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.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.
//  
//  If we don't authenticate, then we won't be able to see the private keys, and thus
//  we won't know which certificates have an associated private key stored on the smart card.

//  The smart card PIN is passed to the Login method.
//  userType 1 indicates a "Normal User".
nUserType := 1
cPin := "0000"
nSuccess := oPkcs11:Login(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    RETURN
ENDIF

//  --------------------------------------------------------------------------
//  The FindCert method can find a particular certificate in a number of different ways.
//  I'll demonstrate some common ways..

//  1) In many cases you'll be working with a smart card that contains one certificate that is to be used for 
//  signing, and it is the certificate that is associated with the private key also stored on the smart card (or USB token).
//  There may be other certificates on the card, but these are the issuer certificates in the chain of authentication.
//  You're just interested in getting the certificate with the private key.
//  You can do it like this:
oCert := CreateObject("Chilkat.Cert")
//  Pass the keyword "privateKey" in the 1st argument, and an empty string in the 2nd arg.
//  This returns the 1st certificate that has a private key.
nSuccess := oPkcs11:FindCert("privateKey", "", oCert)
IF (nSuccess == 1)
    ? "Cert with private key: " + oCert:SubjectCN
ELSE
    ? "No certificates having a private key were found."
ENDIF

//  2) Find a certificate by the Subject Common Name
nSuccess := oPkcs11:FindCert("subjectCN", "Chil application account (8c9be8e0-5544-4cd0-9062-290fbff353a7)", oCert)
IF (nSuccess == 1)
    ? "Found: " + oCert:SubjectCN
ELSE
    ? "Not found: " + oCert:SubjectCN
ENDIF

//  3) Find a certificate by hex serial number
nSuccess := oPkcs11:FindCert("serial", "5087bf1feda006af54a02f23a851104948acc26f", oCert)
IF (nSuccess == 1)
    ? "Found: " + oCert:SerialNumber
ELSE
    ? "Not found: " + oCert:SerialNumber
ENDIF

//  4) Find a certificate by hex serial number and Issuer Common Name
nSuccess := oPkcs11:FindCert("serial:issuerCN", "5087bf1feda006af54a02f23a851104948acc26f:Ibanity Production Third Party Application CA", oCert)
IF (nSuccess == 1)
    ? "Found: " + oCert:SubjectCN
ELSE
    ? "Not found: " + oCert:SubjectCN
ENDIF

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

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

? "Success."

oPkcs11:destroy()
oCert:destroy()