Sample code for 30+ languages & platforms
Java

eHealth.gov.be RequestSecurityToken

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

Chilkat Java Downloads

Java
import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    // 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..
    CkCert cert = new CkCert();
    success = cert.LoadPfxFile("SSIN=12345678.acc.p12","p12_password");
    if (success == false) {
        System.out.println(cert.lastErrorText());
        return;
        }

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

    CkXml xmlToSign = new CkXml();
    xmlToSign.put_Tag("soapenv:Envelope");
    xmlToSign.AddAttribute("xmlns:ns","http://docs.oasis-open.org/ws-sx/ws-trust/200512");
    xmlToSign.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",true,"EncodingType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",true,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3");
    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",true,"wsu:Id","X509-4A13D668E59AAC4F3816750824965588");

    CkBinData bdCert = new CkBinData();
    cert.ExportCertDerBd(bdCert);
    xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",bdCert.getEncoded("base64"));

    xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsu:Timestamp",true,"wsu:Id","TS-4A13D668E59AAC4F3816750824965567");

    CkDateTime dt = new CkDateTime();
    dt.SetFromCurrentSystemTime();
    xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created",dt.getAsTimestamp(false));
    dt.AddSeconds(300);
    xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires",dt.getAsTimestamp(false));
    dt.AddSeconds(-300);

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

    success = xmlToSign.UpdateAttrAt("soapenv:Body|wst:RequestSecurityToken|wst:Claims",true,"Dialect","http://docs.oasis-open.org/wsfed/authorization/200706/authclaims");
    success = xmlToSign.UpdateAttrAt("soapenv:Body|wst:RequestSecurityToken|wst:Claims|auth:ClaimType[1]",true,"Uri","urn:be:fgov:ehealth:1.0:certificateholder:person:ssin");

    xmlToSign.UpdateChildContent("soapenv:Body|wst:RequestSecurityToken|wst:KeyType","http://docs.oasis-open.org/ws-sx/wstrust/200512/PublicKey");

    CkXmlDSigGen gen = new CkXmlDSigGen();

    gen.put_SigLocation("soapenv:Envelope|soapenv:Header|wsse:Security|wsse:BinarySecurityToken");
    gen.put_SigLocationMod(1);
    gen.put_SigId("SIG-4A13D668E59AAC4F38167508249656212");
    gen.put_SigNamespacePrefix("ds");
    gen.put_SigNamespaceUri("http://www.w3.org/2000/09/xmldsig#");
    gen.put_SignedInfoPrefixList("soapenv urn urn1");
    gen.put_IncNamespacePrefix("ec");
    gen.put_IncNamespaceUri("http://www.w3.org/2001/10/xml-exc-c14n#");
    gen.put_SignedInfoCanonAlg("EXCL_C14N");
    gen.put_SignedInfoDigestMethod("sha256");

    // Set the KeyInfoId before adding references..
    gen.put_KeyInfoId("KI-4A13D668E59AAC4F3816750824965589");

    // -------- Reference 1 --------
    gen.AddSameDocRef("TS-4A13D668E59AAC4F3816750824965567","sha256","EXCL_C14N","wsse soapenv urn urn1","");

    // -------- Reference 2 --------
    gen.AddSameDocRef("id-4A13D668E59AAC4F38167508249655911","sha256","EXCL_C14N","urn urn1","");

    // -------- Reference 3 --------
    gen.AddSameDocRef("X509-4A13D668E59AAC4F3816750824965588","sha256","EXCL_C14N","_EMPTY_","");

    gen.SetX509Cert(cert,true);

    gen.put_KeyInfoType("Custom");

    // Create the custom KeyInfo XML..
    CkXml xmlCustomKeyInfo = new CkXml();
    xmlCustomKeyInfo.put_Tag("wsse:SecurityTokenReference");
    xmlCustomKeyInfo.AddAttribute("wsu:Id","STR-4A13D668E59AAC4F38167508249655810");
    xmlCustomKeyInfo.UpdateAttrAt("wsse:Reference",true,"URI","#X509-4A13D668E59AAC4F3816750824965588");
    xmlCustomKeyInfo.UpdateAttrAt("wsse:Reference",true,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3");

    xmlCustomKeyInfo.put_EmitXmlDecl(false);
    gen.put_CustomKeyInfoXml(xmlCustomKeyInfo.getXml());

    // Load XML to be signed...
    CkStringBuilder sbXml = new CkStringBuilder();
    xmlToSign.GetXmlSb(sbXml);

    gen.put_Behaviors("IndentedSignature");

    // Sign the XML...
    success = gen.CreateXmlDSigSb(sbXml);
    if (success == false) {
        System.out.println(gen.lastErrorText());
        return;
        }

    // The sbXml is sent as the HTTP request body below..
    System.out.println(sbXml.getAsString());

    // -----------------------------------------------------------------------------------------------------------
    // Send the SOAP requet to ask the server to issue a security token, which can then be used to access other SOAP services..
    CkHttp http = new CkHttp();

    success = http.SetSslClientCert(cert);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    http.SetRequestHeader("Content-Type","text/xml");

    String url = "https://services-acpt.ehealth.fgov.be/IAM/SecurityTokenService/v1/RequestSecurityToken";
    CkHttpResponse resp = new CkHttpResponse();
    success = http.HttpSb("POST",url,sbXml,"utf-8","application/xml",resp);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    int responseStatus = resp.get_StatusCode();
    System.out.println("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.

    System.out.println(resp.bodyStr());

    // 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.
    CkBinData bdSecToken = new CkBinData();
    resp.GetBodyBd(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

    bdSecToken.WriteFile("qa_data/tokens/ehealth-fgov-be-sectoken.xml");

    System.out.println("OK");
  }
}