Zig Requires Chilkat v11.0.0+

Create XML Signature using Java KeyStore (.jks)

See more XML Digital Signatures Examples

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

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

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

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

    const xml = try chilkat.Xml.init();
    defer xml.deinit();
    xml.setTag("SOAP-ENV:Envelope");
    xml.addAttribute("xmlns:SOAP-ENV", "http://schemas.xmlsoap.org/soap/envelope/") catch {};
    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") catch {};
    xml.updateAttrAt("SOAP-ENV:Header|wsse:Security", true, "SOAP-ENV:mustUnderstand", "1") catch {};
    xml.updateAttrAt("SOAP-ENV:Body", true, "xmlns:SOAP-SEC", "http://schemas.xmlsoap.org/soap/security/2000-12") catch {};
    xml.updateAttrAt("SOAP-ENV:Body", true, "SOAP-SEC:id", "Body") catch {};
    xml.updateAttrAt("SOAP-ENV:Body|z:FooBar", true, "xmlns:z", "http://example.com") catch {};

    // Load a JavaKeyStore file containing the certificate + private key.
    const jks = try chilkat.JavaKeyStore.init();
    defer jks.deinit();
    const password = "secret";
    jks.loadFile(password, "qa_data/jks/test_secret.jks") catch {
        std.debug.print("{s}\n", .{try jks.getLastErrorText(alloc)});
        return;
    };

    // Make sure we have a private key.
    if (jks.getNumPrivateKeys() < 1) {
        std.debug.print("No private key available.\n", .{});
        return;
    }

    // -------------------------------------------------------------------------
    // Get the certificate chain associated with the 1st (and probably only) private key in the JKS.

    const chain = try chilkat.CertChain.init();
    defer chain.deinit();
    jks.certChainAt(0, chain) catch {
        std.debug.print("{s}\n", .{try jks.getLastErrorText(alloc)});
        return;
    };

    const cert = try chilkat.Cert.init();
    defer cert.deinit();
    chain.certAt(0, cert) catch {
        std.debug.print("{s}\n", .{try chain.getLastErrorText(alloc)});
        return;
    };

    // Verify again that this cert has a private key.
    if (!cert.hasPrivateKey()) {
        std.debug.print("Certificate has no associated private key.\n", .{});
        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
    const gen = try chilkat.XmlDSigGen.init();
    defer gen.deinit();

    // Indicate where the Signature will be inserted.
    gen.setSigLocation("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", "", "") catch {};

    // (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
    gen.setSignedInfoPrefixList("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.setKeyInfoType("X509Data");
    gen.setX509Type("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.
    const b_use_private_key = true;
    gen.setX509Cert(cert, b_use_private_key) catch {
        std.debug.print("{s}\n", .{try gen.getLastErrorText(alloc)});
        return;
    };

    // Everything's specified.  Now create and insert the Signature
    const sb_xml = try chilkat.StringBuilder.init();
    defer sb_xml.deinit();
    xml.getXmlSb(sb_xml) catch {};
    gen.createXmlDSigSb(sb_xml) catch {
        std.debug.print("{s}\n", .{try gen.getLastErrorText(alloc)});
        return;
    };

    // Examine the XML with the digital signature inserted
    std.debug.print("{s}\n", .{try sb_xml.getAsString(alloc)});
}