PHP

PKCS11 Find Certificate with Key Usage on Smart Card or USB Token

See more PKCS11 Examples

Demonstrates how to find and return the 1st certificate on a smart card or USB token with a desired intended key usage.

Note: This example requires Chilkat v9.5.0.91 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();

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

// --------------------------------------------------------------------------

$cert = new Cert();

// Find a certificate with an intended key usage.
// Possible key usages to find are:
//
// DigitalSignature
// NonRepudiation
// KeyEncipherment
// DataEncipherment
// CertificateSigning
// CrlSigning
//
// To find a cert having any one of several usages, pass a comma-separated list of usages:
try {
    $pkcs11->FindCert('keyUsage', 'NonRepudiation,DigitalSignature', $cert);
    echo 'Cert with private key: ', $cert->SubjectCN, "\n";
} catch (\Chilkat2\Exception $e) {
    echo "No certificates having the intended key usage were found.\n";
}

// --------------------------------------------------------------------------

// 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";