hartl3y94 / cwa-qr

Generate QR-Codes for checking into events using the official Corona Warn App.

Corona Warn App QR-Code Generator

Generate QR-Codes for checking into events using the official Corona Warn App.

---

Table of Contents

1. Introduction
2. Installation
3. Usage
4. Contributing
5. License

Introduction

Corona Warn App QR-Code Generator is a Go client library and command line application for creating QR-Codes which users of the official Corona Warn App can use to check into events.

It is an implementation of the Protocol used to generate event and location QR codes for the Corona Warn App as described in Coronatheir documentation.

This is not an official implementation! Use it at your own risk!

State

Currently, rotating QR-Codes is not implemented. The seed is random every time. This needs to be addressed. Unfortunaly, the documentation is missing context.

Installation

Download and install the pre-compiled binary manually

Binary releases are evailable on GitHub Releases.

Install using Homebrew

$ brew tap lukasmalkmus/tap
$ brew install cwa-qr

To update:

$ brew upgrade cwa-qr

Install using go get

$ go get github.com/lukasmalkmus/cwa-qr

Install from source

$ git clone https://github.com/lukasmalkmus/cwa-qr.git
$ cd cwa-qr
$ make install # Build and install binary into $GOPATH

Run the Docker image

Docker images are available on DockerHub.

$ docker pull lukasmalkmus/cwa-qr
$ docker run lukasmalkmus/cwa-qr

Validate installation

In all cases the installation can be validated by running cwa-qr -version in the terminal:

Corona Warn App QR-Code Generator version 1.0.0

Usage

$ cwa-qr [flags] <output-file>

Most basic usage:

$ cwa-qr event.png

Flags are optional. If not provided, the application questions for input on the command line.

Library usage

import cwaqr "github.com/lukasmalkmus/cwa-qr"

// ...

qrCode, err := cwaqr.GenerateQRCode(cwaqr.Event{
	// ...
})

// Write qrCode to file, etc.

Contributing

Feel free to submit PRs or to fill issues. Every kind of help is appreciated.

Before committing, make should run without any issues.

License

© Lukas Malkmus, 2021

Distributed under MIT License (The MIT License).

See LICENSE for more information.