(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loXml = createobject("CkXml")
loXml.Tag = "SOAP-ENV:Envelope"
loXml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
loXml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",.T.,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
loXml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",.T.,"SOAP-ENV:mustUnderstand","1")
loXml.UpdateAttrAt("SOAP-ENV:Body",.T.,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
loXml.UpdateAttrAt("SOAP-ENV:Body",.T.,"SOAP-SEC:id","Body")
loXml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",.T.,"xmlns:z","http://example.com")

// Load a JavaKeyStore file containing the certificate + private key.
loJks = createobject("CkJavaKeyStore")
lcPassword = "secret"
llSuccess = loJks.LoadFile(lcPassword,"qa_data/jks/test_secret.jks")
if (llSuccess <> .T.) then
    ? loJks.LastErrorText
    release loXml
    release loJks
    return
endif

// Make sure we have a private key.
if (loJks.NumPrivateKeys < 1) then
    ? "No private key available."
    release loXml
    release loJks
    return
endif

// -------------------------------------------------------------------------
// Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
loChain = loJks.GetCertChain(0)
if (loJks.LastMethodSuccess <> .T.) then
    ? loJks.LastErrorText
    release loXml
    release loJks
    return
endif

loCert = loChain.GetCert(0)
if (loChain.LastMethodSuccess <> .T.) then
    ? loChain.LastErrorText
    release loChain
    release loXml
    release loJks
    return
endif

release loChain

// Verify again that this cert has a private key.
if (loCert.HasPrivateKey() <> .T.) then
    ? "Certificate has no associated private key."
    release loCert
    release loXml
    release loJks
    return
endif

// 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
loGen = createobject("CkXmlDSigGen")

// Indicate where the Signature will be inserted.
loGen.SigLocation = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security"

// Add a reference to the fragment of the XML to be signed.
loGen.AddSameDocRef("Body","sha1","EXCL_C14N","","")

// (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
loGen.SignedInfoPrefixList = "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.
loGen.KeyInfoType = "X509Data"
loGen.X509Type = "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.
llBUsePrivateKey = .T.
llSuccess = loGen.SetX509Cert(loCert,llBUsePrivateKey)
if (llSuccess <> .T.) then
    ? loGen.LastErrorText
    release loCert
    release loXml
    release loJks
    release loGen
    return
endif

release loCert

// Everything's specified.  Now create and insert the Signature
loSbXml = createobject("CkStringBuilder")
loXml.GetXmlSb(loSbXml)
llSuccess = loGen.CreateXmlDSigSb(loSbXml)
if (llSuccess <> .T.) then
    ? loGen.LastErrorText
    release loXml
    release loJks
    release loGen
    release loSbXml
    return
endif

// Examine the XML with the digital signature inserted
? loSbXml.GetAsString()


release loXml
release loJks
release loGen
release loSbXml