PHP

PKCS11 Find Private Key by Label

See more PKCS11 Examples

Demonstrates how to find a private key based on a user-specified label.

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

Chilkat2 PHP

<?php

use Chilkat2\JsonObject;
use Chilkat2\Pkcs11;

// 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);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Provide a template to find a PKCS11 object.
$jsonTemplate = new JsonObject();

// Find an RSA private key with the label "MySshKey".
// Here's an example of how the key was originally imported:
// PKCS11 Import SSH Key
$jsonTemplate->UpdateString('class', 'private_key');
$jsonTemplate->UpdateString('key_type', 'rsa');
$jsonTemplate->UpdateString('label', 'MySshKey');

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

// Do whatever you wish with the private key handle...
// ...
// ...

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