Unicode C
Unicode C
SOAP WS-Security UsernameToken
See more XML Examples
Demonstrates how to add a UsernameToken with the WSS SOAP Message Security header.Note: This example requires Chilkat v9.5.0.66 or later.
Chilkat Unicode C Downloads
#include <C_CkXmlW.h>
#include <C_CkPrngW.h>
#include <C_CkBinDataW.h>
#include <C_CkDateTimeW.h>
#include <C_CkCrypt2W.h>
void ChilkatSample(void)
{
HCkXmlW xml;
HCkXmlW wsse;
HCkXmlW xHeader;
const wchar_t *wsu_id;
const wchar_t *password;
const wchar_t *username;
HCkPrngW prng;
HCkBinDataW bd;
const wchar_t *nonce;
HCkDateTimeW dt;
BOOL bLocal;
const wchar_t *created;
HCkCrypt2W crypt;
const wchar_t *passwordDigest;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// An HTTP SOAP request is an HTTP request where the SOAP XML composes the body.
// This example demonstrates how to add a WS-Security header such as the following:
//
// <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="SecurityToken-6138db82-5a4c-4bf7-915f-af7a10d9ae96">
// <wsse:Username>user</wsse:Username>
// <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">CBb7a2itQDgxVkqYnFtggUxtuqk=</wsse:Password>
// <wsse:Nonce>5ABcqPZWb6ImI2E6tob8MQ==</wsse:Nonce>
// <wsu:Created>2010-06-08T07:26:50Z</wsu:Created>
// </wsse:UsernameToken>
//
// First build some simple SOAP XML that has some header and body.
xml = CkXmlW_Create();
CkXmlW_putTag(xml,L"env:Envelope");
CkXmlW_AddAttribute(xml,L"xmlns:env",L"http://www.w3.org/2003/05/soap-envelope");
CkXmlW_UpdateAttrAt(xml,L"env:Header|n:alertcontrol",TRUE,L"xmlns:n",L"http://example.org/alertcontrol");
CkXmlW_UpdateChildContent(xml,L"env:Header|n:alertcontrol|n:priority",L"1");
CkXmlW_UpdateChildContent(xml,L"env:Header|n:alertcontrol|n:expires",L"2001-06-22T14:00:00-05:00");
CkXmlW_UpdateAttrAt(xml,L"env:Body|m:alert",TRUE,L"xmlns:m",L"http://example.org/alert");
CkXmlW_UpdateChildContent(xml,L"env:Body|m:alert|m:msg",L"Pick up Mary at school at 2pm");
wprintf(L"%s\n",CkXmlW_getXml(xml));
wprintf(L"----\n");
// The following SOAP XML is built:
// <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
// <env:Header>
// <n:alertcontrol xmlns:n="http://example.org/alertcontrol">
// <n:priority>1</n:priority>
// <n:expires>2001-06-22T14:00:00-05:00</n:expires>
// </n:alertcontrol>
// </env:Header>
// <env:Body>
// <m:alert xmlns:m="http://example.org/alert">
// <m:msg>Pick up Mary at school at 2pm</m:msg>
// </m:alert>
// </env:Body>
// </env:Envelope>
//
// Now build the WSSE XML housing that we'll insert into the above SOAP XML at the end.
// <wsse:Security>
// <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="WSU_ID">
// <wsse:Username>USERNAME</wsse:Username>
// <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">PASSWORD_DIGEST</wsse:Password>
// <wsse:Nonce>NONCE</wsse:Nonce>
// <wsu:Created>CREATED</wsu:Created>
// </wsse:UsernameToken>
// </wsse:Security>
wsse = CkXmlW_Create();
CkXmlW_putTag(wsse,L"wsse:Security");
CkXmlW_UpdateAttrAt(wsse,L"wsse:UsernameToken",TRUE,L"xmlns:wsu",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd");
CkXmlW_UpdateAttrAt(wsse,L"wsse:UsernameToken",TRUE,L"wsu:Id",L"WSU_ID");
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsse:Username",L"USERNAME");
CkXmlW_UpdateAttrAt(wsse,L"wsse:UsernameToken|wsse:Password",TRUE,L"Type",L"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest");
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsse:Password",L"PASSWORD_DIGEST");
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsse:Nonce",L"NONCE");
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsu:Created",L"CREATED");
wprintf(L"%s\n",CkXmlW_getXml(wsse));
wprintf(L"----\n");
// Insert the wsse:Security XML into the existing SOAP header:
xHeader = CkXmlW_GetChildWithTag(xml,L"env:Header");
CkXmlW_AddChildTree(xHeader,wsse);
CkXmlW_Dispose(xHeader);
// Now show the SOAP XML with the wsse:Security header added:
wprintf(L"%s\n",CkXmlW_getXml(xml));
wprintf(L"----\n");
// Now our XML looks like this:
// <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
// <env:Header>
// <n:alertcontrol xmlns:n="http://example.org/alertcontrol">
// <n:priority>1</n:priority>
// <n:expires>2001-06-22T14:00:00-05:00</n:expires>
// </n:alertcontrol>
// <wsse:Security>
// <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="WSU_ID">
// <wsse:Username>USERNAME</wsse:Username>
// <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">PASSWORD_DIGEST</wsse:Password>
// <wsse:Nonce>NONCE</wsse:Nonce>
// <wsu:Created>CREATED</wsu:Created>
// </wsse:UsernameToken>
// </wsse:Security>
// </env:Header>
// <env:Body>
// <m:alert xmlns:m="http://example.org/alert">
// <m:msg>Pick up Mary at school at 2pm</m:msg>
// </m:alert>
// </env:Body>
// </env:Envelope>
//
// -----------------------------------------------------
// Now let's fill-in-the-blanks with actual information...
// -----------------------------------------------------
wsu_id = L"Example-1";
CkXmlW_UpdateAttrAt(wsse,L"wsse:UsernameToken",TRUE,L"wsu:Id",wsu_id);
password = L"password";
username = L"user";
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsse:Username",username);
// The nonce should be 16 random bytes.
prng = CkPrngW_Create();
bd = CkBinDataW_Create();
// Generate 16 random bytes into bd.
// Note: The GenRandomBd method is added in Chilkat v9.5.0.66
CkPrngW_GenRandomBd(prng,16,bd);
nonce = CkBinDataW_getEncoded(bd,L"base64");
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsse:Nonce",nonce);
// Get the current date/time in a string with this format: 2010-06-08T07:26:50Z
dt = CkDateTimeW_Create();
CkDateTimeW_SetFromCurrentSystemTime(dt);
bLocal = FALSE;
created = CkDateTimeW_getAsTimestamp(dt,bLocal);
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsu:Created",created);
// The password digest is calculated like this:
// Password_Digest = Base64 ( SHA-1 ( nonce + created + password ) )
CkBinDataW_AppendString(bd,created,L"utf-8");
CkBinDataW_AppendString(bd,password,L"utf-8");
crypt = CkCrypt2W_Create();
CkCrypt2W_putHashAlgorithm(crypt,L"SHA-1");
CkCrypt2W_putEncodingMode(crypt,L"base64");
// Note: The HashBdENC method is added in Chilkat v9.5.0.66
passwordDigest = CkCrypt2W_hashBdENC(crypt,bd);
CkXmlW_UpdateChildContent(wsse,L"wsse:UsernameToken|wsse:Password",passwordDigest);
// Examine the final SOAP XML with WS-Security header added.
wprintf(L"%s\n",CkXmlW_getXml(xml));
CkXmlW_Dispose(xml);
CkXmlW_Dispose(wsse);
CkPrngW_Dispose(prng);
CkBinDataW_Dispose(bd);
CkDateTimeW_Dispose(dt);
CkCrypt2W_Dispose(crypt);
}