Giter Site home page Giter Site logo

edsmilovici / covidpass Goto Github PK

View Code? Open in Web Editor NEW

This project forked from billylo1/covidpass

0.0 0.0 0.0 2.44 MB

Web app for adding Ontario vaccination records to Apple Wallet (forked from covidpass in EU)

Home Page: https://grassroots.vaccine-ontario.ca

License: MIT License

Dockerfile 1.79% JavaScript 3.54% TypeScript 93.41% Shell 1.25%

covidpass's Introduction

Grassroots

This web-based tool allows you to add your Ontario Vaccination Receipt as a pass into your Apple Wallet on iOS in a privacy-respecting way. It achieves this without sending your data to a server and instead uses a hashed representation for the signing step.

Here is a demo

Quick start

  • Go to https://grassroots.vaccine-ontario.ca
  • Click Ontario Health to download your vaccination receipt onto your iPhone (local storage)
  • Select File, Browse, your-vaccine-receipt.pdf
  • Add to the wallet

Debug the web app

yarn install
yarn dev

Run the Docker container

docker build . -t covidpass
docker run -t -i -p 3000:3000 covidpass

FAQ

I do not want to trust a third party with my vaccination data, does this tool respect my privacy?

Processing of your data happens entirely in your browser and only a hashed representation is sent to the server for the signing step.

How do I make sure that nobody can access my vaccination pass from the lock screen (iOS)?

Navigate to the "TouchID & Code" or "FaceID & Code" or just "Code" section in the Settings and switch the toggle to off for Wallet in the section "Allow access from the lock screen". Also see this official guide from Apple.

Using your own Apple Developer Certificate (if you would like to fork this project and run it yourself)

Get your certificate

  • Sign into your Apple Developer Account

  • Go to Certificates, Identifiers and Profiles

  • Register a new Pass Type Identifier under the Identifiers tab

  • Create a new Pass Type ID Certificate under the Certificates tab

  • Select your previously created Pass Type Identifier in the process

  • Move your new certificate to the My Certificates tab in the keychain

  • Export your certificate as a .p12 file

  • Install node.js and download the passkit-keys script

  • Create a keys folder and put the .p12 file inside

  • Run ./passkit-keys <path to your keys folder>

  • You may have to type in the passphrase you defined during the export step

Run the API locally

A description of how you can use your certificate locally with the API will be provided in the readme of the CovidPass API. To connect the web app to your local server, you have to set the API_BASE_URL environment variable accordingly.

Explanation of the process

The whole process of generating the pass file happens locally in your browser. For the signing step, a hashed representation of your data is sent to the server.

First, the following steps happen locally in your browser:

  • Validating the digital signature on the receipt from Ontario Health to ensure it's authentic
  • Decoding your vaccination event data from the PDF file (e.g. date, type of vaccine, dose #, organization who administered it
  • Assembling a pkpass file out of your data
  • Sending the serial number and vaccination event data for verification when the QR code is scanned.
  • Generating a file containing hashes of the data stored in the pass file
  • Sending only the file containing the hashes to the server

Second, the following steps happen on the server:

  • Receiving and checking the hashes which were generated locally
  • Signing the file containing the hashes
  • Sending the signature back

Finally, the following steps happen locally in your browser:

  • Assembling the signed pass file out of the incomplete file generated locally and the signature
  • Saving the file on your device

Logging

  • Sentry.io is used. Please put your DSN into your environment variable SENTRY_DSN at runtime to activate it.

Credits

The idea for this web app originated from the solution of an Austrian web developer, which only works for Austrian certificates at the moment.

The main codebase is forked from covidpass and added Ontario specifcs.

Contribute

Contributions to this project is welcome. Feel free to leave your suggestions, issues or pull requests.

covidpass's People

Contributors

marvinsxtr avatar billylo1 avatar hauketoenjes avatar mackonsti avatar soerenbusse avatar etimberg avatar everdrone avatar j3r3m067 avatar ein-tim avatar frawolf avatar khaost avatar mcvendrell avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.