Ruby

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

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

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

url = "https://www.chilkatsoft.com/exampleData/signedUsingKeyName.xml"
http = Chilkat::CkHttp.new()
sbXml = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb(url,sbXml)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

verifier = Chilkat::CkXmlDSig.new()

# Load the XML containing the signature to be verified.
success = verifier.LoadSignatureSb(sbXml)
if (success != true)
    print verifier.lastErrorText() + "\n";
    exit
end

# (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
xmlKeyInfo = verifier.GetKeyInfo()
if (verifier.get_LastMethodSuccess() == false)
    print "There is no KeyInfo available in the Signature." + "\n";
    exit
end

# Examine the XML:
print xmlKeyInfo.getXml() + "\n";

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

# Get the KeyName.
sbKeyName = Chilkat::CkStringBuilder.new()
sbKeyName.Append(xmlKeyInfo.getChildContent("*:KeyName"))

# sbKeyName contains "dsaKey_123"
print sbKeyName.getAsString() + "\n";

# 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 (sbKeyName.ContentsEqual("dsaKey_123",false) == false)
    print "I don't know this key..." + "\n";
    exit
end

# The DSA public key used in this example is available at:
# https://www.chilkatsoft.com/exampleData/dsa1024_public.zip
pubKey = Chilkat::CkPublicKey.new()
success = pubKey.LoadFromFile("qa_data/dsa/dsa1024_public.pem")
if (success != true)
    print pubKey.lastErrorText() + "\n";
    exit
end

# Provide the DSA public key to the XML DSig verifier:
verifier.SetPublicKey(pubKey)

# Verify the signature
bVerified = verifier.VerifySignature(true)
print "Signature verified = " + bVerified.to_s() + "\n";