Lua
Lua
Create IRS MeF Login Service Request Message
See more XML Digital Signatures Examples
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 Lua Downloads
local chilkat = require("chilkat")
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
-- --------------------------------------------------------------------------------
-- Also see Chilkat's Online WSDL Code Generator
-- to generate code and SOAP Request and Response XML for each operation in a WSDL.
-- --------------------------------------------------------------------------------
-- The goal of this example is to create signed SOAP XML such as the following:
-- <?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">
-- <SOAP-ENV:Header>
-- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
-- <wsse:BinarySecurityToken
-- xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
-- EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
-- ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"
-- wsu:Id="CertId-1673181727">MIIHab...n71P</wsse:BinarySecurityToken>
-- <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
-- <ds:SignedInfo>
-- <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
-- <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
-- <ds:Reference URI="#id-1214941501">
-- <ds:Transforms>
-- <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
-- </ds:Transforms>
-- <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
-- <ds:DigestValue>abcdefghijkLMNOPQRSTUVwxyz012345Em0o3VEOTck=</ds:DigestValue>
-- </ds:Reference>
-- <ds:Reference URI="#id-1871558655">
-- <ds:Transforms>
-- <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
-- </ds:Transforms>
-- <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
-- <ds:DigestValue>abcdefghijkLMNOPQRSTUVwxyz012345Xm5ViA+royg=</ds:DigestValue>
-- </ds:Reference>
-- </ds:SignedInfo>
-- <ds:SignatureValue>abcd...5Nbw==</ds:SignatureValue>
-- <ds:KeyInfo Id="KeyId-256137097">
-- <wsse:SecurityTokenReference xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="STRId-1862925355">
-- <wsse:Reference URI="#CertId-1673181727" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"/>
-- </wsse:SecurityTokenReference>
-- </ds:KeyInfo>
-- </ds:Signature>
-- </wsse:Security>
-- <ns1:MeFHeader xmlns:ns1="http://www.irs.gov/a2a/mef/MeFHeader.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="id-1214941501">
-- <ns1:MessageID>12345202018200000234</ns1:MessageID>
-- <ns1:Action>Login</ns1:Action>
-- <ns1:MessageTs>2020-06-30T15:25:42.678Z</ns1:MessageTs>
-- <ns1:ETIN>12345</ns1:ETIN>
-- <ns1:SessionKeyCd>Y</ns1:SessionKeyCd>
-- <ns1:TestCd>P</ns1:TestCd>
-- <ns1:AppSysID>65432190</ns1:AppSysID>
-- <ns1:WSDLVersionNum>10.3</ns1:WSDLVersionNum>
-- <ns1:ClientSoftwareTxt>SOATest</ns1:ClientSoftwareTxt>
-- </ns1:MeFHeader>
-- </SOAP-ENV:Header>
-- <SOAP-ENV:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="id-1871558655">
-- <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..)
local pfx = chilkat.Pfx.new()
local success = pfx:load_pfx_file("qa_data/pfx/cert_test123.pfx", "test123")
if not success then
print(pfx.last_error_text)
return
end
-- 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.
local signingCert = chilkat.Cert.new()
success = pfx:cert_at(0, signingCert)
if not success then
print(pfx.last_error_text)
return
end
local bdCert = chilkat.BinData.new()
signingCert:export_cert_der_bd(bdCert)
local sbCert64 = chilkat.StringBuilder.new()
bdCert:get_encoded_sb("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">
-- <SOAP-ENV:Header>
-- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
-- <wsse:BinarySecurityToken
-- xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
-- EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
-- ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"
-- wsu:Id="CertId-1673181727">MIIHab...n71P</wsse:BinarySecurityToken>
-- </wsse:Security>
-- <ns1:MeFHeader xmlns:ns1="http://www.irs.gov/a2a/mef/MeFHeader.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="id-1214941501">
-- <ns1:MessageID>12345202018200000234</ns1:MessageID>
-- <ns1:Action>Login</ns1:Action>
-- <ns1:MessageTs>2020-06-30T15:25:42.678Z</ns1:MessageTs>
-- <ns1:ETIN>12345</ns1:ETIN>
-- <ns1:SessionKeyCd>Y</ns1:SessionKeyCd>
-- <ns1:TestCd>P</ns1:TestCd>
-- <ns1:AppSysID>65432190</ns1:AppSysID>
-- <ns1:WSDLVersionNum>10.3</ns1:WSDLVersionNum>
-- <ns1:ClientSoftwareTxt>SOATest</ns1:ClientSoftwareTxt>
-- </ns1:MeFHeader>
-- </SOAP-ENV:Header>
-- <SOAP-ENV:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="id-1871558655">
-- <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:
-- Create the XML to be signed...
local xmlToSign = chilkat.Xml.new()
xmlToSign.tag = "SOAP-ENV:Envelope"
xmlToSign:add_attribute("xmlns:SOAP-ENV", "http://schemas.xmlsoap.org/soap/envelope/")
xmlToSign:add_attribute("xmlns:xsd", "http://www.w3.org/2001/XMLSchema")
xmlToSign:add_attribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance")
xmlToSign:update_attr_at("SOAP-ENV:Header|wsse:Security", true, "xmlns:wsse", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
xmlToSign:update_attr_at("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", true, "xmlns:wsu", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign:update_attr_at("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", true, "EncodingType", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary")
xmlToSign:update_attr_at("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", true, "ValueType", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")
xmlToSign:update_attr_at("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", true, "wsu:Id", "CertId-1673181727")
xmlToSign:update_child_content("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", sbCert64:get_as_string())
xmlToSign:update_attr_at("SOAP-ENV:Header|ns1:MeFHeader", true, "xmlns:ns1", "http://www.irs.gov/a2a/mef/MeFHeader.xsd")
xmlToSign:update_attr_at("SOAP-ENV:Header|ns1:MeFHeader", true, "xmlns:wsu", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign:update_attr_at("SOAP-ENV:Header|ns1:MeFHeader", true, "wsu:Id", "id-1214941501")
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageID", "12345202018200000234")
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:Action", "Login")
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageTs", "2020-06-30T15:25:42.678Z")
xmlToSign:update_child_content_int("SOAP-ENV:Header|ns1:MeFHeader|ns1:ETIN", 12345)
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:SessionKeyCd", "Y")
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:TestCd", "P")
xmlToSign:update_child_content_int("SOAP-ENV:Header|ns1:MeFHeader|ns1:AppSysID", 65432190)
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:WSDLVersionNum", "10.3")
xmlToSign:update_child_content("SOAP-ENV:Header|ns1:MeFHeader|ns1:ClientSoftwareTxt", "SOATest")
xmlToSign:update_attr_at("SOAP-ENV:Body", true, "xmlns:wsu", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign:update_attr_at("SOAP-ENV:Body", true, "wsu:Id", "id-1871558655")
xmlToSign:update_attr_at("SOAP-ENV:Body|LoginRequest", true, "xmlns", "http://www.irs.gov/a2a/mef/MeFMSIServices.xsd")
-- -------------------------------------------------------------------------------------------
-- Setup the XML DSig generator object to create the desired signature.
local gen = chilkat.XmlDSigGen.new()
gen.sig_location = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security"
gen.sig_location_mod = 0
gen.sig_namespace_prefix = "ds"
gen.sig_namespace_uri = "http://www.w3.org/2000/09/xmldsig#"
gen.signed_info_canon_alg = "EXCL_C14N"
gen.signed_info_digest_method = "sha256"
-- Set the KeyInfoId before adding references..
gen.key_info_id = "KeyId-256137097"
-- -------- Reference 1 --------
gen:add_same_doc_ref("id-1214941501", "sha256", "EXCL_C14N", "", "")
-- -------- Reference 2 --------
gen:add_same_doc_ref("id-1871558655", "sha256", "EXCL_C14N", "", "")
-- Provide a certificate + private key. (PFX password is test123)
local cert = chilkat.Cert.new()
success = cert:load_pfx_file("qa_data/pfx/cert_test123.pfx", "test123")
if not success then
print(cert.last_error_text)
return
end
gen:set_x509_cert(cert, true)
gen.key_info_type = "Custom"
-- Create the custom KeyInfo XML..
local xmlCustomKeyInfo = chilkat.Xml.new()
xmlCustomKeyInfo.tag = "wsse:SecurityTokenReference"
xmlCustomKeyInfo:add_attribute("xmlns:wsu", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlCustomKeyInfo:add_attribute("wsu:Id", "STRId-1862925355")
xmlCustomKeyInfo:update_attr_at("wsse:Reference", true, "URI", "#CertId-1673181727")
xmlCustomKeyInfo:update_attr_at("wsse:Reference", true, "ValueType", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")
xmlCustomKeyInfo.emit_xml_decl = false
gen.custom_key_info_xml = xmlCustomKeyInfo:get_xml()
-- -------------------------------------------------------------------------------------------
-- Load XML to be signed...
local sbXml = chilkat.StringBuilder.new()
xmlToSign:get_xml_sb(sbXml)
-- Update BinarySecurityToken_Base64Binary_Content with the actual X509 of the signing cert.
local nReplaced = sbXml:replace("BinarySecurityToken_Base64Binary_Content", cert:get_encoded())
gen.behaviors = "IndentedSignature"
-- Sign the XML...
success = gen:create_xml_dsig_sb(sbXml)
if not success then
print(gen.last_error_text)
return
end
-- -----------------------------------------------
-- Save the signed XML to a file.
success = sbXml:write_file("c:/temp/qa_output/signedXml.xml", "utf-8", false)
print(sbXml:get_as_string())