Lua Requires Chilkat v9.5.0.89+
Lua
Cape Verde Fatura Eletrónica XML Digital Signature
See more XML Digital Signatures Examples
Demonstrates how to sign XML to create a signed invoice compatible with the Cape Verde Fatura Eletrónica requirements.Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
-- First create the following XML to be signed. This can be created programmatically as shown in the code below, or
-- you can simply load the XML to be signed from a file..
-- <?xml version="1.0" encoding="utf-8"?>
-- <Dfe xmlns="urn:cv:efatura:xsd:v1.0" DocumentTypeCode="1" Id="CV2210818123456789000010100000000546735014601" Version="1.0">
-- <Invoice>
-- <LedCode>1</LedCode>
-- <Serie>SL</Serie>
-- <DocumentNumber>5</DocumentNumber>
-- <IssueDate>2021-08-30</IssueDate>
-- <IssueTime>00:01:00</IssueTime>
-- <TaxPointDate>2021-08-18</TaxPointDate>
-- <EmitterParty>
-- <TaxId CountryCode="CV">123456789</TaxId>
-- <Name>Maria</Name>
-- <Address CountryCode="CV">
-- <State>Estado do Emissor</State>
-- <City>Cidade do Emissor</City>
-- <Region>Regi�o do Emissor</Region>
-- <Street>Rua do Emissor</Street>
-- <StreetDetail>Detalhe da rua do Emissor</StreetDetail>
-- <BuildingName>Pr�dio do Emissor</BuildingName>
-- <BuildingNumber>1</BuildingNumber>
-- <BuildingFloor>2</BuildingFloor>
-- <PostalCode>7600</PostalCode>
-- <AddressDetail>Detalhe de endere�o do Emissor</AddressDetail>
-- <AddressCode>CV774999999999999319</AddressCode>
-- </Address>
-- <Contacts>
-- <Telephone>1234567</Telephone>
-- <Mobilephone>1234568</Mobilephone>
-- <Telefax>1234569</Telefax>
-- <Email>somebody@example.com</Email>
-- <Website>emissor.efatura.cv</Website>
-- </Contacts>
-- </EmitterParty>
-- <ReceiverParty>
-- <TaxId CountryCode="CV">123456789</TaxId>
-- <Name>Nome do Recetor</Name>
-- <Address CountryCode="CV">
-- <State>Estado do Recetor</State>
-- <City>Cidade do Recetor</City>
-- <Region>Regi�o do Recetor</Region>
-- <Street>Rua do Recetor</Street>
-- <StreetDetail>Detalhe da rua do Recetor</StreetDetail>
-- <BuildingName>Pr�dio do Recetor</BuildingName>
-- <BuildingNumber>2</BuildingNumber>
-- <BuildingFloor>3</BuildingFloor>
-- <PostalCode>7601</PostalCode>
-- <AddressDetail>Detalhe de endere�o do Recetor</AddressDetail>
-- <AddressCode>CV774999999999999319</AddressCode>
-- </Address>
-- <Contacts>
-- <Telephone>2234567</Telephone>
-- <Mobilephone>2234568</Mobilephone>
-- <Telefax>2234569</Telefax>
-- <Email>rector@efatura.cv</Email>
-- <Website>rector.efatura.cv</Website>
-- </Contacts>
-- </ReceiverParty>
-- <Lines>
-- <Line LineTypeCode="N">
-- <Id>01</Id>
-- <OrderLineReference>1</OrderLineReference>
-- <Quantity UnitCode="EA">3.15</Quantity>
-- <Price>123456</Price>
-- <PriceExtension>388886</PriceExtension>
-- <Discount>15</Discount>
-- <NetTotal>252776</NetTotal>
-- <Tax TaxTypeCode="IVA">
-- <TaxPercentage>15</TaxPercentage>
-- </Tax>
-- <Item>
-- <Description>Telem�vel</Description>
-- <Name>Telem�vel</Name>
-- <BrandName>Apple</BrandName>
-- <ModelName>iPhone X</ModelName>
-- <EmitterIdentification>TLMV</EmitterIdentification>
-- <StandardIdentification>
-- <GTIN>12345</GTIN>
-- </StandardIdentification>
-- <HazardousRiskIndicator>false</HazardousRiskIndicator>
-- </Item>
-- </Line>
-- </Lines>
-- <Totals>
-- <PriceExtensionTotalAmount>388886</PriceExtensionTotalAmount>
-- <ChargeTotalAmount>0</ChargeTotalAmount>
-- <DiscountTotalAmount>136110</DiscountTotalAmount>
-- <NetTotalAmount>252776</NetTotalAmount>
-- <Discount ValueType="P">20</Discount>
-- <TaxTotalAmount>37916</TaxTotalAmount>
-- <PayableAmount>290692</PayableAmount>
-- </Totals>
-- <References>
-- <Reference>
-- <FiscalDocument IsOldDocument="false">CV1200520123456789000112345678901112345678901</FiscalDocument>
-- <PaymentAmount>12345</PaymentAmount>
-- <Tax TaxTypeCode="IR">
-- <TaxPercentage>10</TaxPercentage>
-- </Tax>
-- </Reference>
-- <Reference>
-- <FiscalDocument IsOldDocument="false">CV1200520123456789000112345678901112345678903</FiscalDocument>
-- <PaymentAmount>98765</PaymentAmount>
-- <Tax TaxTypeCode="IVA">
-- <TaxPercentage>15</TaxPercentage>
-- </Tax>
-- </Reference>
-- </References>
-- <Payments>
-- <PaymentDueDate>2021-12-31</PaymentDueDate>
-- <PaymentTerms>
-- <Note>Juros de 12% a partir da data de vencimento</Note>
-- </PaymentTerms>
-- <PayeeFinancialAccount>
-- <NIB>123456789012345678901</NIB>
-- <Name>Nome da Conta 1</Name>
-- </PayeeFinancialAccount>
-- <PayeeFinancialAccount>
-- <NIB>123456789012345678902</NIB>
-- <Name>Nome da Conta 2</Name>
-- </PayeeFinancialAccount>
-- </Payments>
-- <Note>Texto livre</Note>
-- </Invoice>
-- <Transmission>
-- <IssueMode>2</IssueMode>
-- <TransmitterTaxId CountryCode="CV">123456789</TransmitterTaxId>
-- <Software>
-- <Code>EMIPUB</Code>
-- <Name>DNRE Emissor P�blico</Name>
-- <Version>Build #53 12-07-2021 14:00:47 CVT - master</Version>
-- </Software>
-- <Contingency>
-- <LedCode>1</LedCode>
-- <IssueDate>2020-01-01</IssueDate>
-- <IssueTime>01:02:03</IssueTime>
-- <ReasonTypeCode>1</ReasonTypeCode>
-- </Contingency>
-- </Transmission>
-- <RepositoryCode>2</RepositoryCode>
-- </Dfe>
local success = true
-- Create the XML to be signed...
-- Use this online tool to generate code from sample XML:
-- Generate Code to Create XML
local xmlToSign = chilkat.Xml.new()
xmlToSign.tag = "Dfe"
xmlToSign:add_attribute("xmlns", "urn:cv:efatura:xsd:v1.0")
xmlToSign:add_attribute("DocumentTypeCode", "1")
xmlToSign:add_attribute("Id", "CV2210818123456789000010100000000546735014601")
xmlToSign:add_attribute("Version", "1.0")
xmlToSign:update_child_content("Invoice|LedCode", "1")
xmlToSign:update_child_content("Invoice|Serie", "SL")
xmlToSign:update_child_content("Invoice|DocumentNumber", "5")
xmlToSign:update_child_content("Invoice|IssueDate", "2021-08-30")
xmlToSign:update_child_content("Invoice|IssueTime", "00:01:00")
xmlToSign:update_child_content("Invoice|TaxPointDate", "2021-08-18")
xmlToSign:update_attr_at("Invoice|EmitterParty|TaxId", true, "CountryCode", "CV")
xmlToSign:update_child_content("Invoice|EmitterParty|TaxId", "123456789")
xmlToSign:update_child_content("Invoice|EmitterParty|Name", "Maria")
xmlToSign:update_attr_at("Invoice|EmitterParty|Address", true, "CountryCode", "CV")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|State", "Estado do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|City", "Cidade do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|Region", "Regi�o do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|Street", "Rua do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|StreetDetail", "Detalhe da rua do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|BuildingName", "Pr�dio do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|BuildingNumber", "1")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|BuildingFloor", "2")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|PostalCode", "7600")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|AddressDetail", "Detalhe de endere�o do Emissor")
xmlToSign:update_child_content("Invoice|EmitterParty|Address|AddressCode", "CV774999999999999319")
xmlToSign:update_child_content("Invoice|EmitterParty|Contacts|Telephone", "1234567")
xmlToSign:update_child_content("Invoice|EmitterParty|Contacts|Mobilephone", "1234568")
xmlToSign:update_child_content("Invoice|EmitterParty|Contacts|Telefax", "1234569")
xmlToSign:update_child_content("Invoice|EmitterParty|Contacts|Email", "somebody@example.com")
xmlToSign:update_child_content("Invoice|EmitterParty|Contacts|Website", "emissor.efatura.cv")
xmlToSign:update_attr_at("Invoice|ReceiverParty|TaxId", true, "CountryCode", "CV")
xmlToSign:update_child_content("Invoice|ReceiverParty|TaxId", "123456789")
xmlToSign:update_child_content("Invoice|ReceiverParty|Name", "Nome do Recetor")
xmlToSign:update_attr_at("Invoice|ReceiverParty|Address", true, "CountryCode", "CV")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|State", "Estado do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|City", "Cidade do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|Region", "Regi�o do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|Street", "Rua do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|StreetDetail", "Detalhe da rua do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|BuildingName", "Pr�dio do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|BuildingNumber", "2")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|BuildingFloor", "3")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|PostalCode", "7601")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|AddressDetail", "Detalhe de endere�o do Recetor")
xmlToSign:update_child_content("Invoice|ReceiverParty|Address|AddressCode", "CV774999999999999319")
xmlToSign:update_child_content("Invoice|ReceiverParty|Contacts|Telephone", "2234567")
xmlToSign:update_child_content("Invoice|ReceiverParty|Contacts|Mobilephone", "2234568")
xmlToSign:update_child_content("Invoice|ReceiverParty|Contacts|Telefax", "2234569")
xmlToSign:update_child_content("Invoice|ReceiverParty|Contacts|Email", "rector@efatura.cv")
xmlToSign:update_child_content("Invoice|ReceiverParty|Contacts|Website", "rector.efatura.cv")
xmlToSign:update_attr_at("Invoice|Lines|Line", true, "LineTypeCode", "N")
xmlToSign:update_child_content("Invoice|Lines|Line|Id", "01")
xmlToSign:update_child_content("Invoice|Lines|Line|OrderLineReference", "1")
xmlToSign:update_attr_at("Invoice|Lines|Line|Quantity", true, "UnitCode", "EA")
xmlToSign:update_child_content("Invoice|Lines|Line|Quantity", "3.15")
xmlToSign:update_child_content("Invoice|Lines|Line|Price", "123456")
xmlToSign:update_child_content("Invoice|Lines|Line|PriceExtension", "388886")
xmlToSign:update_child_content("Invoice|Lines|Line|Discount", "15")
xmlToSign:update_child_content("Invoice|Lines|Line|NetTotal", "252776")
xmlToSign:update_attr_at("Invoice|Lines|Line|Tax", true, "TaxTypeCode", "IVA")
xmlToSign:update_child_content("Invoice|Lines|Line|Tax|TaxPercentage", "15")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|Description", "Telem�vel")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|Name", "Telem�vel")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|BrandName", "Apple")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|ModelName", "iPhone X")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|EmitterIdentification", "TLMV")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|StandardIdentification|GTIN", "12345")
xmlToSign:update_child_content("Invoice|Lines|Line|Item|HazardousRiskIndicator", "false")
xmlToSign:update_child_content("Invoice|Totals|PriceExtensionTotalAmount", "388886")
xmlToSign:update_child_content("Invoice|Totals|ChargeTotalAmount", "0")
xmlToSign:update_child_content("Invoice|Totals|DiscountTotalAmount", "136110")
xmlToSign:update_child_content("Invoice|Totals|NetTotalAmount", "252776")
xmlToSign:update_attr_at("Invoice|Totals|Discount", true, "ValueType", "P")
xmlToSign:update_child_content("Invoice|Totals|Discount", "20")
xmlToSign:update_child_content("Invoice|Totals|TaxTotalAmount", "37916")
xmlToSign:update_child_content("Invoice|Totals|PayableAmount", "290692")
xmlToSign:update_attr_at("Invoice|References|Reference|FiscalDocument", true, "IsOldDocument", "false")
xmlToSign:update_child_content("Invoice|References|Reference|FiscalDocument", "CV1200520123456789000112345678901112345678901")
xmlToSign:update_child_content("Invoice|References|Reference|PaymentAmount", "12345")
xmlToSign:update_attr_at("Invoice|References|Reference|Tax", true, "TaxTypeCode", "IR")
xmlToSign:update_child_content("Invoice|References|Reference|Tax|TaxPercentage", "10")
xmlToSign:update_attr_at("Invoice|References|Reference[1]|FiscalDocument", true, "IsOldDocument", "false")
xmlToSign:update_child_content("Invoice|References|Reference[1]|FiscalDocument", "CV1200520123456789000112345678901112345678903")
xmlToSign:update_child_content("Invoice|References|Reference[1]|PaymentAmount", "98765")
xmlToSign:update_attr_at("Invoice|References|Reference[1]|Tax", true, "TaxTypeCode", "IVA")
xmlToSign:update_child_content("Invoice|References|Reference[1]|Tax|TaxPercentage", "15")
xmlToSign:update_child_content("Invoice|Payments|PaymentDueDate", "2021-12-31")
xmlToSign:update_child_content("Invoice|Payments|PaymentTerms|Note", "Juros de 12% a partir da data de vencimento")
xmlToSign:update_child_content("Invoice|Payments|PayeeFinancialAccount|NIB", "123456789012345678901")
xmlToSign:update_child_content("Invoice|Payments|PayeeFinancialAccount|Name", "Nome da Conta 1")
xmlToSign:update_child_content("Invoice|Payments|PayeeFinancialAccount[1]|NIB", "123456789012345678902")
xmlToSign:update_child_content("Invoice|Payments|PayeeFinancialAccount[1]|Name", "Nome da Conta 2")
xmlToSign:update_child_content("Invoice|Note", "Texto livre")
xmlToSign:update_child_content("Transmission|IssueMode", "2")
xmlToSign:update_attr_at("Transmission|TransmitterTaxId", true, "CountryCode", "CV")
xmlToSign:update_child_content("Transmission|TransmitterTaxId", "123456789")
xmlToSign:update_child_content("Transmission|Software|Code", "EMIPUB")
xmlToSign:update_child_content("Transmission|Software|Name", "DNRE Emissor P�blico")
xmlToSign:update_child_content("Transmission|Software|Version", "Build #53 12-07-2021 14:00:47 CVT - master")
xmlToSign:update_child_content("Transmission|Contingency|LedCode", "1")
xmlToSign:update_child_content("Transmission|Contingency|IssueDate", "2020-01-01")
xmlToSign:update_child_content("Transmission|Contingency|IssueTime", "01:02:03")
xmlToSign:update_child_content("Transmission|Contingency|ReasonTypeCode", "1")
xmlToSign:update_child_content("RepositoryCode", "2")
local gen = chilkat.XmlDSigGen.new()
gen.sig_location = "Dfe"
gen.sig_location_mod = 0
gen.sig_id = "xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac"
gen.sig_namespace_prefix = "ds"
gen.sig_namespace_uri = "http://www.w3.org/2000/09/xmldsig#"
gen.sig_value_id = "xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-sigvalue"
gen.signed_info_canon_alg = "C14N"
gen.signed_info_digest_method = "sha256"
-- Set the KeyInfoId before adding references..
gen.key_info_id = "xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-keyinfo"
-- 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("xmlns:xades141", "http://uri.etsi.org/01903/v1.4.1#")
object1:add_attribute("Target", "#xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac")
object1:update_attr_at("xades:SignedProperties", true, "Id", "xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-signedprops")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT")
object1:update_attr_at("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|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:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue", "TO BE GENERATED BY CHILKAT")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2", "TO BE GENERATED BY CHILKAT")
object1:update_attr_at("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat", true, "ObjectReference", "#xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-ref0")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description", "DFE Signature")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier", "efatura-uri")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:DocumentationReferences|xades:DocumentationReference", "https://efatura.cv")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType", "text/xml")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Encoding", "UTF-8")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication|xades:CommitmentTypeId|xades:Identifier", "http://uri.etsi.org/01903/v1.2.2#ProofOfApproval")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication|xades:CommitmentTypeId|xades:Description", "Indicates that the signer has approved the content of the signed data object")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication|xades:AllSignedDataObjects", "")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication[1]|xades:CommitmentTypeId|xades:Identifier", "http://uri.etsi.org/01903/v1.2.2#ProofOfOrigin")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication[1]|xades:CommitmentTypeId|xades:Description", "Indicates that the signer recognizes to have created, approved and sent the signed data object")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication[1]|xades:ObjectReference", "#xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-ref0")
object1:update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication[1]|xades:CommitmentTypeQualifiers|xades:CommitmentTypeQualifier", "CV-FE-123456789")
gen:add_object("", object1:get_xml(), "", "")
-- -------- Reference 1 --------
gen:add_same_doc_ref("CV2210818123456789000010100000000546735014601", "sha256", "", "", "")
gen:set_ref_id_attr("CV2210818123456789000010100000000546735014601", "xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-ref0")
-- -------- Reference 2 --------
gen:add_same_doc_ref("xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-keyinfo", "sha256", "C14N", "", "")
-- -------- Reference 3 --------
gen:add_object_ref("xmldsig-cbd86598-e75e-4ae4-9a27-3b4ee2a789ac-signedprops", "sha256", "C14N", "", "http://uri.etsi.org/01903#SignedProperties")
-- Provide a certificate + private key. (PFX password is test123)
local cert = chilkat.Cert.new()
success = cert:load_pfx_file("qa_data/pfx/cert_test123.pfx", "test123")
if not success then
print(cert.last_error_text)
return
end
gen:set_x509_cert(cert, true)
gen.key_info_type = "X509Data"
gen.x509_type = "IssuerSerial,SubjectName,Certificate"
-- Load XML to be signed...
local sbXml = chilkat.StringBuilder.new()
xmlToSign:get_xml_sb(sbXml)
gen.behaviors = "IndentedSignature,Base64Cr13Entity,ForceAddEnvelopedSignatureTransform,Base64Cr13Entity"
-- 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
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.")