(PureBasic) Belgium eHealth Platform - checkAccessControl

See more Belgian eHealth Platform Examples

Demonstrates the checkAccessControl operation of PlatformIntegrationConsumerTest, which requires an X.509 certificate and signature. This tests the validity of your certificate and signature.

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 PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkBinData.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkXmlDSigGen.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkCert.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,"SSIN=12345678.acc.p12","p12_password")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Create the XML to be signed...
    xmlToSign.i = CkXml::ckCreate()
    If xmlToSign.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::setCkTag(xmlToSign, "soapenv:Envelope")
    CkXml::ckAddAttribute(xmlToSign,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckAddAttribute(xmlToSign,"xmlns:urn","urn:be:fgov:ehealth:platformintegrationconsumertest:v1")
    CkXml::ckAddAttribute(xmlToSign,"xmlns:urn1","urn:be:fgov:ehealth:platformintegrationconsumertest:types:v1")
    CkXml::ckUpdateAttrAt(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::ckUpdateAttrAt(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::ckUpdateAttrAt(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::ckUpdateAttrAt(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::ckUpdateAttrAt(xmlToSign,"soapenv:Header|wsse:Security|wsse:BinarySecurityToken",1,"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.i = CkBinData::ckCreate()
    If bdCert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkCert::ckExportCertDerBd(cert,bdCert)

    CkXml::ckUpdateChildContent(xmlToSign,"soapenv:Header|wsse:Security|wsse:BinarySecurityToken",CkBinData::ckGetEncoded(bdCert,"base64"))
    CkXml::ckUpdateAttrAt(xmlToSign,"soapenv:Header|wsse:Security|wsu:Timestamp",1,"wsu:Id","TS-FC77E2C72083DA8E0F16711753508042855")

    dt.i = CkDateTime::ckCreate()
    If dt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(dt)
    CkXml::ckUpdateChildContent(xmlToSign,"soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created",CkDateTime::ckGetAsTimestamp(dt,0))
    CkDateTime::ckAddSeconds(dt,3600)
    CkXml::ckUpdateChildContent(xmlToSign,"soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires",CkDateTime::ckGetAsTimestamp(dt,0))
    CkDateTime::ckAddSeconds(dt,-3600)

    CkXml::ckUpdateAttrAt(xmlToSign,"soapenv:Body",1,"wsu:Id","id-FC77E2C72083DA8E0F16711753508182859")
    CkXml::ckUpdateAttrAt(xmlToSign,"soapenv:Body",1,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
    CkXml::ckUpdateChildContent(xmlToSign,"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

    CkXml::ckUpdateChildContent(xmlToSign,"soapenv:Body|urn:CheckAccessControlRequest|urn1:Timestamp",CkDateTime::ckGetAsTimestamp(dt,1))

    gen.i = CkXmlDSigGen::ckCreate()
    If gen.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXmlDSigGen::setCkSigLocation(gen, "soapenv:Envelope|soapenv:Header|wsse:Security|wsse:BinarySecurityToken")
    CkXmlDSigGen::setCkSigLocationMod(gen, 1)
    CkXmlDSigGen::setCkSigId(gen, "SIG-FC77E2C72083DA8E0F16711753508252860")
    CkXmlDSigGen::setCkSigNamespacePrefix(gen, "ds")
    CkXmlDSigGen::setCkSigNamespaceUri(gen, "http://www.w3.org/2000/09/xmldsig#")
    CkXmlDSigGen::setCkSignedInfoPrefixList(gen, "soapenv urn urn1")
    CkXmlDSigGen::setCkIncNamespacePrefix(gen, "ec")
    CkXmlDSigGen::setCkIncNamespaceUri(gen, "http://www.w3.org/2001/10/xml-exc-c14n#")
    CkXmlDSigGen::setCkSignedInfoCanonAlg(gen, "EXCL_C14N")
    CkXmlDSigGen::setCkSignedInfoDigestMethod(gen, "sha256")

    ; Set the KeyInfoId before adding references..
    CkXmlDSigGen::setCkKeyInfoId(gen, "KI-FC77E2C72083DA8E0F16711753508182857")

    ; -------- Reference 1 --------
    CkXmlDSigGen::ckAddSameDocRef(gen,"TS-FC77E2C72083DA8E0F16711753508042855","sha256","EXCL_C14N","wsse soapenv urn urn1","")

    ; -------- Reference 2 --------
    CkXmlDSigGen::ckAddSameDocRef(gen,"id-FC77E2C72083DA8E0F16711753508182859","sha256","EXCL_C14N","urn urn1","")

    ; -------- Reference 3 --------
    CkXmlDSigGen::ckAddSameDocRef(gen,"X509-FC77E2C72083DA8E0F16711753508182856","sha256","EXCL_C14N","_EMPTY_","")

    CkXmlDSigGen::ckSetX509Cert(gen,cert,1)

    CkXmlDSigGen::setCkKeyInfoType(gen, "Custom")

    ; Create the custom KeyInfo XML..
    xmlCustomKeyInfo.i = CkXml::ckCreate()
    If xmlCustomKeyInfo.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::setCkTag(xmlCustomKeyInfo, "wsse:SecurityTokenReference")
    CkXml::ckAddAttribute(xmlCustomKeyInfo,"wsu:Id","STR-FC77E2C72083DA8E0F16711753508182858")
    CkXml::ckUpdateAttrAt(xmlCustomKeyInfo,"wsse:Reference",1,"URI","#X509-FC77E2C72083DA8E0F16711753508182856")
    CkXml::ckUpdateAttrAt(xmlCustomKeyInfo,"wsse:Reference",1,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")

    CkXml::setCkEmitXmlDecl(xmlCustomKeyInfo, 0)
    CkXmlDSigGen::setCkCustomKeyInfoXml(gen, CkXml::ckGetXml(xmlCustomKeyInfo))

    ; Load XML to be signed...
    sbXml.i = CkStringBuilder::ckCreate()
    If sbXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckGetXmlSb(xmlToSign,sbXml)

    CkXmlDSigGen::setCkBehaviors(gen, "IndentedSignature")

    ; Sign the XML...
    success = CkXmlDSigGen::ckCreateXmlDSigSb(gen,sbXml)
    If success = 0
        Debug CkXmlDSigGen::ckLastErrorText(gen)
        CkCert::ckDispose(cert)
        CkXml::ckDispose(xmlToSign)
        CkBinData::ckDispose(bdCert)
        CkDateTime::ckDispose(dt)
        CkXmlDSigGen::ckDispose(gen)
        CkXml::ckDispose(xmlCustomKeyInfo)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    ; -----------------------------------------------
    ; Send the signed XML...
    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckSetSslClientCert(http,cert)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkCert::ckDispose(cert)
        CkXml::ckDispose(xmlToSign)
        CkBinData::ckDispose(bdCert)
        CkDateTime::ckDispose(dt)
        CkXmlDSigGen::ckDispose(gen)
        CkXml::ckDispose(xmlCustomKeyInfo)
        CkStringBuilder::ckDispose(sbXml)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    CkHttp::ckSetRequestHeader(http,"Content-Type","text/xml")

    ; Change to services.ehealth.fgov.be for the production environment.
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpSb(http,"POST","https://services-acpt.ehealth.fgov.be/PlatformIntegrationConsumerTest/v1",sbXml,"utf-8","application/xml",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkCert::ckDispose(cert)
        CkXml::ckDispose(xmlToSign)
        CkBinData::ckDispose(bdCert)
        CkDateTime::ckDispose(dt)
        CkXmlDSigGen::ckDispose(gen)
        CkXml::ckDispose(xmlCustomKeyInfo)
        CkStringBuilder::ckDispose(sbXml)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    Debug CkHttpResponse::ckBodyStr(resp)
    Debug "response status code = " + Str(CkHttpResponse::ckStatusCode(resp))

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


    CkCert::ckDispose(cert)
    CkXml::ckDispose(xmlToSign)
    CkBinData::ckDispose(bdCert)
    CkDateTime::ckDispose(dt)
    CkXmlDSigGen::ckDispose(gen)
    CkXml::ckDispose(xmlCustomKeyInfo)
    CkStringBuilder::ckDispose(sbXml)
    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure