Unicode C++

PKCS11 XML Signature using Certificate and Private Key on Smart Card / USB Token

See more PKCS11 Examples

Sample code showing how to use PKCS11 to create an XML digital signature with a certificate and private key stored on a smart card or USB token.

Note: This example requires Chilkat v9.5.0.96 or later.

Unicode C++

#include <CkPkcs11W.h>
#include <CkCertW.h>
#include <CkXmlW.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.

    // Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

    CkPkcs11W pkcs11;

    // This example is tested on Windows using a Giesecke and Devrient Sm@rtCafe Expert 3.2 smart card.
    // You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
    // On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
    // Otherwise provide the full path.
    pkcs11.put_SharedLibPath(L"aetpkss1.dll");

    // Make it an authenticated session by calling Login.
    int userType = 1;
    // Make sure to use the correct PIN for your smart card..
    const wchar_t *pin = L"0000";

    success = pkcs11.QuickSession(userType,pin);
    if (success == false) {
        wprintf(L"%s\n",pkcs11.lastErrorText());
        return;
    }

    // Get the certificate (on the smart card) that has a private key.
    CkCertW cert;
    success = pkcs11.FindCert(L"privateKey",L"",cert);
    if (success == true) {
        wprintf(L"Cert with private key: %s\n",cert.subjectCN());
    }
    else {
        wprintf(L"No certificates having a private key were found.\n");
        success = pkcs11.CloseSession();
        return;
    }

    // --------------------------------------------------------------------------
    // At this point, we have the cert to be used for signing.
    // Our XML signing code is the same as for a cert obtained from any other source..

    // First generate the following XML to be signed:
    // Use this online tool to generate code from sample XML: 
    // Generate Code to Create XML

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

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

    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.

    // Note: "Body" refers to the XML element having an "id" equal to "Body", where "id" is case insensitive
    // and where any namespace might qualify the attribute.  In this case, the SOAP-ENV:Body fragment is signed
    // NOT because the tag = "Body", but because it has SOAP-SEC:id="Body"
    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");

    bool bUsePrivateKey = true;
    success = gen.SetX509Cert(cert,bUsePrivateKey);
    if (success != true) {
        wprintf(L"%s\n",gen.lastErrorText());
        success = pkcs11.CloseSession();
        return;
    }

    // Everything's specified.  Now create and insert the Signature
    CkStringBuilderW sbXml;
    xml.put_EmitCompact(true);
    xml.GetXmlSb(sbXml);

    success = gen.CreateXmlDSigSb(sbXml);
    if (success != true) {
        wprintf(L"%s\n",gen.lastErrorText());
        success = pkcs11.CloseSession();
        return;
    }

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

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

    // Revert to an unauthenticated session by calling Logout.
    success = pkcs11.Logout();
    if (success == false) {
        wprintf(L"%s\n",pkcs11.lastErrorText());
        success = pkcs11.CloseSession();
        return;
    }

    // When finished, close the session.
    // It is important to close the session (memory leaks will occur if the session is not properly closed).
    success = pkcs11.CloseSession();
    if (success == false) {
        wprintf(L"%s\n",pkcs11.lastErrorText());
        return;
    }

    wprintf(L"Success.\n");
    }