PHP

Add EncapsulatedTimestamp to Already-Signed XML

See more XML Digital Signatures Examples

Demonstrates how to add an EncapsulatedTimestamp to an existing XML signature.

Note: This example requires Chilkat v9.5.0.90 or greater.

Chilkat2 PHP

<?php

use Chilkat2\JsonObject;
use Chilkat2\StringBuilder;
use Chilkat2\XmlDSig;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Note: We cannot load the already-signed XML into a Chilkat XML object because it would re-format the XML when re-emitted.
// (i.e. indentation and whitespace could change, and it would invalidate the existing signature.)
// We must use a StringBuilder.
$sbXml = new StringBuilder();
try {
    $sbXml->LoadFile('qa_data/xml_dsig_valid_samples/encapsulatedTimestamp_not_yet_added.xml', 'utf-8');
} catch (\Chilkat2\Exception $e) {
    echo "Failed to load the XML file.\n";
    exit;
}

$dsig = new XmlDSig();
try {
    $dsig->LoadSignatureSb($sbXml);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

if ($dsig->HasEncapsulatedTimeStamp()) {
    echo "This signed XML already has an EncapsulatedTimeStamp\n";
    exit;
}

// Specify the timestamping authority URL
$json = new JsonObject();
$json->UpdateString('timestampToken.tsaUrl', 'http://timestamp.digicert.com');
$json->UpdateBool('timestampToken.requestTsaCert', true);

// Call AddEncapsulatedTimeStamp to add the EncapsulatedTimeStamp to the signature.
// Note: If the signed XML contains multiple signatures, the signature modified is the one
// indicated by the dsig.Selector property.
$sbOut = new StringBuilder();
try {
    $dsig->AddEncapsulatedTimeStamp($json, $sbOut);

    $sbOut->WriteFile('qa_output/addedEncapsulatedTimeStamp.xml', 'utf-8', false);

    // The EncapsulatedTimeStamp can be validated when validating the signature by adding the VerifyEncapsulatedTimeStamp
    // keyword to UncommonOptions.  See here:

    // ----------------------------------------
    // Verify the signatures we just produced...
    $verifier = new XmlDSig();
    $verifier->LoadSignatureSb($sbOut);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Add "VerifyEncapsulatedTimeStamp" to the UncommonOptions to also verify any EncapsulatedTimeStamps
$verifier->UncommonOptions = 'VerifyEncapsulatedTimeStamp';

$numSigs = $verifier->NumSignatures;
$verifyIdx = 0;
while ($verifyIdx < $numSigs) {
    $verifier->Selector = $verifyIdx;
    try {
        $verifier->VerifySignature(true);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    $verifyIdx = $verifyIdx + 1;
}

echo "All signatures were successfully verified.\n";