PHP

PKCS11 Find All Certificates on Smart Card or USB Token

See more PKCS11 Examples

Sample code showing how to examine all the certificates on a smart card or USB token.

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

Chilkat2 PHP

<?php

use Chilkat2\Cert;
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();

// Set your shared lib path -- either a full path to the DLL, .so, or .dylib,
// or just the filename if the driver is in a location that can be automatically found. (Such as in C:\Windows\System32)
$pkcs11->SharedLibPath = 'aetpkss1.dll';

try {
    $pkcs11->Initialize();

    // Pass -1 for the slotID to open a session on the first non-empty slot.
    $slotID = -1;

    // Open a session.
    $readWrite = true;
    $pkcs11->OpenSession($slotID, $readWrite);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Make it an authenticated session by calling Login.
//
// If we don't authenticate, then we won't be able to see the private keys, and thus
// we won't know which certificates have an associated private key stored on the smart card.

// The smart card PIN is passed to the Login method.
// userType 1 indicates a "Normal User".
$userType = 1;
$pin = '0000';
try {
    $pkcs11->Login($userType, $pin);

    // Call FindAllCerts to find all certificates on the smart card or USB token.
    $pkcs11->FindAllCerts();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    $pkcs11->CloseSession();
    exit;
}

// The NumCerts property is set by FindAllCerts.
$numCerts = $pkcs11->NumCerts;
echo 'Number of certs: ', $numCerts, "\n";

$privateKeyNote = '';
$cert = new Cert();
$i = 0;
while ($i < $numCerts) {
    $pkcs11->GetCert($i, $cert);
    $privateKeyNote = '';
    if ($cert->HasPrivateKey()) {
        $privateKeyNote = '(has private key)';
    }

    echo $i, ': ', $privateKeyNote, ' ', $cert->SubjectDN, "\n";
    echo $i, ': issuer: ', $cert->IssuerDN, "\n";
    echo "----\n";
    $i = $i + 1;
}

// Revert to an unauthenticated session by calling Logout.
try {
    $pkcs11->Logout();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    $pkcs11->CloseSession();
    exit;
}

// When finished, close the session.
// It is important to close the session (memory leaks will occur if the session is not properly closed).
try {
    $pkcs11->CloseSession();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Success.\n";