Xbase++
Xbase++
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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oPkcs11
LOCAL nOnlyTokensPresent
LOCAL oJson
LOCAL nId
LOCAL cSlotDescription
LOCAL nTokenPresent
LOCAL nRemovableDevice
LOCAL nHardwareSlot
LOCAL nHardwareVersionMajor
LOCAL nHardwareVersionMinor
LOCAL nFirmwareVersionMajor
LOCAL nFirmwareVersionMinor
LOCAL cTokenLabel
LOCAL cTokenManufacturerID
LOCAL cTokenModel
LOCAL cTokenSerialNumber
LOCAL nTokenMaxSessionCount
LOCAL nTokenSessionCount
LOCAL nTokenMaxRwSessionCount
LOCAL nTokenRwSessionCount
LOCAL nTokenMaxPinLen
LOCAL nTokenMinPinLen
LOCAL nTokenTotalPublicMemory
LOCAL nTokenFreePublicMemory
LOCAL nTokenTotalPrivateMemory
LOCAL nTokenFreePrivateMemory
LOCAL nTokenHardwareVersionMajor
LOCAL nTokenHardwareVersionMinor
LOCAL nTokenFirmwareVersionMajor
LOCAL nTokenFirmwareVersionMinor
LOCAL cTokenUtcTime
LOCAL nTokenRsaMinKeySize
LOCAL nTokenRsaMaxKeySize
LOCAL j
LOCAL nCount_j
LOCAL cStrVal
LOCAL cTokenFlag
LOCAL nCryptokiVersionMajor
LOCAL nCryptokiVersionMinor
LOCAL cManufacturerID
LOCAL cLibraryDescription
LOCAL nLibraryVersionMajor
LOCAL nLibraryVersionMinor
LOCAL i
LOCAL nCount_i
LOCAL oAFlags
nSuccess := 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.
oPkcs11 := CreateObject("Chilkat.Pkcs11")
// 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.
oPkcs11:SharedLibPath := "SignatureP11.dll"
nSuccess := oPkcs11:Initialize()
IF (nSuccess == 0)
? oPkcs11:LastErrorText
oPkcs11:destroy()
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.
nOnlyTokensPresent := 1
oJson := CreateObject("Chilkat.JsonObject")
nSuccess := oPkcs11:Discover(nOnlyTokensPresent, oJson)
IF (nSuccess == 0)
? oPkcs11:LastErrorText
oPkcs11:destroy()
oJson:destroy()
RETURN
ENDIF
oJson:EmitCompact := 0
? oJson: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
nCryptokiVersionMajor := oJson:IntOf("cryptokiVersion.major")
nCryptokiVersionMinor := oJson:IntOf("cryptokiVersion.minor")
cManufacturerID := oJson:StringOf("manufacturerID")
cLibraryDescription := oJson:StringOf("libraryDescription")
nLibraryVersionMajor := oJson:IntOf("libraryVersion.major")
nLibraryVersionMinor := oJson:IntOf("libraryVersion.minor")
i := 0
nCount_i := oJson:SizeOfArray("slot")
DO WHILE i < nCount_i
oJson:I := i
nId := oJson:IntOf("slot[i].id")
cSlotDescription := oJson:StringOf("slot[i].slotDescription")
cManufacturerID := oJson:StringOf("slot[i].manufacturerID")
nTokenPresent := oJson:BoolOf("slot[i].tokenPresent")
nRemovableDevice := oJson:BoolOf("slot[i].removableDevice")
nHardwareSlot := oJson:BoolOf("slot[i].hardwareSlot")
nHardwareVersionMajor := oJson:IntOf("slot[i].hardwareVersion.major")
nHardwareVersionMinor := oJson:IntOf("slot[i].hardwareVersion.minor")
nFirmwareVersionMajor := oJson:IntOf("slot[i].firmwareVersion.major")
nFirmwareVersionMinor := oJson:IntOf("slot[i].firmwareVersion.minor")
cTokenLabel := oJson:StringOf("slot[i].token.label")
cTokenManufacturerID := oJson:StringOf("slot[i].token.manufacturerID")
cTokenModel := oJson:StringOf("slot[i].token.model")
cTokenSerialNumber := oJson:StringOf("slot[i].token.serialNumber")
nTokenMaxSessionCount := oJson:IntOf("slot[i].token.maxSessionCount")
nTokenSessionCount := oJson:IntOf("slot[i].token.sessionCount")
nTokenMaxRwSessionCount := oJson:IntOf("slot[i].token.maxRwSessionCount")
nTokenRwSessionCount := oJson:IntOf("slot[i].token.rwSessionCount")
nTokenMaxPinLen := oJson:IntOf("slot[i].token.maxPinLen")
nTokenMinPinLen := oJson:IntOf("slot[i].token.minPinLen")
nTokenTotalPublicMemory := oJson:IntOf("slot[i].token.totalPublicMemory")
nTokenFreePublicMemory := oJson:IntOf("slot[i].token.freePublicMemory")
nTokenTotalPrivateMemory := oJson:IntOf("slot[i].token.totalPrivateMemory")
nTokenFreePrivateMemory := oJson:IntOf("slot[i].token.freePrivateMemory")
nTokenHardwareVersionMajor := oJson:IntOf("slot[i].token.hardwareVersion.major")
nTokenHardwareVersionMinor := oJson:IntOf("slot[i].token.hardwareVersion.minor")
nTokenFirmwareVersionMajor := oJson:IntOf("slot[i].token.firmwareVersion.major")
nTokenFirmwareVersionMinor := oJson:IntOf("slot[i].token.firmwareVersion.minor")
cTokenUtcTime := oJson:StringOf("slot[i].token.utcTime")
nTokenRsaMinKeySize := oJson:IntOf("slot[i].token.rsa.minKeySize")
nTokenRsaMaxKeySize := oJson: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:
oAFlags := oJson:ArrayOf("slot[i].token.flags")
IF (oAFlags:FindString("CKF_USER_PIN_LOCKED", 1) >= 0)
? "The token is locked."
ENDIF
IF (oAFlags:FindString("CKF_RNG", 1) >= 0)
? "The token has a random number generator."
ENDIF
// ...
oAFlags:destroy()
// To iterate over all flags..
j := 0
nCount_j := oJson:SizeOfArray("slot[i].token.flags")
DO WHILE j < nCount_j
oJson:J := j
cTokenFlag := oJson:StringOf("slot[i].token.flags[j]")
j := j + 1
ENDDO
j := 0
nCount_j := oJson:SizeOfArray("slot[i].token.mechanism")
DO WHILE j < nCount_j
oJson:J := j
cStrVal := oJson:StringOf("slot[i].token.mechanism[j]")
j := j + 1
ENDDO
i := i + 1
ENDDO
oPkcs11:destroy()
oJson:destroy()