Chilkat Examples

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

Unicode C++ Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
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
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Unicode C++) Create IRS MeF Login Service Request Message

This example demonstrates how to create a digitally signed Login Service Request Message.

This example used the documentation at https://www.irs.gov/pub/irs-utl/mef-doc-stp_ref_guide.pdf as a guide.

It creates signed XML as specified in section 4.1.1 found in Section 4: Example A2A Web Service Messages.

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

Win Mobile 5.0/Pocket PC 2003

Solaris C/C++

FreeBSD C/C++

OpenBSD C/C++

MinGW C/C++

#include <CkPfxW.h>
#include <CkCertW.h>
#include <CkBinDataW.h>
#include <CkStringBuilderW.h>
#include <CkXmlW.h>
#include <CkXmlDSigGenW.h>

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

    //  The goal of this example is to create signed SOAP XML such as the following:

    //  IMPORTANT:  The IRS's PDF documentation at https://www.irs.gov/pub/irs-utl/mef-doc-stp_ref_guide.pdf
    //  contains a mistake in the section 4.1.1. Specifically, the Id="hdr" attribute is wrong.  It must match the Reference in the ds:Signature,
    //  which is why we changed it to "myHdr".

    //  <?xml version="1.0" encoding="UTF-8" ?>
    //  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
    //      <SOAP-ENV:Header>
    //          <ns1:MeFHeader xmlns:ns1="http://www.irs.gov/a2a/mef/MeFHeader.xsd" Id="myHdr">
    //              <ns1:MessageID>001232006026123abcde</ns1:MessageID>
    //              <ns1:Action>https://www.irs.gov/a2a/mef/Login/</ns1:Action>
    //              <ns1:MessageTs>2006-09-27T08:55:29.348Z</ns1:MessageTs>
    //              <ns1:ETIN>00123</ns1:ETIN>
    //              <ns1:SessionKeyCd>Y</ns1:SessionKeyCd>
    //              <ns1:TestCd>T</ns1:TestCd>
    //              <ns1:AppSysID>username</ns1:AppSysID>
    //              <ns1:WSDLVersionNum>10.0</ns1:WSDLVersionNum>
    //          </ns1:MeFHeader>
    //          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    //              <wsse:BinarySecurityToken
    //  			ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"
    //  			EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
    //  			wsu:Id="X509Token">/CgBr+1CEl/PtYtAaMB0GA1UdDgQWBBSrtL3lSnDOzSluMLggQUgHpkDFGTAJBgNV HRMEAjAAMBkGCSqGSIb2fQdBAAQMMAobBFY1LjADAgMoMA0GCSqGSIb3DQEB BQUAA4GBAC6SVzmX2I2kr5f0Na83ujcSwixpzHE2LqLBFsKm0GdPdarHFB2Qt85zbQ9 PRCROObm9HCIO5KMCjHp7D4g+.0QVA36IbEn8</wsse:BinarySecurityToken>
//
    //              <ds:Signature>
    //                  <ds:SignedInfo>
    //                      <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
    //                      <ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
    //                      <ds:Reference URI="#myHdr">
    //                          <ds:Transforms>
    //                              <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
    //                          </ds:Transforms>
    //                          <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
    //                          <ds:DigestValue>qZk+NkcGgWq6PiVxeFDCbJzQ2J0=</ds:DigestValue>
    //                      </ds:Reference>
    //                      <ds:Reference URI="#myBody">
    //                          <ds:Transforms>
    //                              <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
    //                          </ds:Transforms>
    //                          <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
    //                          <ds:DigestValue>hJg+RBw70m66rkqh+VEp5eVGcPE=</ds:DigestValue>
    //                      </ds:Reference>
    //                  </ds:SignedInfo>
    //                  <ds:SignatureValue>dsBeQ9qNXM1yU6BbWdBkSN676inwf+CgDORUKqOFuwWUzaOxUmHIq1Pb7uAB Yw6xkooLbQGS/M3t4Df+hd31prR9Pn9IFqG87Rt169+Il8L9GRgPhAATgne8Rh3jOaq nfrJ5BBM0VmbZdL+c7dfNcnpW13D/kltZMvlFRXR87Hs=</ds:SignatureValue>
    //                  <ds:KeyInfo>
    //                      <wsse:SecurityTokenReference>
    //                          <wsse:Reference URI="#X509Token" />
    //                      </wsse:SecurityTokenReference>
    //                  </ds:KeyInfo>
    //              </ds:Signature>
    //          </wsse:Security>
    //      </SOAP-ENV:Header>
    //      <SOAP-ENV:Body ID="myBody">
    //          <LoginRequest xmlns="http://www.irs.gov/a2a/mef/MeFMSIServices.xsd" />
    //      </SOAP-ENV:Body>
    //  </SOAP-ENV:Envelope>

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

    //  First, let's load the certificate + private key to be used for signing (from a PFX).
    //  (It is also possible to use certificates installed on a Windows system, or from other file formats..)
    CkPfxW pfx;
    bool success = pfx.LoadPfxFile(L"qa_data/pfx/cert_test123.pfx",L"test123");
    if (success != true) {
        wprintf(L"%s\n",pfx.lastErrorText());
        return;
    }

    //  We'll be needing the X.509 signing cert as base64 for the BinarySecurityToken, so let's get it now..
    //  The certificate having the private key should be the 1st in the PFX.
    CkCertW *signingCert = pfx.GetCert(0);
    if (pfx.get_LastMethodSuccess() != true) {
        wprintf(L"%s\n",pfx.lastErrorText());
        return;
    }

    CkBinDataW bdCert;
    signingCert->ExportCertDerBd(bdCert);
    CkStringBuilderW sbCert64;
    bdCert.GetEncodedSb(L"base64",sbCert64);

    //  -------------------------------------------------------------------------------------------
    //  The XML before signing would look like this:

    //  <?xml version="1.0" encoding="UTF-8" ?>
    //  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
    //      <SOAP-ENV:Header>
    //          <ns1:MeFHeader xmlns:ns1="http://www.irs.gov/a2a/mef/MeFHeader.xsd" Id="myHdr">
    //              <ns1:MessageID>001232006026123abcde</ns1:MessageID>
    //              <ns1:Action>https://www.irs.gov/a2a/mef/Login/</ns1:Action>
    //              <ns1:MessageTs>2006-09-27T08:55:29.348Z</ns1:MessageTs>
    //              <ns1:ETIN>00123</ns1:ETIN>
    //              <ns1:SessionKeyCd>Y</ns1:SessionKeyCd>
    //              <ns1:TestCd>T</ns1:TestCd>
    //              <ns1:AppSysID>username</ns1:AppSysID>
    //              <ns1:WSDLVersionNum>10.0</ns1:WSDLVersionNum>
    //          </ns1:MeFHeader>
    //          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    //              <wsse:BinarySecurityToken
    //  			ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"
    //  			EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
    //  			wsu:Id="X509Token">/CgBr+1CEl/PtYtAaMB0GA1UdDgQWBBSrtL3lSnDOzSluMLggQUgHpkDFGTAJBgNV HRMEAjAAMBkGCSqGSIb2fQdBAAQMMAobBFY1LjADAgMoMA0GCSqGSIb3DQEB BQUAA4GBAC6SVzmX2I2kr5f0Na83ujcSwixpzHE2LqLBFsKm0GdPdarHFB2Qt85zbQ9 PRCROObm9HCIO5KMCjHp7D4g+.0QVA36IbEn8</wsse:BinarySecurityToken>
//
    //          </wsse:Security>
    //      </SOAP-ENV:Header>
    //      <SOAP-ENV:Body ID="myBody">
    //          <LoginRequest xmlns="http://www.irs.gov/a2a/mef/MeFMSIServices.xsd" />
    //      </SOAP-ENV:Body>
    //  </SOAP-ENV:Envelope>

    //  You can use the online XML code generation tool at http://tools.chilkat.io/xmlCreate.cshtml
    //  to generate the following XML creation source code:

    CkXmlW xml;

    xml.put_Tag(L"SOAP-ENV:Envelope");
    xml.AddAttribute(L"xmlns:SOAP-ENV",L"http://schemas.xmlsoap.org/soap/envelope/");
    xml.AddAttribute(L"xmlns:xsd",L"http://www.w3.org/2001/XMLSchema");
    xml.AddAttribute(L"xmlns:xsi",L"http://www.w3.org/2001/XMLSchema-instance");
    xml.AddAttribute(L"xmlns:ds",L"http://www.w3.org/2000/09/xmldsig#");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|ns1:MeFHeader",true,L"xmlns:ns1",L"http://www.irs.gov/a2a/mef/MeFHeader.xsd");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|ns1:MeFHeader",true,L"Id",L"myHdr");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageID",L"001232006026123abcde");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:Action",L"https://www.irs.gov/a2a/mef/Login/");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageTs",L"2006-09-27T08:55:29.348Z");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:ETIN",L"00123");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:SessionKeyCd",L"Y");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:TestCd",L"T");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:AppSysID",L"username");
    xml.UpdateChildContent(L"SOAP-ENV:Header|ns1:MeFHeader|ns1:WSDLVersionNum",L"10.0");
    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"xmlns:wsu",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",true,L"ValueType",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",true,L"EncodingType",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary");
    xml.UpdateAttrAt(L"SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",true,L"wsu:Id",L"X509Token");
    xml.UpdateChildContent(L"SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",sbCert64.getAsString());
    xml.UpdateAttrAt(L"SOAP-ENV:Body",true,L"ID",L"myBody");
    xml.UpdateAttrAt(L"SOAP-ENV:Body|LoginRequest",true,L"xmlns",L"http://www.irs.gov/a2a/mef/MeFMSIServices.xsd");

    //  -------------------------------------------------------------------------------------------
    //  Setup the XML DSig generator object to create the desired signature.

    CkXmlDSigGenW gen;

    //  Indicate where the signature is to be placed.
    gen.put_SigLocation(L"SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security");

    //  Specify namespace prefix and algorithms.
    gen.put_SigNamespacePrefix(L"ds");
    gen.put_SignedInfoCanonAlg(L"EXCL_C14N");
    gen.put_SignedInfoDigestMethod(L"sha1");

    //  Indicate what is to be signed..
    success = gen.AddSameDocRef(L"myHdr",L"sha1",L"EXCL_C14N",L"",L"");
    success = gen.AddSameDocRef(L"myBody",L"sha1",L"EXCL_C14N",L"",L"");

    //  We want the ds:Signature's KeyInfo to contain the following XML:

    //      <wsse:SecurityTokenReference>
    //          <wsse:Reference URI="#X509Token" />
    //      </wsse:SecurityTokenReference>

    //  Create the above XML...
    CkXmlW xmlSecTokRef;
    xmlSecTokRef.put_Tag(L"wsse:SecurityTokenReference");
    xmlSecTokRef.UpdateAttrAt(L"wsse:Reference",true,L"URI",L"#X509Token");

    //  Indicate that the KeyInfoType is "Custom" to allow us to provide the exact XML snippet that will go in KeyInfo.
    gen.put_KeyInfoType(L"Custom");
    xmlSecTokRef.put_EmitCompact(true);
    //  Don't emit the XML declarator for this (it's important).
    xmlSecTokRef.put_EmitXmlDecl(false);
    gen.put_CustomKeyInfoXml(xmlSecTokRef.getXml());

    //  Provide the certificate for signing.
    gen.SetX509Cert(*signingCert,true);
    delete signingCert;

    //  -------------------------------------------------------------------------------------------
    //  OK.. everything is prepared to create the signed XML.
    //  XML signatures are super-complicated, and one source of errors involves whitespace in XML, which must be
    //  maintained exactly or else the signature becomes invalid.  One way to help avoid such errors,
    //  especially if the XML is intended for processing (i.e. not human eyes), is to sign compact XML
    //  where no extra whitespace exists.  Also, we can produce the XML signature on a single line.
    //  Therefore, the entire signed XML is one line (except for the XML declarator), and we avoid
    //  all potential problems relating to anything that migh muck with XML formatting or indentation.
    //  Let's do that..

    //  First, get the XML to be signed in compact form (one line, no indenting or whitespace).
    xml.put_EmitCompact(true);
    CkStringBuilderW sbLoginRequest;
    xml.GetXmlSb(sbLoginRequest);

    //  Indicate we desire compact (single-line) signed XML.
    gen.put_Behaviors(L"CompactSignedXml");

    //  Sign the XML.  This adds the ds:Signature to the XML in sbLoginRequest.
    success = gen.CreateXmlDSigSb(sbLoginRequest);
    if (success != true) {
        wprintf(L"%s\n",gen.lastErrorText());
        return;
    }

    //  Show the result
    wprintf(L"%s\n",sbLoginRequest.getAsString());
    wprintf(L"----\n");

    //  Alternatively, we can create a completely non-compact signature, fully indented..
    sbLoginRequest.Clear();
    xml.put_EmitCompact(false);
    xml.GetXmlSb(sbLoginRequest);
    gen.put_Behaviors(L"IndentedSignature");
    success = gen.CreateXmlDSigSb(sbLoginRequest);
    wprintf(L"%s\n",sbLoginRequest.getAsString());
    }

 

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