Java Requires Chilkat v11.0.0+

Create Enveloping XML Digital Signature

See more XML Digital Signatures Examples

This example creates an enveloping digital signature.
An enveloping signature is where the signed data is contained within the Signature within an Object element.
This example signs non-XML text data where the XML signature constitutes the entire output. Chilkat2 Java

import com.chilkatsoft.chilkat2.BinData;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.PrivateKey;
import com.chilkatsoft.chilkat2.StringBuilder;
import com.chilkatsoft.chilkat2.XmlDSigGen;
import com.chilkatsoft.chilkat2.Zip;
import com.chilkatsoft.chilkat2.ZipEntry;

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.

        // Let's use the ECDSA private key at https://www.chilkatsoft.com/exampleData/secp256r1-key.zip
        // for signing.
        Http http = new Http();
        BinData zipFile = new BinData();
        String keyUrl = "https://www.chilkatsoft.com/exampleData/secp256r1-key.zip";

        try {
            http.quickGetBd(keyUrl, zipFile);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        Zip zip = new Zip();
        zip.openBd(zipFile);

        ZipEntry entry = new ZipEntry();
        try {
            zip.entryMatching("*.pem", entry);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        PrivateKey ecKey = new PrivateKey();
        try {
            ecKey.loadPem(entry.unzipToString(0, "utf-8"));
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // ----------------------------------------------------------------------------
        XmlDSigGen gen = new XmlDSigGen();

        // Provide the ECDSA key to the XML Digital Signature generator
        gen.setPrivateKey(ecKey);

        // Add an enveloped reference to the content to be signed.
        StringBuilder sbContent = new StringBuilder();
        sbContent.append("This is the content that is signed.");
        gen.addEnvelopedRef("abc123", sbContent, "sha256", "C14N", "");

        // Generate the XML digital signature.
        // Notice that in other examples, the sbXml passed to CreateXmlDSigSb
        // already contains XML, and the XML signature is inserted at the location
        // specified by the SigLocation property.  In this case, both SigLocation
        // and sbXml are empty.  The result is that sbXml will contain just the Signature.
        StringBuilder sbXml = new StringBuilder();
        try {
            gen.createXmlDSigSb(sbXml);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Examine the enveloped signature, where the data is contained within the XML Signature
        System.out.println(sbXml.getAsString());

        // The Signature returned is compact and in a single line, like this:
        // <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#ecdsa-sha256"/><ds:Reference URI="#abc123"><ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>tEVrbXXjeTXjF3tIojul4/sgeEGN49E1dxr/GMs8GNE=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>/pILUshwrzgdGc4bPgp85TDfbUiM9pn8EIPNRVWKuoVEtPsv4XRthUrv9aDDvajmyl2okLwTakANgtaxO1ULMw==</ds:SignatureValue><ds:KeyInfo><ds:KeyValue><ds:ECKeyValue xmlns="http://www.w3.org/2009/xmldsig11#"><ds:NamedCurve URI="urn:oid:1.2.840.10045.3.1.7" /><ds:PublicKey>BOVKaiLPKEDChhkA64UEBOXTv/VFHnhrUPN+bXqCvEl7rroAYpH5tKzbiGTtMSlp4JO9Pxg44zeX7EoWDvOrpD0=</ds:PublicKey></ds:ECKeyValue></ds:KeyValue></ds:KeyInfo><ds:Object Id="abc123">This is the content that is signed.</ds:Object></ds:Signature>

        // XML pretty-printed, the signature is as follows, but pretty-printing introductes whitespace that breaks the signature..

        // <?xml version="1.0" encoding="utf-8" ?>
        // <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#ecdsa-sha256" />
        //         <ds:Reference URI="#abc123">
        //             <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" />
        //             <ds:DigestValue>tEVrbXXjeTXjF3tIojul4/sgeEGN49E1dxr/GMs8GNE=</ds:DigestValue>
        //         </ds:Reference>
        //     </ds:SignedInfo>
        //     <ds:SignatureValue>/pILUshwrzgdGc4bPgp85TDfbUiM9pn8EIPNRVWKuoVEtPsv4XRthUrv9aDDvajmyl2okLwTakANgtaxO1ULMw==</ds:SignatureValue>
        //     <ds:KeyInfo>
        //         <ds:KeyValue>
        //             <ds:ECKeyValue xmlns="http://www.w3.org/2009/xmldsig11#">
        //                 <ds:NamedCurve URI="urn:oid:1.2.840.10045.3.1.7" />
        //                 <ds:PublicKey>BOVKaiLPKEDChhkA64UEBOXTv/VFHnhrUPN+bXqCvEl7rroAYpH5tKzbiGTtMSlp4JO9Pxg44zeX7EoWDvOrpD0=</ds:PublicKey>
        //             </ds:ECKeyValue>
        //         </ds:KeyValue>
        //     </ds:KeyInfo>
        //     <ds:Object Id="abc123">This is the content that is signed.</ds:Object>
        // </ds:Signature>
        //
    }
}