The goal of this project is to develop the official Corona-Warn-App for Germany based on the exposure notification API from Apple and Google. The apps (for both iOS and Android) use Bluetooth technology to exchange anonymous encrypted data with other mobile phones (on which the app is also installed) in the vicinity of an app user's phone. The data is stored locally on each user's device, preventing authorities or other parties from accessing or controlling the data. This repository contains the implementation of the server for encryption keys for the Corona-Warn-App.
In this documentation, Corona-Warn-App services are also referred to as CWA services.
You can find the architecture overview here, which will give you a good starting point in how the backend services interact with other services, and what purpose they serve.
After you've checked out this repository, you can run the application in one of the following ways:
- As a Docker-based deployment on your local machine. You can run either:
- Single components using the respective Dockerfile or
- The full backend using the Docker Compose (which is considered the most convenient way)
- As a Maven-based build on your local machine. If you want to develop something in a single component, this approach is preferable.
If you want to use Docker-based deployment, you need to install Docker on your local machine. For more information about downloading and installing Docker, see the official Docker documentation.
For your convenience, a full setup for local development and testing purposes, including the generation of test data has been prepared using Docker Compose. To build the backend services, run
docker-compose build in the repository's root directory. A default configuration file can be found under
.env in the root folder of the repository. If the endpoints are to be exposed to the network the default values in this file should be changed before docker-compose is run.
Once the services are built, you can start the whole backend using
The distribution service runs once and then finishes. If you want to trigger additional distribution runs, run
docker-compose run distribution.
The docker-compose contains the following services:
|Service||Description||Endpoint and Default Credentials|
|submission||The Corona-Warn-App submission service||
|distribution||The Corona-Warn-App distribution service||NO ENDPOINT|
|postgres||A postgres database installation||
|pgadmin||A pgadmin installation for the postgres database||
|cloudserver||Zenko CloudServer is a S3-compliant object store||
Access key: accessKey1
Secret key: verySecretKey1
|verification-fake||A very simple fake implementation for the tan verification.||
The only valid tan is
In rare cases the docker-compose runs into a timing issue if the distribution service starts before the bucket of the objectstore was created. This is not a big issue as you can simply run
docker-compose run distribution to trigger additional distribution runs after the objectstore was initialized.
If you would like to build and run a single CWA service, it's considered easiest to run them in a Docker environment. You can do this using the script provided in the respective CWA service directory. The Docker script first builds the CWA service and then creates an image for the runtime, which means that there are no additional dependencies for you to install.
To build and run the distribution service, run the following command:
To build and run the submission service, run the following command:
The submission service is available on localhost:8080.
If you want to actively develop in one of the CWA services, the Maven-based runtime is most suitable. To prepare your machine to run the CWA project locally, we recommend that you first ensure that you've installed the following:
If you are already running a local Postgres, you need to create a database
cwa and run the following setup scripts:
- Create the different CWA roles first by executing create-roles.sql.
- Create local database users for the specific roles by running create-users.sql.
- It is recommended to also run enable-test-data-docker-compose.sql
, which enables the test data generation profile. If you already had CWA running before and an existing
diagnosis-keytable on your database, you need to run enable-test-data.sql instead.
You can also use
docker-compose to start Postgres and Zenko. If you do that, you have to
set the following environment-variables when running the Spring project:
For the distribution module:
POSTGRESQL_SERVICE_PORT=8001 VAULT_FILESIGNING_SECRET=</path/to/your/private_key> SPRING_PROFILES_ACTIVE=signature-dev,disable-ssl-client-postgres
For the submission module:
After you made sure that the specified dependencies are running, configure them in the respective configuration files.
- Configure the Postgres connection in the submission config and in the distribution config
- Configure the S3 compatible object storage in the distribution config
- Configure the private key for the distribution service, the path need to be prefixed with
VAULT_FILESIGNING_SECRETshould be the path to the private key, example available in
After you've checked out the repository, to build the project, run
mvn install in your base directory.
Navigate to the service you want to start and run the spring-boot:run target. The configured Postgres and the configured S3 compliant object storage are used as default. When you start the submission service, the endpoint is available on your local port 8080.
If you want to start the submission service, for example, you start it as follows:
cd services/submission/ mvn spring-boot:run
To enable the
DEBUG log level, you can run the application using the Spring
mvn spring-boot:run -Dspring.profiles.active=debug
To be able to set breakpoints (e.g. in IntelliJ), it may be necessary to use the
The API that is being exposed by the backend services is documented in an OpenAPI specification. The specification files are available at the following locations:
The full documentation for the Corona-Warn-App can be found in the cwa-documentation repository. The documentation repository contains technical documents, architecture information, and whitepapers related to this implementation.
The documentation for cwa-server can be found under the /docs folder.
The JavaDoc documentation for cwa-server is hosted by Github Pages at https://corona-warn-app.github.io/cwa-server.
The following channels are available for discussions, feedback, and support requests:
Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.
The German government has asked SAP and Deutsche Telekom to develop the Corona-Warn-App for Germany as open source software. Deutsche Telekom is providing the network and mobile technology and will operate and run the backend for the app in a safe, scalable and stable manner. SAP is responsible for the app development, its framework and the underlying platform. Therefore, development teams of SAP and Deutsche Telekom are contributing to this project. At the same time our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.
A list of all public repositories from the Corona-Warn-App can be found here.