Visual FoxPro

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

LOCAL lnSuccess
LOCAL loPkcs11
LOCAL lcPin
LOCAL lnUserType
LOCAL loCert
LOCAL loPrivKey
LOCAL loJsonTemplate
LOCAL lnKeyHandle

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

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

* Establish a logged-on session.
lcPin = "0000"
lnUserType = 1
lnSuccess = loPkcs11.QuickSession(lnUserType,lcPin)
IF (lnSuccess = 0) THEN
    ? loPkcs11.LastErrorText
    RELEASE loPkcs11
    CANCEL
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('Chilkat.Cert')
lnSuccess = loCert.LoadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password")
IF (lnSuccess = 0) THEN
    ? loCert.LastErrorText
    RELEASE loPkcs11
    RELEASE loCert
    CANCEL
ENDIF

* Let's get the certificate's private key.
loPrivKey = CreateObject('Chilkat.PrivateKey')
lnSuccess = loCert.GetPrivateKey(loPrivKey)
IF (lnSuccess = 0) THEN
    ? loCert.LastErrorText
    RELEASE loPkcs11
    RELEASE loCert
    RELEASE loPrivKey
    CANCEL
ENDIF

* Build a PKCS11 template to provide additional information about the key to be imported.
loJsonTemplate = CreateObject('Chilkat.JsonObject')

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

* Indicate that the key can be used for signing.
loJsonTemplate.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.
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

loPkcs11.Logout()
loPkcs11.CloseSession()

RELEASE loPkcs11
RELEASE loCert
RELEASE loPrivKey
RELEASE loJsonTemplate