(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoPkcs11
    Boolean iSuccess
    Boolean iOnlyTokensPresent
    Variant vJson
    Handle hoJson
    Integer iId
    String sSlotDescription
    Boolean iTokenPresent
    Boolean iRemovableDevice
    Boolean iHardwareSlot
    Integer iHardwareVersionMajor
    Integer iHardwareVersionMinor
    Integer iFirmwareVersionMajor
    Integer iFirmwareVersionMinor
    String sTokenLabel
    String sTokenManufacturerID
    String sTokenModel
    String sTokenSerialNumber
    Integer iTokenMaxSessionCount
    Integer iTokenSessionCount
    Integer iTokenMaxRwSessionCount
    Integer iTokenRwSessionCount
    Integer iTokenMaxPinLen
    Integer iTokenMinPinLen
    Integer iTokenTotalPublicMemory
    Integer iTokenFreePublicMemory
    Integer iTokenTotalPrivateMemory
    Integer iTokenFreePrivateMemory
    Integer iTokenHardwareVersionMajor
    Integer iTokenHardwareVersionMinor
    Integer iTokenFirmwareVersionMajor
    Integer iTokenFirmwareVersionMinor
    String sTokenUtcTime
    Integer iTokenRsaMinKeySize
    Integer iTokenRsaMaxKeySize
    Integer j
    Integer iCount_j
    String sStrVal
    Integer iCryptokiVersionMajor
    Integer iCryptokiVersionMinor
    String sManufacturerID
    String sLibraryDescription
    Integer iLibraryVersionMajor
    Integer iLibraryVersionMinor
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatPkcs11)) To hoPkcs11
    If (Not(IsComObjectCreated(hoPkcs11))) Begin
        Send CreateComObject of hoPkcs11
    End

    // Specify the vendor's Cryptoki module DLL / shared lib.
    Set ComSharedLibPath Of hoPkcs11 To "aetpkss1.dll"

    Get ComInitialize Of hoPkcs11 To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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.)
    Move True To iOnlyTokensPresent
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get pvComObject of hoJson to vJson
    Get ComDiscover Of hoPkcs11 iOnlyTokensPresent vJson To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPkcs11 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Set ComEmitCompact Of hoJson To False
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1

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

    Get ComIntOf Of hoJson "cryptokiVersion.major" To iCryptokiVersionMajor
    Get ComIntOf Of hoJson "cryptokiVersion.minor" To iCryptokiVersionMinor
    Get ComStringOf Of hoJson "manufacturerID" To sManufacturerID
    Get ComStringOf Of hoJson "libraryDescription" To sLibraryDescription
    Get ComIntOf Of hoJson "libraryVersion.major" To iLibraryVersionMajor
    Get ComIntOf Of hoJson "libraryVersion.minor" To iLibraryVersionMinor
    Move 0 To i
    Get ComSizeOfArray Of hoJson "slot" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJson To i
        Get ComIntOf Of hoJson "slot[i].id" To iId
        Get ComStringOf Of hoJson "slot[i].slotDescription" To sSlotDescription
        Get ComStringOf Of hoJson "slot[i].manufacturerID" To sManufacturerID
        Get ComBoolOf Of hoJson "slot[i].tokenPresent" To iTokenPresent
        Get ComBoolOf Of hoJson "slot[i].removableDevice" To iRemovableDevice
        Get ComBoolOf Of hoJson "slot[i].hardwareSlot" To iHardwareSlot
        Get ComIntOf Of hoJson "slot[i].hardwareVersion.major" To iHardwareVersionMajor
        Get ComIntOf Of hoJson "slot[i].hardwareVersion.minor" To iHardwareVersionMinor
        Get ComIntOf Of hoJson "slot[i].firmwareVersion.major" To iFirmwareVersionMajor
        Get ComIntOf Of hoJson "slot[i].firmwareVersion.minor" To iFirmwareVersionMinor
        Get ComStringOf Of hoJson "slot[i].token.label" To sTokenLabel
        Get ComStringOf Of hoJson "slot[i].token.manufacturerID" To sTokenManufacturerID
        Get ComStringOf Of hoJson "slot[i].token.model" To sTokenModel
        Get ComStringOf Of hoJson "slot[i].token.serialNumber" To sTokenSerialNumber
        Get ComIntOf Of hoJson "slot[i].token.maxSessionCount" To iTokenMaxSessionCount
        Get ComIntOf Of hoJson "slot[i].token.sessionCount" To iTokenSessionCount
        Get ComIntOf Of hoJson "slot[i].token.maxRwSessionCount" To iTokenMaxRwSessionCount
        Get ComIntOf Of hoJson "slot[i].token.rwSessionCount" To iTokenRwSessionCount
        Get ComIntOf Of hoJson "slot[i].token.maxPinLen" To iTokenMaxPinLen
        Get ComIntOf Of hoJson "slot[i].token.minPinLen" To iTokenMinPinLen
        Get ComIntOf Of hoJson "slot[i].token.totalPublicMemory" To iTokenTotalPublicMemory
        Get ComIntOf Of hoJson "slot[i].token.freePublicMemory" To iTokenFreePublicMemory
        Get ComIntOf Of hoJson "slot[i].token.totalPrivateMemory" To iTokenTotalPrivateMemory
        Get ComIntOf Of hoJson "slot[i].token.freePrivateMemory" To iTokenFreePrivateMemory
        Get ComIntOf Of hoJson "slot[i].token.hardwareVersion.major" To iTokenHardwareVersionMajor
        Get ComIntOf Of hoJson "slot[i].token.hardwareVersion.minor" To iTokenHardwareVersionMinor
        Get ComIntOf Of hoJson "slot[i].token.firmwareVersion.major" To iTokenFirmwareVersionMajor
        Get ComIntOf Of hoJson "slot[i].token.firmwareVersion.minor" To iTokenFirmwareVersionMinor
        Get ComStringOf Of hoJson "slot[i].token.utcTime" To sTokenUtcTime
        Get ComIntOf Of hoJson "slot[i].token.rsa.minKeySize" To iTokenRsaMinKeySize
        Get ComIntOf Of hoJson "slot[i].token.rsa.maxKeySize" To iTokenRsaMaxKeySize
        Move 0 To j
        Get ComSizeOfArray Of hoJson "slot[i].token.flags" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJson To j
            Get ComStringOf Of hoJson "slot[i].token.flags[j]" To sStrVal
            Move (j + 1) To j
        Loop

        Move 0 To j
        Get ComSizeOfArray Of hoJson "slot[i].token.mechanism" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJson To j
            Get ComStringOf Of hoJson "slot[i].token.mechanism[j]" To sStrVal
            Move (j + 1) To j
        Loop

        Move (i + 1) To i
    Loop



End_Procedure