Sample code for 30+ languages & platforms
Zig

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 Zig Downloads

Zig
const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    const pkcs11 = try chilkat.Pkcs11.init();
    defer pkcs11.deinit();

    // Specify the vendor's Cryptoki module DLL / shared lib.
    pkcs11.setSharedLibPath("aetpkss1.dll");

    pkcs11.initialize() catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        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.)
    const only_tokens_present = true;
    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    pkcs11.discover(only_tokens_present, json) catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    };

    json.setEmitCompact(false);
    std.debug.print("{s}\n", .{try json.emit(alloc)});

    // 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: i32 = 0;
    var slot_description: [:0]const u8 = "";
    var token_present: bool = false;
    var removable_device: bool = false;
    var hardware_slot: bool = false;
    var hardware_version_major: i32 = 0;
    var hardware_version_minor: i32 = 0;
    var firmware_version_major: i32 = 0;
    var firmware_version_minor: i32 = 0;
    var token_label: [:0]const u8 = "";
    var token_manufacturer_id: [:0]const u8 = "";
    var token_model: [:0]const u8 = "";
    var token_serial_number: [:0]const u8 = "";
    var token_max_session_count: i32 = 0;
    var token_session_count: i32 = 0;
    var token_max_rw_session_count: i32 = 0;
    var token_rw_session_count: i32 = 0;
    var token_max_pin_len: i32 = 0;
    var token_min_pin_len: i32 = 0;
    var token_total_public_memory: i32 = 0;
    var token_free_public_memory: i32 = 0;
    var token_total_private_memory: i32 = 0;
    var token_free_private_memory: i32 = 0;
    var token_hardware_version_major: i32 = 0;
    var token_hardware_version_minor: i32 = 0;
    var token_firmware_version_major: i32 = 0;
    var token_firmware_version_minor: i32 = 0;
    var token_utc_time: [:0]const u8 = "";
    var token_rsa_min_key_size: i32 = 0;
    var token_rsa_max_key_size: i32 = 0;
    var j: i32 = 0;
    var count_j: i32 = 0;
    var str_val: [:0]const u8 = "";

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

    _ = json.intOf("cryptokiVersion.major");
    _ = json.intOf("cryptokiVersion.minor");
    var manufacturer_id: [:0]const u8 = try json.stringOf(alloc, "manufacturerID");
    _ = try json.stringOf(alloc, "libraryDescription");
    _ = json.intOf("libraryVersion.major");
    _ = json.intOf("libraryVersion.minor");
    var i: i32 = 0;
    const count_i = json.sizeOfArray("slot");
    while (i < count_i) {
        json.setI(i);
        id = json.intOf("slot[i].id");
        slot_description = try json.stringOf(alloc, "slot[i].slotDescription");
        manufacturer_id = try json.stringOf(alloc, "slot[i].manufacturerID");
        token_present = json.boolOf("slot[i].tokenPresent");
        removable_device = json.boolOf("slot[i].removableDevice");
        hardware_slot = json.boolOf("slot[i].hardwareSlot");
        hardware_version_major = json.intOf("slot[i].hardwareVersion.major");
        hardware_version_minor = json.intOf("slot[i].hardwareVersion.minor");
        firmware_version_major = json.intOf("slot[i].firmwareVersion.major");
        firmware_version_minor = json.intOf("slot[i].firmwareVersion.minor");
        token_label = try json.stringOf(alloc, "slot[i].token.label");
        token_manufacturer_id = try json.stringOf(alloc, "slot[i].token.manufacturerID");
        token_model = try json.stringOf(alloc, "slot[i].token.model");
        token_serial_number = try json.stringOf(alloc, "slot[i].token.serialNumber");
        token_max_session_count = json.intOf("slot[i].token.maxSessionCount");
        token_session_count = json.intOf("slot[i].token.sessionCount");
        token_max_rw_session_count = json.intOf("slot[i].token.maxRwSessionCount");
        token_rw_session_count = json.intOf("slot[i].token.rwSessionCount");
        token_max_pin_len = json.intOf("slot[i].token.maxPinLen");
        token_min_pin_len = json.intOf("slot[i].token.minPinLen");
        token_total_public_memory = json.intOf("slot[i].token.totalPublicMemory");
        token_free_public_memory = json.intOf("slot[i].token.freePublicMemory");
        token_total_private_memory = json.intOf("slot[i].token.totalPrivateMemory");
        token_free_private_memory = json.intOf("slot[i].token.freePrivateMemory");
        token_hardware_version_major = json.intOf("slot[i].token.hardwareVersion.major");
        token_hardware_version_minor = json.intOf("slot[i].token.hardwareVersion.minor");
        token_firmware_version_major = json.intOf("slot[i].token.firmwareVersion.major");
        token_firmware_version_minor = json.intOf("slot[i].token.firmwareVersion.minor");
        token_utc_time = try json.stringOf(alloc, "slot[i].token.utcTime");
        token_rsa_min_key_size = json.intOf("slot[i].token.rsa.minKeySize");
        token_rsa_max_key_size = json.intOf("slot[i].token.rsa.maxKeySize");
        j = 0;
        count_j = json.sizeOfArray("slot[i].token.flags");
        while (j < count_j) {
            json.setJ(j);
            str_val = try json.stringOf(alloc, "slot[i].token.flags[j]");
            j = j + 1;
        }

        j = 0;
        count_j = json.sizeOfArray("slot[i].token.mechanism");
        while (j < count_j) {
            json.setJ(j);
            str_val = try json.stringOf(alloc, "slot[i].token.mechanism[j]");
            j = j + 1;
        }

        i = i + 1;
    }
}