PHP

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.96 or later.

Chilkat2 PHP

<?php

use Chilkat2\Cert;
use Chilkat2\JsonObject;
use Chilkat2\Pdf;
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 = 'C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll';
$pin = '0000';
$userType = 1;

// Establish a PKCS11 logged-on session using the driver (.so, .dylib, or .dll) as specified in the SharedLibPath above.
try {
    $pkcs11->QuickSession($userType, $pin);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Get the certificate (on the smart card) that has a private key.
// There are other ways to locate a certificate on the HSM.
// This example assumes there is a single certificate w/ 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;
}

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

// Load a PDF to be signed.
try {
    $pdf->LoadFile('qa_data/pdf/hello.pdf');

    $json = new 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.
    $pdf->SetSigningCert($cert);

    $pdf->SignPdf($json, 'qa_output/out.pdf');

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

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