Lua Requires Chilkat v9.5.0.92+
Lua
Sign XML for Zakat, Tax and Customs Authority (ZATCA)
See more ZATCA Examples
Demonstrates how to sign XML for Zakat, Tax and Customs Authority (ZATCA).Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local success = true
-- Load XML to be signed...
local sbXml = chilkat.StringBuilder.new()
success = sbXml:load_file("qa_data/xml_dsig_valid_samples/UBL_Saudi_ZATCA_Zakat_Tax_and_Customs_Authority_toBeSigned.xml", "utf-8")
if not success then
print("Failed to load XML file to be signed.")
return
end
-- Loads XML containing the following (with data modified from the original sample).
-- <?xml version="1.0" encoding="UTF-8"?>
-- <Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2"><ext:UBLExtensions>
-- <ext:UBLExtension>
-- <ext:ExtensionURI>urn:oasis:names:specification:ubl:dsig:enveloped:xades</ext:ExtensionURI>
-- <ext:ExtensionContent>
-- <sig:UBLDocumentSignatures xmlns:sig="urn:oasis:names:specification:ubl:schema:xsd:CommonSignatureComponents-2" xmlns:sac="urn:oasis:names:specification:ubl:schema:xsd:SignatureAggregateComponents-2" xmlns:sbc="urn:oasis:names:specification:ubl:schema:xsd:SignatureBasicComponents-2">
-- <sac:SignatureInformation>
-- <cbc:ID>urn:oasis:names:specification:ubl:signature:1</cbc:ID>
-- <sbc:ReferencedSignatureID>urn:oasis:names:specification:ubl:signature:Invoice</sbc:ReferencedSignatureID>
--
-- </sac:SignatureInformation>
-- </sig:UBLDocumentSignatures>
-- </ext:ExtensionContent>
-- </ext:UBLExtension>
-- </ext:UBLExtensions>
--
-- <cbc:ProfileID>reporting:1.0</cbc:ProfileID>
-- <cbc:ID>100</cbc:ID>
-- <cbc:UUID>3cf5ee18-ee25-44ea-a444-2c37ba7f28be</cbc:UUID>
-- <cbc:IssueDate>2021-04-25</cbc:IssueDate>
-- <cbc:IssueTime>15:30:00</cbc:IssueTime>
-- <cbc:InvoiceTypeCode name="0100000">388</cbc:InvoiceTypeCode>
-- <cbc:DocumentCurrencyCode>SAR</cbc:DocumentCurrencyCode>
-- <cbc:TaxCurrencyCode>SAR</cbc:TaxCurrencyCode>
-- <cbc:LineCountNumeric>2</cbc:LineCountNumeric>
-- <cac:AdditionalDocumentReference>
-- <cbc:ID>ICV</cbc:ID>
-- <cbc:UUID>46531</cbc:UUID>
-- </cac:AdditionalDocumentReference>
-- <cac:AdditionalDocumentReference>
-- <cbc:ID>PIH</cbc:ID>
-- <cac:Attachment>
-- <cbc:EmbeddedDocumentBinaryObject mimeCode="text/plain">NWZl......NTdlOQ==</cbc:EmbeddedDocumentBinaryObject>
-- </cac:Attachment>
-- </cac:AdditionalDocumentReference>
--
--
-- <cac:AdditionalDocumentReference>
-- <cbc:ID>QR</cbc:ID>
-- <cac:Attachment>
-- <cbc:EmbeddedDocumentBinaryObject mimeCode="text/plain">ARlBbC........FAau5g</cbc:EmbeddedDocumentBinaryObject>
-- </cac:Attachment>
-- </cac:AdditionalDocumentReference><cac:Signature>
-- <cbc:ID>urn:oasis:names:specification:ubl:signature:Invoice</cbc:ID>
-- <cbc:SignatureMethod>urn:oasis:names:specification:ubl:dsig:enveloped:xades</cbc:SignatureMethod>
-- </cac:Signature><cac:AccountingSupplierParty>
-- <cac:Party>
-- <cac:PartyIdentification>
-- <cbc:ID schemeID="MLS">123457890</cbc:ID>
-- </cac:PartyIdentification>
-- <cac:PostalAddress>
-- <cbc:StreetName>King Abdulaziz Road</cbc:StreetName>
-- <cbc:BuildingNumber>9999</cbc:BuildingNumber>
-- <cbc:PlotIdentification>9999</cbc:PlotIdentification>
-- <cbc:CitySubdivisionName>Al Amal</cbc:CitySubdivisionName>
-- <cbc:CityName>Riyadh</cbc:CityName>
-- <cbc:PostalZone>12643</cbc:PostalZone>
-- <cbc:CountrySubentity>Riyadh Region</cbc:CountrySubentity>
-- <cac:Country>
-- <cbc:IdentificationCode>SA</cbc:IdentificationCode>
-- </cac:Country>
-- </cac:PostalAddress>
-- <cac:PartyTaxScheme>
-- <cbc:CompanyID>300099999900003</cbc:CompanyID>
-- <cac:TaxScheme>
-- <cbc:ID>VAT</cbc:ID>
-- </cac:TaxScheme>
-- </cac:PartyTaxScheme>
-- <cac:PartyLegalEntity>
-- <cbc:RegistrationName>Example Co. LTD</cbc:RegistrationName>
-- </cac:PartyLegalEntity>
-- </cac:Party>
-- </cac:AccountingSupplierParty>
-- <cac:AccountingCustomerParty>
-- <cac:Party>
-- <cac:PartyIdentification>
-- <cbc:ID schemeID="SAG">123C12345678</cbc:ID>
-- </cac:PartyIdentification>
-- <cac:PostalAddress>
-- <cbc:StreetName>King Abdullah Road</cbc:StreetName>
-- <cbc:BuildingNumber>9999</cbc:BuildingNumber>
-- <cbc:PlotIdentification>9999</cbc:PlotIdentification>
-- <cbc:CitySubdivisionName>Al Mursalat</cbc:CitySubdivisionName>
-- <cbc:CityName>Riyadh</cbc:CityName>
-- <cbc:PostalZone>11564</cbc:PostalZone>
-- <cbc:CountrySubentity>Riyadh Region</cbc:CountrySubentity>
-- <cac:Country>
-- <cbc:IdentificationCode>SA</cbc:IdentificationCode>
-- </cac:Country>
-- </cac:PostalAddress>
-- <cac:PartyTaxScheme>
-- <cac:TaxScheme>
-- <cbc:ID>VAT</cbc:ID>
-- </cac:TaxScheme>
-- </cac:PartyTaxScheme>
-- <cac:PartyLegalEntity>
-- <cbc:RegistrationName>EXAMPLE MARKETS</cbc:RegistrationName>
-- </cac:PartyLegalEntity>
-- </cac:Party>
-- </cac:AccountingCustomerParty>
-- <cac:Delivery>
-- <cbc:ActualDeliveryDate>2022-04-25</cbc:ActualDeliveryDate>
-- </cac:Delivery>
-- <cac:PaymentMeans>
-- <cbc:PaymentMeansCode>42</cbc:PaymentMeansCode>
-- </cac:PaymentMeans>
-- <cac:TaxTotal>
-- <cbc:TaxAmount currencyID="SAR">135.00</cbc:TaxAmount>
-- <cac:TaxSubtotal>
-- <cbc:TaxableAmount currencyID="SAR">900.00</cbc:TaxableAmount>
-- <cbc:TaxAmount currencyID="SAR">135.00</cbc:TaxAmount>
-- <cac:TaxCategory>
-- <cbc:ID>S</cbc:ID>
-- <cbc:Percent>15</cbc:Percent>
-- <cac:TaxScheme>
-- <cbc:ID>VAT</cbc:ID>
-- </cac:TaxScheme>
-- </cac:TaxCategory>
-- </cac:TaxSubtotal>
-- </cac:TaxTotal>
-- <cac:TaxTotal>
-- <cbc:TaxAmount currencyID="SAR">135.00</cbc:TaxAmount>
-- </cac:TaxTotal>
-- <cac:LegalMonetaryTotal>
-- <cbc:LineExtensionAmount currencyID="SAR">900.00</cbc:LineExtensionAmount>
-- <cbc:TaxExclusiveAmount currencyID="SAR">900.00</cbc:TaxExclusiveAmount>
-- <cbc:TaxInclusiveAmount currencyID="SAR">1035.00</cbc:TaxInclusiveAmount>
-- <cbc:AllowanceTotalAmount currencyID="SAR">0.00</cbc:AllowanceTotalAmount>
-- <cbc:PayableAmount currencyID="SAR">1035.00</cbc:PayableAmount>
-- </cac:LegalMonetaryTotal>
-- <cac:InvoiceLine>
-- <cbc:ID>1</cbc:ID>
-- <cbc:InvoicedQuantity unitCode="PCE">1</cbc:InvoicedQuantity>
-- <cbc:LineExtensionAmount currencyID="SAR">200.00</cbc:LineExtensionAmount>
-- <cac:TaxTotal>
-- <cbc:TaxAmount currencyID="SAR">30.00</cbc:TaxAmount>
-- <cbc:RoundingAmount currencyID="SAR">230.00</cbc:RoundingAmount>
-- </cac:TaxTotal>
-- <cac:Item>
-- <cbc:Name>Item A</cbc:Name>
-- <cac:ClassifiedTaxCategory>
-- <cbc:ID>S</cbc:ID>
-- <cbc:Percent>15</cbc:Percent>
-- <cac:TaxScheme>
-- <cbc:ID>VAT</cbc:ID>
-- </cac:TaxScheme>
-- </cac:ClassifiedTaxCategory>
-- </cac:Item>
-- <cac:Price>
-- <cbc:PriceAmount currencyID="SAR">200.00</cbc:PriceAmount>
-- </cac:Price>
-- </cac:InvoiceLine>
-- <cac:InvoiceLine>
-- <cbc:ID>2</cbc:ID>
-- <cbc:InvoicedQuantity unitCode="PCE">2</cbc:InvoicedQuantity>
-- <cbc:LineExtensionAmount currencyID="SAR">700.00</cbc:LineExtensionAmount>
-- <cac:TaxTotal>
-- <cbc:TaxAmount currencyID="SAR">105.00</cbc:TaxAmount>
-- <cbc:RoundingAmount currencyID="SAR">805.00</cbc:RoundingAmount>
-- </cac:TaxTotal>
-- <cac:Item>
-- <cbc:Name>Item B</cbc:Name>
-- <cac:ClassifiedTaxCategory>
-- <cbc:ID>S</cbc:ID>
-- <cbc:Percent>15</cbc:Percent>
-- <cac:TaxScheme>
-- <cbc:ID>VAT</cbc:ID>
-- </cac:TaxScheme>
-- </cac:ClassifiedTaxCategory>
-- </cac:Item>
-- <cac:Price>
-- <cbc:PriceAmount currencyID="SAR">350.00</cbc:PriceAmount>
-- </cac:Price>
-- </cac:InvoiceLine>
-- </Invoice>
local gen = chilkat.XmlDSigGen.new()
gen.sig_location = "Invoice|ext:UBLExtensions|ext:UBLExtension|ext:ExtensionContent|sig:UBLDocumentSignatures|sac:SignatureInformation"
gen.sig_location_mod = 0
gen.sig_id = "signature"
gen.sig_namespace_prefix = "ds"
gen.sig_namespace_uri = "http://www.w3.org/2000/09/xmldsig#"
gen.signed_info_canon_alg = "C14N_11"
gen.signed_info_digest_method = "sha256"
-- Create an Object to be added to the Signature.
local object1 = chilkat.Xml.new()
object1.tag = "xades:QualifyingProperties"
object1:add_attribute("xmlns:xades", "http://uri.etsi.org/01903/v1.3.2#")
object1:add_attribute("Target", "signature")
object1:update_attr_at("xades:SignedProperties", true, "Id", "xadesSignedProperties")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT")
object1:update_attr_at("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:CertDigest|ds:DigestMethod", true, "Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:CertDigest|ds:DigestValue", "TO BE GENERATED BY CHILKAT")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:IssuerSerial|ds:X509IssuerName", "TO BE GENERATED BY CHILKAT")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:IssuerSerial|ds:X509SerialNumber", "TO BE GENERATED BY CHILKAT")
gen:add_object("", object1:get_xml(), "", "")
-- -------- Reference 1 --------
local xml1 = chilkat.Xml.new()
xml1.tag = "ds:Transforms"
xml1:update_attr_at("ds:Transform", true, "Algorithm", "http://www.w3.org/TR/1999/REC-xpath-19991116")
xml1:update_child_content("ds:Transform|ds:XPath", "not(//ancestor-or-self::ext:UBLExtensions)")
xml1:update_attr_at("ds:Transform[1]", true, "Algorithm", "http://www.w3.org/TR/1999/REC-xpath-19991116")
xml1:update_child_content("ds:Transform[1]|ds:XPath", "not(//ancestor-or-self::cac:Signature)")
xml1:update_attr_at("ds:Transform[2]", true, "Algorithm", "http://www.w3.org/TR/1999/REC-xpath-19991116")
xml1:update_child_content("ds:Transform[2]|ds:XPath", "not(//ancestor-or-self::cac:AdditionalDocumentReference[cbc:ID='QR'])")
xml1:update_attr_at("ds:Transform[3]", true, "Algorithm", "http://www.w3.org/2006/12/xml-c14n11")
gen:add_same_doc_ref2("", "sha256", xml1, "")
gen:set_ref_id_attr("", "invoiceSignedData")
-- -------- Reference 2 --------
gen:add_object_ref("xadesSignedProperties", "sha256", "", "", "http://www.w3.org/2000/09/xmldsig#SignatureProperties")
-- Provide a certificate + private key. (PFX password is test123)
local certFromPfx = chilkat.Cert.new()
success = certFromPfx:load_pfx_file("qa_data/pfx/cert_test123.pfx", "test123")
if not success then
print(certFromPfx.last_error_text)
return
end
-- Alternatively, if your certificate and private key are in separate PEM files, do this:
local cert = chilkat.Cert.new()
success = cert:load_from_file("qa_data/zatca/cert.pem")
if not success then
print(cert.last_error_text)
return
end
print(cert.subject_cn)
-- Load the private key.
local privKey = chilkat.PrivateKey.new()
success = privKey:load_pem_file("qa_data/zatca/ec-secp256k1-priv-key.pem")
if not success then
print(privKey.last_error_text)
return
end
print("Key Type: " .. privKey.key_type)
-- Associate the private key with the certificate.
success = cert:set_private_key(privKey)
if not success then
print(cert.last_error_text)
return
end
-- The certificate passed to SetX509Cert must have an associated private key.
-- If the cert was loaded from a PFX, then it should automatically has an associated private key.
-- If the cert was loaded from PEM, then the private key was explicitly associated as shown above.
success = gen:set_x509_cert(cert, true)
if not success then
print(gen.last_error_text)
return
end
gen.key_info_type = "X509Data"
gen.x509_type = "Certificate"
-- ---------------- This is important -----------------------------------------
-- Add the "ZATCA" behavior to produce the format required by ZATCA.
gen.behaviors = "IndentedSignature,TransformSignatureXPath,ZATCA"
-- ----------------------------------------------------------------------------
-- Sign the XML...
success = gen:create_xml_dsig_sb(sbXml)
if not success then
print(gen.last_error_text)
return
end
-- -----------------------------------------------
-- Save the signed XML to a file.
success = sbXml:write_file("qa_output/signedXml.xml", "utf-8", false)
print(sbXml:get_as_string())
-- ----------------------------------------
-- Verify the signatures we just produced...
local verifier = chilkat.XmlDSig.new()
success = verifier:load_signature_sb(sbXml)
if not success then
print(verifier.last_error_text)
return
end
-- ---------------- This is important -----------------------------------------
-- Specify "ZATCA" in uncommon options
-- to validate signed XML according to ZATCA needs.
-- ----------------------------------------------------------------------------
verifier.uncommon_options = "ZATCA"
local numSigs = verifier.num_signatures
local verifyIdx = 0
while verifyIdx < numSigs do
verifier.selector = verifyIdx
local verified = verifier:verify_signature(true)
if not verified then
print(verifier.last_error_text)
return
end
verifyIdx = verifyIdx + 1
end
print("All signatures were successfully verified.")