Immuni European Federation Gateway Client

Documentation | Contributing

Table of contents

• Context
• Installation
• Contributing
  • Contributors
• Licence
  • Authors / Copyright
  • Third-party component licences
  • Licence details

Context

This repository contains the source code of Immuni's European Federation Gateway Client developed for the interoperability between national backend servers of decentralised contact tracing applications to combat COVID-19.

This client acts as a bridge between the Immuni backend and the federation gateway developed by the EU.

Its main purpose is essentially to allow the upload of the Italian TEKs and download the foreign TEKs from the federation gateway service.

In this way both Italian citizens who go abroad and foreign citizens who come to Italy are able to exchange their Temporary Exposure Keys and get notified if tested positive for the SARS-CoV-2 virus. This makes it possible to extend contact tracing to foreigners travelling in Italy and to Italians travelling abroad, without the need to download additional apps.

More detailed information about the European Federation Gateway Server (efgs) can be found in the following documents:

• Software Design European Federation Gateway Service

Please take the time to read and consider the other repositories in full before digging into the source code or opening an Issue. They contain a lot of details that are fundamental to understanding the source code and this repository's documentation.

Installation

Prerequisites

• Open JDK 11
• Maven

Maven based build

This is the recommended way for taking part in the development. Please check, whether following prerequisites are installed on your machine:

• Open JDK 11 or a similar JDK 11 compatible VM
• Maven

Build Docker Image

This project also supports building a Docker image.

To build the Docker image you need to build the project from the root:

git clone git@github.com:immuni-app/immuni-efgs-gateway-client.git
cd immuni-efgs-gateway-client
mvn clean package

For local testing first ensure you have a MongoDB and Redis instances running locally, then fill the envar in the enviroment section of the docker-compose.yml:

environment:
    MONGO_DB_URI=mongodb://user:password@mongodb:27017/EGFSDB-dev
    REDIS_URL=redis://:password@redis:15166

Also you need the EFGS server running locally, you can install it from the public repo European Federation Gateway Service.

To properly work the client needs also:

• an external signature service (rest API) SIGN_EXTERNAL_URL=https://host/v1/sign.

• the certificate for the connection in mTLS to the European Federation Gateway Service (the country of origin must be defined in the "country" field of the certificate subject) and pack it into a Java Key Store.

environment:
      - EFGS_BASE_URL=https://example.efgs.eu
      - SSLEFGS_JKS_PATH=/security/sslclient/sslefgs.jks
      - SSLEFGS_JKS_PASSWORD=password
      - SSLEFGS_CERT_PASSWORD=password

• the certificate for the connection in mTLS with the external signing service and pack it into a Java Key Store.

environment:
      - SIGN_EXTERNAL_URL=https://host/v1/sign
      - SSLDP_JKS_PATH=/security/sslclient/ssldp.jks
      - SSLDP_JKS_PASSWORD=password
      - SSLDP_CERT_PASSWORD=password

• TrustAnchor to verify the signature of member state certificates and pack it into a Java Key Store.

environment:
      - TRUST_JKS_PATH=/security/truststore/truststore.jks
      - TRUST_JKS_PASSWORD=password
      - TRUST_EFGS_ANCHOR_ALIAS=anchor_alias

Once the requirements above shown are satisfied open a shell with working directory and execute

docker-compose up --build

Contributing

Contributions are most welcome. Before proceeding, please read the Code of Conduct for guidance on how to approach the community and create a positive environment. Additionally, please read our CONTRIBUTING file, which contains guidance on ensuring a smooth contribution process.

To propose a feature request, please open an issue in the Documentation repository. This lets everyone involved see it, consider it, and participate in the discussion. Opening an issue or pull request in this repository may slow down the overall process.

Contributors

Here is a list of Immuni's contributors. Thank you to everyone involved for improving Immuni, day by day.

Licence

Authors / Copyright

Copyright 2020 (c) Presidenza del Consiglio dei Ministri.

Please check the AUTHORS file for extended reference.

Third-party component licences

Please see the Technology Description’s Backend Services Technologies section, which also lists the corresponding licences.

Licence details

The licence for this repository is a GNU Affero General Public Licence version 3 (SPDX: AGPL-3.0). Please see the LICENSE file for full reference.