Sample code for 30+ languages & platforms
Zig Requires Chilkat v11.0.0+

IPS MX Signature - Digitally Sign MX Document

See more XML Digital Signatures Examples

Demonstrates how to digitally sign ISO 20022 SWIFT MX messages.

Chilkat Zig Downloads

Zig
const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    // First create the XML to be signed, or load it from a file, or a string,

    // To load XML from a file:
    const xml_to_sign = try chilkat.Xml.init();
    defer xml_to_sign.deinit();
    try xml_to_sign.loadXmlFile("c:/someDir/mx_document.xml");

    // Or to load XML from a string
    try xml_to_sign.loadXml("...");

    // Or create the XML directly.
    xml_to_sign.clear();

    // Use this online tool to generate code from sample XML:
    // Generate Code to Create XML

    xml_to_sign.setTag("DataPDU");
    xml_to_sign.addAttribute("xmlns", "urn:cma:stp:xsd:stp.1.0") catch {};
    xml_to_sign.updateAttrAt("Body|AppHdr", true, "xmlns", "urn:iso:std:iso:20022:tech:xsd:head.001.001.01") catch {};
    xml_to_sign.updateChildContent("Body|AppHdr|Fr|FIId|FinInstnId|BICFI", "ZZZZZZZZ");
    xml_to_sign.updateChildContent("Body|AppHdr|To|FIId|FinInstnId|BICFI", "YYYYYYYYYY");
    xml_to_sign.updateChildContent("Body|AppHdr|BizMsgIdr", "ZZZZZZZZAXXX999999999999999999999");
    xml_to_sign.updateChildContent("Body|AppHdr|MsgDefIdr", "pacs.008.001.08");
    xml_to_sign.updateChildContent("Body|AppHdr|BizSvc", "IPS");
    xml_to_sign.updateChildContent("Body|AppHdr|CreDt", "2017-09-13T18:18:00Z");
    xml_to_sign.updateAttrAt("Body|Document", true, "xmlns", "urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08") catch {};
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|GrpHdr|MsgId", "ZZZZZZZZAXXX999999999999999999999");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|GrpHdr|CreDtTm", "2017-09-13T18:18:00");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|GrpHdr|NbOfTxs", "1");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|GrpHdr|SttlmInf|SttlmMtd", "CLRG");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtId|EndToEndId", "NOTPROVIDED");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtId|TxId", "ZZZZZZZZAXXX999999999999999999999");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtTpInf|ClrChanl", "RTNS");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtTpInf|LclInstrm|Prtry", "CSCT");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|PmtTpInf|CtgyPurp|Prtry", "001");
    xml_to_sign.updateAttrAt("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|IntrBkSttlmAmt", true, "Ccy", "JOD") catch {};
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|IntrBkSttlmAmt", "71.12");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|IntrBkSttlmDt", "2018-01-14");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|ChrgBr", "SLEV");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|InstgAgt|FinInstnId|BICFI", "ZZZZZZZZ");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|InstdAgt|FinInstnId|BICFI", "UBSIJOA0");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Dbtr|Nm", "John Johnson");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAcct|Id|IBAN", "JO22CITI00000000000555555555");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgt|FinInstnId|BICFI", "ZZZZZZZZ");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgt|FinInstnId|Othr|Id", "200004");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgt|FinInstnId|Othr|SchmeNm|Prtry", "1700099999");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|DbtrAgtAcct|Id|IBAN", "JO66CITI22222222222222222222");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgt|FinInstnId|BICFI", "UBSIJOA0");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgt|FinInstnId|Othr|Id", "210027");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgt|FinInstnId|Othr|SchmeNm|Prtry", "1400199999");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAgtAcct|Id|IBAN", "JO44UBSI33333333333333333333");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Cdtr|Nm", "Omega Jones");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|CdtrAcct|Id|IBAN", "JO95UBSI00000000000777777777");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|InstrForNxtAgt|InstrInf", "/BNF/Details");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Purp|Prtry", "5814");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RgltryRptg|Dtls|Inf", "SOMEINFORMATIONABOUTPAYMENT-1");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RgltryRptg|Dtls|Inf[1]", "SOMEINFORMATIONABOUTPAYMENT-2");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RgltryRptg|Dtls|Inf[2]", "SOMEINFORMATIONABOUTPAYMENT-3");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Tax|Cdtr|TaxId", "9900083901");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|Tax|Dbtr|TaxId", "1000387561");
    xml_to_sign.updateChildContent("Body|Document|FIToFICstmrCdtTrf|CdtTrfTxInf|RmtInf|Ustrd", "EDV UCUN ODENIR");
    xml_to_sign.updateChildContent("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>

    const gen = try chilkat.XmlDSigGen.init();
    defer gen.deinit();

    gen.setSigLocation("DataPDU|Body|AppHdr|Sgntr");
    gen.setSigLocationMod(0);
    gen.setSigNamespacePrefix("ds");
    gen.setSigNamespaceUri("http://www.w3.org/2000/09/xmldsig#");
    gen.setSignedInfoCanonAlg("EXCL_C14N");
    gen.setSignedInfoDigestMethod("sha256");

    // Set the KeyInfoId before adding references..
    gen.setKeyInfoId("_f9f2c543-e50a-4a50-bd91-50155d27f7e2");

    // Create an Object to be added to the Signature.
    const object1 = try chilkat.Xml.init();
    defer object1.deinit();
    object1.setTag("xades:QualifyingProperties");
    object1.addAttribute("xmlns:xades", "http://uri.etsi.org/01903/v1.3.2#") catch {};
    object1.updateAttrAt("xades:SignedProperties", true, "Id", "_4ed8e0ed-f47c-4262-909b-0458532ce7aa-signedprops") catch {};
    object1.updateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT");

    gen.addObject("", try object1.getXml(alloc), "", "") catch {};

    // -------- Reference 1 --------
    gen.addSameDocRef("_f9f2c543-e50a-4a50-bd91-50155d27f7e2", "sha256", "EXCL_C14N", "", "") catch {};

    // -------- Reference 2 --------
    gen.addObjectRef("_4ed8e0ed-f47c-4262-909b-0458532ce7aa-signedprops", "sha256", "EXCL_C14N", "", "http://uri.etsi.org/01903/v1.3.2#SignedProperties") catch {};

    // -------- Reference 3 --------
    gen.addSameDocRef("", "sha256", "EXCL_C14N", "", "") catch {};

    // Provide a certificate + private key. (PFX password is test123)
    const cert = try chilkat.Cert.init();
    defer cert.deinit();
    cert.loadPfxFile("qa_data/pfx/cert_test123.pfx", "test123") catch {
        std.debug.print("{s}\n", .{try cert.getLastErrorText(alloc)});
        return;
    };

    gen.setX509Cert(cert, true) catch {};

    gen.setKeyInfoType("X509Data");
    gen.setX509Type("IssuerSerial");

    // Load XML to be signed...
    const sb_xml = try chilkat.StringBuilder.init();
    defer sb_xml.deinit();
    xml_to_sign.getXmlSb(sb_xml) catch {};

    // Can alternatively use "CompactSignedXml"
    gen.setBehaviors("IndentedSignature,LocalSigningTime");

    // Sign the XML...
    gen.createXmlDSigSb(sb_xml) catch {
        std.debug.print("{s}\n", .{try gen.getLastErrorText(alloc)});
        return;
    };

    // -----------------------------------------------

    // Save the signed XML to a file.
    try sb_xml.writeFile("qa_output/mx_signed.xml", "utf-8", false);

    std.debug.print("{s}\n", .{try sb_xml.getAsString(alloc)});

    // ----------------------------------------
    // Verify the signatures we just produced...
    const verifier = try chilkat.XmlDSig.init();
    defer verifier.deinit();
    verifier.loadSignatureSb(sb_xml) catch {
        std.debug.print("{s}\n", .{try verifier.getLastErrorText(alloc)});
        return;
    };

    // 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.

    const verify_cert = try chilkat.Cert.init();
    defer verify_cert.deinit();
    verify_cert.loadFromFile("qa_data/certs/cert_test123.cer") catch {
        std.debug.print("{s}\n", .{try verify_cert.getLastErrorText(alloc)});
        return;
    };

    const pub_key = try chilkat.PublicKey.init();
    defer pub_key.deinit();
    verify_cert.getPublicKey(pub_key) catch {};

    verifier.setPublicKey(pub_key) catch {};

    const num_sigs = verifier.getNumSignatures();
    var verify_idx: i32 = 0;
    while (verify_idx < num_sigs) {
        verifier.setSelector(verify_idx);
        verifier.verifySignature(true) catch {
            std.debug.print("{s}\n", .{try verifier.getLastErrorText(alloc)});
            return;
        };

        verify_idx = verify_idx + 1;
    }

    std.debug.print("All signatures were successfully verified.\n", .{});
}