Zig

PKCS11 Generate a Session EC Key on the HSM

See more PKCS11 Examples

Generates an EC key on the smart card or token and returns the public and private key handles. The generated EC key exists only for the duration of the PKCS11 session.

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

Zig

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

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

    var success: bool = false;

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

    // Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
    // (The format of the path will change with the operating system.  Obviously, "C:/" is not used on non-Windows systems.
    pkcs11.setSharedLibPath("C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll");

    // Establish a logged-on session.
    const pin = "0000";
    const user_type = 1;
    success = if (pkcs11.quickSession(user_type, pin)) true else |_| false;
    if (!success) {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    }

    // Specify attributes and abilities (how this key can be used) by providing a JSON template.
    // One template is for the public key, and the other for the private key.
    const pub_key_attr = try chilkat.JsonObject.init();
    defer pub_key_attr.deinit();

    // Allow the public key to be used for signature verification
    pub_key_attr.updateBool("verify", true) catch {};

    // Specify the kind of EC key to generate by the curve name
    // Possible curve names are:
    // secp256r1  (also known as P-256 and prime256v1)
    // secp384r1  (also known as P-384)
    // secp521r1  (also known as P-521)
    // secp256k1 (This is the curve used for Bitcoin)
    // secp192r1
    // secp224r1
    // brainpoolP160r1
    // brainpoolP192r1
    // brainpoolP192r1
    // brainpoolP224r1
    // brainpoolP256r1
    // brainpoolP320r1
    // brainpoolP384r1
    // brainpoolP512r1
    // Note: Your smart card or token might not support all of the above EC curves (assuming it supports EC at all).

    // This attribute is required.
    pub_key_attr.updateString("ec_params", "secp256r1") catch {};

    const priv_key_attr = try chilkat.JsonObject.init();
    defer priv_key_attr.deinit();

    // Generate a session EC key.
    // A session key exists only for the duration of the PKS11 session.
    // To generate an EC key that resides on the HSM, set the "token" attribute equal to true
    priv_key_attr.updateBool("token", false) catch {};

    // Allow the private key to be used for signing.
    priv_key_attr.updateBool("sign", true) catch {};

    // Provide a JSON object to receive the public and private key handles.
    const json_handles = try chilkat.JsonObject.init();
    defer json_handles.deinit();
    json_handles.setEmitCompact(false);

    // Provide a Chilkat public key object to receive the public key.
    const pub_key = try chilkat.PublicKey.init();
    defer pub_key.deinit();

    success = if (pkcs11.genEcKey(pub_key_attr, priv_key_attr, json_handles, pub_key)) true else |_| false;
    if (!success) {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        std.debug.print("Failed to generate an EC key.\n", .{});
    } else {
        // Sample JSON handles:
        // {
        //   "public_key_handle": 18415630,
        //   "private_key_handle": 74842125
        // }
        std.debug.print("{s}\n", .{try json_handles.emit(alloc)});
        std.debug.print("public_key_handle: {d}\n", .{json_handles.uIntOf("public_key_handle")});
        std.debug.print("private_key_handle: {d}\n", .{json_handles.uIntOf("private_key_handle")});
        std.debug.print("public key JWK:\n", .{});
        std.debug.print("{s}\n", .{try pub_key.getJwk(alloc)});
        // Sample JWK:
        // {"kty":"EC","crv":"P-256","x":"EDy-Sxl0DZ8tvzy_qnIYl6DYPFjTVnyJ2I9ZTCfKds4","y":"yBZ4HK2yF7F7ZEOn59CgTQp2ApQJ8ZOF736yZxY6LOE"}
        std.debug.print("Success.\n", .{});
    }

    pkcs11.logout() catch {};
    pkcs11.closeSession() catch {};
}