Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrianrudnik/digital-vaccination-wallet-reader-js
Javascript reader and validator for the QR code payloads issued by the European eHealth network.
https://github.com/adrianrudnik/digital-vaccination-wallet-reader-js
corona-warn-app coronavirus-info covpass digital-vaccination-wallet digitaler-impfpass ehealth vuejs vuejs3
Last synced: 2 months ago
JSON representation
Javascript reader and validator for the QR code payloads issued by the European eHealth network.
- Host: GitHub
- URL: https://github.com/adrianrudnik/digital-vaccination-wallet-reader-js
- Owner: adrianrudnik
- License: apache-2.0
- Created: 2021-06-20T12:26:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-19T13:39:25.000Z (over 3 years ago)
- Last Synced: 2024-05-01T17:17:43.784Z (8 months ago)
- Topics: corona-warn-app, coronavirus-info, covpass, digital-vaccination-wallet, digitaler-impfpass, ehealth, vuejs, vuejs3
- Language: JavaScript
- Homepage:
- Size: 273 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QR code payload reader and validator for the digital vaccination passport
This is a simple study on how to validate the QR codes flying
around in peoples pockets with a client side browser instance for
various reasons.
Works on certificates currently issued by the European eHealth network.
JavaScript is not my daily driver, so do not expect super shiny code.
I used this repo to research a possible integration of the german
Digitaler Impfpass to an already existing QR code reader based
entry control solution.
Not sure you want to use this in a commercial solution. The payload
contains special category data as defined by the GDPR Art 9(1). The
user has no way to "consent" to the access, there is no protection like
a simple access PIN or other safeguard. The wallet can also contain
certificates about other persons, not only the owner itself, which is
even worse.
The goal was to do all this in a client browser instance and only pass
the "abstract" result back to the backend. But processing is a very
broad term and does not differ between client and server side, as far
as I understand it. I could also not identify a clean way to fit this
into any exclusion made in GDPR Art 9(2) without some mental gymnastics.
## Project structure
`vuejs-example` contains the full web-based QR code scanner. Requires a
webcam and a QR code.
`lib.mjs` contains the decoding, reading and parsing parts.
`certificates.mjs` contains a static dump of the current issued and
allowed signers. See the comments on how and where to get them.
`example.mjs` is my test on my valid certificate.
## Run the vue.js based prototype
```bash
cd vuejs-example
yarn install
yarn run serve
```
and visit http://localhost:8080 to scan codes with an attached webcam.
## Run locally with node
Just put a valid LIVE QR code content into the `qrCode` variable inside
`example.mjs`.
This does not work with staging certificates.
```bash
yarn install
node example.mjs
```
Output will be something like this:
```js
{
certificates: [
{
CertificateIdentifier: 'URN:UVCI:01DE/A68...#1',
CountryOfVaccination: 'DE',
DoseNumber: 1,
DateOfVaccination: '2021-03-10',
CertificateIssuer: 'Robert Koch-Institut',
MarketingAuthorizationHolder: 'ORG-100030215',
VaccineMedicinalProduct: 'EU/1/20/1528',
TotalSeriesOfDoses: 2
}
],
person: {
Birthday: '1960-04-03',
Surname: 'x',
SurnameStandardised: 'X',
Forename: 'Y',
ForenameStandardised: 'Y'
}
}
```
This is just an example, and it does not read all available information
from it. Just parts to illustrate on how to.
## Covert QR to string on shell
I save the screenshot of the output from CovPass or Corona Warn App into
a JPG and do this on linux:
```bash
sudo apt-get install zbar-tools
zbarimg "code.jpg"
```
to extract a valid payload from it. Put the result into the `qrCode`
variable you can find in `example.mjs` for a test run.
## Why not build a clean lib?
I'm not into NPM. JavaScript is not my primary language. I do not have
the time to maintain this, I need to pay my rent and this is not a topic
I could earn a living from. Feel free to fork and improve.
## Why Apache licensed?
I'm not a lawyer. Most, if not all, public code around this eHealth stuff
is in Apache licensed, so I stuck with it. Want to change the license?
Feel free to do so on your own, I do not care for this example repo.
Other entities might though.
## Additional resources
To get a full overview of the available information on the payload, see
https://github.com/ehn-dcc-development/ehn-dcc-schema/blob/release/1.3.0/DCC.Core.Types.schema.json
https://github.com/ehn-dcc-development/ehn-dcc-schema/blob/release/1.3.0/DCC.Types.schema.json
Also, the example repository was pretty helpful:
https://github.com/ehn-dcc-development/dcc-testdata