AutoIt

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

Local $bSuccess = False

; 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 = ObjCreate("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.
Local $sPin = "0000"
Local $iUserType = 1
$bSuccess = $oPkcs11.QuickSession($iUserType,$sPin)
If ($bSuccess = False) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
    Exit
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 = ObjCreate("Chilkat.Cert")
$bSuccess = $oCert.LoadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password")
If ($bSuccess = False) Then
    ConsoleWrite($oCert.LastErrorText & @CRLF)
    Exit
EndIf

; Let's get the certificate's private key.
$oPrivKey = ObjCreate("Chilkat.PrivateKey")
$bSuccess = $oCert.GetPrivateKey($oPrivKey)
If ($bSuccess = False) Then
    ConsoleWrite($oCert.LastErrorText & @CRLF)
    Exit
EndIf

; Build a PKCS11 template to provide additional information about the key to be imported.
$oJsonTemplate = ObjCreate("Chilkat.JsonObject")

; Indicate that the key is to be stored on the token.  It is NOT a session object.
$oJsonTemplate.UpdateBool("token",True)

; Indicate that the key can be used for signing.
$oJsonTemplate.UpdateBool("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.
$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.
Local $iKeyHandle = $oPkcs11.ImportPrivateKey($oPrivKey,$oJsonTemplate)
If ($iKeyHandle = 0) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
Else
    ConsoleWrite("key handle = " & $iKeyHandle & @CRLF)
    ConsoleWrite("Successfully imported a private key onto the HSM." & @CRLF)
EndIf

$oPkcs11.Logout()
$oPkcs11.CloseSession()