Zig

Import an SSH Key to an HSM using PKCS11

See more PKCS11 Examples

Demonstrates how to import an SSH private key to an HSM (smartcard or token).

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

    // 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.
    // For example:
    pkcs11.setSharedLibPath("C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll");

    // Use your HSM's PIN.
    const pin = "0000";

    // Normal user = 1
    const user_type = 1;

    // Establish a logged-on user session with the HSM.
    pkcs11.quickSession(user_type, pin) catch {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    };

    // Create a PKCS11 template for importing the SSH key.
    const json_template = try chilkat.JsonObject.init();
    defer json_template.deinit();

    // Indicate the key is to be stored on the token (i.e. it is not a session-only key)
    json_template.updateBool("token", true) catch {};
    // The key should have the ability to sign
    json_template.updateBool("sign", true) catch {};

    // Let's provide a few attributes to help us find the this key at a later time.
    // See SSH Public-Key Authentication using an HSM

    // The ID is byte data, so it should be base64 or hex.
    // Specify "id" if passing base64 data, "id_hex" for hexidecimal, or "id_ascii" for directly copying the ascii bytes of the string.
    // You can provide any ID of your choice.  It is optional.
    json_template.updateString("id_hex", "0A0B0C0D01020304") catch {};

    // Optionally specify a label.
    json_template.updateString("label", "MySshKey") catch {};

    // Load the SSH key to be imported to the HSM (smartcard or token)
    const ssh_key = try chilkat.SshKey.init();
    defer ssh_key.deinit();
    ssh_key.setPassword("password_of_the_encrypted_ppk_file");
    const ppk_contents = try ssh_key.loadText(alloc, "c:/my_ssh_keys/someSshKey.ppk");
    ssh_key.fromPuttyPrivateKey(ppk_contents) catch {
        std.debug.print("{s}\n", .{try ssh_key.getLastErrorText(alloc)});
        return;
    };

    // Import the SSH private key onto the HSM.
    // The PKCS11 handle to the imported private key is returned.
    // A 0 is returned on failure.
    const priv_key_handle = pkcs11.importSshKey(ssh_key, json_template);
    if (priv_key_handle == 0) {
        std.debug.print("{s}\n", .{try pkcs11.getLastErrorText(alloc)});
        return;
    }

    // The private key handle is only valid during the PKCS11 session.
    // If you wish to use the private key in another PKCS11 session,
    // you'll first need to find it.  See  SSH Public-Key Authentication using a Smartcard
    std.debug.print("private key handle: {d}\n", .{priv_key_handle});

    std.debug.print("Successfully imported the SSH key onto the HSM.\n", .{});

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