(Tcl) Create XML Signature using Java KeyStore (.jks)

Demonstrates how to create an XML digital signature using a certificate and private key from a Java KeyStore (.jks)

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

# The SOAP XML to be signed in this example contains the following:

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

# Build the XML to sign.
# Use this online tool to generate the code from sample XML: 
# Generate Code to Create XML

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"

# Load a JavaKeyStore file containing the certificate + private key.
set jks [new_CkJavaKeyStore]

set password "secret"
set success [CkJavaKeyStore_LoadFile $jks $password "qa_data/jks/test_secret.jks"]
if {$success != 1} then {
    puts [CkJavaKeyStore_lastErrorText $jks]
    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    exit
}

# Make sure we have a private key.
if {[CkJavaKeyStore_get_NumPrivateKeys $jks] < 1} then {
    puts "No private key available."
    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    exit
}

# -------------------------------------------------------------------------
# Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
# chain is a CkCertChain
set chain [CkJavaKeyStore_GetCertChain $jks 0]
if {[CkJavaKeyStore_get_LastMethodSuccess $jks] != 1} then {
    puts [CkJavaKeyStore_lastErrorText $jks]
    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    exit
}

# cert is a CkCert
set cert [CkCertChain_GetCert $chain 0]
if {[CkCertChain_get_LastMethodSuccess $chain] != 1} then {
    puts [CkCertChain_lastErrorText $chain]
    delete_CkCertChain $chain

    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    exit
}

delete_CkCertChain $chain

# Verify again that this cert has a private key.
if {[CkCert_HasPrivateKey $cert] != 1} then {
    puts "Certificate has no associated private key."
    delete_CkCert $cert

    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    exit
}

# Prepare for signing...
# Use this online tool to generate the following code from an already-signed XML sample: 
# Generate Code to Create an XML Signature
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.
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"

# Note: Because our certificate was loaded from a JKS which also contained the private key,
# Chilkat automatically knows and has the private key associated with the certificate.
# We set bUsePrivateKey to tell the SetX509Cert method to automatically use the private key
# associated with the certificate for signing.
set bUsePrivateKey 1
set success [CkXmlDSigGen_SetX509Cert $gen $cert $bUsePrivateKey]
if {$success != 1} then {
    puts [CkXmlDSigGen_lastErrorText $gen]
    delete_CkCert $cert

    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    delete_CkXmlDSigGen $gen
    exit
}

delete_CkCert $cert

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

CkXml_GetXmlSb $xml $sbXml
set success [CkXmlDSigGen_CreateXmlDSigSb $gen $sbXml]
if {$success != 1} then {
    puts [CkXmlDSigGen_lastErrorText $gen]
    delete_CkXml $xml
    delete_CkJavaKeyStore $jks
    delete_CkXmlDSigGen $gen
    delete_CkStringBuilder $sbXml
    exit
}

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

delete_CkXml $xml
delete_CkJavaKeyStore $jks
delete_CkXmlDSigGen $gen
delete_CkStringBuilder $sbXml