(PHP ActiveX) PKCS11 Sign PDF using Certificate and Private Key on Smart Card / USB Token

See more PKCS11 Examples

Sample code showing how to use PKCS11 to sign a PDF with a certificate and private key stored on a smart card or USB token.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?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 COM("Chilkat_9_5_0.Pkcs11");

// This example is tested on Windows using a Giesecke and Devrient Sm@rtCafe Expert 3.2 smart card.
$pkcs11->SharedLibPath = 'aetpkss1.dll';

$success = $pkcs11->Initialize();
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    exit;
}

// We need to call Discover to get the slot ID.
$onlyTokensPresent = 1;
$jsonPkcs11 = new COM("Chilkat_9_5_0.JsonObject");
$success = $pkcs11->Discover($onlyTokensPresent,$jsonPkcs11);
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    exit;
}

// Make sure we have at least one slot.
if ($jsonPkcs11->SizeOfArray('slot') <= 0) {
    print 'No occuplied slots.' . "\n";
    exit;
}

// Get the ID of the 1st slot
$slotID = $jsonPkcs11->IntOf('slot[0].id');

// Open a session.
$readWrite = 1;
$success = $pkcs11->OpenSession($slotID,$readWrite);
if ($success == 0) {
    print $pkcs11->LastErrorText . "\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';
$success = $pkcs11->Login($userType,$pin);
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    $success = $pkcs11->CloseSession();
    exit;
}

// Get the certificate (on the smart card) that has a private key.
$cert = new COM("Chilkat_9_5_0.Cert");
$success = $pkcs11->FindCert('privateKey','',$cert);
if ($success == 1) {
    print 'Cert with private key: ' . $cert->SubjectCN . "\n";
}
else {
    print 'No certificates having a private key were found.' . "\n";
    $success = $pkcs11->CloseSession();
    exit;
}

// --------------------------------------------------------------------------
// At this point, we have the cert to be used for signing.
// Our PDF signing code is the same as for a cert obtained from any other source..

$pdf = new COM("Chilkat_9_5_0.Pdf");

// Load a PDF to be signed.
$success = $pdf->LoadFile('qa_data/pdf/hello.pdf');
if ($success == 0) {
    print $pdf->LastErrorText . "\n";
    $success = $pkcs11->CloseSession();
    exit;
}

$json = new COM("Chilkat_9_5_0.JsonObject");

$json->UpdateInt('page',1);
$json->UpdateString('appearance.y','top');
$json->UpdateString('appearance.x','left');
$json->UpdateString('appearance.fontScale','10.0');
$json->UpdateString('signingAlgorithm','pss');
$json->UpdateString('hashAlgorithm','sha256');

$i = 0;
$json->I = $i;
$json->UpdateString('appearance.text[i]','Digitaly signed by: Xyz Widgets, Inc.');
$i = $i + 1;
$json->I = $i;
$json->UpdateString('appearance.text[i]','current_dt');
$i = $i + 1;
$json->I = $i;
$json->UpdateString('appearance.text[i]','blah blah blah');

// The certificate is internally linked to the Pkcs11 object, which is currently in an authenticated session.
$success = $pdf->SetSigningCert($cert);

$success = $pdf->SignPdf($json,'qa_output/out.pdf');
if ($success == 0) {
    print $pdf->LastErrorText . "\n";
    $success = $pkcs11->CloseSession();
    exit;
}

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

// Revert to an unauthenticated session by calling Logout.
$success = $pkcs11->Logout();
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    $success = $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).
$success = $pkcs11->CloseSession();
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    exit;
}

print 'Success.' . "\n";

?>