(Node.js) Create XML Signature using Java KeyStore (.jks)

Demonstrates how to create an XML digital signature using a certificate and private key from a Java KeyStore (.jks)

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 requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // The SOAP XML to be signed in this example contains the following:

    // <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
    // <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    //     <SOAP-ENV:Header>
    //         <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1"></wsse:Security>
    //     </SOAP-ENV:Header>
    //     <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">
    //         <z:FooBar xmlns:z="http://example.com" />
    //     </SOAP-ENV:Body>
    // </SOAP-ENV:Envelope>
    // 

    // Build the XML to sign.
    // Use this online tool to generate the code from sample XML: 
    // Generate Code to Create XML

    var xml = new chilkat.Xml();
    xml.Tag = "SOAP-ENV:Envelope";
    xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/");
    xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",true,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
    xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",true,"SOAP-ENV:mustUnderstand","1");
    xml.UpdateAttrAt("SOAP-ENV:Body",true,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12");
    xml.UpdateAttrAt("SOAP-ENV:Body",true,"SOAP-SEC:id","Body");
    xml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",true,"xmlns:z","http://example.com");

    // Load a JavaKeyStore file containing the certificate + private key.
    var jks = new chilkat.JavaKeyStore();
    var password = "secret";
    var success = jks.LoadFile(password,"qa_data/jks/test_secret.jks");
    if (success !== true) {
        console.log(jks.LastErrorText);
        return;
    }

    // Make sure we have a private key.
    if (jks.NumPrivateKeys < 1) {
        console.log("No private key available.");
        return;
    }

    // -------------------------------------------------------------------------
    // Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
    // chain: CertChain
    var chain = jks.GetCertChain(0);
    if (jks.LastMethodSuccess !== true) {
        console.log(jks.LastErrorText);
        return;
    }

    // cert: Cert
    var cert = chain.GetCert(0);
    if (chain.LastMethodSuccess !== true) {
        console.log(chain.LastErrorText);

        return;
    }

    // Verify again that this cert has a private key.
    if (cert.HasPrivateKey() !== true) {
        console.log("Certificate has no associated private key.");

        return;
    }

    // Prepare for signing...
    // Use this online tool to generate the following code from an already-signed XML sample: 
    // Generate Code to Create an XML Signature
    var gen = new chilkat.XmlDSigGen();

    // Indicate where the Signature will be inserted.
    gen.SigLocation = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security";

    // Add a reference to the fragment of the XML to be signed.
    gen.AddSameDocRef("Body","sha1","EXCL_C14N","","");

    // (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
    gen.SignedInfoPrefixList = "wsse SOAP-ENV";

    // Provide the private key for signing via the certificate, and indicate that
    // we want the base64 of the certificate embedded in the KeyInfo.
    gen.KeyInfoType = "X509Data";
    gen.X509Type = "Certificate";

    // Note: Because our certificate was loaded from a JKS which also contained the private key,
    // Chilkat automatically knows and has the private key associated with the certificate.
    // We set bUsePrivateKey to tell the SetX509Cert method to automatically use the private key
    // associated with the certificate for signing.
    var bUsePrivateKey = true;
    success = gen.SetX509Cert(cert,bUsePrivateKey);
    if (success !== true) {
        console.log(gen.LastErrorText);

        return;
    }

    // Everything's specified.  Now create and insert the Signature
    var sbXml = new chilkat.StringBuilder();
    xml.GetXmlSb(sbXml);
    success = gen.CreateXmlDSigSb(sbXml);
    if (success !== true) {
        console.log(gen.LastErrorText);
        return;
    }

    // Examine the XML with the digital signature inserted
    console.log(sbXml.GetAsString());

}

chilkatExample();