(PHP Extension) PKCS11 Find all Private Keys

See more PKCS11 Examples

Demonstrates how to list all private keys on an HSM.

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

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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.
// (The format of the path will change with the operating system.  Obviously, "C:/" is not used on non-Windows systems.
$pkcs11->put_SharedLibPath('C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll');

// Establish a logged-on session.
// Use your actual PIN here.
$pin = '0000';
$userType = 1;
$success = $pkcs11->QuickSession($userType,$pin);
if ($success == false) {
    print $pkcs11->lastErrorText() . "\n";
    exit;
}

// Note: A logged-on session is required to list private keys.

$json = new CkJsonObject();
$json->put_EmitCompact(false);

$success = $pkcs11->FindAllKeys('private',$json);
if ($success == false) {
    print $pkcs11->lastErrorText() . "\n";
    exit;
}

print $json->emit() . "\n";

// Sample output, with parsing code below..

// {
//   "keys": [
//     {
//       "handle": 74842125,
//       "id": "0001020304",
//       "key_type": "RSA",
//       "label": "Chilkat Software, Inc.",
//       "modulus": "twVRf6O ... Rwa1ebFY0=",
//       "exponent": "AAEAAQ=="
//     },
//     {
//       "handle": 18415630,
//       "id": "010203040A0B0C0D0E0F",
//       "key_type": "RSA",
//       "label": "ehealth private key",
//       "modulus": "qdKjhOwA1 ... A4MtX8BYgHmLw==",
//       "exponent": "AAEAAQ=="
//     },
//     {
//       "handle": 3735567,
//       "id": "D531B4B8F308489DA58350596178845973A4562E",
//       "key_type": "RSA",
//       "label": "d531b4b8-f308-489d-a583-505961788459",
//       "modulus": "r0MmXRKBP ... HAd1kUPsNyzcQ==",
//       "exponent": "AAEAAQ=="
//     },
//     {
//       "handle": 238092304,
//       "id": "0A0B0C0D01020304",
//       "key_type": "RSA",
//       "label": "MySshKey",
//       "modulus": "ykFHcfBFOq ... rfXBK/6g9t+S6UjJ1kUQ==",
//       "exponent": "AAEAAQ=="
//     },
//     {
//       "handle": 49348625,
//       "id": "48656C6C6F",
//       "key_type": "RSA",
//       "label": "2048-bit RSA key for testing",
//       "modulus": "vReVaJzXZYIOB ... kamD/8iNvhAKlKbQ==",
//       "exponent": "AAEAAQ=="
//     }
//   ]
// }

// Use this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

$i = 0;
$count_i = $json->SizeOfArray('keys');
while ($i < $count_i) {
    $json->put_I($i);
    $handle = $json->IntOf('keys[i].handle');
    $id = $json->stringOf('keys[i].id');
    $key_type = $json->stringOf('keys[i].key_type');
    $label = $json->stringOf('keys[i].label');
    $modulus = $json->stringOf('keys[i].modulus');
    $exponent = $json->stringOf('keys[i].exponent');
    $i = $i + 1;
}

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

?>