Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

MFC Examples

Web API Categories

ASN.1
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(MFC) 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.88 or later.

Chilkat C/C++ Library Downloads

MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkPkcs11.h>
#include <CkJsonObject.h>
#include <CkCert.h>
#include <CkXml.h>
#include <CkXmlDSigGen.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    CkString strOut;

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

    CkPkcs11 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("aetpkss1.dll");

    bool success = pkcs11.Initialize();
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // We need to call Discover to get the slot ID.
    bool onlyTokensPresent = true;
    CkJsonObject jsonPkcs11;
    success = pkcs11.Discover(onlyTokensPresent,jsonPkcs11);
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Make sure we have at least one slot.
    if (jsonPkcs11.SizeOfArray("slot") <= 0) {
        strOut.append("No occuplied slots.");
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Get the ID of the 1st slot
    int slotID = jsonPkcs11.IntOf("slot[0].id");

    // Open a session.
    bool readWrite = true;
    success = pkcs11.OpenSession(slotID,readWrite);
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Make it an authenticated session by calling Login.
    int userType = 1;
    // Make sure to use the correct PIN for your smart card..
    const char *pin = "0000";
    success = pkcs11.Login(userType,pin);
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Get the certificate (on the smart card) that has a private key.
    CkCert cert;
    success = pkcs11.FindCert("privateKey","",cert);
    if (success == true) {
        strOut.append("Cert with private key: ");
        strOut.append(cert.subjectCN());
        strOut.append("\r\n");
    }
    else {
        strOut.append("No certificates having a private key were found.");
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        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>

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

    CkXmlDSigGen gen;

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

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

    bool bUsePrivateKey = true;
    success = gen.SetX509Cert(cert,bUsePrivateKey);
    if (success != true) {
        strOut.append(gen.lastErrorText());
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

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

    success = gen.CreateXmlDSigSb(sbXml);
    if (success != true) {
        strOut.append(gen.lastErrorText());
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Examine the XML with the digital signature inserted
    strOut.append(sbXml.getAsString());
    strOut.append("\r\n");

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

    // Revert to an unauthenticated session by calling Logout.
    success = pkcs11.Logout();
    if (success == false) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        success = pkcs11.CloseSession();
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        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) {
        strOut.append(pkcs11.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    strOut.append("Success.");
    strOut.append("\r\n");


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }

 

© 2000-2022 Chilkat Software, Inc. All Rights Reserved.