(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Xml
oleobject loo_Wsse
oleobject loo_XHeader
string ls_Wsu_id
string ls_Password
string ls_Username
oleobject loo_Prng
oleobject loo_Bd
string ls_Nonce
oleobject loo_Dt
integer li_BLocal
string ls_Created
oleobject loo_Crypt
string ls_PasswordDigest

// 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.
loo_Xml = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")
if li_rc < 0 then
    destroy loo_Xml
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Xml.Tag = "env:Envelope"
loo_Xml.AddAttribute("xmlns:env","http://www.w3.org/2003/05/soap-envelope")
loo_Xml.UpdateAttrAt("env:Header|n:alertcontrol",1,"xmlns:n","http://example.org/alertcontrol")
loo_Xml.UpdateChildContent("env:Header|n:alertcontrol|n:priority","1")
loo_Xml.UpdateChildContent("env:Header|n:alertcontrol|n:expires","2001-06-22T14:00:00-05:00")
loo_Xml.UpdateAttrAt("env:Body|m:alert",1,"xmlns:m","http://example.org/alert")
loo_Xml.UpdateChildContent("env:Body|m:alert|m:msg","Pick up Mary at school at 2pm")
Write-Debug loo_Xml.GetXml()
Write-Debug "----"

// 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>

loo_Wsse = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_Wsse.ConnectToNewObject("Chilkat.Xml")

loo_Wsse.Tag = "wsse:Security"
loo_Wsse.UpdateAttrAt("wsse:UsernameToken",1,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
loo_Wsse.UpdateAttrAt("wsse:UsernameToken",1,"wsu:Id","WSU_ID")
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsse:Username","USERNAME")
loo_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")
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsse:Password","PASSWORD_DIGEST")
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsse:Nonce","NONCE")
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsu:Created","CREATED")
Write-Debug loo_Wsse.GetXml()
Write-Debug "----"

// Insert the wsse:Security XML into the existing SOAP header:
loo_XHeader = loo_Xml.GetChildWithTag("env:Header")
loo_XHeader.AddChildTree(loo_Wsse)
destroy loo_XHeader

// Now show the SOAP XML with the wsse:Security header added:
Write-Debug loo_Xml.GetXml()
Write-Debug "----"

// 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...
// -----------------------------------------------------

ls_Wsu_id = "Example-1"
loo_Wsse.UpdateAttrAt("wsse:UsernameToken",1,"wsu:Id",ls_Wsu_id)

ls_Password = "password"
ls_Username = "user"
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsse:Username",ls_Username)

// The nonce should be 16 random bytes.
loo_Prng = create oleobject
// Use "Chilkat_9_5_0.Prng" for versions of Chilkat < 10.0.0
li_rc = loo_Prng.ConnectToNewObject("Chilkat.Prng")

loo_Bd = create oleobject
// Use "Chilkat_9_5_0.BinData" for versions of Chilkat < 10.0.0
li_rc = loo_Bd.ConnectToNewObject("Chilkat.BinData")

// Generate 16 random bytes into bd.
// Note: The GenRandomBd method is added in Chilkat v9.5.0.66
loo_Prng.GenRandomBd(16,loo_Bd)

ls_Nonce = loo_Bd.GetEncoded("base64")
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsse:Nonce",ls_Nonce)

// Get the current date/time in a string with this format: 2010-06-08T07:26:50Z
loo_Dt = create oleobject
// Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
li_rc = loo_Dt.ConnectToNewObject("Chilkat.CkDateTime")

loo_Dt.SetFromCurrentSystemTime()
li_BLocal = 0
ls_Created = loo_Dt.GetAsTimestamp(li_BLocal)
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsu:Created",ls_Created)

// The password digest is calculated like this:
// Password_Digest = Base64 ( SHA-1 ( nonce + created + password ) )
loo_Bd.AppendString(ls_Created,"utf-8")
loo_Bd.AppendString(ls_Password,"utf-8")

loo_Crypt = create oleobject
// Use "Chilkat_9_5_0.Crypt2" for versions of Chilkat < 10.0.0
li_rc = loo_Crypt.ConnectToNewObject("Chilkat.Crypt2")

loo_Crypt.HashAlgorithm = "SHA-1"
loo_Crypt.EncodingMode = "base64"
// Note: The HashBdENC method is added in Chilkat v9.5.0.66
ls_PasswordDigest = loo_Crypt.HashBdENC(loo_Bd)
loo_Wsse.UpdateChildContent("wsse:UsernameToken|wsse:Password",ls_PasswordDigest)

// Examine the final SOAP XML with WS-Security header added.
Write-Debug loo_Xml.GetXml()


destroy loo_Xml
destroy loo_Wsse
destroy loo_Prng
destroy loo_Bd
destroy loo_Dt
destroy loo_Crypt