(Delphi ActiveX) SOAP WS-Security UsernameToken

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 for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
xml: TChilkatXml;
wsse: TChilkatXml;
xHeader: IChilkatXml;
wsu_id: WideString;
password: WideString;
username: WideString;
prng: TChilkatPrng;
bd: TChilkatBinData;
nonce: WideString;
dt: TCkDateTime;
bLocal: Integer;
created: WideString;
crypt: TChilkatCrypt2;
passwordDigest: WideString;

begin
// This example requires the Chilkat Crypt API to have been previously unlocked.
// See Unlock Chilkat Crypt 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 := TChilkatXml.Create(Self);
xml.Tag := 'env:Envelope';
xml.AddAttribute('xmlns:env','http://www.w3.org/2003/05/soap-envelope');
xml.UpdateAttrAt('env:Header|n:alertcontrol',1,'xmlns:n','http://example.org/alertcontrol');
xml.UpdateChildContent('env:Header|n:alertcontrol|n:priority','1');
xml.UpdateChildContent('env:Header|n:alertcontrol|n:expires','2001-06-22T14:00:00-05:00');
xml.UpdateAttrAt('env:Body|m:alert',1,'xmlns:m','http://example.org/alert');
xml.UpdateChildContent('env:Body|m:alert|m:msg','Pick up Mary at school at 2pm');
Memo1.Lines.Add(xml.GetXml());
Memo1.Lines.Add('----');

// 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 := TChilkatXml.Create(Self);
wsse.Tag := 'wsse:Security';
wsse.UpdateAttrAt('wsse:UsernameToken',1,'xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
wsse.UpdateAttrAt('wsse:UsernameToken',1,'wsu:Id','WSU_ID');
wsse.UpdateChildContent('wsse:UsernameToken|wsse:Username','USERNAME');
wsse.UpdateAttrAt('wsse:UsernameToken|wsse:Password',1,'Type','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest');
wsse.UpdateChildContent('wsse:UsernameToken|wsse:Password','PASSWORD_DIGEST');
wsse.UpdateChildContent('wsse:UsernameToken|wsse:Nonce','NONCE');
wsse.UpdateChildContent('wsse:UsernameToken|wsu:Created','CREATED');
Memo1.Lines.Add(wsse.GetXml());
Memo1.Lines.Add('----');

// Insert the wsse:Security XML into the existing SOAP header:
xHeader := xml.GetChildWithTag('env:Header');
xHeader.AddChildTree(wsse.ControlInterface);

// Now show the SOAP XML with the wsse:Security header added:
Memo1.Lines.Add(xml.GetXml());
Memo1.Lines.Add('----');

// 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 := 'Example-1';
wsse.UpdateAttrAt('wsse:UsernameToken',1,'wsu:Id',wsu_id);

password := 'password';
username := 'user';
wsse.UpdateChildContent('wsse:UsernameToken|wsse:Username',username);

// The nonce should be 16 random bytes.
prng := TChilkatPrng.Create(Self);
bd := TChilkatBinData.Create(Self);
// Generate 16 random bytes into bd.
// Note: The GenRandomBd method is added in Chilkat v9.5.0.66
prng.GenRandomBd(16,bd.ControlInterface);

nonce := bd.GetEncoded('base64');
wsse.UpdateChildContent('wsse:UsernameToken|wsse:Nonce',nonce);

// Get the current date/time in a string with this format: 2010-06-08T07:26:50Z
dt := TCkDateTime.Create(Self);
dt.SetFromCurrentSystemTime();
bLocal := 0;
created := dt.GetAsTimestamp(bLocal);
wsse.UpdateChildContent('wsse:UsernameToken|wsu:Created',created);

// The password digest is calculated like this:
// Password_Digest = Base64 ( SHA-1 ( nonce + created + password ) )
bd.AppendString(created,'utf-8');
bd.AppendString(password,'utf-8');

crypt := TChilkatCrypt2.Create(Self);
crypt.HashAlgorithm := 'SHA-1';
crypt.EncodingMode := 'base64';
// Note: The HashBdENC method is added in Chilkat v9.5.0.66
passwordDigest := crypt.HashBdENC(bd.ControlInterface);
wsse.UpdateChildContent('wsse:UsernameToken|wsse:Password',passwordDigest);

// Examine the final SOAP XML with WS-Security header added.
Memo1.Lines.Add(xml.GetXml());
end;