Unicode C++

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) Unicode C++

#include <CkXmlW.h>
#include <CkJavaKeyStoreW.h>
#include <CkCertChainW.h>
#include <CkCertW.h>
#include <CkXmlDSigGenW.h>
#include <CkStringBuilderW.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkXmlW xml;
    xml.put_Tag(L"SOAP-ENV:Envelope");
    xml.AddAttribute(L"xmlns:SOAP-ENV",L"http://schemas.xmlsoap.org/soap/envelope/");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|wsse:Security",true,L"xmlns:wsse",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|wsse:Security",true,L"SOAP-ENV:mustUnderstand",L"1");
    xml.UpdateAttrAt(L"SOAP-ENV:Body",true,L"xmlns:SOAP-SEC",L"http://schemas.xmlsoap.org/soap/security/2000-12");
    xml.UpdateAttrAt(L"SOAP-ENV:Body",true,L"SOAP-SEC:id",L"Body");
    xml.UpdateAttrAt(L"SOAP-ENV:Body|z:FooBar",true,L"xmlns:z",L"http://example.com");

    // Load a JavaKeyStore file containing the certificate + private key.
    CkJavaKeyStoreW jks;
    const wchar_t *password = L"secret";
    success = jks.LoadFile(password,L"qa_data/jks/test_secret.jks");
    if (success == false) {
        wprintf(L"%s\n",jks.lastErrorText());
        return;
    }

    // Make sure we have a private key.
    if (jks.get_NumPrivateKeys() < 1) {
        wprintf(L"No private key available.\n");
        return;
    }

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

    CkCertChainW chain;
    success = jks.CertChainAt(0,chain);
    if (success == false) {
        wprintf(L"%s\n",jks.lastErrorText());
        return;
    }

    CkCertW cert;
    success = chain.CertAt(0,cert);
    if (success == false) {
        wprintf(L"%s\n",chain.lastErrorText());
        return;
    }

    // Verify again that this cert has a private key.
    if (cert.HasPrivateKey() != true) {
        wprintf(L"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
    CkXmlDSigGenW gen;

    // Indicate where the Signature will be inserted.
    gen.put_SigLocation(L"SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security");

    // Add a reference to the fragment of the XML to be signed.
    gen.AddSameDocRef(L"Body",L"sha1",L"EXCL_C14N",L"",L"");

    // (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
    gen.put_SignedInfoPrefixList(L"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.put_KeyInfoType(L"X509Data");
    gen.put_X509Type(L"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.
    bool bUsePrivateKey = true;
    success = gen.SetX509Cert(cert,bUsePrivateKey);
    if (success != true) {
        wprintf(L"%s\n",gen.lastErrorText());
        return;
    }

    // Everything's specified.  Now create and insert the Signature
    CkStringBuilderW sbXml;
    xml.GetXmlSb(sbXml);
    success = gen.CreateXmlDSigSb(sbXml);
    if (success == false) {
        wprintf(L"%s\n",gen.lastErrorText());
        return;
    }

    // Examine the XML with the digital signature inserted
    wprintf(L"%s\n",sbXml.getAsString());
    }