AutoIt

Import an SSH Key to an HSM using PKCS11

See more PKCS11 Examples

Demonstrates how to import an SSH private key to an HSM (smartcard or token).

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

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

; Use your HSM's PIN.
Local $sPin = "0000"

; Normal user = 1
Local $iUserType = 1

; Establish a logged-on user session with the HSM.
$bSuccess = $oPkcs11.QuickSession($iUserType,$sPin)
If ($bSuccess = False) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
    Exit
EndIf

; Create a PKCS11 template for importing the SSH key.
$oJsonTemplate = ObjCreate("Chilkat.JsonObject")

; Indicate the key is to be stored on the token (i.e. it is not a session-only key)
$oJsonTemplate.UpdateBool("token",True)
; The key should have the ability to sign
$oJsonTemplate.UpdateBool("sign",True)

; Let's provide a few attributes to help us find the this key at a later time.
; See SSH Public-Key Authentication using an HSM

; The ID is byte data, so it should be base64 or hex.
; Specify "id" if passing base64 data, "id_hex" for hexidecimal, or "id_ascii" for directly copying the ascii bytes of the string.
; You can provide any ID of your choice.  It is optional.
$oJsonTemplate.UpdateString("id_hex","0A0B0C0D01020304")

; Optionally specify a label.
$oJsonTemplate.UpdateString("label","MySshKey")

; Load the SSH key to be imported to the HSM (smartcard or token)
$oSshKey = ObjCreate("Chilkat.SshKey")
$oSshKey.Password = "password_of_the_encrypted_ppk_file"
Local $sPpkContents = $oSshKey.LoadText("c:/my_ssh_keys/someSshKey.ppk")
$bSuccess = $oSshKey.FromPuttyPrivateKey($sPpkContents)
If ($bSuccess = False) Then
    ConsoleWrite($oSshKey.LastErrorText & @CRLF)
    Exit
EndIf

; Import the SSH private key onto the HSM.
; The PKCS11 handle to the imported private key is returned.
; A 0 is returned on failure.
Local $iPrivKeyHandle = $oPkcs11.ImportSshKey($oSshKey,$oJsonTemplate)
If ($iPrivKeyHandle = 0) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
    Exit
EndIf

; The private key handle is only valid during the PKCS11 session.
; If you wish to use the private key in another PKCS11 session,
; you'll first need to find it.  See  SSH Public-Key Authentication using a Smartcard
ConsoleWrite("private key handle: " & $iPrivKeyHandle & @CRLF)

ConsoleWrite("Successfully imported the SSH key onto the HSM." & @CRLF)

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