PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Pkcs11
string ls_Pin
integer li_UserType
oleobject loo_Cert
oleobject loo_PrivKey
oleobject loo_JsonTemplate
integer li_KeyHandle

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

loo_Pkcs11 = create oleobject
li_rc = loo_Pkcs11.ConnectToNewObject("Chilkat.Pkcs11")
if li_rc < 0 then
    destroy loo_Pkcs11
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

// Establish a logged-on session.
ls_Pin = "0000"
li_UserType = 1
li_Success = loo_Pkcs11.QuickSession(li_UserType,ls_Pin)
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    return
end if

// 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.
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

li_Success = loo_Cert.LoadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password")
if li_Success = 0 then
    Write-Debug loo_Cert.LastErrorText
    destroy loo_Pkcs11
    destroy loo_Cert
    return
end if

// Let's get the certificate's private key.
loo_PrivKey = create oleobject
li_rc = loo_PrivKey.ConnectToNewObject("Chilkat.PrivateKey")

li_Success = loo_Cert.GetPrivateKey(loo_PrivKey)
if li_Success = 0 then
    Write-Debug loo_Cert.LastErrorText
    destroy loo_Pkcs11
    destroy loo_Cert
    destroy loo_PrivKey
    return
end if

// Build a PKCS11 template to provide additional information about the key to be imported.
loo_JsonTemplate = create oleobject
li_rc = loo_JsonTemplate.ConnectToNewObject("Chilkat.JsonObject")

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

// Indicate that the key can be used for signing.
loo_JsonTemplate.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.
loo_JsonTemplate.UpdateString("id_hex","010203040A0B0C0D0E0F")
loo_JsonTemplate.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.
li_KeyHandle = loo_Pkcs11.ImportPrivateKey(loo_PrivKey,loo_JsonTemplate)
if li_KeyHandle = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
else
    Write-Debug "key handle = " + string(li_KeyHandle)
    Write-Debug "Successfully imported a private key onto the HSM."
end if

loo_Pkcs11.Logout()
loo_Pkcs11.CloseSession()


destroy loo_Pkcs11
destroy loo_Cert
destroy loo_PrivKey
destroy loo_JsonTemplate