Lua Requires Chilkat v11.0.0+

PKCS11 Import a Private Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing RSA private key onto the smartcard/token. The imported key is a token object, meaning it stays on the HSM and exists beyond the end of the PKCS11 session. Lua

local chilkat = require("chilkat")

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

local pkcs11 = chilkat.Pkcs11.new()

-- 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.shared_lib_path = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll"

-- Establish a logged-on session.
local pin = "0000"
local userType = 1
local success = pkcs11:quick_session(userType, pin)
if not success then
    print(pkcs11.last_error_text)
    return
end

-- Let's import a certificate's private key onto the HSM.
-- First, we'll load the certificate from a .pfx (also known as .p12), which is a file format
-- that also includes the certificate's private key.
local cert = chilkat.Cert.new()
success = cert:load_pfx_file("qa_data/pfx/ehealth.fgov.be_testing.p12", "p12_password")
if not success then
    print(cert.last_error_text)
    return
end

-- Let's get the certificate's private key.
local privKey = chilkat.PrivateKey.new()
success = cert:get_private_key(privKey)
if not success then
    print(cert.last_error_text)
    return
end

-- Build a PKCS11 template to provide additional information about the key to be imported.
local jsonTemplate = chilkat.JsonObject.new()

-- Indicate that the key is to be stored on the token.  It is NOT a session object.
jsonTemplate:update_bool("token", true)

-- Indicate that the key can be used for signing.
jsonTemplate:update_bool("sign", true)

-- Provide an arbitrary ID and label (anything you want).
-- The information in the ID and/or label provides one means for finding the key in future PKCS11 sessions.
jsonTemplate:update_string("id_hex", "010203040A0B0C0D0E0F")
jsonTemplate:update_string("label", "ehealth private key")

-- Import the key.  The private key handle is returned on success.  Otherwise 0 is returned.
-- If our only task for now is to simply import the key, we can ignore the returned handle,
-- other than to check for success/failure.  Otherwise, the handle can be used in other PKCS11 operations.
-- This example just creates the key and does not use the returned handle.
local keyHandle = pkcs11:import_private_key(privKey, jsonTemplate)
if keyHandle == 0 then
    print(pkcs11.last_error_text)
else
    print("key handle = " .. keyHandle)
    print("Successfully imported a private key onto the HSM.")
end

pkcs11:logout()
pkcs11:close_session()