(Tcl) PKCS11 Discover Readers and Smart Cards / Tokens

See more PKCS11 Examples

Example showing how to discover the readers (slots) and smart cards and tokens available through a vendor's PKCS11 Cryptoki module.

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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]

# Specify the vendor's Cryptoki module DLL / shared lib.
CkPkcs11_put_SharedLibPath $pkcs11 "aetpkss1.dll"

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

# Call Discover to discover what's available.
# Indicate that we only want to return slots (readers) where tokens (smart cards) are present.
# (If the device is a USB token, such as an ePass300Auto, then by definition it has a "token" present.)
set onlyTokensPresent 1
set json [new_CkJsonObject]

set success [CkPkcs11_Discover $pkcs11 $onlyTokensPresent $json]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkJsonObject $json
    exit
}

CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]

# Sample JSON output.
# Code for parsing this JSON is shown below..

# {
#   "cryptokiVersion": {
#     "major": 2,
#     "minor": 20
#   },
#   "manufacturerID": "A.E.T. Europe B.V.",
#   "libraryDescription": "Cryptographic Token Interface",
#   "libraryVersion": {
#     "major": 3,
#     "minor": 0
#   },
#   "slot": [
#     {
#       "id": 52482,
#       "slotDescription": "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0",
#       "manufacturerID": "SCM Microsystems Inc. SCR33x USB",
#       "tokenPresent": true,
#       "removableDevice": true,
#       "hardwareSlot": true,
#       "hardwareVersion": {
#         "major": 0,
#         "minor": 0
#       },
#       "firmwareVersion": {
#         "major": 0,
#         "minor": 0
#       },
#       "token": {
#         "label": "chilkat",
#         "manufacturerID": "A.E.T. Europe B.V.",
#         "model": "19C40406010D00C0",
#         "serialNumber": "21619600583C4505",
#         "flags": [
#           "CKF_RNG",
#           "CKF_LOGIN_REQUIRED",
#           "CKF_USER_PIN_INITIALIZED",
#           "CKF_TOKEN_INITIALIZED"
#         ],
#         "maxSessionCount": 126,
#         "sessionCount": 0,
#         "maxRwSessionCount": 126,
#         "rwSessionCount": 0,
#         "maxPinLen": 15,
#         "minPinLen": 4,
#         "totalPublicMemory": 32767,
#         "freePublicMemory": 32767,
#         "totalPrivateMemory": 32767,
#         "freePrivateMemory": 32767,
#         "hardwareVersion": {
#           "major": 0,
#           "minor": 0
#         },
#         "firmwareVersion": {
#           "major": 0,
#           "minor": 0
#         },
#         "utcTime": "",
#         "rsa": {
#           "minKeySize": 768,
#           "maxKeySize": 2048
#         },
#         "mechanism": [
#           "CKM_RSA_PKCS",
#           "CKM_RSA_X_509",
#           "CKM_RSA_PKCS_OAEP",
#           "CKM_MD5_RSA_PKCS",
#           "CKM_SHA1_RSA_PKCS",
#           "CKM_SHA224_RSA_PKCS",
#           "CKM_SHA256_RSA_PKCS",
#           "CKM_SHA384_RSA_PKCS",
#           "CKM_SHA512_RSA_PKCS",
#           "CKM_RIPEMD160_RSA_PKCS",
#           "CKM_CPK_ECDSA",
#           "CKM_CPK_ECDSA_SHA1",
#           "CKM_CPK_ECIES",
#           "CKM_CPK_ECIES_STDDH_SHA1KDF_DES3CBC_PAD_SHA1HMAC",
#           "CKM_CPK_ECIES_STDDH_SHA1KDF_AES128CBC_PAD_SHA1HMAC",
#           "CKM_CPK_PKCS7_SIGNED",
#           "CKM_CPK_PKCS7_ENVELOPE_DES3CBC_PAD",
#           "CKM_RSA_PKCS_PSS",
#           "CKM_RSA_PKCS_KEY_PAIR_GEN",
#           "CKM_RC2_KEY_GEN",
#           "CKM_RC2_ECB",
#           "CKM_RC2_CBC",
#           "CKM_RC2_CBC_PAD",
#           "CKM_RC4_KEY_GEN",
#           "CKM_RC4",
#           "CKM_DES_KEY_GEN",
#           "CKM_DES2_KEY_GEN",
#           "CKM_DES3_KEY_GEN",
#           "CKM_DES_ECB",
#           "CKM_DES_CBC",
#           "CKM_DES3_ECB",
#           "CKM_DES3_CBC",
#           "CKM_DES_CBC_PAD",
#           "CKM_DES3_CBC_PAD",
#           "CKM_MD5",
#           "CKM_SHA_1",
#           "CKM_SHA224",
#           "CKM_SHA256",
#           "CKM_SHA384",
#           "CKM_SHA512",
#           "CKM_RIPEMD160"
#         ]
#       }
#     }
#   ]
# }

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

set cryptokiVersionMajor [CkJsonObject_IntOf $json "cryptokiVersion.major"]
set cryptokiVersionMinor [CkJsonObject_IntOf $json "cryptokiVersion.minor"]
set manufacturerID [CkJsonObject_stringOf $json "manufacturerID"]
set libraryDescription [CkJsonObject_stringOf $json "libraryDescription"]
set libraryVersionMajor [CkJsonObject_IntOf $json "libraryVersion.major"]
set libraryVersionMinor [CkJsonObject_IntOf $json "libraryVersion.minor"]
set i 0
set count_i [CkJsonObject_SizeOfArray $json "slot"]
while {$i < $count_i} {
    CkJsonObject_put_I $json $i
    set id [CkJsonObject_IntOf $json "slot[i].id"]
    set slotDescription [CkJsonObject_stringOf $json "slot[i].slotDescription"]
    set manufacturerID [CkJsonObject_stringOf $json "slot[i].manufacturerID"]
    set tokenPresent [CkJsonObject_BoolOf $json "slot[i].tokenPresent"]
    set removableDevice [CkJsonObject_BoolOf $json "slot[i].removableDevice"]
    set hardwareSlot [CkJsonObject_BoolOf $json "slot[i].hardwareSlot"]
    set hardwareVersionMajor [CkJsonObject_IntOf $json "slot[i].hardwareVersion.major"]
    set hardwareVersionMinor [CkJsonObject_IntOf $json "slot[i].hardwareVersion.minor"]
    set firmwareVersionMajor [CkJsonObject_IntOf $json "slot[i].firmwareVersion.major"]
    set firmwareVersionMinor [CkJsonObject_IntOf $json "slot[i].firmwareVersion.minor"]
    set tokenLabel [CkJsonObject_stringOf $json "slot[i].token.label"]
    set tokenManufacturerID [CkJsonObject_stringOf $json "slot[i].token.manufacturerID"]
    set tokenModel [CkJsonObject_stringOf $json "slot[i].token.model"]
    set tokenSerialNumber [CkJsonObject_stringOf $json "slot[i].token.serialNumber"]
    set tokenMaxSessionCount [CkJsonObject_IntOf $json "slot[i].token.maxSessionCount"]
    set tokenSessionCount [CkJsonObject_IntOf $json "slot[i].token.sessionCount"]
    set tokenMaxRwSessionCount [CkJsonObject_IntOf $json "slot[i].token.maxRwSessionCount"]
    set tokenRwSessionCount [CkJsonObject_IntOf $json "slot[i].token.rwSessionCount"]
    set tokenMaxPinLen [CkJsonObject_IntOf $json "slot[i].token.maxPinLen"]
    set tokenMinPinLen [CkJsonObject_IntOf $json "slot[i].token.minPinLen"]
    set tokenTotalPublicMemory [CkJsonObject_IntOf $json "slot[i].token.totalPublicMemory"]
    set tokenFreePublicMemory [CkJsonObject_IntOf $json "slot[i].token.freePublicMemory"]
    set tokenTotalPrivateMemory [CkJsonObject_IntOf $json "slot[i].token.totalPrivateMemory"]
    set tokenFreePrivateMemory [CkJsonObject_IntOf $json "slot[i].token.freePrivateMemory"]
    set tokenHardwareVersionMajor [CkJsonObject_IntOf $json "slot[i].token.hardwareVersion.major"]
    set tokenHardwareVersionMinor [CkJsonObject_IntOf $json "slot[i].token.hardwareVersion.minor"]
    set tokenFirmwareVersionMajor [CkJsonObject_IntOf $json "slot[i].token.firmwareVersion.major"]
    set tokenFirmwareVersionMinor [CkJsonObject_IntOf $json "slot[i].token.firmwareVersion.minor"]
    set tokenUtcTime [CkJsonObject_stringOf $json "slot[i].token.utcTime"]
    set tokenRsaMinKeySize [CkJsonObject_IntOf $json "slot[i].token.rsa.minKeySize"]
    set tokenRsaMaxKeySize [CkJsonObject_IntOf $json "slot[i].token.rsa.maxKeySize"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $json "slot[i].token.flags"]
    while {$j < $count_j} {
        CkJsonObject_put_J $json $j
        set strVal [CkJsonObject_stringOf $json "slot[i].token.flags[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $json "slot[i].token.mechanism"]
    while {$j < $count_j} {
        CkJsonObject_put_J $json $j
        set strVal [CkJsonObject_stringOf $json "slot[i].token.mechanism[j]"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkPkcs11 $pkcs11
delete_CkJsonObject $json