(Unicode C) XML-DSig Add Reference with Transforms Specified Explicitly

Demonstrates how to use the new AddSameDocRef2 method to explicitly specify the XML Transforms fragment.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkXmlW.h>
#include <C_CkXmlDSigGenW.h>
#include <C_CkCertW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkXmlDSigW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkXmlW xmlToSign;
    HCkXmlDSigGenW gen;
    HCkXmlW object1;
    HCkXmlW xml1;
    HCkCertW cert;
    HCkStringBuilderW sbXml;
    HCkXmlDSigW verifier;
    int numSigs;
    int verifyIdx;
    BOOL verified;

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

    success = TRUE;

    // Create the following XML to be signed:

    // <doc>
    //     <s id="s1">Some text...</s>
    //     <p>Some text...</p>
    //     <p class="note">A note...</p>
    // </doc>

    // Use this online tool to generate code from sample XML: 
    // Generate Code to Create XML

    xmlToSign = CkXmlW_Create();
    CkXmlW_putTag(xmlToSign,L"doc");
    CkXmlW_UpdateAttrAt(xmlToSign,L"s",TRUE,L"id",L"s1");
    CkXmlW_UpdateChildContent(xmlToSign,L"s",L"Some text...");
    CkXmlW_UpdateChildContent(xmlToSign,L"p",L"Some text...");
    CkXmlW_UpdateAttrAt(xmlToSign,L"p[1]",TRUE,L"class",L"note");
    CkXmlW_UpdateChildContent(xmlToSign,L"p[1]",L"A note...");

    wprintf(L"%s\n",CkXmlW_getXml(xmlToSign));

    gen = CkXmlDSigGenW_Create();

    CkXmlDSigGenW_putSigLocation(gen,L"doc");
    CkXmlDSigGenW_putSigLocationMod(gen,0);
    CkXmlDSigGenW_putSigId(gen,L"Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature");
    CkXmlDSigGenW_putSigNamespacePrefix(gen,L"ds");
    CkXmlDSigGenW_putSigNamespaceUri(gen,L"http://www.w3.org/2000/09/xmldsig#");
    CkXmlDSigGenW_putSigValueId(gen,L"Signature-78f29839-06af-448f-b479-ca46457fab1b-SignatureValue");
    CkXmlDSigGenW_putSignedInfoCanonAlg(gen,L"C14N");
    CkXmlDSigGenW_putSignedInfoDigestMethod(gen,L"sha1");

    // Set the KeyInfoId before adding references..
    CkXmlDSigGenW_putKeyInfoId(gen,L"Signature-78f29839-06af-448f-b479-ca46457fab1b-KeyInfo");

    // The following XML to be added as an Object to the Signature

    // Use this online tool to generate code from sample XML: 
    // Generate Code to Create XML

    // <xades:QualifyingProperties Id="Signature-78f29839-06af-448f-b479-ca46457fab1b-QualifyingProperties" Target="#Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xades="http://uri.etsi.org/01903/v1.3.2#">
    //     <xades:SignedProperties Id="Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties">
    //         <xades:SignedSignatureProperties>
    //             <xades:SigningTime>TO BE GENERATED BY CHILKAT</xades:SigningTime>
    //             <xades:SigningCertificate>
    //                 <xades:Cert>
    //                     <xades:CertDigest>
    //                         <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
    //                         <ds:DigestValue>TO BE GENERATED BY CHILKAT</ds:DigestValue>
    //                     </xades:CertDigest>
    //                     <xades:IssuerSerial>
    //                         <ds:X509IssuerName>TO BE GENERATED BY CHILKAT</ds:X509IssuerName>
    //                         <ds:X509SerialNumber>TO BE GENERATED BY CHILKAT</ds:X509SerialNumber>
    //                     </xades:IssuerSerial>
    //                 </xades:Cert>
    //             </xades:SigningCertificate>
    //         </xades:SignedSignatureProperties>
    //         <xades:SignedDataObjectProperties>
    //             <xades:DataObjectFormat ObjectReference="#Reference-24eb6003-d41c-442c-a731-d4c58f94790b">
    //                 <xades:Description/>
    //                 <xades:ObjectIdentifier>
    //                     <xades:Identifier Qualifier="OIDAsURN">urn:oid:1.2.840.10003.5.109.10</xades:Identifier>
    //                     <xades:Description/>
    //                 </xades:ObjectIdentifier>
    //                 <xades:MimeType>text/xml</xades:MimeType>
    //                 <xades:Encoding/>
    //             </xades:DataObjectFormat>
    //         </xades:SignedDataObjectProperties>
    //     </xades:SignedProperties>
    // </xades:QualifyingProperties>

    object1 = CkXmlW_Create();
    CkXmlW_putTag(object1,L"xades:QualifyingProperties");
    CkXmlW_AddAttribute(object1,L"Id",L"Signature-78f29839-06af-448f-b479-ca46457fab1b-QualifyingProperties");
    CkXmlW_AddAttribute(object1,L"Target",L"#Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature");
    CkXmlW_AddAttribute(object1,L"xmlns:ds",L"http://www.w3.org/2000/09/xmldsig#");
    CkXmlW_AddAttribute(object1,L"xmlns:xades",L"http://uri.etsi.org/01903/v1.3.2#");
    CkXmlW_UpdateAttrAt(object1,L"xades:SignedProperties",TRUE,L"Id",L"Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime",L"TO BE GENERATED BY CHILKAT");
    // Note: It may be that http://www.w3.org/2001/04/xmlenc#sha256 is needed in the following line instead of http://www.w3.org/2000/09/xmldsig#sha1
    CkXmlW_UpdateAttrAt(object1,L"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:CertDigest|ds:DigestMethod",TRUE,L"Algorithm",L"http://www.w3.org/2000/09/xmldsig#sha1");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:CertDigest|ds:DigestValue",L"TO BE GENERATED BY CHILKAT");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:IssuerSerial|ds:X509IssuerName",L"TO BE GENERATED BY CHILKAT");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:IssuerSerial|ds:X509SerialNumber",L"TO BE GENERATED BY CHILKAT");
    CkXmlW_UpdateAttrAt(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat",TRUE,L"ObjectReference",L"#Reference-24eb6003-d41c-442c-a731-d4c58f94790b");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description",L"");
    CkXmlW_UpdateAttrAt(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier",TRUE,L"Qualifier",L"OIDAsURN");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier",L"urn:oid:1.2.840.10003.5.109.10");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Description",L"");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType",L"text/xml");
    CkXmlW_UpdateChildContent(object1,L"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Encoding",L"");

    wprintf(L"%s\n",CkXmlW_getXml(object1));

    CkXmlDSigGenW_AddObject(gen,L"",CkXmlW_getXml(object1),L"",L"");

    // -------- Reference 1 --------

    // Create the following Transforms fragment:

    // Use this online tool to generate code from sample XML: 
    // Generate Code to Create XML

    // <ds:Transforms>
    //     <ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
    //     <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
    //     <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
    //         <ds:XPath xmlns:ds="http://www.w3.org/2000/09/xmldsig#">not(ancestor-or-self::ds:Signature)</ds:XPath>
    //     </ds:Transform>
    // </ds:Transforms>

    xml1 = CkXmlW_Create();
    CkXmlW_putTag(xml1,L"ds:Transforms");
    CkXmlW_UpdateAttrAt(xml1,L"ds:Transform",TRUE,L"Algorithm",L"http://www.w3.org/TR/2001/REC-xml-c14n-20010315");
    CkXmlW_UpdateAttrAt(xml1,L"ds:Transform[1]",TRUE,L"Algorithm",L"http://www.w3.org/2000/09/xmldsig#enveloped-signature");
    CkXmlW_UpdateAttrAt(xml1,L"ds:Transform[2]",TRUE,L"Algorithm",L"http://www.w3.org/TR/1999/REC-xpath-19991116");
    CkXmlW_UpdateAttrAt(xml1,L"ds:Transform[2]|ds:XPath",TRUE,L"xmlns:ds",L"http://www.w3.org/2000/09/xmldsig#");
    CkXmlW_UpdateChildContent(xml1,L"ds:Transform[2]|ds:XPath",L"not(ancestor-or-self::ds:Signature)");

    // This is the "Transforms" XML fragment passed to AddSameDocRef2.
    wprintf(L"%s\n",CkXmlW_getXml(xml1));

    CkXmlDSigGenW_AddSameDocRef2(gen,L"",L"sha1",xml1,L"");

    CkXmlDSigGenW_SetRefIdAttr(gen,L"",L"Reference-24eb6003-d41c-442c-a731-d4c58f94790b");

    // -------- Reference 2 --------
    CkXmlDSigGenW_AddObjectRef(gen,L"Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties",L"sha1",L"",L"",L"http://uri.etsi.org/01903#SignedProperties");

    // -------- Reference 3 --------
    CkXmlDSigGenW_AddSameDocRef(gen,L"Signature-78f29839-06af-448f-b479-ca46457fab1b-KeyInfo",L"sha1",L"",L"",L"");

    // Provide a certificate + private key. (PFX password is test123)
    cert = CkCertW_Create();
    success = CkCertW_LoadPfxFile(cert,L"qa_data/pfx/cert_test123.pfx",L"test123");
    if (success != TRUE) {
        wprintf(L"%s\n",CkCertW_lastErrorText(cert));
        CkXmlW_Dispose(xmlToSign);
        CkXmlDSigGenW_Dispose(gen);
        CkXmlW_Dispose(object1);
        CkXmlW_Dispose(xml1);
        CkCertW_Dispose(cert);
        return;
    }

    CkXmlDSigGenW_SetX509Cert(gen,cert,TRUE);

    CkXmlDSigGenW_putKeyInfoType(gen,L"X509Data+KeyValue");
    CkXmlDSigGenW_putX509Type(gen,L"CertChain");

    // Load XML to be signed...
    sbXml = CkStringBuilderW_Create();
    CkXmlW_GetXmlSb(xmlToSign,sbXml);

    CkXmlDSigGenW_putBehaviors(gen,L"IndentedSignature");

    // Sign the XML...
    success = CkXmlDSigGenW_CreateXmlDSigSb(gen,sbXml);
    if (success != TRUE) {
        wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
        CkXmlW_Dispose(xmlToSign);
        CkXmlDSigGenW_Dispose(gen);
        CkXmlW_Dispose(object1);
        CkXmlW_Dispose(xml1);
        CkCertW_Dispose(cert);
        CkStringBuilderW_Dispose(sbXml);
        return;
    }

    // -----------------------------------------------

    // Save the signed XML to a file.
    success = CkStringBuilderW_WriteFile(sbXml,L"qa_output/signedXml.xml",L"utf-8",FALSE);

    wprintf(L"%s\n",CkStringBuilderW_getAsString(sbXml));

    // ----------------------------------------
    // Verify the signatures we just produced...
    verifier = CkXmlDSigW_Create();
    success = CkXmlDSigW_LoadSignatureSb(verifier,sbXml);
    if (success != TRUE) {
        wprintf(L"%s\n",CkXmlDSigW_lastErrorText(verifier));
        CkXmlW_Dispose(xmlToSign);
        CkXmlDSigGenW_Dispose(gen);
        CkXmlW_Dispose(object1);
        CkXmlW_Dispose(xml1);
        CkCertW_Dispose(cert);
        CkStringBuilderW_Dispose(sbXml);
        CkXmlDSigW_Dispose(verifier);
        return;
    }

    numSigs = CkXmlDSigW_getNumSignatures(verifier);
    verifyIdx = 0;
    while (verifyIdx < numSigs) {
        CkXmlDSigW_putSelector(verifier,verifyIdx);
        verified = CkXmlDSigW_VerifySignature(verifier,TRUE);
        if (verified != TRUE) {
            wprintf(L"%s\n",CkXmlDSigW_lastErrorText(verifier));
            CkXmlW_Dispose(xmlToSign);
            CkXmlDSigGenW_Dispose(gen);
            CkXmlW_Dispose(object1);
            CkXmlW_Dispose(xml1);
            CkCertW_Dispose(cert);
            CkStringBuilderW_Dispose(sbXml);
            CkXmlDSigW_Dispose(verifier);
            return;
        }

        verifyIdx = verifyIdx + 1;
    }

    wprintf(L"All signatures were successfully verified.\n");


    CkXmlW_Dispose(xmlToSign);
    CkXmlDSigGenW_Dispose(gen);
    CkXmlW_Dispose(object1);
    CkXmlW_Dispose(xml1);
    CkCertW_Dispose(cert);
    CkStringBuilderW_Dispose(sbXml);
    CkXmlDSigW_Dispose(verifier);

    }