Lua Requires Chilkat v11.0.0+

Create XML Signature using Java KeyStore (.jks)

See more XML Digital Signatures Examples

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

local chilkat = require("chilkat")

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

local xml = chilkat.Xml.new()
xml.tag = "SOAP-ENV:Envelope"
xml:add_attribute("xmlns:SOAP-ENV", "http://schemas.xmlsoap.org/soap/envelope/")
xml:update_attr_at("SOAP-ENV:Header|wsse:Security", true, "xmlns:wsse", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
xml:update_attr_at("SOAP-ENV:Header|wsse:Security", true, "SOAP-ENV:mustUnderstand", "1")
xml:update_attr_at("SOAP-ENV:Body", true, "xmlns:SOAP-SEC", "http://schemas.xmlsoap.org/soap/security/2000-12")
xml:update_attr_at("SOAP-ENV:Body", true, "SOAP-SEC:id", "Body")
xml:update_attr_at("SOAP-ENV:Body|z:FooBar", true, "xmlns:z", "http://example.com")

-- Load a JavaKeyStore file containing the certificate + private key.
local jks = chilkat.JavaKeyStore.new()
local password = "secret"
local success = jks:load_file(password, "qa_data/jks/test_secret.jks")
if not success then
    print(jks.last_error_text)
    return
end

-- Make sure we have a private key.
if jks.num_private_keys < 1 then
    print("No private key available.")
    return
end

-- -------------------------------------------------------------------------
-- Get the certificate chain associated with the 1st (and probably only) private key in the JKS.

local chain = chilkat.CertChain.new()
success = jks:cert_chain_at(0, chain)
if not success then
    print(jks.last_error_text)
    return
end

local cert = chilkat.Cert.new()
success = chain:cert_at(0, cert)
if not success then
    print(chain.last_error_text)
    return
end

-- Verify again that this cert has a private key.
if not cert:has_private_key() then
    print("Certificate has no associated private key.")
    return
end

-- 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
local gen = chilkat.XmlDSigGen.new()

-- Indicate where the Signature will be inserted.
gen.sig_location = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security"

-- Add a reference to the fragment of the XML to be signed.
gen:add_same_doc_ref("Body", "sha1", "EXCL_C14N", "", "")

-- (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
gen.signed_info_prefix_list = "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.
gen.key_info_type = "X509Data"
gen.x509_type = "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.
local bUsePrivateKey = true
success = gen:set_x509_cert(cert, bUsePrivateKey)
if not success then
    print(gen.last_error_text)
    return
end

-- Everything's specified.  Now create and insert the Signature
local sbXml = chilkat.StringBuilder.new()
xml:get_xml_sb(sbXml)
success = gen:create_xml_dsig_sb(sbXml)
if not success then
    print(gen.last_error_text)
    return
end

-- Examine the XML with the digital signature inserted
print(sbXml:get_as_string())