Sample code for 30+ languages & platforms
Visual FoxPro

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 Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loPkcs11
LOCAL lnOnlyTokensPresent
LOCAL loJson
LOCAL lnId
LOCAL lcSlotDescription
LOCAL lnTokenPresent
LOCAL lnRemovableDevice
LOCAL lnHardwareSlot
LOCAL lnHardwareVersionMajor
LOCAL lnHardwareVersionMinor
LOCAL lnFirmwareVersionMajor
LOCAL lnFirmwareVersionMinor
LOCAL lcTokenLabel
LOCAL lcTokenManufacturerID
LOCAL lcTokenModel
LOCAL lcTokenSerialNumber
LOCAL lnTokenMaxSessionCount
LOCAL lnTokenSessionCount
LOCAL lnTokenMaxRwSessionCount
LOCAL lnTokenRwSessionCount
LOCAL lnTokenMaxPinLen
LOCAL lnTokenMinPinLen
LOCAL lnTokenTotalPublicMemory
LOCAL lnTokenFreePublicMemory
LOCAL lnTokenTotalPrivateMemory
LOCAL lnTokenFreePrivateMemory
LOCAL lnTokenHardwareVersionMajor
LOCAL lnTokenHardwareVersionMinor
LOCAL lnTokenFirmwareVersionMajor
LOCAL lnTokenFirmwareVersionMinor
LOCAL lcTokenUtcTime
LOCAL lnTokenRsaMinKeySize
LOCAL lnTokenRsaMaxKeySize
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lnCryptokiVersionMajor
LOCAL lnCryptokiVersionMinor
LOCAL lcManufacturerID
LOCAL lcLibraryDescription
LOCAL lnLibraryVersionMajor
LOCAL lnLibraryVersionMinor
LOCAL i
LOCAL lnCount_i

lnSuccess = 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.

loPkcs11 = CreateObject('Chilkat.Pkcs11')

* Specify the vendor's Cryptoki module DLL / shared lib.
loPkcs11.SharedLibPath = "aetpkss1.dll"

lnSuccess = loPkcs11.Initialize()
IF (lnSuccess = 0) THEN
    ? loPkcs11.LastErrorText
    RELEASE loPkcs11
    CANCEL
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.)
lnOnlyTokensPresent = 1
loJson = CreateObject('Chilkat.JsonObject')
lnSuccess = loPkcs11.Discover(lnOnlyTokensPresent,loJson)
IF (lnSuccess = 0) THEN
    ? loPkcs11.LastErrorText
    RELEASE loPkcs11
    RELEASE loJson
    CANCEL
ENDIF

loJson.EmitCompact = 0
? loJson.Emit()

* 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

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")
    lnTokenPresent = loJson.BoolOf("slot[i].tokenPresent")
    lnRemovableDevice = loJson.BoolOf("slot[i].removableDevice")
    lnHardwareSlot = 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")
    j = 0
    lnCount_j = loJson.SizeOfArray("slot[i].token.flags")
    DO WHILE j < lnCount_j
        loJson.J = j
        lcStrVal = 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