Lua Requires Chilkat v11.0.0+
Lua
IPS MX Signature - Digitally Sign MX Document
See more XML Digital Signatures Examples
Demonstrates how to digitally sign ISO 20022 SWIFT MX messages.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.
local success = true
-- First create the XML to be signed, or load it from a file, or a string,
-- To load XML from a file:
local xmlToSign = chilkat.Xml.new()
success = xmlToSign:load_xml_file("c:/someDir/mx_document.xml")
-- Or to load XML from a string
success = xmlToSign:load_xml("...")
-- Or create the XML directly.
xmlToSign:clear()
-- Use this online tool to generate code from sample XML:
-- Generate Code to Create XML
xmlToSign.tag = "DataPDU"
xmlToSign:add_attribute("xmlns", "urn:cma:stp:xsd:stp.1.0")
xmlToSign:update_attr_at("Body|AppHdr", true, "xmlns", "urn:iso:std:iso:20022:tech:xsd:head.001.001.01")
xmlToSign:update_child_content("Body|AppHdr|Fr|FIId|FinInstnId|BICFI", "ZZZZZZZZ")
xmlToSign:update_child_content("Body|AppHdr|To|FIId|FinInstnId|BICFI", "YYYYYYYYYY")
xmlToSign:update_child_content("Body|AppHdr|BizMsgIdr", "ZZZZZZZZAXXX999999999999999999999")
xmlToSign:update_child_content("Body|AppHdr|MsgDefIdr", "pacs.008.001.08")
xmlToSign:update_child_content("Body|AppHdr|BizSvc", "IPS")
xmlToSign:update_child_content("Body|AppHdr|CreDt", "2017-09-13T18:18:00Z")
xmlToSign:update_attr_at("Body|Document", true, "xmlns", "urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|GrpHdr|MsgId", "ZZZZZZZZAXXX999999999999999999999")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|GrpHdr|CreDtTm", "2017-09-13T18:18:00")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|GrpHdr|NbOfTxs", "1")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|GrpHdr|SttlmInf|SttlmMtd", "CLRG")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtId|EndToEndId", "NOTPROVIDED")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtId|TxId", "ZZZZZZZZAXXX999999999999999999999")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtTpInf|ClrChanl", "RTNS")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtTpInf|LclInstrm|Prtry", "CSCT")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtTpInf|CtgyPurp|Prtry", "001")
xmlToSign:update_attr_at("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|IntrBkSttlmAmt", true, "Ccy", "JOD")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|IntrBkSttlmAmt", "71.12")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|IntrBkSttlmDt", "2018-01-14")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|ChrgBr", "SLEV")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|InstgAgt|FinInstnId|BICFI", "ZZZZZZZZ")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|InstdAgt|FinInstnId|BICFI", "UBSIJOA0")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Dbtr|Nm", "John Johnson")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAcct|Id|IBAN", "JO22CITI00000000000555555555")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgt|FinInstnId|BICFI", "ZZZZZZZZ")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgt|FinInstnId|Othr|Id", "200004")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgt|FinInstnId|Othr|SchmeNm|Prtry", "1700099999")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgtAcct|Id|IBAN", "JO66CITI22222222222222222222")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgt|FinInstnId|BICFI", "UBSIJOA0")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgt|FinInstnId|Othr|Id", "210027")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgt|FinInstnId|Othr|SchmeNm|Prtry", "1400199999")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgtAcct|Id|IBAN", "JO44UBSI33333333333333333333")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Cdtr|Nm", "Omega Jones")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAcct|Id|IBAN", "JO95UBSI00000000000777777777")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|InstrForNxtAgt|InstrInf", "/BNF/Details")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Purp|Prtry", "5814")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RgltryRptg|Dtls|Inf", "SOMEINFORMATIONABOUTPAYMENT-1")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RgltryRptg|Dtls|Inf[1]", "SOMEINFORMATIONABOUTPAYMENT-2")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RgltryRptg|Dtls|Inf[2]", "SOMEINFORMATIONABOUTPAYMENT-3")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Tax|Cdtr|TaxId", "9900083901")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Tax|Dbtr|TaxId", "1000387561")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RmtInf|Ustrd", "EDV UCUN ODENIR")
xmlToSign:update_child_content("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RmtInf|Ustrd[1]", "EXTRA INFO")
-- The following XML is to be signed:
-- <?xml version="1.0" encoding="UTF-8"?>
-- <DataPDU xmlns="urn:cma:stp:xsd:stp.1.0">
-- <Body>
-- <AppHdr xmlns="urn:iso:std:iso:20022:tech:xsd:head.001.001.01">
-- <Fr>
-- <FIId>
-- <FinInstnId>
-- <BICFI>ZZZZZZZZ</BICFI>
-- </FinInstnId>
-- </FIId>
-- </Fr>
-- <To>
-- <FIId>
-- <FinInstnId>
-- <BICFI>YYYYYYYYYY</BICFI>
-- </FinInstnId>
-- </FIId>
-- </To>
-- <BizMsgIdr>ZZZZZZZZAXXX999999999999999999999</BizMsgIdr>
-- <MsgDefIdr>pacs.008.001.08</MsgDefIdr>
-- <BizSvc>IPS</BizSvc>
-- <CreDt>2017-09-13T18:18:00Z</CreDt>
-- </AppHdr>
-- <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08">
-- <FIToFICstmrCdtTrf>
-- <GrpHdr>
-- <MsgId>ZZZZZZZZAXXX999999999999999999999</MsgId>
-- <CreDtTm>2017-09-13T18:18:00</CreDtTm>
-- <NbOfTxs>1</NbOfTxs>
-- <SttlmInf>
-- <SttlmMtd>CLRG</SttlmMtd>
-- </SttlmInf>
-- </GrpHdr>
-- <CdtTrfTxInf>
-- <PmtId>
-- <EndToEndId>NOTPROVIDED</EndToEndId>
-- <TxId>ZZZZZZZZAXXX999999999999999999999</TxId>
-- </PmtId>
-- <PmtTpInf>
-- <ClrChanl>RTNS</ClrChanl>
-- <LclInstrm>
-- <Prtry>CSCT</Prtry>
-- </LclInstrm>
-- <CtgyPurp>
-- <Prtry>001</Prtry>
-- </CtgyPurp>
-- </PmtTpInf>
-- <IntrBkSttlmAmt Ccy="JOD">71.12</IntrBkSttlmAmt>
-- <IntrBkSttlmDt>2018-01-14</IntrBkSttlmDt>
-- <ChrgBr>SLEV</ChrgBr>
-- <InstgAgt>
-- <FinInstnId>
-- <BICFI>ZZZZZZZZ</BICFI>
-- </FinInstnId>
-- </InstgAgt>
-- <InstdAgt>
-- <FinInstnId>
-- <BICFI>UBSIJOA0</BICFI>
-- </FinInstnId>
-- </InstdAgt>
-- <Dbtr>
-- <Nm>John Johnson</Nm>
-- </Dbtr>
-- <DbtrAcct>
-- <Id>
-- <IBAN>JO22CITI00000000000555555555</IBAN>
-- </Id>
-- </DbtrAcct>
-- <DbtrAgt>
-- <FinInstnId>
-- <BICFI>ZZZZZZZZ</BICFI>
-- <Othr>
-- <Id>200004</Id>
-- <SchmeNm>
-- <Prtry>1700089999</Prtry>
-- </SchmeNm>
-- </Othr>
-- </FinInstnId>
-- </DbtrAgt>
-- <DbtrAgtAcct>
-- <Id>
-- <IBAN>JO66CITI22222222222222222222</IBAN>
-- </Id>
-- </DbtrAgtAcct>
-- <CdtrAgt>
-- <FinInstnId>
-- <BICFI>UBSIJOA0</BICFI>
-- <Othr>
-- <Id>210027</Id>
-- <SchmeNm>
-- <Prtry>1400199999</Prtry>
-- </SchmeNm>
-- </Othr>
-- </FinInstnId>
-- </CdtrAgt>
-- <CdtrAgtAcct>
-- <Id>
-- <IBAN>JO44UBSI33333333333333333333</IBAN>
-- </Id>
-- </CdtrAgtAcct>
-- <Cdtr>
-- <Nm>Omega Jones</Nm>
-- </Cdtr>
-- <CdtrAcct>
-- <Id>
-- <IBAN>JO95UBSI00000000000777777777</IBAN>
-- </Id>
-- </CdtrAcct>
-- <InstrForNxtAgt>
-- <InstrInf>/BNF/Details</InstrInf>
-- </InstrForNxtAgt>
-- <Purp>
-- <Prtry>5814</Prtry>
-- </Purp>
-- <RgltryRptg>
-- <Dtls>
-- <Inf>SOMEINFORMATIONABOUTPAYMENT-1</Inf>
-- <Inf>SOMEINFORMATIONABOUTPAYMENT-2</Inf>
-- <Inf>SOMEINFORMATIONABOUTPAYMENT-3</Inf>
-- </Dtls>
-- </RgltryRptg>
-- <Tax>
-- <Cdtr>
-- <TaxId>9900083901</TaxId>
-- </Cdtr>
-- <Dbtr>
-- <TaxId>1000387561</TaxId>
-- </Dbtr>
-- </Tax>
-- <RmtInf>
-- <Ustrd>EDV UCUN ODENIR</Ustrd>
-- <Ustrd>EXTRA INFO</Ustrd>
-- </RmtInf>
-- </CdtTrfTxInf>
-- </FIToFICstmrCdtTrf>
-- </Document>
-- </Body>
-- </DataPDU>
local gen = chilkat.XmlDSigGen.new()
gen.sig_location = "DataPDU|Body|AppHdr|Sgntr"
gen.sig_location_mod = 0
gen.sig_namespace_prefix = "ds"
gen.sig_namespace_uri = "http://www.w3.org/2000/09/xmldsig#"
gen.signed_info_canon_alg = "EXCL_C14N"
gen.signed_info_digest_method = "sha256"
-- Set the KeyInfoId before adding references..
gen.key_info_id = "_f9f2c543-e50a-4a50-bd91-50155d27f7e2"
-- 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:update_attr_at("xades:SignedProperties", true, "Id", "_4ed8e0ed-f47c-4262-909b-0458532ce7aa-signedprops")
object1:update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT")
gen:add_object("", object1:get_xml(), "", "")
-- -------- Reference 1 --------
gen:add_same_doc_ref("_f9f2c543-e50a-4a50-bd91-50155d27f7e2", "sha256", "EXCL_C14N", "", "")
-- -------- Reference 2 --------
gen:add_object_ref("_4ed8e0ed-f47c-4262-909b-0458532ce7aa-signedprops", "sha256", "EXCL_C14N", "", "http://uri.etsi.org/01903/v1.3.2#SignedProperties")
-- -------- Reference 3 --------
gen:add_same_doc_ref("", "sha256", "EXCL_C14N", "", "")
-- 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"
-- Load XML to be signed...
local sbXml = chilkat.StringBuilder.new()
xmlToSign:get_xml_sb(sbXml)
-- Can alternatively use "CompactSignedXml"
gen.behaviors = "IndentedSignature,LocalSigningTime"
-- 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/mx_signed.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
-- Important: The above signature did not include the full X.509 certificate.
-- You must call verifier.SetPublicKey to provide the public key of the certificate required for validation.
local verifyCert = chilkat.Cert.new()
success = verifyCert:load_from_file("qa_data/certs/cert_test123.cer")
if not success then
print(verifyCert.last_error_text)
return
end
local pubKey = chilkat.PublicKey.new()
verifyCert:get_public_key(pubKey)
verifier:set_public_key(pubKey)
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.")