PHP

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.

Chilkat2 PHP

<?php

use Chilkat2\JsonObject;
use Chilkat2\Pkcs11;
use Chilkat2\SshKey;

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

$pkcs11 = new Pkcs11();

// Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
// For example:
$pkcs11->SharedLibPath = 'C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll';

// Use your HSM's PIN.
$pin = '0000';

// Normal user = 1
$userType = 1;

// Establish a logged-on user session with the HSM.
try {
    $pkcs11->QuickSession($userType, $pin);

    // Create a PKCS11 template for importing the SSH key.
    $jsonTemplate = new JsonObject();

    // Indicate the key is to be stored on the token (i.e. it is not a session-only key)
    $jsonTemplate->UpdateBool('token', true);
    // The key should have the ability to sign
    $jsonTemplate->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.
    $jsonTemplate->UpdateString('id_hex', '0A0B0C0D01020304');

    // Optionally specify a label.
    $jsonTemplate->UpdateString('label', 'MySshKey');

    // Load the SSH key to be imported to the HSM (smartcard or token)
    $sshKey = new SshKey();
    $sshKey->Password = 'password_of_the_encrypted_ppk_file';
    $ppkContents = $sshKey->LoadText('c:/my_ssh_keys/someSshKey.ppk');
    $sshKey->FromPuttyPrivateKey($ppkContents);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Import the SSH private key onto the HSM.
// The PKCS11 handle to the imported private key is returned.
// A 0 is returned on failure.
$privKeyHandle = $pkcs11->ImportSshKey($sshKey, $jsonTemplate);
if ($privKeyHandle == 0) {
    echo $pkcs11->LastErrorText, "\n";
    exit;
}

// 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
echo 'private key handle: ', $privKeyHandle, "\n";

echo "Successfully imported the SSH key onto the HSM.\n";

$pkcs11->Logout();
$pkcs11->CloseSession();