PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkBinData.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkPrng.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkCrypt2.pb"
Procedure ChilkatExample()
; 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.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "env:Envelope")
CkXml::ckAddAttribute(xml,"xmlns:env","http://www.w3.org/2003/05/soap-envelope")
CkXml::ckUpdateAttrAt(xml,"env:Header|n:alertcontrol",1,"xmlns:n","http://example.org/alertcontrol")
CkXml::ckUpdateChildContent(xml,"env:Header|n:alertcontrol|n:priority","1")
CkXml::ckUpdateChildContent(xml,"env:Header|n:alertcontrol|n:expires","2001-06-22T14:00:00-05:00")
CkXml::ckUpdateAttrAt(xml,"env:Body|m:alert",1,"xmlns:m","http://example.org/alert")
CkXml::ckUpdateChildContent(xml,"env:Body|m:alert|m:msg","Pick up Mary at school at 2pm")
Debug CkXml::ckGetXml(xml)
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>
wsse.i = CkXml::ckCreate()
If wsse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(wsse, "wsse:Security")
CkXml::ckUpdateAttrAt(wsse,"wsse:UsernameToken",1,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
CkXml::ckUpdateAttrAt(wsse,"wsse:UsernameToken",1,"wsu:Id","WSU_ID")
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsse:Username","USERNAME")
CkXml::ckUpdateAttrAt(wsse,"wsse:UsernameToken|wsse:Password",1,"Type","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest")
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsse:Password","PASSWORD_DIGEST")
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsse:Nonce","NONCE")
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsu:Created","CREATED")
Debug CkXml::ckGetXml(wsse)
Debug "----"
; Insert the wsse:Security XML into the existing SOAP header:
xHeader.i = CkXml::ckGetChildWithTag(xml,"env:Header")
CkXml::ckAddChildTree(xHeader,wsse)
CkXml::ckDispose(xHeader)
; Now show the SOAP XML with the wsse:Security header added:
Debug CkXml::ckGetXml(xml)
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...
; -----------------------------------------------------
wsu_id.s = "Example-1"
CkXml::ckUpdateAttrAt(wsse,"wsse:UsernameToken",1,"wsu:Id",wsu_id)
password.s = "password"
username.s = "user"
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsse:Username",username)
; The nonce should be 16 random bytes.
prng.i = CkPrng::ckCreate()
If prng.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
bd.i = CkBinData::ckCreate()
If bd.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Generate 16 random bytes into bd.
; Note: The GenRandomBd method is added in Chilkat v9.5.0.66
CkPrng::ckGenRandomBd(prng,16,bd)
nonce.s = CkBinData::ckGetEncoded(bd,"base64")
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsse:Nonce",nonce)
; Get the current date/time in a string with this format: 2010-06-08T07:26:50Z
dt.i = CkDateTime::ckCreate()
If dt.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkDateTime::ckSetFromCurrentSystemTime(dt)
bLocal.i = 0
created.s = CkDateTime::ckGetAsTimestamp(dt,bLocal)
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsu:Created",created)
; The password digest is calculated like this:
; Password_Digest = Base64 ( SHA-1 ( nonce + created + password ) )
CkBinData::ckAppendString(bd,created,"utf-8")
CkBinData::ckAppendString(bd,password,"utf-8")
crypt.i = CkCrypt2::ckCreate()
If crypt.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkCrypt2::setCkHashAlgorithm(crypt, "SHA-1")
CkCrypt2::setCkEncodingMode(crypt, "base64")
; Note: The HashBdENC method is added in Chilkat v9.5.0.66
passwordDigest.s = CkCrypt2::ckHashBdENC(crypt,bd)
CkXml::ckUpdateChildContent(wsse,"wsse:UsernameToken|wsse:Password",passwordDigest)
; Examine the final SOAP XML with WS-Security header added.
Debug CkXml::ckGetXml(xml)
CkXml::ckDispose(xml)
CkXml::ckDispose(wsse)
CkPrng::ckDispose(prng)
CkBinData::ckDispose(bd)
CkDateTime::ckDispose(dt)
CkCrypt2::ckDispose(crypt)
ProcedureReturn
EndProcedure