(Lianja) 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.

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loPkcs11 = createobject("CkPkcs11")

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

// Establish a logged-on session.
lcPin = "0000"
lnUserType = 1
llSuccess = loPkcs11.QuickSession(lnUserType,lcPin)
if (llSuccess = .F.) then
    ? loPkcs11.LastErrorText
    release loPkcs11
    return
endif

// 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.
loCert = createobject("CkCert")
llSuccess = loCert.LoadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password")
if (llSuccess = .F.) then
    ? loCert.LastErrorText
    release loPkcs11
    release loCert
    return
endif

// Let's get the certificate's private key.
loPrivKey = loCert.ExportPrivateKey()
if (loCert.LastMethodSuccess = .F.) then
    ? loCert.LastErrorText
    release loPkcs11
    release loCert
    return
endif

// Build a PKCS11 template to provide additional information about the key to be imported.
loJsonTemplate = createobject("CkJsonObject")

// Indicate that the key is to be stored on the token.  It is NOT a session object.
loJsonTemplate.UpdateBool("token",.T.)

// Indicate that the key can be used for signing.
loJsonTemplate.UpdateBool("sign",.T.)

// 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.
loJsonTemplate.UpdateString("id_hex","010203040A0B0C0D0E0F")
loJsonTemplate.UpdateString("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.
lnKeyHandle = loPkcs11.ImportPrivateKey(loPrivKey,loJsonTemplate)
if (lnKeyHandle = 0) then
    ? loPkcs11.LastErrorText
else
    ? "key handle = " + str(lnKeyHandle)
    ? "Successfully imported a private key onto the HSM."
endif

release loPrivKey

loPkcs11.Logout()
loPkcs11.CloseSession()


release loPkcs11
release loCert
release loJsonTemplate