Java

Create/Verify XML Signature with External Text Reference

See more XML Digital Signatures Examples

Demonstrates how to create an XML digital signature where the referenced data is external. In this case, the data is a text file located at the following URL: https://www.chilkatsoft.com/helloWorld.txt Chilkat2 Java

import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.StringBuilder;
import com.chilkatsoft.chilkat2.Xml;
import com.chilkatsoft.chilkat2.XmlDSig;
import com.chilkatsoft.chilkat2.XmlDSigGen;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        // This example inserts an XML signature into the following XML:

        // <?xml version="1.0" encoding="UTF-8" standalone="no"?>
        // <abc>
        //   <xyz>
        //     <name>helloWorld.txt</name>
        //     <url>https://www.chilkatsoft.com/helloWorld.txt</url>
        //   </xyz>
        // </abc>

        // Build the above XML to be signed.
        Xml xml = new Xml();
        xml.setTag("abc");
        xml.updateChildContent("xyz|name", "helloWorld.txt");
        xml.updateChildContent("xyz|url", "https://www.chilkatsoft.com/helloWorld.txt");

        Cert cert = new Cert();

        try {
            cert.loadPfxFile("qa_data/pfx/test_secret.pfx", "secret");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        XmlDSigGen gen = new XmlDSigGen();

        // Indicate the location within the XML the Signature will be inserted.
        gen.setSigLocation("abc|xyz");

        // Get the content of the text data to be referenced.
        Http http = new Http();
        StringBuilder sbExternalTxt = new StringBuilder();
        try {
            http.quickGetSb("https://www.chilkatsoft.com/helloWorld.txt", sbExternalTxt);

            gen.addExternalTextRef("https://www.chilkatsoft.com/helloWorld.txt", sbExternalTxt, "utf-8", false, "sha256", "");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // 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");

        boolean bUsePrivateKey = true;
        try {
            gen.setX509Cert(cert, bUsePrivateKey);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Indicate we want an indented signature for readability.
        // This can be removed after debugging is finished..
        gen.setBehaviors("IndentedSignature");

        // Now create and insert the Signature
        StringBuilder sbXml = new StringBuilder();
        xml.getXmlSb(sbXml);
        try {
            gen.createXmlDSigSb(sbXml);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Examine the XML with the digital signature inserted
        System.out.println(sbXml.getAsString());

        // Here is the output:

        // <?xml version="1.0" encoding="utf-8"?>
        // <abc>
        //     <xyz>
        //         <name>helloWorld.txt</name>
        //         <url>https://www.chilkatsoft.com/helloWorld.txt</url>
        //     <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        //   <ds:SignedInfo>
        //     <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
        //     <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
        //     <ds:Reference URI="https://www.chilkatsoft.com/helloWorld.txt">
        //       <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
        //       <ds:DigestValue>f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=</ds:DigestValue>
        //     </ds:Reference>
        //   </ds:SignedInfo>
        //   <ds:SignatureValue>syFSl...pZDiFQ==</ds:SignatureValue>
        //   <ds:KeyInfo>
        //     <ds:X509Data>
        //       <ds:X509Certificate>MIIHAz...GwnUZWCaDE=</ds:X509Certificate>
        //     </ds:X509Data>
        //   </ds:KeyInfo>
        // </ds:Signature></xyz>
        // </abc>

        // Let's verify the signature...
        XmlDSig verifier = new XmlDSig();
        try {
            verifier.loadSignatureSb(sbXml);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Let's examine the external references, and fetch the data for each..
        StringBuilder sbExternalData = new StringBuilder();
        int numRefs = verifier.getNumReferences();
        int i = 0;
        while (i < numRefs) {
            boolean bExternal = verifier.isReferenceExternal(i);
            if (bExternal) {
                String uri = verifier.referenceUri(i);

                // We're assuming the URI is an https:// or http:// URL...
                // Let's also assume we know that the referenced data is text and we want the utf-8 byte representation.
                sbExternalData.clear();
                try {
                    http.quickGetSb(uri, sbExternalData);

                    verifier.setRefDataSb(i, sbExternalData, "utf-8");
                } catch (ChilkatException e) {
                    System.out.println(e.getLastErrorText());
                    return;
                }
            }

            i = i + 1;
        }

        // Now that we have the external data available, we can verify the reference digest(s) and the signature.
        try {
            verifier.verifySignature(true);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Signature verified!");
    }
}