Sample code for 30+ languages & platforms
Tcl Requires Chilkat v11.0.0+

eHealth.gov.be RequestSecurityToken

Request a security token for use with the eHealth.gov.be SOAP web services.

Chilkat Tcl Downloads

Download Chilkat for Tcl
Tcl 

load ./chilkat.dll

set success 0

#  This requires the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

#  Provide a certificate + private key.
#  Note: If your certificate + private key is located on a hardware token or smartcard, you can call a different function to load from smartcard..
set cert [new_CkCert]

set success [CkCert_LoadPfxFile $cert "SSIN=12345678.acc.p12" "p12_password"]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkCert $cert
    exit
}

#  Create the following XML to be signed..

#  <?xml version="1.0" encoding="UTF-8"?>
#  <soapenv:Envelope xmlns:ns="http://docs.oasis-open.org/ws-sx/ws-trust/200512" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
#  	<soapenv:Header>
#  		<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
#  		xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
#  			<wsse:BinarySecurityToken EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary" 
#  			    ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" 
#  			    wsu:Id="X509-4A13D668E59AAC4F3816750824965588">{organization certificate}</wsse:BinarySecurityToken>			
#  			<wsu:Timestamp wsu:Id="TS-4A13D668E59AAC4F3816750824965567">
#  				<wsu:Created>2023-02-01T12:42:11.156Z</wsu:Created>
#  				<wsu:Expires>2023-02-01T12:58:51.156Z</wsu:Expires>
#  			</wsu:Timestamp>
#  		</wsse:Security>
#  	</soapenv:Header>
#  	<soapenv:Body wsu:Id="id-4A13D668E59AAC4F38167508249655911" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
#  		<wst:RequestSecurityToken Context="RC-302613de-a809-46b5-931a-0a55bfca5937" 
#  		    xmlns:auth="http://docs.oasis-open.org/wsfed/authorization/200706"
#  		    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
#  		    xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
#  		    xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
#  		    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
#  		    xmlns:wst="http://docs.oasis-open.org/ws-sx/ws-trust/200512">
#  			<wst:TokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1</wst:TokenType>
#  			<wst:RequestType>http://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue</wst:RequestType>
#  			<wst:Claims Dialect="http://docs.oasis-open.org/wsfed/authorization/200706/authclaims">
#  				<auth:ClaimType Uri="urn:be:fgov:kbo-bce:organization:cbe-number">
#  					<auth:Value>{cbenumber}</auth:Value>
#  				</auth:ClaimType>
#  				<auth:ClaimType Uri="urn:be:fgov:ehealth:1.0:certificateholder:enterprise:cbe-number">
#  					<auth:Value>{cbenumber}</auth:Value>
#  				</auth:ClaimType>
#  			</wst:Claims>
#  			<wst:Lifetime>
#  				<wsu:Created>2023-02-01T08:30:10+02:00</wsu:Created>
#  				<wsu:Expires>2023-02-01T09:30:10+02:00</wsu:Expires>
#  			</wst:Lifetime>
#  			<wst:KeyType>http://docs.oasis-open.org/ws-sx/wstrust/200512/PublicKey</wst:KeyType>
#  		</wst:RequestSecurityToken>
#  	</soapenv:Body>
#  </soapenv:Envelope>

set xmlToSign [new_CkXml]

CkXml_put_Tag $xmlToSign "soapenv:Envelope"
CkXml_AddAttribute $xmlToSign "xmlns:ns" "http://docs.oasis-open.org/ws-sx/ws-trust/200512"
CkXml_AddAttribute $xmlToSign "xmlns:soapenv" "http://schemas.xmlsoap.org/soap/envelope/"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Header|wsse:Security" 1 "xmlns:wsse" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Header|wsse:Security" 1 "xmlns:wsu" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Header|wsse:Security|wsse:BinarySecurityToken" 1 "EncodingType" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Header|wsse:Security|wsse:BinarySecurityToken" 1 "ValueType" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Header|wsse:Security|wsse:BinarySecurityToken" 1 "wsu:Id" "X509-4A13D668E59AAC4F3816750824965588"

set bdCert [new_CkBinData]

CkCert_ExportCertDerBd $cert $bdCert
CkXml_UpdateChildContent $xmlToSign "soapenv:Header|wsse:Security|wsse:BinarySecurityToken" [CkBinData_getEncoded $bdCert "base64"]

CkXml_UpdateAttrAt $xmlToSign "soapenv:Header|wsse:Security|wsu:Timestamp" 1 "wsu:Id" "TS-4A13D668E59AAC4F3816750824965567"

set dt [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dt
CkXml_UpdateChildContent $xmlToSign "soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created" [CkDateTime_getAsTimestamp $dt 0]
CkDateTime_AddSeconds $dt 300
CkXml_UpdateChildContent $xmlToSign "soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires" [CkDateTime_getAsTimestamp $dt 0]
CkDateTime_AddSeconds $dt -300

CkXml_UpdateAttrAt $xmlToSign "soapenv:Body" 1 "wsu:Id" "id-4A13D668E59AAC4F38167508249655911"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body" 1 "xmlns:wsu" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "Context" "RC-302613de-a809-46b5-931a-0a55bfca5937"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "xmlns:auth" "http://docs.oasis-open.org/wsfed/authorization/200706"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "xmlns:ds" "http://www.w3.org/2000/09/xmldsig#"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "xmlns:wsa" "http://schemas.xmlsoap.org/ws/2004/08/addressing"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "xmlns:wsp" "http://schemas.xmlsoap.org/ws/2004/09/policy"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "xmlns:wsse" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken" 1 "xmlns:wst" "http://docs.oasis-open.org/ws-sx/ws-trust/200512"
CkXml_UpdateChildContent $xmlToSign "soapenv:Body|wst:RequestSecurityToken|wst:TokenType" "http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1"
CkXml_UpdateChildContent $xmlToSign "soapenv:Body|wst:RequestSecurityToken|wst:RequestType" "http://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue"

set success [CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken|wst:Claims" 1 "Dialect" "http://docs.oasis-open.org/wsfed/authorization/200706/authclaims"]
set success [CkXml_UpdateAttrAt $xmlToSign "soapenv:Body|wst:RequestSecurityToken|wst:Claims|auth:ClaimType[1]" 1 "Uri" "urn:be:fgov:ehealth:1.0:certificateholder:person:ssin"]

CkXml_UpdateChildContent $xmlToSign "soapenv:Body|wst:RequestSecurityToken|wst:KeyType" "http://docs.oasis-open.org/ws-sx/wstrust/200512/PublicKey"

set gen [new_CkXmlDSigGen]

CkXmlDSigGen_put_SigLocation $gen "soapenv:Envelope|soapenv:Header|wsse:Security|wsse:BinarySecurityToken"
CkXmlDSigGen_put_SigLocationMod $gen 1
CkXmlDSigGen_put_SigId $gen "SIG-4A13D668E59AAC4F38167508249656212"
CkXmlDSigGen_put_SigNamespacePrefix $gen "ds"
CkXmlDSigGen_put_SigNamespaceUri $gen "http://www.w3.org/2000/09/xmldsig#"
CkXmlDSigGen_put_SignedInfoPrefixList $gen "soapenv urn urn1"
CkXmlDSigGen_put_IncNamespacePrefix $gen "ec"
CkXmlDSigGen_put_IncNamespaceUri $gen "http://www.w3.org/2001/10/xml-exc-c14n#"
CkXmlDSigGen_put_SignedInfoCanonAlg $gen "EXCL_C14N"
CkXmlDSigGen_put_SignedInfoDigestMethod $gen "sha256"

#  Set the KeyInfoId before adding references..
CkXmlDSigGen_put_KeyInfoId $gen "KI-4A13D668E59AAC4F3816750824965589"

#  -------- Reference 1 --------
CkXmlDSigGen_AddSameDocRef $gen "TS-4A13D668E59AAC4F3816750824965567" "sha256" "EXCL_C14N" "wsse soapenv urn urn1" ""

#  -------- Reference 2 --------
CkXmlDSigGen_AddSameDocRef $gen "id-4A13D668E59AAC4F38167508249655911" "sha256" "EXCL_C14N" "urn urn1" ""

#  -------- Reference 3 --------
CkXmlDSigGen_AddSameDocRef $gen "X509-4A13D668E59AAC4F3816750824965588" "sha256" "EXCL_C14N" "_EMPTY_" ""

CkXmlDSigGen_SetX509Cert $gen $cert 1

CkXmlDSigGen_put_KeyInfoType $gen "Custom"

#  Create the custom KeyInfo XML..
set xmlCustomKeyInfo [new_CkXml]

CkXml_put_Tag $xmlCustomKeyInfo "wsse:SecurityTokenReference"
CkXml_AddAttribute $xmlCustomKeyInfo "wsu:Id" "STR-4A13D668E59AAC4F38167508249655810"
CkXml_UpdateAttrAt $xmlCustomKeyInfo "wsse:Reference" 1 "URI" "#X509-4A13D668E59AAC4F3816750824965588"
CkXml_UpdateAttrAt $xmlCustomKeyInfo "wsse:Reference" 1 "ValueType" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"

CkXml_put_EmitXmlDecl $xmlCustomKeyInfo 0
CkXmlDSigGen_put_CustomKeyInfoXml $gen [CkXml_getXml $xmlCustomKeyInfo]

#  Load XML to be signed...
set sbXml [new_CkStringBuilder]

CkXml_GetXmlSb $xmlToSign $sbXml

CkXmlDSigGen_put_Behaviors $gen "IndentedSignature"

#  Sign the XML...
set success [CkXmlDSigGen_CreateXmlDSigSb $gen $sbXml]
if {$success == 0} then {
    puts [CkXmlDSigGen_lastErrorText $gen]
    delete_CkCert $cert
    delete_CkXml $xmlToSign
    delete_CkBinData $bdCert
    delete_CkDateTime $dt
    delete_CkXmlDSigGen $gen
    delete_CkXml $xmlCustomKeyInfo
    delete_CkStringBuilder $sbXml
    exit
}

#  The sbXml is sent as the HTTP request body below..
puts [CkStringBuilder_getAsString $sbXml]

#  -----------------------------------------------------------------------------------------------------------
#  Send the SOAP requet to ask the server to issue a security token, which can then be used to access other SOAP services..
set http [new_CkHttp]

set success [CkHttp_SetSslClientCert $http $cert]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkCert $cert
    delete_CkXml $xmlToSign
    delete_CkBinData $bdCert
    delete_CkDateTime $dt
    delete_CkXmlDSigGen $gen
    delete_CkXml $xmlCustomKeyInfo
    delete_CkStringBuilder $sbXml
    delete_CkHttp $http
    exit
}

CkHttp_SetRequestHeader $http "Content-Type" "text/xml"

set url "https://services-acpt.ehealth.fgov.be/IAM/SecurityTokenService/v1/RequestSecurityToken"
set resp [new_CkHttpResponse]

set success [CkHttp_HttpSb $http "POST" $url $sbXml "utf-8" "application/xml" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkCert $cert
    delete_CkXml $xmlToSign
    delete_CkBinData $bdCert
    delete_CkDateTime $dt
    delete_CkXmlDSigGen $gen
    delete_CkXml $xmlCustomKeyInfo
    delete_CkStringBuilder $sbXml
    delete_CkHttp $http
    delete_CkHttpResponse $resp
    exit
}

set responseStatus [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $responseStatus"

#  You'll want to check to see if the response status code = 200.
#  If not, then the response body contains error information instead of a security token.
#  This example will assume we received 200 status code.

puts [CkHttpResponse_bodyStr $resp]

#  The response body contains XML like this:

#  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
#      <SOAP-ENV:Header/>
#      <SOAP-ENV:Body>
#          <wst:RequestSecurityTokenResponse xmlns:wst="http://docs.oasis-open.org/ws-sx/ws-trust/200512" Context="RC-302613de-a809-46b5-931a-0a55bfca5937">
#              <wst:RequestedSecurityToken>
#                  <Assertion xmlns="urn:oasis:names:tc:SAML:1.0:assertion" AssertionID="_3e8ea5c951b2167c274974750ace9b5d" 
#  ...
#                  </Assertion>
#              </wst:RequestedSecurityToken>
#          </wst:RequestSecurityTokenResponse>
#      </SOAP-ENV:Body>
#  </SOAP-ENV:Envelope>

#  The portion of the response from  <Assertion ..> ... </Assertion>  is the SAML security token to be included
#  in a subsesquent SOAP request.  It is extremely important to not modify the contents of the security token in any way, including not changing
#  whitespace or any formatting.  Therefore, we get the response body exactly as-is, to be used in a SOAP request.

#  Copy the response body to a Chilkat BinData object.
set bdSecToken [new_CkBinData]

CkHttpResponse_GetBodyBd $resp $bdSecToken

#  Let's save the bdSecToken to a file, and pick it up in the next example where it is used
#  in a SOAP request, such as in this example:  AddressBook Search for Professionals

CkBinData_WriteFile $bdSecToken "qa_data/tokens/ehealth-fgov-be-sectoken.xml"

puts "OK"

delete_CkCert $cert
delete_CkXml $xmlToSign
delete_CkBinData $bdCert
delete_CkDateTime $dt
delete_CkXmlDSigGen $gen
delete_CkXml $xmlCustomKeyInfo
delete_CkStringBuilder $sbXml
delete_CkHttp $http
delete_CkHttpResponse $resp
delete_CkBinData $bdSecToken