(PHP Extension) ZATCA QR Code TLV Encoding and ECDSA Cryptographic Stamp

See more ZATCA Examples

Demonstrates how to create the TLV encoding of the QR code fields, then apply the ECDSA signature and ECDSA public key, and finally insert into the previously signed XML E-Invoice.

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

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.

// In Step 1, we applied a signature to an e-invoice Zakat, Tax and Customs Authority (ZATCA) of Saudi Arabia

// This example is Step 2, where we compose the TLV encoding of the QR code, apply the ECDSA signature, and then insert into the signed XML without disturbing the signed XML.

// Construct TLV (Tag-Length-Value) encoding of the QR data.
// We have 5 pieces of data: Seller Name, VAT Number, Time Stamp, Invoice Total, and VAT Total.
// For example:
$sellerName = 'Firoz Ashraf';
$vatNumber = '1234567891';

// The timestamp in QR Code should be based on Invoice Issue Time (KSA-25) and Invoice Issue Date (BT-2). 
// It can either be in format YYYY-MM-DD'T'HH:MM:SS (for local time in KSA) or YYYY-MM-DD'T'HH:MM:SS'Z' (for UTC time or Zulu time)

// Get the current UTC date/time in this format: YYYY-MM-DD'T'HH:MM:SS'Z'
$dt = new CkDateTime();
$dt->SetFromCurrentSystemTime();
$timeStamp = $dt->getAsTimestamp(false);
$invoiceTotal = '100.00';
$vatTotal = '15.00';

// TLV encode into a Chilkat BinData object.
$bdTlv = new CkBinData();

$charset = 'utf-8';

$tag = 1;
$bdTlv->AppendByte($tag);
$bdTlv->AppendCountedString(1,false,$sellerName,$charset);
$tag = $tag + 1;
// This is tag 2
$bdTlv->AppendByte($tag);
$bdTlv->AppendCountedString(1,false,$vatNumber,$charset);
$tag = $tag + 1;
// This is tag 3
$bdTlv->AppendByte($tag);
$bdTlv->AppendCountedString(1,false,$timeStamp,$charset);
$tag = $tag + 1;
// This is tag 4
$bdTlv->AppendByte($tag);
$bdTlv->AppendCountedString(1,false,$invoiceTotal,$charset);
$tag = $tag + 1;
// This is tag 5
$bdTlv->AppendByte($tag);
$bdTlv->AppendCountedString(1,false,$vatTotal,$charset);

// ----------------------------------------------------------------------------------------------------------------------------------------------
// For tag 6, we need the SHA256 hash from the signed XML.  This is the DigestValue as shown in the fragment of the XML Signature below:

//     <ds:Reference Id="invoiceSignedData" URI="">
//         <ds:Transforms>
//             <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
//                 <ds:XPath>not(//ancestor-or-self::ext:UBLExtensions)</ds:XPath>
//             </ds:Transform>
//             <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
//                 <ds:XPath>not(//ancestor-or-self::cac:Signature)</ds:XPath>
//             </ds:Transform>
//             <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
//                 <ds:XPath>not(//ancestor-or-self::cac:AdditionalDocumentReference[cbc:ID='QR'])</ds:XPath>
//             </ds:Transform>
//             <ds:Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/>
//         </ds:Transforms>
//         <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
//         <ds:DigestValue>zCp+kF1qzNgXD6AhLq69/CYCklMFSXUmmVPbm4v/76U=</ds:DigestValue>
//     </ds:Reference>

// To get this information, we'll need to load the signed XML into a Chilkat XML object, and then access it.
// Load the XML we previously signed...
$signedXmlFilePath = 'qa_data/zatca/testing/SignedXML.xml';
$xmlSigned = new CkXml();
$success = $xmlSigned->LoadXmlFile($signedXmlFilePath);
if ($success == false) {
    print $xmlSigned->lastErrorText() . "\n";
    exit;
}

// digestValue is a base64 string.
$sbDigestValue = new CkStringBuilder();
$success = $xmlSigned->GetChildContentSb('ext:UBLExtensions|ext:UBLExtension|ext:ExtensionContent|sig:UBLDocumentSignatures|sac:SignatureInformation|ds:Signature|ds:SignedInfo|ds:Reference[0]|ds:DigestValue',$sbDigestValue);
if ($success == false) {
    print 'Failed to get DigestValue from signed XML.' . "\n";
    exit;
}

print 'DigestValue = ' . $sbDigestValue->getAsString() . "\n";

// Append the DigestValue base64 string to the TLV.
$tag = 6;
$bdTlv->AppendByte($tag);
$bdTlv->AppendByte($sbDigestValue->get_Length());
$bdTlv->AppendSb($sbDigestValue,'utf-8');

// ----------------------------------------------------------------------------------------------------------------------------------------------
// Tag 7 will contain the <ds:Signature> value from the signed XML.
// PS> To get the XML path passed to GetChildContentSb, you can copy/paste the signed XML into Chilkat's online tool at https://tools.chilkat.io/xmlParse
// The parsing code that is generated by the online tool will reveal the required path to the element in the XML.
$sbSignatureValue = new CkStringBuilder();
$success = $xmlSigned->GetChildContentSb('ext:UBLExtensions|ext:UBLExtension|ext:ExtensionContent|sig:UBLDocumentSignatures|sac:SignatureInformation|ds:Signature|ds:SignatureValue',$sbSignatureValue);
if ($success == false) {
    print 'Failed to get SignatureValue from signed XML.' . "\n";
    exit;
}

print 'SignatureValue = ' . $sbSignatureValue->getAsString() . "\n";

// Append the SignatureValue base64 string to the TLV.
$tag = 7;
$bdTlv->AppendByte($tag);
$bdTlv->AppendByte($sbSignatureValue->get_Length());
$bdTlv->AppendSb($sbSignatureValue,'utf-8');

// ----------------------------------------------------------------------------------------------------------------------------------------------
// Tag 8 will contain the public key of the signing certificate.
// The signing certificate is available within the signed XML at <ds:X509Certificate>.
$x509Certificate = $xmlSigned->getChildContent('ext:UBLExtensions|ext:UBLExtension|ext:ExtensionContent|sig:UBLDocumentSignatures|sac:SignatureInformation|ds:Signature|ds:KeyInfo|ds:X509Data|ds:X509Certificate');
if ($xmlSigned->get_LastMethodSuccess() == false) {
    print 'Failed to get X509Certificate from the signed XML.' . "\n";
    exit;
}

$cert = new CkCert();
$success = $cert->SetFromEncoded($x509Certificate);
if ($success == false) {
    print 'Failed to load signing certificate from base64.' . "\n";
    exit;
}

// We want to get the cert's public key bytes having this ASN.1 format.
// SEQUENCE (2 elem)
//   SEQUENCE (2 elem)
//     OBJECT IDENTIFIER 1.2.840.10045.2.1 ecPublicKey (ANSI X9.62 public key type)
//     OBJECT IDENTIFIER 1.3.132.0.10 secp256k1 (SECG (Certicom) named elliptic curve)
//   BIT STRING (520 bit) 0000010001110000110111000001111110100110101110110101111000110001110100

// Note: The cert.GetPubKeyDer method was added in Chilkat v9.5.0.92
$bdPubKey = new CkBinData();
$success = $cert->GetPubKeyDer(true,$bdPubKey);
if ($success == false) {
    print 'Failed to get certificate's public key.' . "\n";
    exit;
}

// We want to add the binary bytes of the public key (not the base64 string) to the QR code.
$tag = 8;
$bdTlv->AppendByte($tag);
$bdTlv->AppendByte($bdPubKey->get_NumBytes());
$bdTlv->AppendBd($bdPubKey);

// Show the public key in base64 format:
print 'Certificate public key:' . "\n";
print $bdPubKey->getEncoded('base64') . "\n";

// ----------------------------------------------------------------------------------------------------------------------------------------------
// Tag 9 will contain the signature contained in the signing certificate.

// Note: The cert.GetPubKeyDer method was added in Chilkat v9.5.0.92
$bdCertSig = new CkBinData();
$success = $cert->GetSignature($bdCertSig);
if ($success == false) {
    print 'Failed to get certificate's signature.' . "\n";
    exit;
}

// We want to add the binary bytes of the signature (not the base64 string) to the QR code.
$tag = 9;
$bdTlv->AppendByte($tag);
$bdTlv->AppendByte($bdCertSig->get_NumBytes());
$bdTlv->AppendBd($bdCertSig);

// Show the cert's signature in hex format:
print 'Certificate signature:' . "\n";
print $bdCertSig->getEncoded('hex') . "\n";

// ----------------------------------------------------------------------------------------------------------------------------------------------
// At this point the full QR code is contained in bdTlv.
// Get it as a base64 string
$qr_base64 = $bdTlv->getEncoded('base64');
print 'QR: ' . $qr_base64 . "\n";

// ----------------------------------------------------------------------------------------------------------------------------------------------
// Insert the QR XML fragment into the previously signed XML -- without disturbing (invalidating) the signature.

// We need to build and insert the following XML fragment under the 
// as a cac:AdditionalDocumentReference just before the "<cac:Signature>" opening tag.

//    <cac:AdditionalDocumentReference>
//         <cbc:ID>QR</cbc:ID>
//         <cac:Attachment>
//             <cbc:EmbeddedDocumentBinaryObject mimeCode="text/plain">BASE64_TLV_CONTENT</cbc:EmbeddedDocumentBinaryObject>
//         </cac:Attachment>
//    </cac:AdditionalDocumentReference>

$xmlQR = new CkXml();
$xmlQR->put_Tag('cac:AdditionalDocumentReference');
$xmlQR->UpdateChildContent('cbc:ID','QR');
$xmlQR->UpdateAttrAt('cac:Attachment|cbc:EmbeddedDocumentBinaryObject',true,'mimeCode','text/plain');
$xmlQR->UpdateChildContent('cac:Attachment|cbc:EmbeddedDocumentBinaryObject',$bdTlv->getEncoded('base64'));

// Load our previously signed XML into a Chilkat StringBuilder.
// We should not load the previously signed XML into a Chilkat XML object because the XML gets loaded into an internal DOM (Document Object Model).
// When re-emitted from the DOM, formatting can change and it would break the XML signature.
// Therefore, we must load into a StringBuilder and insert the new fragment without disturbing the remainder.
// The inserted fragment is ignored because the following transform was included in the XML signature reference:

//             <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
//                 <ds:XPath>not(//ancestor-or-self::cac:AdditionalDocumentReference[cbc:ID='QR'])</ds:XPath>
//             </ds:Transform>

$sbSignedXml = new CkStringBuilder();
$success = $sbSignedXml->LoadFile($signedXmlFilePath,'utf-8');
if ($success == false) {
    print 'Failed to load previously signed XML file.' . "\n";
    exit;
}

$sbReplaceStr = new CkStringBuilder();
$xmlQR->put_EmitXmlDecl(false);
$xmlQR->put_EmitCompact(true);
$sbReplaceStr->Append($xmlQR->getXml());
$sbReplaceStr->Append('<cac:Signature>');
$success = $sbSignedXml->ReplaceFirst('<cac:Signature>',$sbReplaceStr->getAsString());
if ($success == false) {
    print 'Did not find <cac:Signature> in the signed XML' . "\n";
    exit;
}

// Save the updated signed XML.
$success = $sbSignedXml->WriteFile('qa_output/signedXML_withQR.xml','utf-8',false);

// ----------------------------------------
// Verify the updated signed XML to make sure we didn't invalidate the signature...
$verifier = new CkXmlDSig();
$success = $verifier->LoadSignatureSb($sbSignedXml);
if ($success != true) {
    print $verifier->lastErrorText() . "\n";
    exit;
}

// ---------------- This is important -----------------------------------------
// Starting in Chilkat v9.5.0.92, specify "ZATCA" in uncommon options 
// to validate signed XML according to ZATCA needs.
// ----------------------------------------------------------------------------
$verifier->put_UncommonOptions('ZATCA');

$numSigs = $verifier->get_NumSignatures();
$verifyIdx = 0;
while ($verifyIdx < $numSigs) {
    $verifier->put_Selector($verifyIdx);
    $verified = $verifier->VerifySignature(true);
    if ($verified != true) {
        print $verifier->lastErrorText() . "\n";
        exit;
    }

    $verifyIdx = $verifyIdx + 1;
}

print 'All signatures were successfully verified.' . "\n";

?>