top of page
Search

Joining X-road infrastructure as a service provider

Writer: Andres Ehrenpreis
Andres Ehrenpreis
Aug 19, 2021
3 min read

Updated: Sep 1, 2021



For the start I will give the most up to date links where the most trustworthy information is given.

  1. Short descriptive article about the actions needed to be done (by RIA): https://abi.ria.ee/xtee/et/x-tee-juhend/x-teega-liitumine (doesn't have all the steps that a technical project manager should consider)

  2. Central documentation for all the instructions needed for joining X-road (by RIA): https://www.ria.ee/et/riigi-infosusteem/x-tee/liitumine.html

  3. X-road self-service portal: https://x-tee.ee/home

  4. How to order certs from RIHA: https://abi.ria.ee/xtee/et/x-tee-iseteeninduskeskkond/sertifikaatide-taotlemine also some description about AUTH vs SIGN certs needed when joining x-road (explained below)

  5. Ruby on Rails gem for communicating on X-road: https://github.com/domify/x_road

For me these were either too much in detail or on the contrary- too much simplified. I would have wished to have more suitable instructions for technical project manager role. Therefore I created my own instruction-set which I had to go through:


Requirements for your system before joining

Following is necessary for every environment you are planning to connect to x-road (dev, staging, production):

  • Static IP(s): either one or many if you should have any load balancer or sth like that. This is needed since the HSM security server requires special whitelist rules to let your traffic through

    • For development environment you might need to prepare VPN connection with static IP if you should have distributed team.

  • Self-signed certificate (CLIENT cert from here on), you can prepare it with the following command:

sudo openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout xroad_application.key -out xroad_application.crt


Steps to set up successful connection

  1. Sign contract with RIA to join X-road. You will find the link for the contract from here or download it directly from here.

  2. Register your institution and sub-service in x-road self-service portal: https://x-tee.ee/

  3. Either setup your own security server or use any of the providers (Telia or EENet for example). Since EENet works in the areas of science, culture and education, then you need to qualify as their client first (decision is made based on looking at your company's statute document).


Steps to join external service provider's x-road security server (HSM)

  1. Contact the provider and send them necessary information:

    1. your company name

    2. reg.-code

    3. contact details

    4. x-road environments (dev, test, prod)

    5. ...

  2. Receive certificate request generated by the security server service provider and their security server's basic information which might be needed in next steps

  3. Based on the CSR received in previous step order your security-server certificate (SIGN cert from here on), but be sure to order it from the right place! Clarify which CSRs you received- are they good for certs from SK ID Solutions or RIHA:

    1. For example Telia might create CSR for cert from RIHA. In that case you can order SIGN cert from x-tee.ee. Instructions for that are here: https://abi.ria.ee/xtee/et/x-tee-iseteeninduskeskkond/sertifikaatide-taotlemine

    2. EENet might send you CSR for cert from SK ID Solutions. You can place the cert-order through a form here: https://www.skidsolutions.eu/teenused/teenused-x-tee-liikmele/?service/x_tee_member Make sure you pick the correct environment (dev, test, production)!

  4. Make the CLIENT certificate as instructed in Requirements for your system before joining

  5. When you receive the SIGN certificate, send it to the security server service provider together with the CLIENT certificate you created in previous step.

Now you should be ready to go. As next steps you probably want to use some services and registries available in X-road. For that contact them directly and describe your need. If the agree then they will open first the test-service to you and after legal signed agreement you can also make use of the production services/registries.


PS! If you liked the article you can buy me a coffee to support me going! :)



Recent Posts

See All

Comments


bottom of page