PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkPkcs11.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
success.i = 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.
pkcs11.i = CkPkcs11::ckCreate()
If pkcs11.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Specify the vendor's Cryptoki module DLL / shared lib.
CkPkcs11::setCkSharedLibPath(pkcs11, "aetpkss1.dll")
success = CkPkcs11::ckInitialize(pkcs11)
If success = 0
Debug CkPkcs11::ckLastErrorText(pkcs11)
CkPkcs11::ckDispose(pkcs11)
ProcedureReturn
EndIf
; 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.)
onlyTokensPresent.i = 1
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkPkcs11::ckDiscover(pkcs11,onlyTokensPresent,json)
If success = 0
Debug CkPkcs11::ckLastErrorText(pkcs11)
CkPkcs11::ckDispose(pkcs11)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
Debug CkJsonObject::ckEmit(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
id.i
slotDescription.s
tokenPresent.i
removableDevice.i
hardwareSlot.i
hardwareVersionMajor.i
hardwareVersionMinor.i
firmwareVersionMajor.i
firmwareVersionMinor.i
tokenLabel.s
tokenManufacturerID.s
tokenModel.s
tokenSerialNumber.s
tokenMaxSessionCount.i
tokenSessionCount.i
tokenMaxRwSessionCount.i
tokenRwSessionCount.i
tokenMaxPinLen.i
tokenMinPinLen.i
tokenTotalPublicMemory.i
tokenFreePublicMemory.i
tokenTotalPrivateMemory.i
tokenFreePrivateMemory.i
tokenHardwareVersionMajor.i
tokenHardwareVersionMinor.i
tokenFirmwareVersionMajor.i
tokenFirmwareVersionMinor.i
tokenUtcTime.s
tokenRsaMinKeySize.i
tokenRsaMaxKeySize.i
j.i
count_j.i
strVal.s
; Use this online tool to generate parsing code from sample JSON:
; Generate Parsing Code from JSON
cryptokiVersionMajor.i = CkJsonObject::ckIntOf(json,"cryptokiVersion.major")
cryptokiVersionMinor.i = CkJsonObject::ckIntOf(json,"cryptokiVersion.minor")
manufacturerID.s = CkJsonObject::ckStringOf(json,"manufacturerID")
libraryDescription.s = CkJsonObject::ckStringOf(json,"libraryDescription")
libraryVersionMajor.i = CkJsonObject::ckIntOf(json,"libraryVersion.major")
libraryVersionMinor.i = CkJsonObject::ckIntOf(json,"libraryVersion.minor")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(json,"slot")
While i < count_i
CkJsonObject::setCkI(json, i)
id = CkJsonObject::ckIntOf(json,"slot[i].id")
slotDescription = CkJsonObject::ckStringOf(json,"slot[i].slotDescription")
manufacturerID = CkJsonObject::ckStringOf(json,"slot[i].manufacturerID")
tokenPresent = CkJsonObject::ckBoolOf(json,"slot[i].tokenPresent")
removableDevice = CkJsonObject::ckBoolOf(json,"slot[i].removableDevice")
hardwareSlot = CkJsonObject::ckBoolOf(json,"slot[i].hardwareSlot")
hardwareVersionMajor = CkJsonObject::ckIntOf(json,"slot[i].hardwareVersion.major")
hardwareVersionMinor = CkJsonObject::ckIntOf(json,"slot[i].hardwareVersion.minor")
firmwareVersionMajor = CkJsonObject::ckIntOf(json,"slot[i].firmwareVersion.major")
firmwareVersionMinor = CkJsonObject::ckIntOf(json,"slot[i].firmwareVersion.minor")
tokenLabel = CkJsonObject::ckStringOf(json,"slot[i].token.label")
tokenManufacturerID = CkJsonObject::ckStringOf(json,"slot[i].token.manufacturerID")
tokenModel = CkJsonObject::ckStringOf(json,"slot[i].token.model")
tokenSerialNumber = CkJsonObject::ckStringOf(json,"slot[i].token.serialNumber")
tokenMaxSessionCount = CkJsonObject::ckIntOf(json,"slot[i].token.maxSessionCount")
tokenSessionCount = CkJsonObject::ckIntOf(json,"slot[i].token.sessionCount")
tokenMaxRwSessionCount = CkJsonObject::ckIntOf(json,"slot[i].token.maxRwSessionCount")
tokenRwSessionCount = CkJsonObject::ckIntOf(json,"slot[i].token.rwSessionCount")
tokenMaxPinLen = CkJsonObject::ckIntOf(json,"slot[i].token.maxPinLen")
tokenMinPinLen = CkJsonObject::ckIntOf(json,"slot[i].token.minPinLen")
tokenTotalPublicMemory = CkJsonObject::ckIntOf(json,"slot[i].token.totalPublicMemory")
tokenFreePublicMemory = CkJsonObject::ckIntOf(json,"slot[i].token.freePublicMemory")
tokenTotalPrivateMemory = CkJsonObject::ckIntOf(json,"slot[i].token.totalPrivateMemory")
tokenFreePrivateMemory = CkJsonObject::ckIntOf(json,"slot[i].token.freePrivateMemory")
tokenHardwareVersionMajor = CkJsonObject::ckIntOf(json,"slot[i].token.hardwareVersion.major")
tokenHardwareVersionMinor = CkJsonObject::ckIntOf(json,"slot[i].token.hardwareVersion.minor")
tokenFirmwareVersionMajor = CkJsonObject::ckIntOf(json,"slot[i].token.firmwareVersion.major")
tokenFirmwareVersionMinor = CkJsonObject::ckIntOf(json,"slot[i].token.firmwareVersion.minor")
tokenUtcTime = CkJsonObject::ckStringOf(json,"slot[i].token.utcTime")
tokenRsaMinKeySize = CkJsonObject::ckIntOf(json,"slot[i].token.rsa.minKeySize")
tokenRsaMaxKeySize = CkJsonObject::ckIntOf(json,"slot[i].token.rsa.maxKeySize")
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"slot[i].token.flags")
While j < count_j
CkJsonObject::setCkJ(json, j)
strVal = CkJsonObject::ckStringOf(json,"slot[i].token.flags[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(json,"slot[i].token.mechanism")
While j < count_j
CkJsonObject::setCkJ(json, j)
strVal = CkJsonObject::ckStringOf(json,"slot[i].token.mechanism[j]")
j = j + 1
Wend
i = i + 1
Wend
CkPkcs11::ckDispose(pkcs11)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure