Unicode C
Unicode C
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)Chilkat Unicode C Downloads
#include <C_CkXmlW.h>
#include <C_CkJavaKeyStoreW.h>
#include <C_CkCertChainW.h>
#include <C_CkCertW.h>
#include <C_CkXmlDSigGenW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
BOOL success;
HCkXmlW xml;
HCkJavaKeyStoreW jks;
const wchar_t *password;
HCkCertChainW chain;
HCkCertW cert;
HCkXmlDSigGenW gen;
BOOL bUsePrivateKey;
HCkStringBuilderW sbXml;
success = FALSE;
// 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
xml = CkXmlW_Create();
CkXmlW_putTag(xml,L"SOAP-ENV:Envelope");
CkXmlW_AddAttribute(xml,L"xmlns:SOAP-ENV",L"http://schemas.xmlsoap.org/soap/envelope/");
CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Header|wsse:Security",TRUE,L"xmlns:wsse",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Header|wsse:Security",TRUE,L"SOAP-ENV:mustUnderstand",L"1");
CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Body",TRUE,L"xmlns:SOAP-SEC",L"http://schemas.xmlsoap.org/soap/security/2000-12");
CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Body",TRUE,L"SOAP-SEC:id",L"Body");
CkXmlW_UpdateAttrAt(xml,L"SOAP-ENV:Body|z:FooBar",TRUE,L"xmlns:z",L"http://example.com");
// Load a JavaKeyStore file containing the certificate + private key.
jks = CkJavaKeyStoreW_Create();
password = L"secret";
success = CkJavaKeyStoreW_LoadFile(jks,password,L"qa_data/jks/test_secret.jks");
if (success == FALSE) {
wprintf(L"%s\n",CkJavaKeyStoreW_lastErrorText(jks));
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
return;
}
// Make sure we have a private key.
if (CkJavaKeyStoreW_getNumPrivateKeys(jks) < 1) {
wprintf(L"No private key available.\n");
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
return;
}
// -------------------------------------------------------------------------
// Get the certificate chain associated with the 1st (and probably only) private key in the JKS.
chain = CkCertChainW_Create();
success = CkJavaKeyStoreW_CertChainAt(jks,0,chain);
if (success == FALSE) {
wprintf(L"%s\n",CkJavaKeyStoreW_lastErrorText(jks));
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
CkCertChainW_Dispose(chain);
return;
}
cert = CkCertW_Create();
success = CkCertChainW_CertAt(chain,0,cert);
if (success == FALSE) {
wprintf(L"%s\n",CkCertChainW_lastErrorText(chain));
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
CkCertChainW_Dispose(chain);
CkCertW_Dispose(cert);
return;
}
// Verify again that this cert has a private key.
if (CkCertW_HasPrivateKey(cert) != TRUE) {
wprintf(L"Certificate has no associated private key.\n");
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
CkCertChainW_Dispose(chain);
CkCertW_Dispose(cert);
return;
}
// 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
gen = CkXmlDSigGenW_Create();
// Indicate where the Signature will be inserted.
CkXmlDSigGenW_putSigLocation(gen,L"SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security");
// Add a reference to the fragment of the XML to be signed.
CkXmlDSigGenW_AddSameDocRef(gen,L"Body",L"sha1",L"EXCL_C14N",L"",L"");
// (You can read about the SignedInfoPrefixList in the online reference documentation. It's optional..)
CkXmlDSigGenW_putSignedInfoPrefixList(gen,L"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.
CkXmlDSigGenW_putKeyInfoType(gen,L"X509Data");
CkXmlDSigGenW_putX509Type(gen,L"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.
bUsePrivateKey = TRUE;
success = CkXmlDSigGenW_SetX509Cert(gen,cert,bUsePrivateKey);
if (success != TRUE) {
wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
CkCertChainW_Dispose(chain);
CkCertW_Dispose(cert);
CkXmlDSigGenW_Dispose(gen);
return;
}
// Everything's specified. Now create and insert the Signature
sbXml = CkStringBuilderW_Create();
CkXmlW_GetXmlSb(xml,sbXml);
success = CkXmlDSigGenW_CreateXmlDSigSb(gen,sbXml);
if (success == FALSE) {
wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
CkCertChainW_Dispose(chain);
CkCertW_Dispose(cert);
CkXmlDSigGenW_Dispose(gen);
CkStringBuilderW_Dispose(sbXml);
return;
}
// Examine the XML with the digital signature inserted
wprintf(L"%s\n",CkStringBuilderW_getAsString(sbXml));
CkXmlW_Dispose(xml);
CkJavaKeyStoreW_Dispose(jks);
CkCertChainW_Dispose(chain);
CkCertW_Dispose(cert);
CkXmlDSigGenW_Dispose(gen);
CkStringBuilderW_Dispose(sbXml);
}