(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Xml
oleobject loo_Jks
string ls_Password
integer li_Success
oleobject loo_Chain
oleobject loo_Cert
oleobject loo_Gen
integer li_BUsePrivateKey
oleobject loo_SbXml

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

loo_Xml = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")
if li_rc < 0 then
    destroy loo_Xml
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Xml.Tag = "SOAP-ENV:Envelope"
loo_Xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",1,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",1,"SOAP-ENV:mustUnderstand","1")
loo_Xml.UpdateAttrAt("SOAP-ENV:Body",1,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
loo_Xml.UpdateAttrAt("SOAP-ENV:Body",1,"SOAP-SEC:id","Body")
loo_Xml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",1,"xmlns:z","http://example.com")

// Load a JavaKeyStore file containing the certificate + private key.
loo_Jks = create oleobject
// Use "Chilkat_9_5_0.JavaKeyStore" for versions of Chilkat < 10.0.0
li_rc = loo_Jks.ConnectToNewObject("Chilkat.JavaKeyStore")

ls_Password = "secret"
li_Success = loo_Jks.LoadFile(ls_Password,"qa_data/jks/test_secret.jks")
if li_Success <> 1 then
    Write-Debug loo_Jks.LastErrorText
    destroy loo_Xml
    destroy loo_Jks
    return
end if

// Make sure we have a private key.
if loo_Jks.NumPrivateKeys < 1 then
    Write-Debug "No private key available."
    destroy loo_Xml
    destroy loo_Jks
    return
end if

// -------------------------------------------------------------------------
// Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
loo_Chain = loo_Jks.GetCertChain(0)
if loo_Jks.LastMethodSuccess <> 1 then
    Write-Debug loo_Jks.LastErrorText
    destroy loo_Xml
    destroy loo_Jks
    return
end if

loo_Cert = loo_Chain.GetCert(0)
if loo_Chain.LastMethodSuccess <> 1 then
    Write-Debug loo_Chain.LastErrorText
    destroy loo_Chain
    destroy loo_Xml
    destroy loo_Jks
    return
end if

destroy loo_Chain

// Verify again that this cert has a private key.
if loo_Cert.HasPrivateKey() <> 1 then
    Write-Debug "Certificate has no associated private key."
    destroy loo_Cert
    destroy loo_Xml
    destroy loo_Jks
    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
loo_Gen = create oleobject
// Use "Chilkat_9_5_0.XmlDSigGen" for versions of Chilkat < 10.0.0
li_rc = loo_Gen.ConnectToNewObject("Chilkat.XmlDSigGen")

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

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

// (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
loo_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.
loo_Gen.KeyInfoType = "X509Data"
loo_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.
li_BUsePrivateKey = 1
li_Success = loo_Gen.SetX509Cert(loo_Cert,li_BUsePrivateKey)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    destroy loo_Cert
    destroy loo_Xml
    destroy loo_Jks
    destroy loo_Gen
    return
end if

destroy loo_Cert

// Everything's specified.  Now create and insert the Signature
loo_SbXml = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbXml.ConnectToNewObject("Chilkat.StringBuilder")

loo_Xml.GetXmlSb(loo_SbXml)
li_Success = loo_Gen.CreateXmlDSigSb(loo_SbXml)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    destroy loo_Xml
    destroy loo_Jks
    destroy loo_Gen
    destroy loo_SbXml
    return
end if

// Examine the XML with the digital signature inserted
Write-Debug loo_SbXml.GetAsString()


destroy loo_Xml
destroy loo_Jks
destroy loo_Gen
destroy loo_SbXml