PHP

PKCS11 Certificate Chain

See more PKCS11 Examples

Demonstrates how to make CA certs available for the certificate chain to be included when creating a signature (using a PKCS11 compatible smart card / USB token) such as for PDF, XMLDSig, etc.

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

Chilkat2 PHP

<?php

use Chilkat2\Cert;
use Chilkat2\Pkcs11;
use Chilkat2\XmlCertVault;

// 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();

// You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
// On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
// Otherwise provide the full path.
$pkcs11->SharedLibPath = 'bit4xpki.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.
$userType = 1;
// Make sure to use the correct PIN for your smart card..
$pin = '0000';
try {
    $pkcs11->Login($userType, $pin);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    $pkcs11->CloseSession();
    exit;
}

// Get the certificate (on the smart card) that has a private key.
$cert = new Cert();
try {
    $pkcs11->FindCert('privateKey', '', $cert);
    echo 'Cert with private key: ', $cert->SubjectCN, "\n";
} catch (\Chilkat2\Exception $e) {
    echo "No certificates having a private key were found.\n";
    $pkcs11->CloseSession();
    exit;
}

// If the certificates in the chain of authentication were contained on the smart card,
// then Chilkat would already have them (via the FindCert function) and the certs in the chain will be automatically used
// as needed when signing occurs.

// If you have CA certs located elsewhere, such as in .cer files, you can make them available to Chilkat in the following way:

$certVault = new XmlCertVault();
// Please review the methods available in the XML certificate vault class.  Different methods exist for adding certificates
// from various sources, such as PEM, PFX, or in-memory sources..
$certVault->AddCertFile('someDir/caIntermediateCert.cer');
// ...
$certVault->AddCertFile('someDir/caCert.cer');
// (Your code should check the return value to make sure it succeeded.)

try {
    $cert->UseCertVault($certVault);

    // --------------------------------------------------------------------------
    // At this point, we have the cert (and certs in the chain of authentication) to be used for signing.
    // The code for using the certificate in creating the digital signature, such as for a PDF, XML, etc., go here...

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

    // Revert to an unauthenticated session by calling Logout.
    $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";