(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

// 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.

loPkcs11 = createobject("CkPkcs11")

// 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.
loPkcs11.SharedLibPath = "SignatureP11.dll"

llSuccess = loPkcs11.Initialize()
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    return
endif

// Call Discover to discover what's available.
// Indicate that we only want to return slots (readers) where tokens (or smart cards) are present.
llOnlyTokensPresent = .T.
loJson = createobject("CkJsonObject")
llSuccess = loPkcs11.Discover(llOnlyTokensPresent,loJson)
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    release loJson
    return
endif

loJson.EmitCompact = .F.
? loJson.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

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

lnCryptokiVersionMajor = loJson.IntOf("cryptokiVersion.major")
lnCryptokiVersionMinor = loJson.IntOf("cryptokiVersion.minor")
lcManufacturerID = loJson.StringOf("manufacturerID")
lcLibraryDescription = loJson.StringOf("libraryDescription")
lnLibraryVersionMajor = loJson.IntOf("libraryVersion.major")
lnLibraryVersionMinor = loJson.IntOf("libraryVersion.minor")
i = 0
lnCount_i = loJson.SizeOfArray("slot")
do while i < lnCount_i
    loJson.I = i
    lnId = loJson.IntOf("slot[i].id")
    lcSlotDescription = loJson.StringOf("slot[i].slotDescription")
    lcManufacturerID = loJson.StringOf("slot[i].manufacturerID")
    llTokenPresent = loJson.BoolOf("slot[i].tokenPresent")
    llRemovableDevice = loJson.BoolOf("slot[i].removableDevice")
    llHardwareSlot = loJson.BoolOf("slot[i].hardwareSlot")
    lnHardwareVersionMajor = loJson.IntOf("slot[i].hardwareVersion.major")
    lnHardwareVersionMinor = loJson.IntOf("slot[i].hardwareVersion.minor")
    lnFirmwareVersionMajor = loJson.IntOf("slot[i].firmwareVersion.major")
    lnFirmwareVersionMinor = loJson.IntOf("slot[i].firmwareVersion.minor")
    lcTokenLabel = loJson.StringOf("slot[i].token.label")
    lcTokenManufacturerID = loJson.StringOf("slot[i].token.manufacturerID")
    lcTokenModel = loJson.StringOf("slot[i].token.model")
    lcTokenSerialNumber = loJson.StringOf("slot[i].token.serialNumber")
    lnTokenMaxSessionCount = loJson.IntOf("slot[i].token.maxSessionCount")
    lnTokenSessionCount = loJson.IntOf("slot[i].token.sessionCount")
    lnTokenMaxRwSessionCount = loJson.IntOf("slot[i].token.maxRwSessionCount")
    lnTokenRwSessionCount = loJson.IntOf("slot[i].token.rwSessionCount")
    lnTokenMaxPinLen = loJson.IntOf("slot[i].token.maxPinLen")
    lnTokenMinPinLen = loJson.IntOf("slot[i].token.minPinLen")
    lnTokenTotalPublicMemory = loJson.IntOf("slot[i].token.totalPublicMemory")
    lnTokenFreePublicMemory = loJson.IntOf("slot[i].token.freePublicMemory")
    lnTokenTotalPrivateMemory = loJson.IntOf("slot[i].token.totalPrivateMemory")
    lnTokenFreePrivateMemory = loJson.IntOf("slot[i].token.freePrivateMemory")
    lnTokenHardwareVersionMajor = loJson.IntOf("slot[i].token.hardwareVersion.major")
    lnTokenHardwareVersionMinor = loJson.IntOf("slot[i].token.hardwareVersion.minor")
    lnTokenFirmwareVersionMajor = loJson.IntOf("slot[i].token.firmwareVersion.major")
    lnTokenFirmwareVersionMinor = loJson.IntOf("slot[i].token.firmwareVersion.minor")
    lcTokenUtcTime = loJson.StringOf("slot[i].token.utcTime")
    lnTokenRsaMinKeySize = loJson.IntOf("slot[i].token.rsa.minKeySize")
    lnTokenRsaMaxKeySize = loJson.IntOf("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:
    loAFlags = loJson.ArrayOf("slot[i].token.flags")
    if (loAFlags.FindString("CKF_USER_PIN_LOCKED",.T.) >= 0) then
        ? "The token is locked."
    endif

    if (loAFlags.FindString("CKF_RNG",.T.) >= 0) then
        ? "The token has a random number generator."
    endif

    // ...
    release loAFlags

    // To iterate over all flags..
    j = 0
    lnCount_j = loJson.SizeOfArray("slot[i].token.flags")
    do while j < lnCount_j
        loJson.J = j
        lcTokenFlag = loJson.StringOf("slot[i].token.flags[j]")
        j = j + 1
    enddo

    j = 0
    lnCount_j = loJson.SizeOfArray("slot[i].token.mechanism")
    do while j < lnCount_j
        loJson.J = j
        lcStrVal = loJson.StringOf("slot[i].token.mechanism[j]")
        j = j + 1
    enddo
    i = i + 1
enddo


release loPkcs11
release loJson