(Chilkat2-Python) HTTP request for a SOAP web service using WS-Security 1.0 with a digital certificate for authentication

See more HTTP Examples

Demonstrates how to build and send an HTTP request for a SOAP web service using WS-Security 1.0 with a digital certificate for authentication.

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# 

# ------------------------------------
# Step 1: Load the signing certificate
# ------------------------------------
cert = chilkat2.Cert()
success = cert.LoadFromSmartcard("")
if (success == False):
    print(cert.LastErrorText)
    sys.exit()

# ---------------------------------------
# Step 2: Build the SOAP XML to be signed
# ---------------------------------------

xml = chilkat2.Xml()
xml.Tag = "SOAP-ENV:Envelope"
xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
xml.AddAttribute("xmlns:web","http://www.example.com/webservice/")
xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",True,"xmlns:ds","http://www.w3.org/2000/09/xmldsig#")
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,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",True,"xmlns:xenc","http://www.w3.org/2001/04/xmlenc#")
xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",True,"SOAP-ENV:mustUnderstand","1")
xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",True,"A1","")
xml.UpdateAttrAt("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")
xml.UpdateAttrAt("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#X509")
xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",True,"wsu:Id","x509cert00")
xml.UpdateChildContent("SOAP-ENV:Header|wsse:Security|wsse:BinarySecurityToken",cert.GetEncoded())
xml.UpdateAttrAt("SOAP-ENV:Body",True,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xml.UpdateAttrAt("SOAP-ENV:Body",True,"wsu:Id","TheBody")
xml.UpdateChildContent("SOAP-ENV:Body|web:MyRequest|web:Parameter","MyValue")

# ---------------------------------------
# Step 3: Sign the XML
# ---------------------------------------

gen = chilkat2.XmlDSigGen()

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.SignedInfoPrefixList = "ds wsu xenc SOAP-ENV "
gen.IncNamespacePrefix = "c14n"
gen.IncNamespaceUri = "http://www.w3.org/2001/10/xml-exc-c14n#"
gen.SignedInfoCanonAlg = "EXCL_C14N"
gen.SignedInfoDigestMethod = "sha1"

# -------- Reference 1 --------
gen.AddSameDocRef("TheBody","sha1","EXCL_C14N","wsu SOAP-ENV","")

gen.SetX509Cert(cert,True)

gen.KeyInfoType = "Custom"

# Create the custom KeyInfo XML..
xmlCustomKeyInfo = chilkat2.Xml()
xmlCustomKeyInfo.Tag = "wsse:SecurityTokenReference"
xmlCustomKeyInfo.Content = "5"
xmlCustomKeyInfo.UpdateAttrAt("wsse:Reference",True,"URI","#x509cert00")
xmlCustomKeyInfo.UpdateAttrAt("wsse:Reference",True,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509")

xmlCustomKeyInfo.EmitXmlDecl = False
gen.CustomKeyInfoXml = xmlCustomKeyInfo.GetXml()

# Load XML to be signed...
sbXml = chilkat2.StringBuilder()
xml.EmitXmlDecl = False
xml.GetXmlSb(sbXml)

gen.Behaviors = "IndentedSignature"

# Sign the XML...
success = gen.CreateXmlDSigSb(sbXml)
if (success != True):
    print(gen.LastErrorText)
    sys.exit()

# ---------------------------------------------------------
# Step 4: Send the HTTP POST containing the Signed SOAP XML
# ---------------------------------------------------------

http = chilkat2.Http()

http.SetRequestHeader("SOAPAction","\"http://www.example.com/MyWebService\"")
http.SetRequestHeader("Host","www.example.com")
http.SetRequestHeader("Content-Type","text/xml; charset=utf-8")

# resp is a CkHttpResponse
resp = http.PTextSb("POST","https://example.com/MyWebService",sbXml,"utf-8","text/xml; charset=utf-8",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

print("Finished.")