(Unicode C) Create XML Digital Signature using Certificate on Smart Card

See more ScMinidriver Examples

Demonstrates how to load a certificate located on a smart card or USB token and then use it for creating an XML digital signature such that the cryptographic signing happens on the smart card.

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_CkScMinidriverW.h>
#include <C_CkCertW.h>
#include <C_CkXmlW.h>
#include <C_CkXmlDSigGenW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkScMinidriverW scmd;
    const wchar_t *readerName;
    BOOL success;
    int retval;
    const wchar_t *certPart;
    const wchar_t *partValue;
    HCkCertW cert;
    HCkXmlW xml;
    HCkXmlDSigGenW gen;
    BOOL bUsePrivateKey;
    HCkStringBuilderW sbXml;

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

    scmd = CkScMinidriverW_Create();

    // Reader names (smart card readers or USB tokens) can be discovered
    // via List Readers or Find Smart Cards
    readerName = L"SCM Microsystems Inc. SCR33x USB Smart Card Reader 0";
    success = CkScMinidriverW_AcquireContext(scmd,readerName);
    if (success == FALSE) {
        wprintf(L"%s\n",CkScMinidriverW_lastErrorText(scmd));
        CkScMinidriverW_Dispose(scmd);
        return;
    }

    // If successful, the name of the currently inserted smart card is available:
    wprintf(L"Card name: %s\n",CkScMinidriverW_cardName(scmd));

    // If desired, perform regular PIN authentication with the smartcard.
    // For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
    retval = CkScMinidriverW_PinAuthenticate(scmd,L"user",L"000000");
    if (retval != 0) {
        wprintf(L"PIN Authentication failed.\n");
    }

    // You can find a cerficate using any of the following certificate parts:
    // "subjectDN" -- The full distinguished name of the cert.
    // "subjectDN_withTags" -- Same as above, but in a format that includes the subject part tags, such as the "CN=" in "CN=something"
    // "subjectCN" -- The common name part (CN) of the certificate's subject.
    // "serial" -- The certificate serial number.
    // "serial:issuerCN" -- The certificate serial number + the issuer's common name, delimited with a colon char.
    // These are the same certificate parts that can be retrieved by listing certificates on the smart card (or USB token).
    // See List Certificates on Smart Card Example
    certPart = L"subjectCN";
    partValue = L"PIVKey E42D60A759D39147A26E0AF2FB1183C5";

    // If the certificate is found, it is loaded into the cert object.
    cert = CkCertW_Create();
    success = CkScMinidriverW_FindCert(scmd,certPart,partValue,cert);
    if (success == FALSE) {
        wprintf(L"Failed to find the certificate.\n");
        CkScMinidriverW_DeleteContext(scmd);
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        return;
    }

    wprintf(L"Successfully loaded the cert object from the smart card / USB token.\n");

    // Note: When successful, the cert object is internally linked to the ScMinidriver object's authenticated session.
    // The cert object can now be used to sign or do other cryptographic operations that occur on the smart card / USB token.
    // If your application calls PinDeauthenticate or DeleteContext, the cert will no longer be able to sign on the smart card
    // because the smart card ScMinidriver session will no longer be authenticated or deleted.

    // ------------------------------------------------------------------------------------------------------------
    // We have the certificate.  Now let's do the XML digital signature..

    // Create the following XML to be signed:

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

    xml = CkXmlW_Create();
    CkXmlW_putTag(xml,L"SOAP-ENV:Envelope");
    CkXmlW_AddAttribute(xml,L"xmlns:SOAP-ENV",L"http://schemas.xmlsoap.org/soap/envelope/");
    CkXmlW_UpdateAttrAt(xml,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");
    CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Header|wsse:Security",TRUE,L"SOAP-ENV:mustUnderstand",L"1");
    CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Body",TRUE,L"xmlns:SOAP-SEC",L"http://schemas.xmlsoap.org/soap/security/2000-12");
    CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Body",TRUE,L"SOAP-SEC:id",L"Body");
    CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Body|z:FooBar",TRUE,L"xmlns:z",L"http://example.com");

    // Prepare for signing...
    gen = CkXmlDSigGenW_Create();

    // Indicate where the Signature will be inserted.
    CkXmlDSigGenW_putSigLocation(gen,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"
    CkXmlDSigGenW_AddSameDocRef(gen,L"Body",L"sha1",L"EXCL_C14N",L"",L"");

    // (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
    CkXmlDSigGenW_putSignedInfoPrefixList(gen,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.
    CkXmlDSigGenW_putKeyInfoType(gen,L"X509Data");
    CkXmlDSigGenW_putX509Type(gen,L"Certificate");

    // Note: Our certificate was loaded from the smartcard and is internally linked to the authenticated ScMinidriver session.
    // The signing will occur on the smart card using the chosen certificate.
    bUsePrivateKey = TRUE;
    success = CkXmlDSigGenW_SetX509Cert(gen,cert,bUsePrivateKey);
    if (success != TRUE) {
        wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        CkXmlW_Dispose(xml);
        CkXmlDSigGenW_Dispose(gen);
        return;
    }

    // Everything's specified.  Now create and insert the Signature
    sbXml = CkStringBuilderW_Create();
    CkXmlW_GetXmlSb(xml,sbXml);
    success = CkXmlDSigGenW_CreateXmlDSigSb(gen,sbXml);
    if (success != TRUE) {
        wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        CkXmlW_Dispose(xml);
        CkXmlDSigGenW_Dispose(gen);
        CkStringBuilderW_Dispose(sbXml);
        return;
    }

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

    // ------------------------------------------------------------------------------------------------------------
    // Cleanup our ScMinidriver session...

    // When finished with operations that required authentication, you may if you wish, deauthenticate the session.
    success = CkScMinidriverW_PinDeauthenticate(scmd,L"user");
    if (success == FALSE) {
        wprintf(L"%s\n",CkScMinidriverW_lastErrorText(scmd));
    }

    // Delete the context when finished with the card.
    success = CkScMinidriverW_DeleteContext(scmd);
    if (success == FALSE) {
        wprintf(L"%s\n",CkScMinidriverW_lastErrorText(scmd));
    }



    CkScMinidriverW_Dispose(scmd);
    CkCertW_Dispose(cert);
    CkXmlW_Dispose(xml);
    CkXmlDSigGenW_Dispose(gen);
    CkStringBuilderW_Dispose(sbXml);

    }