Swift
Swift
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 Swift Downloads
func chilkatTest() {
var success: Bool = false
// 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..)
let pfx = CkoPfx()!
success = pfx.loadFile(path: "qa_data/pfx/cert_test123.pfx", password: "test123")
if success == false {
print("\(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.
let signingCert = CkoCert()!
success = pfx.cert(at: 0, cert: signingCert)
if success == false {
print("\(pfx.lastErrorText!)")
return
}
let bdCert = CkoBinData()!
signingCert.exportDerBd(cerData: bdCert)
let sbCert64 = CkoStringBuilder()!
bdCert.getEncodedSb(encoding: "base64", sb: 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...
let xmlToSign = CkoXml()!
xmlToSign.tag = "SOAP-ENV:Envelope"
xmlToSign.addAttribute(name: "xmlns:SOAP-ENV", value: "http://schemas.xmlsoap.org/soap/envelope/")
xmlToSign.addAttribute(name: "xmlns:xsd", value: "http://www.w3.org/2001/XMLSchema")
xmlToSign.addAttribute(name: "xmlns:xsi", value: "http://www.w3.org/2001/XMLSchema-instance")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|wsse:Security", autoCreate: true, attrName: "xmlns:wsse", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", autoCreate: true, attrName: "xmlns:wsu", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", autoCreate: true, attrName: "EncodingType", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", autoCreate: true, attrName: "ValueType", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", autoCreate: true, attrName: "wsu:Id", attrValue: "CertId-1673181727")
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken", value: sbCert64.getAsString())
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|ns1:MeFHeader", autoCreate: true, attrName: "xmlns:ns1", attrValue: "http://www.irs.gov/a2a/mef/MeFHeader.xsd")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|ns1:MeFHeader", autoCreate: true, attrName: "xmlns:wsu", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Header|ns1:MeFHeader", autoCreate: true, attrName: "wsu:Id", attrValue: "id-1214941501")
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageID", value: "12345202018200000234")
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:Action", value: "Login")
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageTs", value: "2020-06-30T15:25:42.678Z")
xmlToSign.updateChildContentInt(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:ETIN", value: 12345)
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:SessionKeyCd", value: "Y")
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:TestCd", value: "P")
xmlToSign.updateChildContentInt(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:AppSysID", value: 65432190)
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:WSDLVersionNum", value: "10.3")
xmlToSign.updateChildContent(tagPath: "SOAP-ENV:Header|ns1:MeFHeader|ns1:ClientSoftwareTxt", value: "SOATest")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Body", autoCreate: true, attrName: "xmlns:wsu", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Body", autoCreate: true, attrName: "wsu:Id", attrValue: "id-1871558655")
xmlToSign.updateAttrAt(tagPath: "SOAP-ENV:Body|LoginRequest", autoCreate: true, attrName: "xmlns", attrValue: "http://www.irs.gov/a2a/mef/MeFMSIServices.xsd")
// -------------------------------------------------------------------------------------------
// Setup the XML DSig generator object to create the desired signature.
let gen = CkoXmlDSigGen()!
gen.sigLocation = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security"
gen.sigLocationMod = 0
gen.sigNamespacePrefix = "ds"
gen.sigNamespaceUri = "http://www.w3.org/2000/09/xmldsig#"
gen.signedInfoCanonAlg = "EXCL_C14N"
gen.signedInfoDigestMethod = "sha256"
// Set the KeyInfoId before adding references..
gen.keyInfoId = "KeyId-256137097"
// -------- Reference 1 --------
gen.addSameDocRef(id: "id-1214941501", digestMethod: "sha256", canonMethod: "EXCL_C14N", prefixList: "", refType: "")
// -------- Reference 2 --------
gen.addSameDocRef(id: "id-1871558655", digestMethod: "sha256", canonMethod: "EXCL_C14N", prefixList: "", refType: "")
// Provide a certificate + private key. (PFX password is test123)
let cert = CkoCert()!
success = cert.loadPfxFile(path: "qa_data/pfx/cert_test123.pfx", password: "test123")
if success == false {
print("\(cert.lastErrorText!)")
return
}
gen.setX509Cert(cert: cert, usePrivateKey: true)
gen.keyInfoType = "Custom"
// Create the custom KeyInfo XML..
let xmlCustomKeyInfo = CkoXml()!
xmlCustomKeyInfo.tag = "wsse:SecurityTokenReference"
xmlCustomKeyInfo.addAttribute(name: "xmlns:wsu", value: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlCustomKeyInfo.addAttribute(name: "wsu:Id", value: "STRId-1862925355")
xmlCustomKeyInfo.updateAttrAt(tagPath: "wsse:Reference", autoCreate: true, attrName: "URI", attrValue: "#CertId-1673181727")
xmlCustomKeyInfo.updateAttrAt(tagPath: "wsse:Reference", autoCreate: true, attrName: "ValueType", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")
xmlCustomKeyInfo.emitXmlDecl = false
gen.customKeyInfoXml = xmlCustomKeyInfo.getXml()
// -------------------------------------------------------------------------------------------
// Load XML to be signed...
let sbXml = CkoStringBuilder()!
xmlToSign.getSb(sb: sbXml)
// Update BinarySecurityToken_Base64Binary_Content with the actual X509 of the signing cert.
var nReplaced: Int = sbXml.replace(value: "BinarySecurityToken_Base64Binary_Content", replacement: cert.getEncoded()).intValue
gen.behaviors = "IndentedSignature"
// Sign the XML...
success = gen.createXmlDSigSb(sbXml: sbXml)
if success == false {
print("\(gen.lastErrorText!)")
return
}
// -----------------------------------------------
// Save the signed XML to a file.
success = sbXml.writeFile(path: "c:/temp/qa_output/signedXml.xml", charset: "utf-8", emitBom: false)
print("\(sbXml.getAsString()!)")
}