PureBasic

PKCS11 Find All Certificates on Smart Card or USB Token

See more PKCS11 Examples

Sample code showing how to examine all the certificates 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, "aetpkss1.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

    ; Call FindAllCerts to find all certificates on the smart card or USB token.
    success = CkPkcs11::ckFindAllCerts(pkcs11)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        success = CkPkcs11::ckCloseSession(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; The NumCerts property is set by FindAllCerts.
    numCerts.i = CkPkcs11::ckNumCerts(pkcs11)
    Debug "Number of certs: " + Str(numCerts)

    privateKeyNote.s
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    i.i = 0
    While i < numCerts
        CkPkcs11::ckGetCert(pkcs11,i,cert)
        privateKeyNote = ""
        If CkCert::ckHasPrivateKey(cert) = 1
            privateKeyNote = "(has private key)"
        EndIf

        Debug Str(i) + ": " + privateKeyNote + " " + CkCert::ckSubjectDN(cert)
        Debug Str(i) + ": issuer: " + CkCert::ckIssuerDN(cert)
        Debug "----"
        i = i + 1
    Wend

    ; 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