(Visual FoxPro) 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

LOCAL loXml
LOCAL loJks
LOCAL lcPassword
LOCAL lnSuccess
LOCAL loChain
LOCAL loCert
LOCAL loGen
LOCAL lnBUsePrivateKey
LOCAL loSbXml

* 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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loXml = CreateObject('Chilkat.Xml')
loXml.Tag = "SOAP-ENV:Envelope"
loXml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
loXml.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")
loXml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",1,"SOAP-ENV:mustUnderstand","1")
loXml.UpdateAttrAt("SOAP-ENV:Body",1,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
loXml.UpdateAttrAt("SOAP-ENV:Body",1,"SOAP-SEC:id","Body")
loXml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",1,"xmlns:z","http://example.com")

* Load a JavaKeyStore file containing the certificate + private key.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JavaKeyStore')
loJks = CreateObject('Chilkat.JavaKeyStore')
lcPassword = "secret"
lnSuccess = loJks.LoadFile(lcPassword,"qa_data/jks/test_secret.jks")
IF (lnSuccess <> 1) THEN
    ? loJks.LastErrorText
    RELEASE loXml
    RELEASE loJks
    CANCEL
ENDIF

* Make sure we have a private key.
IF (loJks.NumPrivateKeys < 1) THEN
    ? "No private key available."
    RELEASE loXml
    RELEASE loJks
    CANCEL
ENDIF

* -------------------------------------------------------------------------
* Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
loChain = loJks.GetCertChain(0)
IF (loJks.LastMethodSuccess <> 1) THEN
    ? loJks.LastErrorText
    RELEASE loXml
    RELEASE loJks
    CANCEL
ENDIF

loCert = loChain.GetCert(0)
IF (loChain.LastMethodSuccess <> 1) THEN
    ? loChain.LastErrorText
    RELEASE loChain
    RELEASE loXml
    RELEASE loJks
    CANCEL
ENDIF

RELEASE loChain

* Verify again that this cert has a private key.
IF (loCert.HasPrivateKey() <> 1) THEN
    ? "Certificate has no associated private key."
    RELEASE loCert
    RELEASE loXml
    RELEASE loJks
    CANCEL
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
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.XmlDSigGen')
loGen = CreateObject('Chilkat.XmlDSigGen')

* 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.
lnBUsePrivateKey = 1
lnSuccess = loGen.SetX509Cert(loCert,lnBUsePrivateKey)
IF (lnSuccess <> 1) THEN
    ? loGen.LastErrorText
    RELEASE loCert
    RELEASE loXml
    RELEASE loJks
    RELEASE loGen
    CANCEL
ENDIF

RELEASE loCert

* Everything's specified.  Now create and insert the Signature
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbXml = CreateObject('Chilkat.StringBuilder')
loXml.GetXmlSb(loSbXml)
lnSuccess = loGen.CreateXmlDSigSb(loSbXml)
IF (lnSuccess <> 1) THEN
    ? loGen.LastErrorText
    RELEASE loXml
    RELEASE loJks
    RELEASE loGen
    RELEASE loSbXml
    CANCEL
ENDIF

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

RELEASE loXml
RELEASE loJks
RELEASE loGen
RELEASE loSbXml