|
Chilkat • HOME • .NET Core C# • Android™ • AutoIt • C • C# • C++ • Chilkat2-Python • CkPython • Classic ASP • DataFlex • Delphi ActiveX • Delphi DLL • Go • Java • Lianja • Mono C# • Node.js • Objective-C • PHP ActiveX • PHP Extension • Perl • PowerBuilder • PowerShell • PureBasic • Ruby • SQL Server • Swift 2 • Swift 3,4,5... • Tcl • Unicode C • Unicode C++ • VB.NET • VBScript • Visual Basic 6.0 • Visual FoxPro • Xojo Plugin
(PowerBuilder) Create IRS MeF Login Service Request MessageThis 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.
integer li_rc oleobject loo_Pfx integer li_Success oleobject loo_SigningCert oleobject loo_BdCert oleobject loo_SbCert64 oleobject loo_Xml oleobject loo_Gen oleobject loo_XmlSecTokRef oleobject loo_SbLoginRequest // 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..) loo_Pfx = create oleobject li_rc = loo_Pfx.ConnectToNewObject("Chilkat_9_5_0.Pfx") if li_rc < 0 then destroy loo_Pfx MessageBox("Error","Connecting to COM object failed") return end if li_Success = loo_Pfx.LoadPfxFile("qa_data/pfx/cert_test123.pfx","test123") if li_Success <> 1 then Write-Debug loo_Pfx.LastErrorText destroy loo_Pfx return end if // 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. loo_SigningCert = loo_Pfx.GetCert(0) if loo_Pfx.LastMethodSuccess <> 1 then Write-Debug loo_Pfx.LastErrorText destroy loo_Pfx return end if loo_BdCert = create oleobject li_rc = loo_BdCert.ConnectToNewObject("Chilkat_9_5_0.BinData") loo_SigningCert.ExportCertDerBd(loo_BdCert) loo_SbCert64 = create oleobject li_rc = loo_SbCert64.ConnectToNewObject("Chilkat_9_5_0.StringBuilder") loo_BdCert.GetEncodedSb("base64",loo_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: loo_Xml = create oleobject li_rc = loo_Xml.ConnectToNewObject("Chilkat_9_5_0.Xml") loo_Xml.Tag = "SOAP-ENV:Envelope" loo_Xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/") loo_Xml.AddAttribute("xmlns:xsd","http://www.w3.org/2001/XMLSchema") loo_Xml.AddAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance") loo_Xml.AddAttribute("xmlns:ds","http://www.w3.org/2000/09/xmldsig#") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|ns1:MeFHeader",1,"xmlns:ns1","http://www.irs.gov/a2a/mef/MeFHeader.xsd") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|ns1:MeFHeader",1,"Id","myHdr") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageID","001232006026123abcde") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:Action","https://www.irs.gov/a2a/mef/Login/") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:MessageTs","2006-09-27T08:55:29.348Z") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:ETIN","00123") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:SessionKeyCd","Y") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:TestCd","T") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:AppSysID","username") loo_Xml.UpdateChildContent("SOAP-ENV:Header|ns1:MeFHeader|ns1:WSDLVersionNum","10.0") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",1,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",1,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",1,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",1,"EncodingType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary") loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",1,"wsu:Id","X509Token") loo_Xml.UpdateChildContent("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",loo_SbCert64.GetAsString()) loo_Xml.UpdateAttrAt("SOAP-ENV:Body",1,"ID","myBody") loo_Xml.UpdateAttrAt("SOAP-ENV:Body|LoginRequest",1,"xmlns","http://www.irs.gov/a2a/mef/MeFMSIServices.xsd") // ------------------------------------------------------------------------------------------- // Setup the XML DSig generator object to create the desired signature. loo_Gen = create oleobject li_rc = loo_Gen.ConnectToNewObject("Chilkat_9_5_0.XmlDSigGen") // Indicate where the signature is to be placed. loo_Gen.SigLocation = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security" // Specify namespace prefix and algorithms. loo_Gen.SigNamespacePrefix = "ds" loo_Gen.SignedInfoCanonAlg = "EXCL_C14N" loo_Gen.SignedInfoDigestMethod = "sha1" // Indicate what is to be signed.. li_Success = loo_Gen.AddSameDocRef("myHdr","sha1","EXCL_C14N","","") li_Success = loo_Gen.AddSameDocRef("myBody","sha1","EXCL_C14N","","") // We want the ds:Signature's KeyInfo to contain the following XML: // <wsse:SecurityTokenReference> // <wsse:Reference URI="#X509Token" /> // </wsse:SecurityTokenReference> // Create the above XML... loo_XmlSecTokRef = create oleobject li_rc = loo_XmlSecTokRef.ConnectToNewObject("Chilkat_9_5_0.Xml") loo_XmlSecTokRef.Tag = "wsse:SecurityTokenReference" loo_XmlSecTokRef.UpdateAttrAt("wsse:Reference",1,"URI","#X509Token") // Indicate that the KeyInfoType is "Custom" to allow us to provide the exact XML snippet that will go in KeyInfo. loo_Gen.KeyInfoType = "Custom" loo_XmlSecTokRef.EmitCompact = 1 // Don't emit the XML declarator for this (it's important). loo_XmlSecTokRef.EmitXmlDecl = 0 loo_Gen.CustomKeyInfoXml = loo_XmlSecTokRef.GetXml() // Provide the certificate for signing. loo_Gen.SetX509Cert(loo_SigningCert,1) destroy loo_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). loo_Xml.EmitCompact = 1 loo_SbLoginRequest = create oleobject li_rc = loo_SbLoginRequest.ConnectToNewObject("Chilkat_9_5_0.StringBuilder") loo_Xml.GetXmlSb(loo_SbLoginRequest) // Indicate we desire compact (single-line) signed XML. loo_Gen.Behaviors = "CompactSignedXml" // Sign the XML. This adds the ds:Signature to the XML in sbLoginRequest. li_Success = loo_Gen.CreateXmlDSigSb(loo_SbLoginRequest) if li_Success <> 1 then Write-Debug loo_Gen.LastErrorText destroy loo_Pfx destroy loo_BdCert destroy loo_SbCert64 destroy loo_Xml destroy loo_Gen destroy loo_XmlSecTokRef destroy loo_SbLoginRequest return end if // Show the result Write-Debug loo_SbLoginRequest.GetAsString() Write-Debug "----" // Alternatively, we can create a completely non-compact signature, fully indented.. loo_SbLoginRequest.Clear() loo_Xml.EmitCompact = 0 loo_Xml.GetXmlSb(loo_SbLoginRequest) loo_Gen.Behaviors = "IndentedSignature" li_Success = loo_Gen.CreateXmlDSigSb(loo_SbLoginRequest) Write-Debug loo_SbLoginRequest.GetAsString() destroy loo_Pfx destroy loo_BdCert destroy loo_SbCert64 destroy loo_Xml destroy loo_Gen destroy loo_XmlSecTokRef destroy loo_SbLoginRequest |
||||
© 2000-2023 Chilkat Software, Inc. All Rights Reserved.