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

Demonstrates how to use the new AddObjectRef2 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_CkXml.h>
#include <C_CkXmlDSigGen.h>
#include <C_CkCert.h>
#include <C_CkStringBuilder.h>
#include <C_CkXmlDSig.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkXml xmlToSign;
    HCkXmlDSigGen gen;
    HCkXml object1;
    HCkXml xml1;
    HCkXml xml2;
    HCkCert cert;
    HCkStringBuilder sbXml;
    HCkXmlDSig 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;

    // Build the following XML to be signed:

    // <?xml version="1.0" encoding="utf-8"?>
    // <InitUpload xmlns="http://e-dokumenty.mf.gov.pl">
    //     <DocumentType>JPK</DocumentType>
    //     <Version>01.02.01.20160617</Version>
    //     <EncryptionKey algorithm="RSA" encoding="Base64" mode="ECB" padding="PKCS#1">xxxx</EncryptionKey>
    //     <DocumentList>
    //         <Document>
    //             <FormCode schemaVersion="1-1" systemCode="JPK_VAT (3)">JPK_VAT</FormCode>
    //             <FileName>JPK_VAT_3_v1-1_20181201.xml</FileName>
    //             <ContentLength>8736</ContentLength>
    //             <HashValue algorithm="SHA-256" encoding="Base64">JEDI1pItwh6dj/Xx1uts/x61qnjZ4DLHpkZMhmf1oKQ=</HashValue>
    //             <FileSignatureList filesNumber="1">
    //                 <Packaging>
    //                     <SplitZip mode="zip" type="split"/>
    //                 </Packaging>
    //                 <Encryption>
    //                     <AES block="16" mode="CBC" padding="PKCS#7" size="256">
    //                         <IV bytes="16" encoding="Base64">z64oN9zXHt1+S3XACRSCYw==</IV>
    //                     </AES>
    //                 </Encryption>
    //                 <FileSignature>
    //                     <OrdinalNumber>1</OrdinalNumber>
    //                     <FileName>JPK_VAT_3_v1-1_20181201-000.xml.zip.aes</FileName>
    //                     <ContentLength>16</ContentLength>
    //                     <HashValue algorithm="MD5" encoding="Base64">5MX0q1935fvMjLFV7E1yDw==</HashValue>
    //                 </FileSignature>
    //             </FileSignatureList>
    //         </Document>
    //     </DocumentList>
    // </InitUpload>

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

    xmlToSign = CkXml_Create();
    CkXml_putTag(xmlToSign,"InitUpload");
    CkXml_AddAttribute(xmlToSign,"xmlns","http://e-dokumenty.mf.gov.pl");
    CkXml_UpdateChildContent(xmlToSign,"DocumentType","JPK");
    CkXml_UpdateChildContent(xmlToSign,"Version","01.02.01.20160617");
    CkXml_UpdateAttrAt(xmlToSign,"EncryptionKey",TRUE,"algorithm","RSA");
    CkXml_UpdateAttrAt(xmlToSign,"EncryptionKey",TRUE,"encoding","Base64");
    CkXml_UpdateAttrAt(xmlToSign,"EncryptionKey",TRUE,"mode","ECB");
    CkXml_UpdateAttrAt(xmlToSign,"EncryptionKey",TRUE,"padding","PKCS#1");
    CkXml_UpdateChildContent(xmlToSign,"EncryptionKey","xxxx");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FormCode",TRUE,"schemaVersion","1-1");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FormCode",TRUE,"systemCode","JPK_VAT (3)");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FormCode","JPK_VAT");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FileName","JPK_VAT_3_v1-1_20181201.xml");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|ContentLength","8736");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|HashValue",TRUE,"algorithm","SHA-256");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|HashValue",TRUE,"encoding","Base64");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|HashValue","JEDI1pItwh6dj/Xx1uts/x61qnjZ4DLHpkZMhmf1oKQ=");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList",TRUE,"filesNumber","1");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Packaging|SplitZip",TRUE,"mode","zip");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Packaging|SplitZip",TRUE,"type","split");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES",TRUE,"block","16");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES",TRUE,"mode","CBC");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES",TRUE,"padding","PKCS#7");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES",TRUE,"size","256");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES|IV",TRUE,"bytes","16");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES|IV",TRUE,"encoding","Base64");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FileSignatureList|Encryption|AES|IV","z64oN9zXHt1+S3XACRSCYw==");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FileSignatureList|FileSignature|OrdinalNumber","1");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FileSignatureList|FileSignature|FileName","JPK_VAT_3_v1-1_20181201-000.xml.zip.aes");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FileSignatureList|FileSignature|ContentLength","16");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|FileSignature|HashValue",TRUE,"algorithm","MD5");
    CkXml_UpdateAttrAt(xmlToSign,"DocumentList|Document|FileSignatureList|FileSignature|HashValue",TRUE,"encoding","Base64");
    CkXml_UpdateChildContent(xmlToSign,"DocumentList|Document|FileSignatureList|FileSignature|HashValue","5MX0q1935fvMjLFV7E1yDw==");

    gen = CkXmlDSigGen_Create();

    CkXmlDSigGen_putSigLocation(gen,"InitUpload");
    CkXmlDSigGen_putSigLocationMod(gen,0);
    CkXmlDSigGen_putSigId(gen,"id-1234");
    CkXmlDSigGen_putSigNamespacePrefix(gen,"ds");
    CkXmlDSigGen_putSigNamespaceUri(gen,"http://www.w3.org/2000/09/xmldsig#");
    CkXmlDSigGen_putSignedInfoCanonAlg(gen,"EXCL_C14N");
    CkXmlDSigGen_putSignedInfoDigestMethod(gen,"sha256");

    // Create an Object to be added to the Signature.

    // <xades:QualifyingProperties Target="#id-1234" xmlns:xades="http://uri.etsi.org/01903/v1.3.2#">
    //     <xades:SignedProperties Id="xades-id-1234">
    //         <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="#r-id-1">
    //                 <xades:MimeType>text/xml</xades:MimeType>
    //             </xades:DataObjectFormat>
    //         </xades:SignedDataObjectProperties>
    //     </xades:SignedProperties>
    // </xades:QualifyingProperties>

    object1 = CkXml_Create();
    CkXml_putTag(object1,"xades:QualifyingProperties");
    CkXml_AddAttribute(object1,"xmlns:xades","http://uri.etsi.org/01903/v1.3.2#");
    CkXml_AddAttribute(object1,"Target","#id-1234");
    CkXml_UpdateAttrAt(object1,"xades:SignedProperties",TRUE,"Id","xades-id-1234");
    // 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
    CkXml_UpdateChildContent(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime","TO BE GENERATED BY CHILKAT");
    CkXml_UpdateAttrAt(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod",TRUE,"Algorithm","http://www.w3.org/2000/09/xmldsig#sha1");
    CkXml_UpdateChildContent(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue","TO BE GENERATED BY CHILKAT");
    CkXml_UpdateChildContent(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2","TO BE GENERATED BY CHILKAT");
    CkXml_UpdateAttrAt(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat",TRUE,"ObjectReference","#r-id-1");
    CkXml_UpdateChildContent(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType","text/xml");

    CkXmlDSigGen_AddObject(gen,"",CkXml_getXml(object1),"","");

    // -------- Reference 1 --------
    // Build the following Transforms fragment:

    // <ds:Transforms>
    //     <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
    //         <ds:XPath>not(ancestor-or-self::ds:Signature)</ds:XPath>
    //     </ds:Transform>
    //     <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
    // </ds:Transforms>

    xml1 = CkXml_Create();
    CkXml_putTag(xml1,"ds:Transforms");
    CkXml_UpdateAttrAt(xml1,"ds:Transform",TRUE,"Algorithm","http://www.w3.org/TR/1999/REC-xpath-19991116");
    CkXml_UpdateChildContent(xml1,"ds:Transform|ds:XPath","not(ancestor-or-self::ds:Signature)");
    CkXml_UpdateAttrAt(xml1,"ds:Transform[1]",TRUE,"Algorithm","http://www.w3.org/2001/10/xml-exc-c14n#");

    CkXmlDSigGen_AddSameDocRef2(gen,"","sha256",xml1,"");
    CkXmlDSigGen_SetRefIdAttr(gen,"","r-id-1");

    // -------- Reference 2 --------
    // Build the following Transforms fragment:

    // <ds:Transforms>
    //     <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
    // </ds:Transforms>

    xml2 = CkXml_Create();
    CkXml_putTag(xml2,"ds:Transforms");
    CkXml_UpdateAttrAt(xml2,"ds:Transform",TRUE,"Algorithm","http://www.w3.org/2001/10/xml-exc-c14n#");

    CkXmlDSigGen_AddObjectRef2(gen,"xades-id-1234","sha256",xml2,"http://uri.etsi.org/01903#SignedProperties");

    // Provide a certificate + private key. (PFX password is test123)
    cert = CkCert_Create();
    success = CkCert_LoadPfxFile(cert,"qa_data/pfx/cert_test123.pfx","test123");
    if (success != TRUE) {
        printf("%s\n",CkCert_lastErrorText(cert));
        CkXml_Dispose(xmlToSign);
        CkXmlDSigGen_Dispose(gen);
        CkXml_Dispose(object1);
        CkXml_Dispose(xml1);
        CkXml_Dispose(xml2);
        CkCert_Dispose(cert);
        return;
    }

    CkXmlDSigGen_SetX509Cert(gen,cert,TRUE);

    CkXmlDSigGen_putKeyInfoType(gen,"X509Data");
    CkXmlDSigGen_putX509Type(gen,"Certificate");

    // Load XML to be signed...
    sbXml = CkStringBuilder_Create();
    CkXml_GetXmlSb(xmlToSign,sbXml);

    CkXmlDSigGen_putBehaviors(gen,"IndentedSignature");

    // Sign the XML...
    success = CkXmlDSigGen_CreateXmlDSigSb(gen,sbXml);
    if (success != TRUE) {
        printf("%s\n",CkXmlDSigGen_lastErrorText(gen));
        CkXml_Dispose(xmlToSign);
        CkXmlDSigGen_Dispose(gen);
        CkXml_Dispose(object1);
        CkXml_Dispose(xml1);
        CkXml_Dispose(xml2);
        CkCert_Dispose(cert);
        CkStringBuilder_Dispose(sbXml);
        return;
    }

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

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

    printf("%s\n",CkStringBuilder_getAsString(sbXml));

    // ----------------------------------------
    // Verify the signatures we just produced...
    verifier = CkXmlDSig_Create();
    success = CkXmlDSig_LoadSignatureSb(verifier,sbXml);
    if (success != TRUE) {
        printf("%s\n",CkXmlDSig_lastErrorText(verifier));
        CkXml_Dispose(xmlToSign);
        CkXmlDSigGen_Dispose(gen);
        CkXml_Dispose(object1);
        CkXml_Dispose(xml1);
        CkXml_Dispose(xml2);
        CkCert_Dispose(cert);
        CkStringBuilder_Dispose(sbXml);
        CkXmlDSig_Dispose(verifier);
        return;
    }

    numSigs = CkXmlDSig_getNumSignatures(verifier);
    verifyIdx = 0;
    while (verifyIdx < numSigs) {
        CkXmlDSig_putSelector(verifier,verifyIdx);
        verified = CkXmlDSig_VerifySignature(verifier,TRUE);
        if (verified != TRUE) {
            printf("%s\n",CkXmlDSig_lastErrorText(verifier));
            CkXml_Dispose(xmlToSign);
            CkXmlDSigGen_Dispose(gen);
            CkXml_Dispose(object1);
            CkXml_Dispose(xml1);
            CkXml_Dispose(xml2);
            CkCert_Dispose(cert);
            CkStringBuilder_Dispose(sbXml);
            CkXmlDSig_Dispose(verifier);
            return;
        }

        verifyIdx = verifyIdx + 1;
    }

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


    CkXml_Dispose(xmlToSign);
    CkXmlDSigGen_Dispose(gen);
    CkXml_Dispose(object1);
    CkXml_Dispose(xml1);
    CkXml_Dispose(xml2);
    CkCert_Dispose(cert);
    CkStringBuilder_Dispose(sbXml);
    CkXmlDSig_Dispose(verifier);

    }