Unicode C
Unicode C
Sign XML (XAdES) using AWS CloudHSM
See more PKCS11 Examples
Demonstrates how to sign XML using AWS CloudHSM. The signing of the hash happens on a hardware token in AWS CloudHSM. Everything else involving the updating the XML to add the signature happens locally within Chilkat.Note: This example requires Chilkat v9.5.0.96 or later.
Chilkat Unicode C Downloads
#include <C_CkPkcs11W.h>
#include <C_CkCertW.h>
#include <C_CkXmlW.h>
#include <C_CkXmlDSigGenW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
BOOL success;
HCkPkcs11W pkcs11;
const wchar_t *pin;
int userType;
HCkCertW cert;
HCkXmlW xml;
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.
// Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.
pkcs11 = CkPkcs11W_Create();
// Provide the path to the AWS CloudHSM PKCS11 driver.
// This example runs on Windows, so we'll provide the CloudHSM DLL.
// If your code runs on Linux, the CloudHSM driver might be at /opt/cloudhsm/lib/libcloudhsm_pkcs11.so
CkPkcs11W_putSharedLibPath(pkcs11,L"C:\\Program Files\\Amazon\\CloudHSM\\lib\\cloudhsm_pkcs11.dll");
// Your PIN should be a string containing your crypto user's login and password, with a colon char delimiting.
// See https://docs.aws.amazon.com/cloudhsm/latest/userguide/pkcs11-pin.html
pin = L"user:password";
userType = 1;
success = CkPkcs11W_QuickSession(pkcs11,userType,pin);
if (success == FALSE) {
wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
CkPkcs11W_Dispose(pkcs11);
return;
}
cert = CkCertW_Create();
success = CkCertW_LoadFromFile(cert,L"qa_data/certs/myCert.cer");
if (success == FALSE) {
wprintf(L"%s\n",CkCertW_lastErrorText(cert));
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
return;
}
// Tell the certificate to link with the PKCS11 session.
// The cert's private key should be installed on the CloudHSM.
// If there are multiple private keys on the CloudHSM, then Chilkat will automatically
// locate and use the private key corresponding to the certificate.
success = CkCertW_LinkPkcs11(cert,pkcs11);
if (success == FALSE) {
wprintf(L"%s\n",CkCertW_lastErrorText(cert));
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
return;
}
// --------------------------------------------------------------------------
// At this point, we have the cert to be used for signing.
// Our XML signing code is the same as for a cert obtained from any other source..
// First generate the following XML to be signed:
// Use this online tool to generate code from sample XML:
// Generate Code to Create XML
// <?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>
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");
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.
// Note: "Body" refers to the XML element having an "id" equal to "Body", where "id" is case insensitive
// and where any namespace might qualify the attribute. In this case, the SOAP-ENV:Body fragment is signed
// NOT because the tag = "Body", but because it has SOAP-SEC:id="Body"
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");
bUsePrivateKey = TRUE;
success = CkXmlDSigGenW_SetX509Cert(gen,cert,bUsePrivateKey);
if (success != TRUE) {
wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
success = CkPkcs11W_CloseSession(pkcs11);
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
CkXmlW_Dispose(xml);
CkXmlDSigGenW_Dispose(gen);
return;
}
// Everything's specified. Now create and insert the Signature
sbXml = CkStringBuilderW_Create();
CkXmlW_putEmitCompact(xml,TRUE);
CkXmlW_GetXmlSb(xml,sbXml);
success = CkXmlDSigGenW_CreateXmlDSigSb(gen,sbXml);
if (success != TRUE) {
wprintf(L"%s\n",CkXmlDSigGenW_lastErrorText(gen));
success = CkPkcs11W_CloseSession(pkcs11);
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
CkXmlW_Dispose(xml);
CkXmlDSigGenW_Dispose(gen);
CkStringBuilderW_Dispose(sbXml);
return;
}
// Examine the XML with the digital signature inserted
wprintf(L"%s\n",CkStringBuilderW_getAsString(sbXml));
// --------------------------------------------------------------------------
// Revert to an unauthenticated session by calling Logout.
success = CkPkcs11W_Logout(pkcs11);
if (success == FALSE) {
wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
success = CkPkcs11W_CloseSession(pkcs11);
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
CkXmlW_Dispose(xml);
CkXmlDSigGenW_Dispose(gen);
CkStringBuilderW_Dispose(sbXml);
return;
}
// When finished, close the session.
// It is important to close the session (memory leaks will occur if the session is not properly closed).
success = CkPkcs11W_CloseSession(pkcs11);
if (success == FALSE) {
wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
CkXmlW_Dispose(xml);
CkXmlDSigGenW_Dispose(gen);
CkStringBuilderW_Dispose(sbXml);
return;
}
wprintf(L"Success.\n");
// --------------------------------------------------------------------------------
// Also see Chilkat's Online WSDL Code Generator
// to generate code and SOAP Request and Response XML for each operation in a WSDL.
// --------------------------------------------------------------------------------
CkPkcs11W_Dispose(pkcs11);
CkCertW_Dispose(cert);
CkXmlW_Dispose(xml);
CkXmlDSigGenW_Dispose(gen);
CkStringBuilderW_Dispose(sbXml);
}