(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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.

    let pkcs11 = CkoPkcs11()!

    // Specify the vendor's Cryptoki module DLL / shared lib.
    pkcs11.sharedLibPath = "aetpkss1.dll"

    var success: Bool = pkcs11.initialize()
    if success == false {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    // 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.)
    var onlyTokensPresent: Bool = true
    let json = CkoJsonObject()!
    success = pkcs11.discover(onlyTokensPresent, json: json)
    if success == false {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    json.emitCompact = false
    print("\(json.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

    var id: Int
    var slotDescription: String?
    var tokenPresent: Bool
    var removableDevice: Bool
    var hardwareSlot: Bool
    var hardwareVersionMajor: Int
    var hardwareVersionMinor: Int
    var firmwareVersionMajor: Int
    var firmwareVersionMinor: Int
    var tokenLabel: String?
    var tokenManufacturerID: String?
    var tokenModel: String?
    var tokenSerialNumber: String?
    var tokenMaxSessionCount: Int
    var tokenSessionCount: Int
    var tokenMaxRwSessionCount: Int
    var tokenRwSessionCount: Int
    var tokenMaxPinLen: Int
    var tokenMinPinLen: Int
    var tokenTotalPublicMemory: Int
    var tokenFreePublicMemory: Int
    var tokenTotalPrivateMemory: Int
    var tokenFreePrivateMemory: Int
    var tokenHardwareVersionMajor: Int
    var tokenHardwareVersionMinor: Int
    var tokenFirmwareVersionMajor: Int
    var tokenFirmwareVersionMinor: Int
    var tokenUtcTime: String?
    var tokenRsaMinKeySize: Int
    var tokenRsaMaxKeySize: Int
    var j: Int
    var count_j: Int
    var strVal: String?

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

    var cryptokiVersionMajor: Int = json.int(of: "cryptokiVersion.major").intValue
    var cryptokiVersionMinor: Int = json.int(of: "cryptokiVersion.minor").intValue
    var manufacturerID: String? = json.string(of: "manufacturerID")
    var libraryDescription: String? = json.string(of: "libraryDescription")
    var libraryVersionMajor: Int = json.int(of: "libraryVersion.major").intValue
    var libraryVersionMinor: Int = json.int(of: "libraryVersion.minor").intValue
    var i: Int = 0
    var count_i: Int = json.size(ofArray: "slot").intValue
    while i < count_i {
        json.i = i
        id = json.int(of: "slot[i].id").intValue
        slotDescription = json.string(of: "slot[i].slotDescription")
        manufacturerID = json.string(of: "slot[i].manufacturerID")
        tokenPresent = json.bool(of: "slot[i].tokenPresent")
        removableDevice = json.bool(of: "slot[i].removableDevice")
        hardwareSlot = json.bool(of: "slot[i].hardwareSlot")
        hardwareVersionMajor = json.int(of: "slot[i].hardwareVersion.major").intValue
        hardwareVersionMinor = json.int(of: "slot[i].hardwareVersion.minor").intValue
        firmwareVersionMajor = json.int(of: "slot[i].firmwareVersion.major").intValue
        firmwareVersionMinor = json.int(of: "slot[i].firmwareVersion.minor").intValue
        tokenLabel = json.string(of: "slot[i].token.label")
        tokenManufacturerID = json.string(of: "slot[i].token.manufacturerID")
        tokenModel = json.string(of: "slot[i].token.model")
        tokenSerialNumber = json.string(of: "slot[i].token.serialNumber")
        tokenMaxSessionCount = json.int(of: "slot[i].token.maxSessionCount").intValue
        tokenSessionCount = json.int(of: "slot[i].token.sessionCount").intValue
        tokenMaxRwSessionCount = json.int(of: "slot[i].token.maxRwSessionCount").intValue
        tokenRwSessionCount = json.int(of: "slot[i].token.rwSessionCount").intValue
        tokenMaxPinLen = json.int(of: "slot[i].token.maxPinLen").intValue
        tokenMinPinLen = json.int(of: "slot[i].token.minPinLen").intValue
        tokenTotalPublicMemory = json.int(of: "slot[i].token.totalPublicMemory").intValue
        tokenFreePublicMemory = json.int(of: "slot[i].token.freePublicMemory").intValue
        tokenTotalPrivateMemory = json.int(of: "slot[i].token.totalPrivateMemory").intValue
        tokenFreePrivateMemory = json.int(of: "slot[i].token.freePrivateMemory").intValue
        tokenHardwareVersionMajor = json.int(of: "slot[i].token.hardwareVersion.major").intValue
        tokenHardwareVersionMinor = json.int(of: "slot[i].token.hardwareVersion.minor").intValue
        tokenFirmwareVersionMajor = json.int(of: "slot[i].token.firmwareVersion.major").intValue
        tokenFirmwareVersionMinor = json.int(of: "slot[i].token.firmwareVersion.minor").intValue
        tokenUtcTime = json.string(of: "slot[i].token.utcTime")
        tokenRsaMinKeySize = json.int(of: "slot[i].token.rsa.minKeySize").intValue
        tokenRsaMaxKeySize = json.int(of: "slot[i].token.rsa.maxKeySize").intValue
        j = 0
        count_j = json.size(ofArray: "slot[i].token.flags").intValue
        while j < count_j {
            json.j = j
            strVal = json.string(of: "slot[i].token.flags[j]")
            j = j + 1
        }

        j = 0
        count_j = json.size(ofArray: "slot[i].token.mechanism").intValue
        while j < count_j {
            json.j = j
            strVal = json.string(of: "slot[i].token.mechanism[j]")
            j = j + 1
        }

        i = i + 1
    }


}