Tcl

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.

Tcl

load ./chilkat.dll

set success 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.

set pkcs11 [new_CkPkcs11]

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

set success [CkPkcs11_Initialize $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

# Pass -1 for the slotID to open a session on the first non-empty slot.
set slotID -1

# Open a session.
set readWrite 1
set success [CkPkcs11_OpenSession $pkcs11 $slotID $readWrite]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

# 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".
set userType 1
set pin "0000"
set success [CkPkcs11_Login $pkcs11 $userType $pin]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

# --------------------------------------------------------------------------
# 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:
set cert [new_CkCert]

# 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.
set success [CkPkcs11_FindCert $pkcs11 "privateKey" "" $cert]
if {$success == 1} then {
    puts "Cert with private key: [CkCert_subjectCN $cert]"
} else {
    puts "No certificates having a private key were found."
}

# 2) Find a certificate by the Subject Common Name
set success [CkPkcs11_FindCert $pkcs11 "subjectCN" "Chil application account (8c9be8e0-5544-4cd0-9062-290fbff353a7)" $cert]
if {$success == 1} then {
    puts "Found: [CkCert_subjectCN $cert]"
} else {
    puts "Not found: [CkCert_subjectCN $cert]"
}

# 3) Find a certificate by hex serial number
set success [CkPkcs11_FindCert $pkcs11 "serial" "5087bf1feda006af54a02f23a851104948acc26f" $cert]
if {$success == 1} then {
    puts "Found: [CkCert_serialNumber $cert]"
} else {
    puts "Not found: [CkCert_serialNumber $cert]"
}

# 4) Find a certificate by hex serial number and Issuer Common Name
set success [CkPkcs11_FindCert $pkcs11 "serial:issuerCN" "5087bf1feda006af54a02f23a851104948acc26f:Ibanity Production Third Party Application CA" $cert]
if {$success == 1} then {
    puts "Found: [CkCert_subjectCN $cert]"
} else {
    puts "Not found: [CkCert_subjectCN $cert]"
}

# --------------------------------------------------------------------------

# Revert to an unauthenticated session by calling Logout.
set success [CkPkcs11_Logout $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    exit
}

# When finished, close the session.
# It is important to close the session (memory leaks will occur if the session is not properly closed).
set success [CkPkcs11_CloseSession $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    exit
}

puts "Success."

delete_CkPkcs11 $pkcs11
delete_CkCert $cert