(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim xml As New Chilkat.Xml
xml.Tag = "SOAP-ENV:Envelope"
Dim success As Boolean
success = xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
success = xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",True,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
success = xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",True,"SOAP-ENV:mustUnderstand","1")
success = xml.UpdateAttrAt("SOAP-ENV:Body",True,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
success = xml.UpdateAttrAt("SOAP-ENV:Body",True,"SOAP-SEC:id","Body")
success = xml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",True,"xmlns:z","http://example.com")

// Load a JavaKeyStore file containing the certificate + private key.
Dim jks As New Chilkat.JavaKeyStore
Dim password As String
password = "secret"
Dim success As Boolean
success = jks.LoadFile(password,"qa_data/jks/test_secret.jks")
If (success <> True) Then
    System.DebugLog(jks.LastErrorText)
    Return
End If

// Make sure we have a private key.
If (jks.NumPrivateKeys < 1) Then
    System.DebugLog("No private key available.")
    Return
End If

// -------------------------------------------------------------------------
// Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
Dim chain As Chilkat.CertChain
chain = jks.GetCertChain(0)
If (jks.LastMethodSuccess <> True) Then
    System.DebugLog(jks.LastErrorText)
    Return
End If

Dim cert As Chilkat.Cert
cert = chain.GetCert(0)
If (chain.LastMethodSuccess <> True) Then
    System.DebugLog(chain.LastErrorText)

    Return
End If

// Verify again that this cert has a private key.
If (cert.HasPrivateKey() <> True) Then
    System.DebugLog("Certificate has no associated private key.")

    Return
End If

// 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
Dim gen As New Chilkat.XmlDSigGen

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

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

// (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
gen.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.
gen.KeyInfoType = "X509Data"
gen.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.
Dim bUsePrivateKey As Boolean
bUsePrivateKey = True
success = gen.SetX509Cert(cert,bUsePrivateKey)
If (success <> True) Then
    System.DebugLog(gen.LastErrorText)

    Return
End If

// Everything's specified.  Now create and insert the Signature
Dim sbXml As New Chilkat.StringBuilder
success = xml.GetXmlSb(sbXml)
success = gen.CreateXmlDSigSb(sbXml)
If (success <> True) Then
    System.DebugLog(gen.LastErrorText)
    Return
End If

// Examine the XML with the digital signature inserted
System.DebugLog(sbXml.GetAsString())