(PHP Extension) Belgium eHealth Platform - checkAccessControl

See more Belgian eHealth Platform Examples

Note: This example requires Chilkat v11.0.0 or greater.

For more information, see https://www.ehealth.fgov.be/ehealthplatform/nl/beveiliging-van-webservices#1

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux

<?php

include("chilkat.php");

$success = false;

// This example assumes 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..
$cert = new CkCert();
$success = $cert->LoadPfxFile('SSIN=12345678.acc.p12','p12_password');
if ($success == false) {
    print $cert->lastErrorText() . "\n";
    exit;
}

// Create the XML to be signed...
$xmlToSign = new CkXml();
$xmlToSign->put_Tag('soapenv:Envelope');
$xmlToSign->AddAttribute('xmlns:soapenv','http://schemas.xmlsoap.org/soap/envelope/');
$xmlToSign->AddAttribute('xmlns:urn','urn:be:fgov:ehealth:platformintegrationconsumertest:v1');
$xmlToSign->AddAttribute('xmlns:urn1','urn:be:fgov:ehealth:platformintegrationconsumertest:types:v1');
$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-FC77E2C72083DA8E0F16711753508182856');

// ---------------------------------------------------------------------------------------------------------------
// A note about the Id's, such as X509-FC77E2C72083DA8E0F16711753508182856, TS-FC77E2C72083DA8E0F16711753508042855, etc.
// These Id's simply need to be unique within the XML document.  You don't need to generate new Id's every time.
// You can use the same Id's in each XML document that is submitted. The purpose of each Id is to
// match the XMLDsig Reference to the element in XML being referenced. 
// In other words, you could use the Id's "mickey_mouse", "donald_duck", and "goofy", and it would work perfectly OK,
// as long as no other XML elements also use the Id's "mickey_mouse", "donald_duck", or "goofy"
// ---------------------------------------------------------------------------------------------------------------

$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-FC77E2C72083DA8E0F16711753508042855');

$dt = new CkDateTime();
$dt->SetFromCurrentSystemTime();
$xmlToSign->UpdateChildContent('soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created',$dt->getAsTimestamp(false));
$dt->AddSeconds(3600);
$xmlToSign->UpdateChildContent('soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires',$dt->getAsTimestamp(false));
$dt->AddSeconds(-3600);

$xmlToSign->UpdateAttrAt('soapenv:Body',true,'wsu:Id','id-FC77E2C72083DA8E0F16711753508182859');
$xmlToSign->UpdateAttrAt('soapenv:Body',true,'xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
$xmlToSign->UpdateChildContent('soapenv:Body|urn:CheckAccessControlRequest|urn1:Message','Hello World');

// Create a timestamp with the current date/time in the following format: 2014-12-30T15:29:03.157+01:00

$xmlToSign->UpdateChildContent('soapenv:Body|urn:CheckAccessControlRequest|urn1:Timestamp',$dt->getAsTimestamp(true));

$gen = new CkXmlDSigGen();

$gen->put_SigLocation('soapenv:Envelope|soapenv:Header|wsse:Security|wsse:BinarySecurityToken');
$gen->put_SigLocationMod(1);
$gen->put_SigId('SIG-FC77E2C72083DA8E0F16711753508252860');
$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-FC77E2C72083DA8E0F16711753508182857');

// -------- Reference 1 --------
$gen->AddSameDocRef('TS-FC77E2C72083DA8E0F16711753508042855','sha256','EXCL_C14N','wsse soapenv urn urn1','');

// -------- Reference 2 --------
$gen->AddSameDocRef('id-FC77E2C72083DA8E0F16711753508182859','sha256','EXCL_C14N','urn urn1','');

// -------- Reference 3 --------
$gen->AddSameDocRef('X509-FC77E2C72083DA8E0F16711753508182856','sha256','EXCL_C14N','_EMPTY_','');

$gen->SetX509Cert($cert,true);

$gen->put_KeyInfoType('Custom');

// Create the custom KeyInfo XML..
$xmlCustomKeyInfo = new CkXml();
$xmlCustomKeyInfo->put_Tag('wsse:SecurityTokenReference');
$xmlCustomKeyInfo->AddAttribute('wsu:Id','STR-FC77E2C72083DA8E0F16711753508182858');
$xmlCustomKeyInfo->UpdateAttrAt('wsse:Reference',true,'URI','#X509-FC77E2C72083DA8E0F16711753508182856');
$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...
$sbXml = new CkStringBuilder();
$xmlToSign->GetXmlSb($sbXml);

$gen->put_Behaviors('IndentedSignature');

// Sign the XML...
$success = $gen->CreateXmlDSigSb($sbXml);
if ($success == false) {
    print $gen->lastErrorText() . "\n";
    exit;
}

// -----------------------------------------------
// Send the signed XML...
$http = new CkHttp();

$success = $http->SetSslClientCert($cert);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$http->SetRequestHeader('Content-Type','text/xml');

// Change to services.ehealth.fgov.be for the production environment.
$resp = new CkHttpResponse();
$success = $http->HttpSb('POST','https://services-acpt.ehealth.fgov.be/PlatformIntegrationConsumerTest/v1',$sbXml,'utf-8','application/xml',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->bodyStr() . "\n";
print 'response status code = ' . $resp->get_StatusCode() . "\n";

// A successful response is a 200 status code, with this sample response:

// <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
//    <soapenv:Header xmlns:v1="urn:be:fgov:ehealth:platformintegrationconsumertest:v1" xmlns:v11="urn:be:fgov:ehealth:platformintegrationconsumertest:types:v1"/>
//    <soapenv:Body xmlns:ic="urn:be:fgov:ehealth:platformintegrationconsumertest:v1" xmlns:type="urn:be:fgov:ehealth:platformintegrationconsumertest:types:v1">
//       <ic:CheckAccessControlResponse>
//          <type:Message>Hello World</type:Message>
//          <type:Timestamp>2023-09-28T22:17:26.643+02:00</type:Timestamp>
//          <type:AuthenticatedConsumer>CN="SSIN=aaaaaa", OU=eHealth-platform Belgium, OU=bbbb, OU="SSIN=aaaaaaa", O=Federal Government, C=BE</type:AuthenticatedConsumer>
//       </ic:CheckAccessControlResponse>
//    </soapenv:Body>
// </soapenv:Envelope>

?>