(Node.js) Sign SOAP XML for New Zealand Customs Service

See more XAdES Examples

Demonstrates how to create an XAdES signed SOAP XML pertaining to the New Zealand Customs Service.

Note: This example requires Chilkat v9.5.0.96 or later.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var success = true;

    // Create the following XML to be signed:

    // <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    //     xmlns:v1="http://customs.govt.nz/jbms/msggate/reqresp/v1">
    //     <soapenv:Header>
    //         <wsse:Security soapenv:mustUnderstand="1"
    //             xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    //             xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    //             <wsu:Timestamp wsu:Id="TS-037E78514E9B9132CB16817563559151">
    //                 <wsu:Created>2023-04-17T18:32:35.913Z</wsu:Created>
    //                 <wsu:Expires>2023-04-17T19:32:35.913Z</wsu:Expires>
    //             </wsu:Timestamp>
    //         </wsse:Security>
    //     </soapenv:Header>
    //     <soapenv:Body wsu:Id="id-8"
    //         xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    //         <v1:RequestResponse>
    //             <v1:Submitter>TEST1234</v1:Submitter>
    //             <v1:MailboxMsgId>999999</v1:MailboxMsgId>
    //         </v1:RequestResponse>
    //     </soapenv:Body>
    // </soapenv:Envelope>

    // Create a random ID like this: TS-037E78514E9B9132CB16817563559151
    var tsId = new chilkat.StringBuilder();
    tsId.Append("TS-");
    tsId.AppendRandom(16,"hex");

    // STR-037E78514E9B9132CB16817563559614
    var strId = new chilkat.StringBuilder();
    strId.Append("STR-");
    strId.AppendRandom(16,"hex");

    // KI-037E78514E9B9132CB16817563559583
    var keyInfoId = new chilkat.StringBuilder();
    keyInfoId.Append("KI-");
    keyInfoId.AppendRandom(16,"hex");

    // Create a date/time for the current time with this format:  2023-04-17T18:32:35.913Z
    var dt = new chilkat.CkDateTime();
    dt.SetFromCurrentSystemTime();

    var sbNow = new chilkat.StringBuilder();
    sbNow.Append(dt.GetAsTimestamp(false));
    // If we really need the milliseconds, we can replace the "Z" with ".000Z"
    // The server will also likely accept a timestamp without milliseconds, such as 2023-04-17T18:32:35Z
    var n = sbNow.Replace("Z",".000Z");

    var sbNowPlusOneHour = new chilkat.StringBuilder();
    dt.AddSeconds(3600);
    sbNowPlusOneHour.Append(dt.GetAsTimestamp(false));
    n = sbNowPlusOneHour.Replace("Z",".000Z");

    var xmlToSign = new chilkat.Xml();
    xmlToSign.Tag = "soapenv:Envelope";
    xmlToSign.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
    xmlToSign.AddAttribute("xmlns:v1","http://customs.govt.nz/jbms/msggate/reqresp/v1");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"soapenv:mustUnderstand","1");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsu:Timestamp",true,"wsu:Id",tsId.GetAsString());
    xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created",sbNow.GetAsString());
    xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires",sbNowPlusOneHour.GetAsString());
    xmlToSign.UpdateAttrAt("soapenv:Body",true,"wsu:Id","id-8");
    xmlToSign.UpdateAttrAt("soapenv:Body",true,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd");
    xmlToSign.UpdateChildContent("soapenv:Body|v1:RequestResponse|v1:Submitter","TEST1234");
    xmlToSign.UpdateChildContent("soapenv:Body|v1:RequestResponse|v1:MailboxMsgId","999999");

    var gen = new chilkat.XmlDSigGen();

    gen.SigLocation = "soapenv:Envelope|soapenv:Header|wsse:Security";
    gen.SigLocationMod = 0;
    gen.SigId = "SIG-037E78514E9B9132CB16817563559695";
    gen.SigNamespacePrefix = "ds";
    gen.SigNamespaceUri = "http://www.w3.org/2000/09/xmldsig#";
    gen.SignedInfoPrefixList = "soapenv v1";
    gen.IncNamespacePrefix = "ec";
    gen.IncNamespaceUri = "http://www.w3.org/2001/10/xml-exc-c14n#";
    gen.SignedInfoCanonAlg = "EXCL_C14N";
    gen.SignedInfoDigestMethod = "sha256";

    // Set the KeyInfoId before adding references..
    gen.KeyInfoId = keyInfoId.GetAsString();

    // -------- Reference 1 --------
    var xml1 = new chilkat.Xml();
    xml1.Tag = "ds:Transforms";
    xml1.UpdateAttrAt("ds:Transform",true,"Algorithm","http://www.w3.org/2001/10/xml-exc-c14n#");
    xml1.UpdateAttrAt("ds:Transform|ec:InclusiveNamespaces",true,"PrefixList","wsse soapenv v1");
    xml1.UpdateAttrAt("ds:Transform|ec:InclusiveNamespaces",true,"xmlns:ec","http://www.w3.org/2001/10/xml-exc-c14n#");

    gen.AddSameDocRef2(tsId.GetAsString(),"sha256",xml1,"");

    // -------- Reference 2 --------
    var xml2 = new chilkat.Xml();
    xml2.Tag = "ds:Transforms";
    xml2.UpdateAttrAt("ds:Transform",true,"Algorithm","http://www.w3.org/2001/10/xml-exc-c14n#");
    xml2.UpdateAttrAt("ds:Transform|ec:InclusiveNamespaces",true,"PrefixList","v1");
    xml2.UpdateAttrAt("ds:Transform|ec:InclusiveNamespaces",true,"xmlns:ec","http://www.w3.org/2001/10/xml-exc-c14n#");

    gen.AddSameDocRef2("id-8","sha256",xml2,"");

    // Provide a certificate + private key. (PFX password is test123)
    var cert = new chilkat.Cert();
    success = cert.LoadPfxFile("qa_data/pfx/cert_test123.pfx","test123");
    if (success !== true) {
        console.log(cert.LastErrorText);
        return;
    }

    gen.SetX509Cert(cert,true);

    gen.KeyInfoType = "Custom";

    // Create the custom KeyInfo XML..
    var xmlCustomKeyInfo = new chilkat.Xml();
    xmlCustomKeyInfo.Tag = "wsse:SecurityTokenReference";
    xmlCustomKeyInfo.AddAttribute("wsu:Id",strId.GetAsString());
    xmlCustomKeyInfo.UpdateAttrAt("wsse:KeyIdentifier",true,"EncodingType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary");
    xmlCustomKeyInfo.UpdateAttrAt("wsse:KeyIdentifier",true,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3");
    // Insert the single-line base64 of the signing certificate's DER
    cert.UncommonOptions = "Base64CertNoCRLF";
    xmlCustomKeyInfo.UpdateChildContent("wsse:KeyIdentifier",cert.GetEncoded());

    xmlCustomKeyInfo.EmitXmlDecl = false;
    gen.CustomKeyInfoXml = xmlCustomKeyInfo.GetXml();

    // Load XML to be signed...
    var sbXml = new chilkat.StringBuilder();
    xmlToSign.GetXmlSb(sbXml);

    gen.Behaviors = "IndentedSignature";

    // Sign the XML...
    gen.VerboseLogging = true;
    success = gen.CreateXmlDSigSb(sbXml);
    if (success !== true) {
        console.log(gen.LastErrorText);
        return;
    }

    // Save the signed XML to a file.
    success = sbXml.WriteFile("c:/temp/qa_output/signedXml.xml","utf-8",false);

    console.log(sbXml.GetAsString());

}

chilkatExample();