Lua
Lua
PKCS11 Get Token Info
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, and get token information for each.Chilkat Lua Downloads
local chilkat = require("chilkat")
-- 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.
local pkcs11 = chilkat.Pkcs11.new()
-- Specify the vendor's Cryptoki module DLL / shared lib.
-- The following PKCS11 driver DLL is for the WatchData ProxKey USB token.
-- You would use your smartcard/token vendor's PKCS11 driver DLL.
pkcs11.shared_lib_path = "SignatureP11.dll"
local success = pkcs11:initialize()
if not success then
print(pkcs11.last_error_text)
return
end
-- Call Discover to discover what's available.
-- Indicate that we only want to return slots (readers) where tokens (or smart cards) are present.
local onlyTokensPresent = true
local json = chilkat.JsonObject.new()
success = pkcs11:discover(onlyTokensPresent, json)
if not success then
print(pkcs11.last_error_text)
return
end
json.emit_compact = false
print(json:emit())
-- Sample JSON output.
-- Code for parsing this JSON is shown below..
-- {
-- "cryptokiVersion": {
-- "major": 2,
-- "minor": 10
-- },
-- "manufacturerID": "WatchData",
-- "libraryDescription": "PKCS#11 cryptoki module",
-- "libraryVersion": {
-- "major": 3,
-- "minor": 10
-- },
-- "slot": [
-- {
-- "id": 16385,
-- "slotDescription": "Watchdata IC CARD Reader/Writer",
-- "manufacturerID": "Watchdata",
-- "tokenPresent": true,
-- "removableDevice": true,
-- "hardwareSlot": true,
-- "hardwareVersion": {
-- "major": 1,
-- "minor": 0
-- },
-- "firmwareVersion": {
-- "major": 1,
-- "minor": 0
-- },
-- "token": {
-- "label": "WD PROXKey",
-- "manufacturerID": "Watchdata Corp.",
-- "model": "TimeCos/PK",
-- "serialNumber": "WD05376504",
-- "flags": [
-- "CKF_RNG",
-- "CKF_LOGIN_REQUIRED",
-- "CKF_USER_PIN_INITIALIZED",
-- "CKF_DUAL_CRYPTO_OPERATIONS",
-- "CKF_TOKEN_INITIALIZED"
-- ],
-- "maxSessionCount": 0,
-- "sessionCount": 0,
-- "maxRwSessionCount": 0,
-- "rwSessionCount": 0,
-- "maxPinLen": 32,
-- "minPinLen": 6,
-- "totalPublicMemory": 61440,
-- "freePublicMemory": 70144,
-- "totalPrivateMemory": 61440,
-- "freePrivateMemory": 70144,
-- "hardwareVersion": {
-- "major": 2,
-- "minor": 1
-- },
-- "firmwareVersion": {
-- "major": 0,
-- "minor": 0
-- },
-- "utcTime": "2024011509254600",
-- "mechanism": [
-- "CKM_RSA_PKCS_KEY_PAIR_GEN",
-- "CKM_EC_KEY_PAIR_GEN",
-- "CKM_DES_KEY_GEN",
-- "80000001",
-- "8000000B",
-- "CKM_AES_KEY_GEN",
-- "CKM_DES2_KEY_GEN",
-- "CKM_DES3_KEY_GEN",
-- "CKM_RSA_PKCS",
-- "CKM_RSA_X_509",
-- "CKM_ECDSA",
-- "CKM_ECDSA_SHA1",
-- "CKM_MD2_RSA_PKCS",
-- "CKM_MD5_RSA_PKCS",
-- "CKM_SHA1_RSA_PKCS",
-- "CKM_SHA256_RSA_PKCS",
-- "CKM_DES_ECB",
-- "CKM_DES_CBC",
-- "CKM_DES_CBC_PAD",
-- "80000002",
-- "CKM_CPK_ECDSA",
-- "CKM_CPK_ECDSA_SHA1",
-- "8000000C",
-- "8000000D",
-- "8000000E",
-- "CKM_AES_ECB",
-- "CKM_AES_CBC",
-- "CKM_AES_CBC_PAD",
-- "CKM_DES3_ECB",
-- "CKM_DES3_CBC",
-- "CKM_DES3_CBC_PAD",
-- "CKM_SHA_1",
-- "CKM_SHA_1_HMAC",
-- "CKM_SHA_1_HMAC_GENERAL",
-- "CKM_SHA256",
-- "CKM_SHA256_HMAC",
-- "CKM_SHA256_HMAC_GENERAL",
-- "CKM_MD2",
-- "CKM_MD2_HMAC",
-- "CKM_MD2_HMAC_GENERAL",
-- "CKM_MD5",
-- "CKM_MD5_HMAC",
-- "CKM_MD5_HMAC_GENERAL",
-- "CKM_SSL3_PRE_MASTER_KEY_GEN",
-- "CKM_SSL3_MASTER_KEY_DERIVE",
-- "CKM_SSL3_KEY_AND_MAC_DERIVE",
-- "CKM_SSL3_MD5_MAC",
-- "CKM_SSL3_SHA1_MAC"
-- ],
-- "rsa": {
-- "minKeySize": 1024,
-- "maxKeySize": 4096
-- }
-- }
-- }
-- ]
-- }
-- Use this online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON
local id = 0
local slotDescription = ""
local tokenPresent = false
local removableDevice = false
local hardwareSlot = false
local hardwareVersionMajor = 0
local hardwareVersionMinor = 0
local firmwareVersionMajor = 0
local firmwareVersionMinor = 0
local tokenLabel = ""
local tokenManufacturerID = ""
local tokenModel = ""
local tokenSerialNumber = ""
local tokenMaxSessionCount = 0
local tokenSessionCount = 0
local tokenMaxRwSessionCount = 0
local tokenRwSessionCount = 0
local tokenMaxPinLen = 0
local tokenMinPinLen = 0
local tokenTotalPublicMemory = 0
local tokenFreePublicMemory = 0
local tokenTotalPrivateMemory = 0
local tokenFreePrivateMemory = 0
local tokenHardwareVersionMajor = 0
local tokenHardwareVersionMinor = 0
local tokenFirmwareVersionMajor = 0
local tokenFirmwareVersionMinor = 0
local tokenUtcTime = ""
local tokenRsaMinKeySize = 0
local tokenRsaMaxKeySize = 0
local j = 0
local count_j = 0
local strVal = ""
local tokenFlag = ""
-- Use this online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON
local cryptokiVersionMajor = json:int_of("cryptokiVersion.major")
local cryptokiVersionMinor = json:int_of("cryptokiVersion.minor")
local manufacturerID = json:string_of("manufacturerID")
local libraryDescription = json:string_of("libraryDescription")
local libraryVersionMajor = json:int_of("libraryVersion.major")
local libraryVersionMinor = json:int_of("libraryVersion.minor")
local i = 0
local count_i = json:size_of_array("slot")
while i < count_i do
json.i = i
id = json:int_of("slot[i].id")
slotDescription = json:string_of("slot[i].slotDescription")
manufacturerID = json:string_of("slot[i].manufacturerID")
tokenPresent = json:bool_of("slot[i].tokenPresent")
removableDevice = json:bool_of("slot[i].removableDevice")
hardwareSlot = json:bool_of("slot[i].hardwareSlot")
hardwareVersionMajor = json:int_of("slot[i].hardwareVersion.major")
hardwareVersionMinor = json:int_of("slot[i].hardwareVersion.minor")
firmwareVersionMajor = json:int_of("slot[i].firmwareVersion.major")
firmwareVersionMinor = json:int_of("slot[i].firmwareVersion.minor")
tokenLabel = json:string_of("slot[i].token.label")
tokenManufacturerID = json:string_of("slot[i].token.manufacturerID")
tokenModel = json:string_of("slot[i].token.model")
tokenSerialNumber = json:string_of("slot[i].token.serialNumber")
tokenMaxSessionCount = json:int_of("slot[i].token.maxSessionCount")
tokenSessionCount = json:int_of("slot[i].token.sessionCount")
tokenMaxRwSessionCount = json:int_of("slot[i].token.maxRwSessionCount")
tokenRwSessionCount = json:int_of("slot[i].token.rwSessionCount")
tokenMaxPinLen = json:int_of("slot[i].token.maxPinLen")
tokenMinPinLen = json:int_of("slot[i].token.minPinLen")
tokenTotalPublicMemory = json:int_of("slot[i].token.totalPublicMemory")
tokenFreePublicMemory = json:int_of("slot[i].token.freePublicMemory")
tokenTotalPrivateMemory = json:int_of("slot[i].token.totalPrivateMemory")
tokenFreePrivateMemory = json:int_of("slot[i].token.freePrivateMemory")
tokenHardwareVersionMajor = json:int_of("slot[i].token.hardwareVersion.major")
tokenHardwareVersionMinor = json:int_of("slot[i].token.hardwareVersion.minor")
tokenFirmwareVersionMajor = json:int_of("slot[i].token.firmwareVersion.major")
tokenFirmwareVersionMinor = json:int_of("slot[i].token.firmwareVersion.minor")
tokenUtcTime = json:string_of("slot[i].token.utcTime")
tokenRsaMinKeySize = json:int_of("slot[i].token.rsa.minKeySize")
tokenRsaMaxKeySize = json:int_of("slot[i].token.rsa.maxKeySize")
-- The following token flag strings are possible:
-- CKF_RNG: has random # generator
-- CKF_WRITE_PROTECTED: token is write-protected
-- CKF_LOGIN_REQUIRED:user must login
-- CKF_USER_PIN_INITIALIZED:normal user's PIN is set
-- CKF_RESTORE_KEY_NOT_NEEDED: Every time the state of cryptographic operations of a session is
-- successfully saved, all keys needed to continue those operations are stored in the state
-- CKF_CLOCK_ON_TOKEN: The token has some sort of clock. The time on the clock is returned in the slot[i].token.utcTime
-- CKF_PROTECTED_AUTHENTICATION_PATH: There is some way for the user to login without sending a PIN through the Cryptoki library itself
-- CKF_DUAL_CRYPTO_OPERATIONS: A single session with the token can perform dual simultaneous cryptographic operations
-- (digest and encrypt; decrypt and digest; sign and encrypt; and decrypt and sign)
-- CKF_TOKEN_INITIALIZED: The token has been initialized.
-- CKF_SECONDARY_AUTHENTICATION: The token supports secondary authentication for private key objects.
-- CKF_USER_PIN_COUNT_LOW: An incorrect user login PIN has been entered at least once since the last successful authentication.
-- CKF_USER_PIN_FINAL_TRY: Supplying an incorrect user PIN will it to become locked.
-- CKF_USER_PIN_LOCKED: The user PIN has been locked. User login to the token is not possible.
-- CKF_USER_PIN_TO_BE_CHANGED: The user PIN value is the default value set by token initialization or manufacturing,
-- or the PIN has been expired by the card.
-- CKF_SO_PIN_COUNT_LOW: An incorrect SO login PIN has been entered at least once since the last successful authentication.
-- CKF_SO_PIN_FINAL_TRY: Supplying an incorrect SO PIN will it to become locked.
-- CKF_SO_PIN_LOCKED: The SO PIN has been locked. SO login to the token is not possible.
-- CKF_SO_PIN_TO_BE_CHANGED: The SO PIN value is the default value set by token initialization or manufacturing,
-- or the PIN has been expired by the card.
-- To see if particular flags are present:
local aFlags = json:array_of("slot[i].token.flags")
if aFlags:find_string("CKF_USER_PIN_LOCKED", true) >= 0 then
print("The token is locked.")
end
if aFlags:find_string("CKF_RNG", true) >= 0 then
print("The token has a random number generator.")
end
-- ...
-- To iterate over all flags..
j = 0
count_j = json:size_of_array("slot[i].token.flags")
while j < count_j do
json.j = j
tokenFlag = json:string_of("slot[i].token.flags[j]")
j = j + 1
end
j = 0
count_j = json:size_of_array("slot[i].token.mechanism")
while j < count_j do
json.j = j
strVal = json:string_of("slot[i].token.mechanism[j]")
j = j + 1
end
i = i + 1
end