Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Latest commit

 

History

History
92 lines (66 loc) · 4.53 KB

architecture-overview.md

File metadata and controls

92 lines (66 loc) · 4.53 KB
Raw

Software Design Verification Portal

by Alexander Stiefel (alexander.stiefel@t-systems.com)

Introduction

This document describes the component Verification Portal for the System “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. A teleTAN is a proof that somebody was tested positive for SARS-CoV-2.

This document links the overall system architecture with the software design of the Verification Portal, it links user stories with implementation inside the Verification Portal.

This document is intended to be read by people who want to get insights how verification for hotline and health authorities works in detail, it is our guideline for implementation. This document is a mixture of software design and requirement specification, it may be split in future.

Please be aware that several aspects in this document are not final, certain important information is missing.

Overview

Purpose of the Software Component

The primary scope of the component is to create a proof certificate (teleTAN) whether users were positive tested for SARS-CoV-2 or not. The proof is generated by hotline employees based on the information the can obtain. The scope of the Verification Portal is just the creation of the proof certificate - the teleTAN. Not in scope is the support of validating the request of people calling the hotline.

Context

The Verification Portal is part of the Portal Server. The Portal Server consists of this component and the Verification IAM and is a logical grouping of services and not a "Server" in the traditional sense.

The context is:

  • Verification Portal
    • a web portal allowing to generate teleTAN
  • Verification IAM
    • a Identity and Access Management software, managing users, right, roles and implementing two factor authentication
  • One Time Password Generator
    • used to provide the 2nd factor for authentication
  • Verification Server
    • System which trusts the Verification Portal and ultimately generates the teleTAN

Core Entities

Entity Definition
teleTAN Is a subtype of TAN with reduced length and life time. This TAN is handed over via phone and contains only uppercase letters and numbers, excluding 0,O and I,1,L. Length of teleTAN is 9 characters, plus 1 check character. The lifetime of a teleTAN is 1h. This entity is managed by Verification Server
SARS-CoV-2 Test A SARS-CoV-2 Test aggregates several probes donated by a single person to verified whether they proof an infection with the SARS-CoV-2 virus or not. A SARS-CoV-2 Test can have multiple states, “positive”, “negative”, “unknown”, “erroneous”

Software Design

Technology Stack

  1. Spring Boot
  2. Docker images for deployment

Security

Security of the portal is implemented by

  1. tight integration with Verification IAM
  2. using two factor authentication
  3. manual process for onboarding new users

Authentication

Authentication is based on the OpenID specifications, which works on top of the OAuth 2.0 (RFC 6749) framework. OpenID uses Json Web Tokens (JWT) which are signed by the IAM to provide integrity and authenticity.

Security Requirements

  1. Session Timeout The session timeout is 4 hours.

  2. Display timeout for teleTAN A teleTAN must not be shown after 10min.

  3. All server to server communications must be authenticated with client certificates

  4. Implement network connectivity between Verification Portal and Verification Server as special OTC route

Implemented Use Cases

Referenced User Stories

Will be detailed in later versions of this document

Actors

  1. Hotline Employee Has technical role "c19hotline". Is an employee which mainly triggers the use case Create teleTAN.
  2. Employee Health Authority Has technical role "c19healthauthority". Not implemented in the current release.
  3. Verifion Portal User Admin Has technical role "verificationPortalAdmin". Administrator who executes user administration in the Verification IAM
  4. Hotline Trustee Has technical role "c19hotlineTrustee", but is not implemented in this component, is implemented in a manual eMail based flow. This actor approves the requests for user creation in the Verification IAM

Use Cases

List of use cases

  1. Use Case Create teleTAN
  2. Use Case Login
  3. Use Case Logout
  4. Use Case Change Password
  5. Use Case Change 2nd Factor Device
  6. Use Case Password forgotten

Data Model

This component has no data to persist.