Zig

PKCS11 Find Specific Certificate on Smart Card or USB Token

See more PKCS11 Examples

This example code shows how to find a particular certificate on a smart card or USB token.

Note: This example requires Chilkat v9.5.0.88 or later.

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();

    // Set your shared lib path -- either a full path to the DLL, .so, or .dylib,
    // or just the filename if the driver is in a location that can be automatically found. (Such as in C:\Windows\System32)
    pkcs11.setSharedLibPath("C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll");

    pkcs11.initialize() catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    };

    // Pass -1 for the slotID to open a session on the first non-empty slot.
    const slot_id = -1;

    // Open a session.
    const read_write = true;
    pkcs11.openSession(slot_id, read_write) catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    };

    // Make it an authenticated session by calling Login.
    //
    // If we don't authenticate, then we won't be able to see the private keys, and thus
    // we won't know which certificates have an associated private key stored on the smart card.

    // The smart card PIN is passed to the Login method.
    // userType 1 indicates a "Normal User".
    const user_type = 1;
    const pin = "0000";
    pkcs11.login(user_type, pin) catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        try pkcs11.closeSession();
        return;
    };

    // --------------------------------------------------------------------------
    // The FindCert method can find a particular certificate in a number of different ways.
    // I'll demonstrate some common ways..

    // 1) In many cases you'll be working with a smart card that contains one certificate that is to be used for
    // signing, and it is the certificate that is associated with the private key also stored on the smart card (or USB token).
    // There may be other certificates on the card, but these are the issuer certificates in the chain of authentication.
    // You're just interested in getting the certificate with the private key.
    // You can do it like this:
    const cert = try chilkat.Cert.init();
    defer cert.deinit();
    // Pass the keyword "privateKey" in the 1st argument, and an empty string in the 2nd arg.
    // This returns the 1st certificate that has a private key.
    if (pkcs11.findCert("privateKey", "", cert)) {
        std.debug.print("Cert with private key: {s}\n", .{try cert.getSubjectCN(alloc)});
    } else |_| {
        std.debug.print("No certificates having a private key were found.\n", .{});
    }

    // 2) Find a certificate by the Subject Common Name
    if (pkcs11.findCert("subjectCN", "Chil application account (8c9be8e0-5544-4cd0-9062-290fbff353a7)", cert)) {
        std.debug.print("Found: {s}\n", .{try cert.getSubjectCN(alloc)});
    } else |_| {
        std.debug.print("Not found: {s}\n", .{try cert.getSubjectCN(alloc)});
    }

    // 3) Find a certificate by hex serial number
    if (pkcs11.findCert("serial", "5087bf1feda006af54a02f23a851104948acc26f", cert)) {
        std.debug.print("Found: {s}\n", .{try cert.getSerialNumber(alloc)});
    } else |_| {
        std.debug.print("Not found: {s}\n", .{try cert.getSerialNumber(alloc)});
    }

    // 4) Find a certificate by hex serial number and Issuer Common Name
    if (pkcs11.findCert("serial:issuerCN", "5087bf1feda006af54a02f23a851104948acc26f:Ibanity Production Third Party Application CA", cert)) {
        std.debug.print("Found: {s}\n", .{try cert.getSubjectCN(alloc)});
    } else |_| {
        std.debug.print("Not found: {s}\n", .{try cert.getSubjectCN(alloc)});
    }

    // --------------------------------------------------------------------------

    // Revert to an unauthenticated session by calling Logout.
    pkcs11.logout() catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        try pkcs11.closeSession();
        return;
    };

    // When finished, close the session.
    // It is important to close the session (memory leaks will occur if the session is not properly closed).
    pkcs11.closeSession() catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Success.\n", .{});
}