Tcl
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 Tcl Downloads

Download Chilkat for Tcl
Tcl

load ./chilkat.dll

set success 0

# 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.

set pkcs11 [new_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
CkPkcs11_put_SharedLibPath $pkcs11 "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
set pin "user:password"
set userType 1

set success [CkPkcs11_QuickSession $pkcs11 $userType $pin]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    exit
}

set cert [new_CkCert]

set success [CkCert_LoadFromFile $cert "qa_data/certs/myCert.cer"]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    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.
set success [CkCert_LinkPkcs11 $cert $pkcs11]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    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>

set xml [new_CkXml]

CkXml_put_Tag $xml "SOAP-ENV:Envelope"
CkXml_AddAttribute $xml "xmlns:SOAP-ENV" "http://schemas.xmlsoap.org/soap/envelope/"
CkXml_UpdateAttrAt $xml "SOAP-ENV:Header|wsse:Security" 1 "xmlns:wsse" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
CkXml_UpdateAttrAt $xml "SOAP-ENV:Header|wsse:Security" 1 "SOAP-ENV:mustUnderstand" "1"
CkXml_UpdateAttrAt $xml "SOAP-ENV:Body" 1 "xmlns:SOAP-SEC" "http://schemas.xmlsoap.org/soap/security/2000-12"
CkXml_UpdateAttrAt $xml "SOAP-ENV:Body" 1 "SOAP-SEC:id" "Body"
CkXml_UpdateAttrAt $xml "SOAP-ENV:Body|z:FooBar" 1 "xmlns:z" "http://example.com"

set gen [new_CkXmlDSigGen]

# Indicate where the Signature will be inserted.
CkXmlDSigGen_put_SigLocation $gen "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"
CkXmlDSigGen_AddSameDocRef $gen "Body" "sha1" "EXCL_C14N" "" ""

# (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
CkXmlDSigGen_put_SignedInfoPrefixList $gen "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.
CkXmlDSigGen_put_KeyInfoType $gen "X509Data"
CkXmlDSigGen_put_X509Type $gen "Certificate"

set bUsePrivateKey 1
set success [CkXmlDSigGen_SetX509Cert $gen $cert $bUsePrivateKey]
if {$success != 1} then {
    puts [CkXmlDSigGen_lastErrorText $gen]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkXml $xml
    delete_CkXmlDSigGen $gen
    exit
}

# Everything's specified.  Now create and insert the Signature
set sbXml [new_CkStringBuilder]

CkXml_put_EmitCompact $xml 1
CkXml_GetXmlSb $xml $sbXml

set success [CkXmlDSigGen_CreateXmlDSigSb $gen $sbXml]
if {$success != 1} then {
    puts [CkXmlDSigGen_lastErrorText $gen]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkXml $xml
    delete_CkXmlDSigGen $gen
    delete_CkStringBuilder $sbXml
    exit
}

# Examine the XML with the digital signature inserted
puts [CkStringBuilder_getAsString $sbXml]

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

# Revert to an unauthenticated session by calling Logout.
set success [CkPkcs11_Logout $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    set success [CkPkcs11_CloseSession $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkXml $xml
    delete_CkXmlDSigGen $gen
    delete_CkStringBuilder $sbXml
    exit
}

# When finished, close the session.
# It is important to close the session (memory leaks will occur if the session is not properly closed).
set success [CkPkcs11_CloseSession $pkcs11]
if {$success == 0} then {
    puts [CkPkcs11_lastErrorText $pkcs11]
    delete_CkPkcs11 $pkcs11
    delete_CkCert $cert
    delete_CkXml $xml
    delete_CkXmlDSigGen $gen
    delete_CkStringBuilder $sbXml
    exit
}

puts "Success."

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

delete_CkPkcs11 $pkcs11
delete_CkCert $cert
delete_CkXml $xml
delete_CkXmlDSigGen $gen
delete_CkStringBuilder $sbXml