Tcl

Verify XML Digital Signature having KeyName

See more XML Digital Signatures Examples

Demonstrates how to verify an XML digital signature where the KeyInfo part contains the KeyName element.
In this case, the public key is not specifically stored in the signed XML.
Rather, application specific information about the key is stored in the KeyName element.
This example uses the KeyName to find and matching public key.

This example requires Chilkat v9.5.0.69 or greater.

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.

# The signed XML to be verified in this example contains the following:
# 
# <?xml version="1.0" encoding="UTF-8" standalone="no"?>
# <Envelope>
#   <Header>
#     <Security>
#     <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:SignedInfo><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><ds:SignatureMethod Algorithm="http://www.w3.org/2009/xmldsig11#dsa-sha256"/><ds:Reference URI="#abc"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>XTjDIHSEsDNTO9yn4cKtyXjRUjPFXkOQOLYI5mueZhk=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>NXOIMevGCqFl0Dwtp2KkqkT05GRV8CjmHZ9LhFpt8/d7+lkIi7mITA==</ds:SignatureValue><ds:KeyInfo><ds:KeyName>dsaKey_123</ds:KeyName></ds:KeyInfo></ds:Signature></Security>
#   </Header>
#   <Body Id="abc">
#     <z:FooBar xmlns:z="https://www.example-code.com"/>
#   </Body>
# </Envelope>
# 

# The above XML is available at https://www.chilkatsoft.com/exampleData/signedUsingKeyName.xml
# First we'll fetch the signed XML:

set url "https://www.chilkatsoft.com/exampleData/signedUsingKeyName.xml"
set http [new_CkHttp]

set sbXml [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http $url $sbXml]
if {$success != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbXml
    exit
}

set verifier [new_CkXmlDSig]

# Load the XML containing the signature to be verified.
set success [CkXmlDSig_LoadSignatureSb $verifier $sbXml]
if {$success != 1} then {
    puts [CkXmlDSig_lastErrorText $verifier]
    delete_CkHttp $http
    delete_CkStringBuilder $sbXml
    delete_CkXmlDSig $verifier
    exit
}

# (The Chilkat XML Digital Signature API has the capability to handle XML documents with multiple signatures.
# We know in advance that this signed XML has just one Signature, so we leave the dsig.Selector property at the
# default value of 0.)

# Let's get the KeyInfo XML so we can then get the KeyName.
# xmlKeyInfo is a CkXml
set xmlKeyInfo [CkXmlDSig_GetKeyInfo $verifier]
if {[CkXmlDSig_get_LastMethodSuccess $verifier] == 0} then {
    puts "There is no KeyInfo available in the Signature."
    delete_CkHttp $http
    delete_CkStringBuilder $sbXml
    delete_CkXmlDSig $verifier
    exit
}

# Examine the XML:
puts [CkXml_getXml $xmlKeyInfo]

# The KeyInfo XML that is returned looks like this:
# 
# 	<ds:KeyInfo>
# 	    <ds:KeyName>dsaKey_123</ds:KeyName>
# 	</ds:KeyInfo>
# 

# Get the KeyName.
set sbKeyName [new_CkStringBuilder]

CkStringBuilder_Append $sbKeyName [CkXml_getChildContent $xmlKeyInfo "*:KeyName"]
delete_CkXml $xmlKeyInfo

# sbKeyName contains "dsaKey_123"
puts [CkStringBuilder_getAsString $sbKeyName]

# The application now locates and loads the public key for verification
# based on the key name.  This example will do the following:
# If the key name equals "dsaKey_123", then load the DSA key from
# "qa_data/dsa/dsa1024_public.pem"
# 

if {[CkStringBuilder_ContentsEqual $sbKeyName "dsaKey_123" 0] == 0} then {
    puts "I don't know this key..."
    delete_CkHttp $http
    delete_CkStringBuilder $sbXml
    delete_CkXmlDSig $verifier
    delete_CkStringBuilder $sbKeyName
    exit
}

# The DSA public key used in this example is available at:
# https://www.chilkatsoft.com/exampleData/dsa1024_public.zip
set pubKey [new_CkPublicKey]

set success [CkPublicKey_LoadFromFile $pubKey "qa_data/dsa/dsa1024_public.pem"]
if {$success != 1} then {
    puts [CkPublicKey_lastErrorText $pubKey]
    delete_CkHttp $http
    delete_CkStringBuilder $sbXml
    delete_CkXmlDSig $verifier
    delete_CkStringBuilder $sbKeyName
    delete_CkPublicKey $pubKey
    exit
}

# Provide the DSA public key to the XML DSig verifier:
CkXmlDSig_SetPublicKey $verifier $pubKey

# Verify the signature
set bVerified [CkXmlDSig_VerifySignature $verifier 1]
puts "Signature verified = $bVerified"

delete_CkHttp $http
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier
delete_CkStringBuilder $sbKeyName
delete_CkPublicKey $pubKey