Development • Documentation • Support • Contribute • Contributors • Repositories • Licensing
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 verification portal for the Corona-Warn-App.
In the world of the Corona Warn App the Verification Portal allows hotline employees to generate teleTANs which are used by users of the mobile app to upload their diagnostic keys. The parts of the verification component cooperate in the following manner:
- The Verification Server of the Corona Warn App (repository: cwa-verification-server) helps validating whether upload requests from the mobile app are valid or not.
- The Verification Portal of the Corona Warn App (repository: cwa-verification-portal) allows hotline employees to generate teleTANs which are used by users of the mobile app to upload their diagnostic keys.
- The Verification Identity and Access of the Corona Warn App (repository: cwa-verification-iam) ensures that only authorized health personnel get access to the Verification Portal.
- The Test Result Server of the Corona Warn App (repository: cwa-testresult-server) receives the results from laboratories and delivers these results to the app via the verification-server.
In other words: For all People who are willing to join the tracing process and have a positive test result, there will be a service hotline one can call to get a temporary Transaction Authentication Number (TAN) to join the process. The agents at the service hotline will ask the caller some questions to verify his status and then provide one with a TAN. This serves as an interim solution until all laboratories have enabled the QR-code process and as a second option for users who did not choose to receive the test result through the app.
This component provides a simple user interface for the service agents to generate the temporary TeleTAN. For security reasons it cooperates with an Identity and Access Management (IAM) component using OpenID Connect standard protocols with additional 2-Factor-Authentication (2FA) based on one-time passwords (OTP). As mentioned above, the IAM component is hosted in another project of the corona-warn-app org.
This component can be built locally in order to test the functionality of the interfaces and verify the concepts it is build upon. There are two ways to build:
- Maven build - to run this component as spring application on your local machine
- Docker build - to run it as docker container build from the provided docker build file
Open JDK 11
Maven
(optional): Docker
Whether you cloned or downloaded the 'zipped' sources you will either find the sources in the chosen checkout-directory or get a zip file with the source code, which you can expand to a folder of your choice.
In either case open a terminal pointing to the directory you put the sources in. The local build process is described afterwards depending on the way you choose.
For actively take part on the development this is the way you should choose.
Please check, whether following prerequisites are fulfilled
- Open JDK 11 or a similar JDK 11 compatible VM
- Maven
is installed on your machine.
You can then open a terminal pointing to the root directory of the verification server and do the following:
mvn package
java -jar target/cwa-verification-portal-0.0.1-SNAPSHOT.jar
The verificationportal will start up and run locally on your machine available on port 8081. Please keep in mind, that you need another component [cwa-verification-iam] the get this running in a sensable manner.
We recommend that you first check the prerequisites to ensure that
is installed on your machine.
On the command line do the following:
docker build -f|--file <path to dockerfile> -t <imagename> <path-to-verificationportalserver-root>
docker run -p 127.0.0.1:8081:8081/tcp -it <imagename>or simply
docker build --pull --rm -f "Dockerfile" -t cwa-verificationportal "."
docker run -p 127.0.0.1:8081:8081/tcp -it cwa-verificationportalif you are in the root of the checked out repository.
The docker image will then run on your local machine on port 8081 assuming you configured docker for shared network mode.
This project has adopted the Contributor Covenant in version 2.0 as our code of conduct. Please see the details in our CODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.
We are building this application for Germany. We want to be as open and transparent as possible, also to interested parties in the global developer community who do not speak German. Later on this application might also serve as a template for other projects outside of Germany. For these reasons, we decided to apply English as the primary project language.
Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself, documentation and all end-user facing content will - of course - be made available in German (and probably other languages as well). We also try to make some developer documentation available in German, but please understand that focussing on the Lingua Franca of the global developer community makes the development of this application as efficient as possible.
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 white papers related to this implementation.
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
|---|---|
| General Discussion |  |
| Concept Feedback |  |
| Verification Portal Issue | |
| Other Requests |  |
Contribution and feedback is 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 AG and Deutsche Telekom AG 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.
Copyright (c) 2020-2022 Deutsche Telekom AG.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.