(Ruby) Sign XML (XAdES) in the Cloud using Azure Key Vault

See more Signing in the Cloud Examples

Note: This example requires Chilkat v9.5.0.96 or greater.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

# Create the XML to be signed.
sbXml = Chilkat::CkStringBuilder.new()

bCrlf = true
sbXml.AppendLine("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\" ?>",bCrlf)
sbXml.AppendLine("<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\">",bCrlf)
sbXml.AppendLine("    <SOAP-ENV:Header>",bCrlf)
sbXml.AppendLine("        <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>",bCrlf)
sbXml.AppendLine("    </SOAP-ENV:Header>",bCrlf)
sbXml.AppendLine("    <SOAP-ENV:Body xmlns:SOAP-SEC=\"http://schemas.xmlsoap.org/soap/security/2000-12\" SOAP-SEC:id=\"Body\">",bCrlf)
sbXml.AppendLine("        <z:FooBar xmlns:z=\"http://example.com\" />",bCrlf)
sbXml.AppendLine("    </SOAP-ENV:Body>",bCrlf)
sbXml.AppendLine("</SOAP-ENV:Envelope>",bCrlf)

# Load the certificate used for signing.  The certificate's private key is stored in 
# the Azure Key Vault.
# However, we still need the certificate locally (without private key).
cert = Chilkat::CkCert.new()
success = cert.LoadFromFile("qa_data/certs/myCert.cer")
if (success == false)
    print cert.lastErrorText() + "\n";
    exit
end

# Here's a screenshot of our certificate with private key on Azure Key Vault:


# To sign using the Azure Key Vault, 
# add the following lines of code to specify your authentication credentials,
# and the name of the certificate w/ private key on the Azure server to be used.
jsonAzure = Chilkat::CkJsonObject.new()
# Set the "service" equal to "azure_keyvault" to tell Chilkat to use Azure Key Vault for signing.
jsonAzure.UpdateString("service","azure_keyvault")
jsonAzure.UpdateString("client_id","APP_ID")
jsonAzure.UpdateString("client_secret","APP_PASSWORD")
jsonAzure.UpdateString("tenant_id","TENANT_ID")
# In the above screenshot, our vault name is "kvchilkat".  You will use your vault name.
jsonAzure.UpdateString("vault_name","VAULT_NAME")
# In the above screenshot, our cert name is "ChilkatTest1".  You will use your cert name.
jsonAzure.UpdateString("cert_name","CERT_NAME")
# In the above screenshot, our cert version is "63b94a23389546ecbc8eb6208a1bef37".  You will use your cert version.
jsonAzure.UpdateString("cert_version","CERT_VERSION")
success = cert.SetCloudSigner(jsonAzure)

# Prepare for signing...
gen = Chilkat::CkXmlDSigGen.new()

# 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")

gen.put_KeyInfoType("X509Data")
gen.put_X509Type("IssuerSerial")

bUsePrivateKey = true
success = gen.SetX509Cert(cert,bUsePrivateKey)
if (success != true)
    print gen.lastErrorText() + "\n";

    exit
end

# Everything's specified.  Now create and insert the Signature
# (The actual signing of the hash will happen on the Aruba server.)
success = gen.CreateXmlDSigSb(sbXml)
if (success != true)
    print gen.lastErrorText() + "\n";
    exit
end

# Examine the XML with the digital signature inserted
print sbXml.getAsString() + "\n";

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