mirror of
https://github.com/covidpass-org/covidpass.git
synced 2025-02-23 15:07:44 +01:00
minor adjustment
This commit is contained in:
parent
6fa29a501c
commit
bfdef3153f
27
README.md
27
README.md
@ -1,21 +1,13 @@
|
||||
# Grassroots
|
||||
|
||||
This web app offers the ability to add your Ontario Vaccination Receipt as a pass into your Apple Wallet on iOS. Grassroots accomplishes this without sending your data to a server and instead only uses a hashed representation for the signing step.
|
||||
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 only uses a hashed representation for the signing step.
|
||||
|
||||
Here is a [demo](https://www.youtube.com/watch?v=AIrG5Qbjptg)
|
||||
|
||||
# Getting started
|
||||
|
||||
If you want to add your vaccination certificate into your wallet with Grassroots, there are two main options.
|
||||
|
||||
* Visit [https://grassroots.vaccine-ontario.ca](https://grassroots.vaccine-ontario.ca)
|
||||
|
||||
# Quick start
|
||||
|
||||
## Using our service
|
||||
|
||||
* Go to [https://grassroots.vaccine-ontario.ca](https://grassroots.vaccine-ontario.ca)
|
||||
* Click Ontario Health to download your vaccination receipt onto your iPhone
|
||||
* Click Ontario Health to download your vaccination receipt onto your iPhone (local storage)
|
||||
* Select File, Browse, your-vaccine-receipt.pdf
|
||||
* Add to the wallet
|
||||
|
||||
@ -35,15 +27,15 @@ docker run -t -i -p 3000:3000 covidpass
|
||||
|
||||
# FAQ
|
||||
|
||||
#### I do not want to trust a third party with my vaccination data, what makes this a secure option?
|
||||
#### 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.
|
||||
Processing of your data happens entirely in your mobile 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](https://support.apple.com/guide/iphone/control-access-information-lock-screen-iph9a2a69136/ios) from Apple.
|
||||
|
||||
# Using your own Apple Developer Certificate
|
||||
# Using your own Apple Developer Certificate (if you would like to fork this project and run it yourself)
|
||||
|
||||
## Get your certificate
|
||||
|
||||
@ -60,7 +52,6 @@ Navigate to the "TouchID & Code" or "FaceID & Code" or just "Code" section in th
|
||||
* 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
|
||||
* Base64 encode the contents of the newly generated .pem file inside the keys folder
|
||||
|
||||
## Run the API locally
|
||||
|
||||
@ -73,8 +64,8 @@ The whole process of generating the pass file happens locally in your browser. F
|
||||
|
||||
First, the following steps happen locally in your browser:
|
||||
|
||||
* Validating the digital signature on the receipt to ensure it's authentic
|
||||
* Decoding your vaccination event data from the PDF file
|
||||
* 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
|
||||
* Generating a file containing hashes of the data stored in the pass file
|
||||
* Sending only the file containing the hashes to the server
|
||||
@ -94,8 +85,8 @@ Finally, the following steps happen locally in your browser:
|
||||
|
||||
The idea for this web app originated from the [solution of an Austrian web developer](https://coronapass.fabianpimminger.com), which only works for Austrian certificates at the moment.
|
||||
|
||||
The main codebase is forked from [covidpass](https://github.com/covidpass-org/covidpass)
|
||||
The main codebase is forked from [covidpass](https://github.com/covidpass-org/covidpass) and added Ontario specifcs.
|
||||
|
||||
# Contribute
|
||||
|
||||
Any contribution to this project is welcome. Feel free to leave your suggestions, issues or pull requests.
|
||||
Contributions to this project is welcome. Feel free to leave your suggestions, issues or pull requests.
|
||||
|
Loading…
x
Reference in New Issue
Block a user