Swift
Swift
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 Swift Downloads
func chilkatTest() {
// 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.
let xml = CkoXml()!
xml.tag = "env:Envelope"
xml.addAttribute(name: "xmlns:env", value: "http://www.w3.org/2003/05/soap-envelope")
xml.updateAttrAt(tagPath: "env:Header|n:alertcontrol", autoCreate: true, attrName: "xmlns:n", attrValue: "http://example.org/alertcontrol")
xml.updateChildContent(tagPath: "env:Header|n:alertcontrol|n:priority", value: "1")
xml.updateChildContent(tagPath: "env:Header|n:alertcontrol|n:expires", value: "2001-06-22T14:00:00-05:00")
xml.updateAttrAt(tagPath: "env:Body|m:alert", autoCreate: true, attrName: "xmlns:m", attrValue: "http://example.org/alert")
xml.updateChildContent(tagPath: "env:Body|m:alert|m:msg", value: "Pick up Mary at school at 2pm")
print("\(xml.getXml()!)")
print("----")
// 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>
let wsse = CkoXml()!
wsse.tag = "wsse:Security"
wsse.updateAttrAt(tagPath: "wsse:UsernameToken", autoCreate: true, attrName: "xmlns:wsu", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
wsse.updateAttrAt(tagPath: "wsse:UsernameToken", autoCreate: true, attrName: "wsu:Id", attrValue: "WSU_ID")
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsse:Username", value: "USERNAME")
wsse.updateAttrAt(tagPath: "wsse:UsernameToken|wsse:Password", autoCreate: true, attrName: "Type", attrValue: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest")
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsse:Password", value: "PASSWORD_DIGEST")
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsse:Nonce", value: "NONCE")
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsu:Created", value: "CREATED")
print("\(wsse.getXml()!)")
print("----")
// Insert the wsse:Security XML into the existing SOAP header:
var xHeader: CkoXml? = xml.getChild(withTag: "env:Header")
xHeader!.addChildTree(tree: wsse)
xHeader = nil
// Now show the SOAP XML with the wsse:Security header added:
print("\(xml.getXml()!)")
print("----")
// 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...
// -----------------------------------------------------
var wsu_id: String? = "Example-1"
wsse.updateAttrAt(tagPath: "wsse:UsernameToken", autoCreate: true, attrName: "wsu:Id", attrValue: wsu_id)
var password: String? = "password"
var username: String? = "user"
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsse:Username", value: username)
// The nonce should be 16 random bytes.
let prng = CkoPrng()!
let bd = CkoBinData()!
// Generate 16 random bytes into bd.
// Note: The GenRandomBd method is added in Chilkat v9.5.0.66
prng.genRandomBd(numBytes: 16, bd: bd)
var nonce: String? = bd.getEncoded(encoding: "base64")
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsse:Nonce", value: nonce)
// Get the current date/time in a string with this format: 2010-06-08T07:26:50Z
let dt = CkoDateTime()!
dt.setFromCurrentSystemTime()
var bLocal: Bool = false
var created: String? = dt.get(asTimestamp: bLocal)
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsu:Created", value: created)
// The password digest is calculated like this:
// Password_Digest = Base64 ( SHA-1 ( nonce + created + password ) )
bd.appendString(str: created, charset: "utf-8")
bd.appendString(str: password, charset: "utf-8")
let crypt = CkoCrypt2()!
crypt.hashAlgorithm = "SHA-1"
crypt.encodingMode = "base64"
// Note: The HashBdENC method is added in Chilkat v9.5.0.66
var passwordDigest: String? = crypt.hashBdENC(bd: bd)
wsse.updateChildContent(tagPath: "wsse:UsernameToken|wsse:Password", value: passwordDigest)
// Examine the final SOAP XML with WS-Security header added.
print("\(xml.getXml()!)")
}