PureBasic

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.

PureBasic

IncludeFile "CkPkcs11.pb"
IncludeFile "CkCert.pb"

Procedure ChilkatExample()

    success.i = 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.

    pkcs11.i = CkPkcs11::ckCreate()
    If pkcs11.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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)
    CkPkcs11::setCkSharedLibPath(pkcs11, "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll")

    success = CkPkcs11::ckInitialize(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; Pass -1 for the slotID to open a session on the first non-empty slot.
    slotID.i = -1

    ; Open a session.
    readWrite.i = 1
    success = CkPkcs11::ckOpenSession(pkcs11,slotID,readWrite)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    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".
    userType.i = 1
    pin.s = "0000"
    success = CkPkcs11::ckLogin(pkcs11,userType,pin)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    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:
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    success = CkPkcs11::ckFindCert(pkcs11,"privateKey","",cert)
    If success = 1
        Debug "Cert with private key: " + CkCert::ckSubjectCN(cert)
    Else
        Debug "No certificates having a private key were found."
    EndIf

    ; 2) Find a certificate by the Subject Common Name
    success = CkPkcs11::ckFindCert(pkcs11,"subjectCN","Chil application account (8c9be8e0-5544-4cd0-9062-290fbff353a7)",cert)
    If success = 1
        Debug "Found: " + CkCert::ckSubjectCN(cert)
    Else
        Debug "Not found: " + CkCert::ckSubjectCN(cert)
    EndIf

    ; 3) Find a certificate by hex serial number
    success = CkPkcs11::ckFindCert(pkcs11,"serial","5087bf1feda006af54a02f23a851104948acc26f",cert)
    If success = 1
        Debug "Found: " + CkCert::ckSerialNumber(cert)
    Else
        Debug "Not found: " + CkCert::ckSerialNumber(cert)
    EndIf

    ; 4) Find a certificate by hex serial number and Issuer Common Name
    success = CkPkcs11::ckFindCert(pkcs11,"serial:issuerCN","5087bf1feda006af54a02f23a851104948acc26f:Ibanity Production Third Party Application CA",cert)
    If success = 1
        Debug "Found: " + CkCert::ckSubjectCN(cert)
    Else
        Debug "Not found: " + CkCert::ckSubjectCN(cert)
    EndIf

    ; --------------------------------------------------------------------------

    ; Revert to an unauthenticated session by calling Logout.
    success = CkPkcs11::ckLogout(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; When finished, close the session.
    ; It is important to close the session (memory leaks will occur if the session is not properly closed).
    success = CkPkcs11::ckCloseSession(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    Debug "Success."


    CkPkcs11::ckDispose(pkcs11)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure