CkPython
Sign XML (XAdES) using AWS CloudHSM

Demonstrates how to sign XML using AWS CloudHSM. The signing of the hash happens on a hardware token in AWS CloudHSM. Everything else involving the updating the XML to add the signature happens locally within Chilkat.
Note: This example requires Chilkat v9.5.0.96 or later.
Chilkat CkPython Downloads

Download Chilkat for CkPython
CkPython
import sys
import chilkat

success = False

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

# Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

pkcs11 = chilkat.CkPkcs11()

# Provide the path to the AWS CloudHSM PKCS11 driver.
# This example runs on Windows, so we'll provide the CloudHSM DLL.
# If your code runs on Linux, the CloudHSM driver might be at /opt/cloudhsm/lib/libcloudhsm_pkcs11.so
pkcs11.put_SharedLibPath("C:\\Program Files\\Amazon\\CloudHSM\\lib\\cloudhsm_pkcs11.dll")

# Your PIN should be a string containing your crypto user's login and password, with a colon char delimiting.
# See https://docs.aws.amazon.com/cloudhsm/latest/userguide/pkcs11-pin.html
pin = "user:password"
userType = 1

success = pkcs11.QuickSession(userType,pin)
if (success == False):
    print(pkcs11.lastErrorText())
    sys.exit()

cert = chilkat.CkCert()
success = cert.LoadFromFile("qa_data/certs/myCert.cer")
if (success == False):
    print(cert.lastErrorText())
    sys.exit()

# Tell the certificate to link with the PKCS11 session.
# The cert's private key should be installed on the CloudHSM.
# If there are multiple private keys on the CloudHSM, then Chilkat will automatically
# locate and use the private key corresponding to the certificate.
success = cert.LinkPkcs11(pkcs11)
if (success == False):
    print(cert.lastErrorText())
    sys.exit()

# --------------------------------------------------------------------------
# At this point, we have the cert to be used for signing.
# Our XML signing code is the same as for a cert obtained from any other source..

# First generate the following XML to be signed:
# Use this online tool to generate code from sample XML: 
# Generate Code to Create XML

# <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
# <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
#     <SOAP-ENV:Header>
#         <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1"></wsse:Security>
#     </SOAP-ENV:Header>
#     <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">
#         <z:FooBar xmlns:z="http://example.com" />
#     </SOAP-ENV:Body>
# </SOAP-ENV:Envelope>

xml = chilkat.CkXml()
xml.put_Tag("SOAP-ENV:Envelope")
xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
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,"SOAP-ENV:mustUnderstand","1")
xml.UpdateAttrAt("SOAP-ENV:Body",True,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
xml.UpdateAttrAt("SOAP-ENV:Body",True,"SOAP-SEC:id","Body")
xml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",True,"xmlns:z","http://example.com")

gen = chilkat.CkXmlDSigGen()

# Indicate where the Signature will be inserted.
gen.put_SigLocation("SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security")

# Add a reference to the fragment of the XML to be signed.

# Note: "Body" refers to the XML element having an "id" equal to "Body", where "id" is case insensitive
# and where any namespace might qualify the attribute.  In this case, the SOAP-ENV:Body fragment is signed
# NOT because the tag = "Body", but because it has SOAP-SEC:id="Body"
gen.AddSameDocRef("Body","sha1","EXCL_C14N","","")

# (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
gen.put_SignedInfoPrefixList("wsse SOAP-ENV")

# Provide the private key for signing via the certificate, and indicate that
# we want the base64 of the certificate embedded in the KeyInfo.
gen.put_KeyInfoType("X509Data")
gen.put_X509Type("Certificate")

bUsePrivateKey = True
success = gen.SetX509Cert(cert,bUsePrivateKey)
if (success != True):
    print(gen.lastErrorText())
    success = pkcs11.CloseSession()
    sys.exit()

# Everything's specified.  Now create and insert the Signature
sbXml = chilkat.CkStringBuilder()
xml.put_EmitCompact(True)
xml.GetXmlSb(sbXml)

success = gen.CreateXmlDSigSb(sbXml)
if (success != True):
    print(gen.lastErrorText())
    success = pkcs11.CloseSession()
    sys.exit()

# Examine the XML with the digital signature inserted
print(sbXml.getAsString())

# --------------------------------------------------------------------------

# Revert to an unauthenticated session by calling Logout.
success = pkcs11.Logout()
if (success == False):
    print(pkcs11.lastErrorText())
    success = pkcs11.CloseSession()
    sys.exit()

# When finished, close the session.
# It is important to close the session (memory leaks will occur if the session is not properly closed).
success = pkcs11.CloseSession()
if (success == False):
    print(pkcs11.lastErrorText())
    sys.exit()

print("Success.")

# --------------------------------------------------------------------------------
# Also see Chilkat's Online WSDL Code Generator
# to generate code and SOAP Request and Response XML for each operation in a WSDL.
# --------------------------------------------------------------------------------