PHP Extension

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.

PHP Extension

<?php

include("chilkat.php");

$success = 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.

$pkcs11 = new CkPkcs11();

// Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
// For example:
$pkcs11->put_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.
$success = $pkcs11->QuickSession($userType,$pin);
if ($success == false) {
    print $pkcs11->lastErrorText() . "\n";
    exit;
}

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

// 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) {
    print $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:  
print 'private key handle: ' . $privKeyHandle . "\n";

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

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

?>