wus.core

wus.core is a .NET Core C# example on how to communicate with Digipoort, the Dutch government gateway for exchanging XBRL data. The Digipoort API interface uses SOAP based webservices following the WUS 2.0 protocol. This example assumes you are familiar with Digipoort and its purpose.

Most of the existing C# WUS 2.0 examples use the Windows Communication Foundation (WCF) framework, but Microsoft will not be porting this full framework to .NET Core as it is too tightly coupled to the Windows operating system.

There are projects like CoreWCF to enable WCF on .NET Core, but at this time there is no support for message security. And without message security it is not possible to have all the WS-* protocol support (Addressing, Security and Digital signatures) required by WUS 2.0.

The recommended successor to WCF on .NET Core is gRPC, however this framework will no longer support WS-* protocols

This C# example has its own WS-* protocol implementation, with the main part located in the WusXmlDSig.cs file. The rest of the implementation is pretty straightforward, using LINQ to XML, serializers, extensions and exceptions.

Requirements

• .NET Core 6.0
• PKIo X.509 (test) certificate for identification and signing

Note: All development and testing has been done under Linux.

Usage

• Get a copy of this example using: git clone https://github.com/pkortekaas/wus.core.git
• Do a dotnet restore to get all the dependency modules
• Main entrypoint is in WusClient/Program.cs
• Unit tests can be run using dotnet test -l "console;verbosity=normal"
• Make sure your PKIo certifcate can be found, either through the certificate store or from the local filesystem
• You should be all set to run: dotnet run --project WusClient from the solution directory
• The sample code runs again the Digipoort conformance or preprod environment

Remarks

• If you run into certificate chain validation issues, make sure all the required intermediate CA certifiates are installed. This is different on the various operating systems.
• Server certificates changes may require new thumbprints and ca chains
• Of the various status requests, only the (New)StatusProcess requests are implemented

Sample output

dotnet test -l "console;verbosity=normal"

Starting test execution, please wait...

A total of 1 test files matched the specified pattern.
[xUnit.net 00:00:00.00] xUnit.net VSTest Adapter v2.4.0 (64-bit .NET Core 3.1.13)
[xUnit.net 00:00:00.32]   Discovering: wus.core.Tests
[xUnit.net 00:00:00.36]   Discovered:  wus.core.Tests
[xUnit.net 00:00:00.36]   Starting:    wus.core.Tests
  √ wus.core.Tests.KeyInfoSecurityTokenTests.KeyInfoSecurityToken_SetTokenAndPrefixAndVerify_Pass [3ms]
  √ wus.core.Tests.InitialTests.X509Certificate_FindCertificate_Pass [8ms]
  √ wus.core.Tests.InitialTests.TestDataFiles_CheckExistence_Pass(fileName: "tampered-deliver-response.xml") [< 1ms]
  √ wus.core.Tests.InitialTests.TestDataFiles_CheckExistence_Pass(fileName: "valid-deliver-response.xml") [< 1ms]
  √ wus.core.Tests.InitialTests.TestDataFiles_CheckExistence_Pass(fileName: "fault-deliver-response.xml") [< 1ms]
  √ wus.core.Tests.InitialTests.TestDataFiles_CheckExistence_Pass(fileName: "fault-newstatus-response.xml") [< 1ms]
  √ wus.core.Tests.InitialTests.TestDataFiles_CheckExistence_Pass(fileName: "valid-instance.xbrl") [< 1ms]
  √ wus.core.Tests.InitialTests.TestDataFiles_CheckExistence_Pass(fileName: "valid-newstatus-response.xml") [< 1ms]
  √ wus.core.Tests.WusResponseTests.HandleResponse_FaultNewStatusResponse_Fail [18ms]
  √ wus.core.Tests.XmlSerializerTests.XmlSerializer_ToXml_Pass [20ms]
  √ wus.core.Tests.XmlSerializerTests.XmlSerializer_ToXElementHasOnlyDefaultNamespace_Pass [< 1ms]
  √ wus.core.Tests.XmlDSigTests.VerifySignature_ValidData_Pass [43ms]
  √ wus.core.Tests.XmlDSigTests.VerifySignature_TamperedData_Fail [2ms]
  √ wus.core.Tests.WusDocumentTests.CreateDocumentBytes_Create_Pass [47ms]
  √ wus.core.Tests.WusResponseTests.HandleResponse_ValidDelilverResponse_Pass [34ms]
  √ wus.core.Tests.WusDocumentTests.CreateDocumentBytes_CreateAndVerifySignature_Pass [6ms]
  √ wus.core.Tests.WusResponseTests.HandleResponse_ValidNewStatusResponse_Pass [9ms]
  √ wus.core.Tests.WusResponseTests.HandleResponse_FaultDeliverResponse_Fail [3ms]
  √ wus.core.Tests.WusResponseTests.HandleResponse_ValidNewStatusReturn_Pass [10ms]
  √ wus.core.Tests.WusResponseTests.HandleResponse_InvalidSignature_Fail [7ms]
  √ wus.core.Tests.WusProcessorTests.WusProcessor_NewStatusFault_Fail [104ms]
[xUnit.net 00:00:00.56]   Finished:    wus.core.Tests
  √ wus.core.Tests.WusProcessorTests.WusProcessor_Deliver_Pass [12ms]
  √ wus.core.Tests.WusProcessorTests.WusProcessor_NewStatus_Pass [12ms]
  √ wus.core.Tests.WusProcessorTests.WusProcessor_DeliverNullArgument_Fail [2ms]
  √ wus.core.Tests.WusProcessorTests.WusProcessor_NewStatusNullArgument_Fail [2ms]
  √ wus.core.Tests.WusProcessorTests.WusProcessor_DeliverFault_Fail [7ms]

Test Run Successful.
Total tests: 26
     Passed: 26
 Total time: 0.9826 Seconds

dotnet run -p WusClient

[18:02:48 INF] Program [Main] Startup
[18:02:48 INF] Program [Main] -------------------- Deliver --------------------
[18:02:49 DBG] HttpClientFactory [Create] Validate server certificate: 7C46D36D7D8B5B5CB14FCC6DDBCD551BDB8B1DD0 True
[18:02:49 INF] Program [Main] Aanleverkenmerk: Happyflow
[18:02:49 INF] Program [Main] Kenmerk: e5875052-f17b-4520-b7ec-ce41636e9934
[18:02:49 INF] Program [Main] ------------------- New Status ------------------
[18:02:49 INF] Program [Main] Status: 105 - Aanleverproces gestart.
[18:02:49 INF] Program [Main] Status: 100 - Aanleveren gelukt.
[18:02:49 INF] Program [Main] Status: 110 - Aanleverproces wordt aangeboden.
[18:02:49 INF] Program [Main] Status: 200 - Authenticatie gelukt.
[18:02:49 INF] Program [Main] Status: 301 - Validatie gelukt.
[18:02:49 INF] Program [Main] Status: 301 - Validatie gelukt.
[18:02:49 INF] Program [Main] Status: 405 - Afleveren naar uitvragende partij bezig...
[18:02:49 INF] Program [Main] Status: 400 - Afleveren uitvragende partij gelukt.
[18:02:49 INF] Program [Main] Status: 500 - Validatie bij de uitvragende partij gelukt.
[18:02:49 INF] Program [Main] ------------------- All Status ------------------
[18:02:49 INF] Program [Main] Status: 105 - Aanleverproces gestart.
[18:02:49 INF] Program [Main] Status: 100 - Aanleveren gelukt.
[18:02:49 INF] Program [Main] Status: 110 - Aanleverproces wordt aangeboden.
[18:02:49 INF] Program [Main] Status: 200 - Authenticatie gelukt.
[18:02:49 INF] Program [Main] Status: 301 - Validatie gelukt.
[18:02:49 INF] Program [Main] Status: 301 - Validatie gelukt.
[18:02:49 INF] Program [Main] Status: 405 - Afleveren naar uitvragende partij bezig...
[18:02:49 INF] Program [Main] Status: 400 - Afleveren uitvragende partij gelukt.
[18:02:49 INF] Program [Main] Status: 500 - Validatie bij de uitvragende partij gelukt.
[18:02:49 INF] Program [Main] Shutdown

References

Digipoort

Koppelvlak WUS voor bedrijven

Aansluit Suite Digipoort