(PHP Extension) Create XML Signature with External XML Reference

Demonstrates how to create an XML digital signature where the referenced data is external. In this case, the data is an XML file located at the following URL: https://www.chilkatsoft.com/data/helloWorld.xml

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

// This example inserts an XML signature in the following XML:

// <?xml version="1.0" encoding="UTF-8" standalone="no"?>
// <abc>
//   <xyz>
// 	<name>helloWorld.xml</name>
// 	<url>https://www.chilkatsoft.com/data/helloWorld.xml</url>
//   </xyz>
// </abc>

// Build the above XML to be signed.
$xml = new CkXml();
$xml->put_Tag('abc');
$xml->UpdateChildContent('xyz|name','helloWorld.xml');
$xml->UpdateChildContent('xyz|url','https://www.chilkatsoft.com/data/helloWorld.xml');

$cert = new CkCert();

$success = $cert->LoadPfxFile('qa_data/pfx/test_secret.pfx','secret');
if ($success == false) {
    print $cert->lastErrorText() . "\n";
    exit;
}

$gen = new CkXmlDSigGen();

// Indicate the location within the XML the Signature will be inserted.
$gen->put_SigLocation('abc|xyz');

// Get the content of the XML data to be referenced.
$http = new CkHttp();
$sbExternalXml = new CkStringBuilder();
$success = $http->QuickGetSb('https://www.chilkatsoft.com/data/helloWorld.xml',$sbExternalXml);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$success = $gen->AddExternalXmlRef('https://www.chilkatsoft.com/data/helloWorld.xml',$sbExternalXml,'sha256','EXCL_C14N','');
if ($success == false) {
    print $gen->lastErrorText() . "\n";
    exit;
}

// Provide the private key for signing via the certificate, and indicate that
// we want the base64 of the certificate embedded in the KeyInfo.
$gen->put_KeyInfoType('X509Data');
$gen->put_X509Type('Certificate');

$bUsePrivateKey = true;
$success = $gen->SetX509Cert($cert,$bUsePrivateKey);
if ($success != true) {
    print $gen->lastErrorText() . "\n";
    exit;
}

// Indicate we want an indented signature for readability.
// This can be removed after debugging is finished..
$gen->put_Behaviors('IndentedSignature');

// Now create and insert the Signature
$sbXml = new CkStringBuilder();
$xml->GetXmlSb($sbXml);
$success = $gen->CreateXmlDSigSb($sbXml);
if ($success != true) {
    print $gen->lastErrorText() . "\n";
    exit;
}

// Examine the XML with the digital signature inserted
print $sbXml->getAsString() . "\n";

// Here is the output:

// <?xml version="1.0" encoding="utf-8"?>
// <abc>
//     <xyz>
//         <name>helloWorld.xml</name>
//         <url>https://www.chilkatsoft.com/data/helloWorld.xml</url>
//     <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
//   <ds:SignedInfo>
//     <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
//     <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
//     <ds:Reference URI="https://www.chilkatsoft.com/data/helloWorld.xml">
//       <ds:Transforms>
//         <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
//       </ds:Transforms>
//       <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
//       <ds:DigestValue>H/s775OZhel6wdBhe02l4LK6m0lkplOisKxAbVwWxp0=</ds:DigestValue>
//     </ds:Reference>
//   </ds:SignedInfo>
//   <ds:SignatureValue>UruwnBqh..Ll4IzUA==</ds:SignatureValue>
//   <ds:KeyInfo>
//     <ds:X509Data>
//       <ds:X509Certificate>MIIHAz...nUZWCaDE=</ds:X509Certificate>
//     </ds:X509Data>
//   </ds:KeyInfo>
// </ds:Signature></xyz>
// </abc>

// Let's verify the signature...
$verifier = new CkXmlDSig();
$success = $verifier->LoadSignatureSb($sbXml);
if ($success != true) {
    print $verifier->lastErrorText() . "\n";
    exit;
}

// Let's examine the external references, and fetch the data for each..
$sbExternalData = new CkStringBuilder();
$numRefs = $verifier->get_NumReferences();
$i = 0;
while ($i < $numRefs) {
    $bExternal = $verifier->IsReferenceExternal($i);
    if ($bExternal == true) {
        $uri = $verifier->referenceUri($i);

        // We're assuming the URI is an https:// or http:// URL...
        // Let's also assume we know that the referenced data is text and we want the utf-8 byte representation.
        $sbExternalData->Clear();
        $success = $http->QuickGetSb($uri,$sbExternalData);
        if ($success == false) {
            print $http->lastErrorText() . "\n";
            exit;
        }

        // Because the referenced external data was explicitly XML, it was the canonicalized XML that was digested.
        // We need to canonicalize the XML in the same way as when signed.
        $canonXml = $verifier->canonicalizeXml($sbExternalData->getAsString(),'EXCL_C14N',false);
        $sbExternalData->SetString($canonXml);

        $success = $verifier->SetRefDataSb($i,$sbExternalData,'utf-8');
        if ($success == false) {
            print $verifier->lastErrorText() . "\n";
            exit;
        }

    }

    $i = $i + 1;
}

// Now that we have the external data available, we can verify the reference digest(s) and the signature.
$bVerified = $verifier->VerifySignature(true);
if ($bVerified != true) {
    print $verifier->lastErrorText() . "\n";
    exit;
}

print 'Signature verified!' . "\n";

?>