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

LOCAL nSuccess
LOCAL oPkcs11
LOCAL cPin
LOCAL nUserType
LOCAL oCert
LOCAL oPrivKey
LOCAL oJsonTemplate
LOCAL nKeyHandle

nSuccess := 0

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

oPkcs11 := CreateObject("Chilkat.Pkcs11")

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

//  Establish a logged-on session.
cPin := "0000"
nUserType := 1
nSuccess := oPkcs11:QuickSession(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    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.
oCert := CreateObject("Chilkat.Cert")
nSuccess := oCert:LoadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12", "p12_password")
IF (nSuccess == 0)
    ? oCert:LastErrorText
    oPkcs11:destroy()
    oCert:destroy()
    RETURN
ENDIF

//  Let's get the certificate's private key.
oPrivKey := CreateObject("Chilkat.PrivateKey")
nSuccess := oCert:GetPrivateKey(oPrivKey)
IF (nSuccess == 0)
    ? oCert:LastErrorText
    oPkcs11:destroy()
    oCert:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

//  Build a PKCS11 template to provide additional information about the key to be imported.
oJsonTemplate := CreateObject("Chilkat.JsonObject")

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

//  Indicate that the key can be used for signing.
oJsonTemplate:UpdateBool("sign", 1)

//  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.
oJsonTemplate:UpdateString("id_hex", "010203040A0B0C0D0E0F")
oJsonTemplate: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.
nKeyHandle := oPkcs11:ImportPrivateKey(oPrivKey, oJsonTemplate)
IF (nKeyHandle == 0)
    ? oPkcs11:LastErrorText
ELSE
    ? "key handle = " + Str(nKeyHandle)
    ? "Successfully imported a private key onto the HSM."
ENDIF

oPkcs11:Logout()
oPkcs11:CloseSession()

oPkcs11:destroy()
oCert:destroy()
oPrivKey:destroy()
oJsonTemplate:destroy()