Lurkars/esp-ena
1
0
Fork 0
mirror of https://github.com/Lurkars/esp-ena.git synced 2024-11-22 18:16:10 +01:00
Code Issues Projects Releases Wiki Activity
7e82c695ea
esp-ena/README.md

254 lines
11 KiB
Markdown
Raw Blame History

# esp-ena
Implementation of contact tracing with the Covid-19 Exposure Notification API by Apple and Google on an ESP32 (with [ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html)).
More information about the Covid-19 Exposure Notification at [Apple](https://www.apple.com/covid19/contacttracing/) and [Google](https://www.google.com/covid19/exposurenotifications/). This is fully compatible with the official API and is meant for people without smartphone or without access to Apple/Google's implementation.
The main source (the Exposure Notification API) is also available in a separate branch in [**component**](https://github.com/Lurkars/esp-ena/tree/component).
This implementation fully covers the BLE part including the cryptography specifications needed and the exposure check.
The following acronyms will be used in code and comments:
* *ENA* Exposure Notification API
* *ENIN* ENIntervalNumber - timestamp 10 minutes resolution
* *TEK* Temporary Exposure Key - personal secret key changed every 24h, published when infected
* *RPI* Rolling Proximity Identifier - send and received identifier changed every 10 minutes
* *AEM* Associated Encrypted Metadata - send and received metadata
### Features implemented
* send/receive BLE beacons as defined in [Bluetooth® Specification (Apple/Google)](https://blog.google/documents/70/Exposure_Notification_-_Bluetooth_Specification_v1.2.2.pdf) and [Cryptography Specification (Apple/Google)](https://blog.google/documents/69/Exposure_Notification_-_Cryptography_Specification_v1.2.1.pdf)
* BLE privacy (change random MAC address in random interval)
* permanent storage on flash of last keys, beacons and exposures (storage is limited, see [storage math](#some-storage-math) for details)
* calculating exposure risks/scores (after adding reported keys and storing exposure information) as defined in [ENExposureConfiguration (Apple v1)](https://developer.apple.com/documentation/exposurenotification/enexposureconfiguration/calculating_the_exposure_risk_value_in_exposurenotification_version_1)
* receive Exposure Key export from an ENA Exposure Key export proxy server [ena-eke-proxy module](#ena-eke-proxy), see [ena-eke-proxy server reference implemenation](https://github.com/Lurkars/ena-eke-proxy)
* Upload of own Exposure keys to proxy server
### Additional features for full ENA device
Interface with display and input to
* show exposure status
* connect to WiFi
* delete data
* set language (currently supported: English and German)
* set timezone
* enter tan and uploading own exposure keys
* set time and date (if no RTC/NTP available)
#### supported devices
##### M5StickC and M5StickC PLUS
* RTC support
* display support
* PMU support
* input with 2 buttons and accelerometer control
* ok/cancel with button 1 and button 2 (depending on screen orientation)
* up, down, left, right by tilting device
* long press button 1 for changing character set on input
##### Custom device
* RTC support with DS3231 (for correct system time)
* display support with SSD1306
* input with a 7 button control (joystick up,down,left,right,enter,cancel,ok)
* battery support with ESP32 development boards with integrated LiPo support
##### LILYGO TTGO T-Wristband \[in development\]
* display support
* RTC and input in development
### Limitations/Problems/Questions
* WiFi or other external connection needed for infections status (auto-connect to open WiFis?)
* obtaining accessibility
* all parameters (scanning time, thresholds etc.)
* service UUID is send reversed, RPI and AEM also send in reverse? Don't know BLE specification enough
### some storage math
Due to limited storage, I made some calculations. I have fixed counting of TEKs (14 for two weeks), temporary beacons (1000, longest period for temp. storage is 20 minutes, so recognizing about 1000 different beacons in 20 minutes is possible) and exposure information (choose 500, this is like a limit of infected keys to be met). So the biggest limitation is to store beacons permanently after threshold of 5 minutes. That's what those calculations are for to check, if storage is enough for practical use.
overview of storage in bytes without permanent beacons:
| | size (B) | num | overall (B) |
| :-----------: | -------: | ---: | ----------: |
| TEK | 21 | 14 | 294 |
| Exposure Info | 20 | 500 | 10000 |
| temp. Beacon | 32 | 1000 | 32000 |
Additional 4 bytes counting for every type gives overall 42310B used without perm. beacons.
For now, a partition size of 2494464B will leave 2452154B free for met beacons which leads to a total storage of 76629
beacons. This gives the following table, where I added some lower boundaries to calculate with.
| total beacons | aver. per day | aver. for 10 minute window |
| ------------: | ------------: | -------------------------: |
| 50000 | 3571 | 24 |
| 70000 | 5000 | 34 |
| 76629 | 5473 | 38 |
So on average it is possible to meet 38 (24 on a lower boundary) different devices inside of 10 minutes. I have no practical experience/numbers how many beacons are stored on average for a 14-days period in currently running ENA-Apps. But I think regarding the average is calculated for 24h (which is quite unpractical because of sleep and hours without meeting many people), the storage should be enough for the purpose of contact tracing.
## How to use
### Hardware Required
For base functionality just an ESP32 is required, for full device M5StickC (PLUS) or for a custom device DS3231 RTC, SSD1306 Display and 7 buttons are required.
### Configure the project
```
idf.py menuconfig
```
**required**
* enable Bluetooth (BLE)
> Component config -> Bluetooth -> [*] Bluetooth
* add partition-table for storage (currently hardcoded name "ena")
> Partition Table -> Partition table -> (x) Custom partition table CSV
* mbedTLS enable HKDF
> Component config -> mbedTLS -> [*] HKDF algorithm (RFC 5869)
* flash size > 3.9GB
> Serial flasher config -> Flash size -> (x) 4MB
* choose interface device (custom, M5StickC, M5StickC PLUS, TTGO T-Wristband \[in development\])
> ENA Interface -> ENA Interface device
***important***
If you ran into error ``region 'iram0_0_seg' overflowed by xxx bytes`` you can try disabling WiFi IRAM optimization
> Component config -> Wi-Fi -> WiFi IRAM speed optimization -> ( )
> Component config -> Wi-Fi -> WiFi RX IRAM speed optimization -> ( )
**recommended**
* BLE *Scan Duplicate* (By Device Address and Advertising Data)
> Component config -> Bluetooth -> Bluetooth controller -> Scan Duplicate Type -> (X) Scan Duplicate By Device Address And Advertising Data
**debug options**
* Log output set to Debug
> Component config -> Log output -> Default log verbosity -> (X) Debug
* Exposure Notification API / Storage enable *Dump storage*
> Exposure Notification API -> Storage -> [X] Dump storage
#### Configure SSL cert manually!
For *ena-eke-proxy* connection over SSL a valid certificate for used server under *components/ena-eke-proxy/certs/cert.pem* is required.
For my own proxy server, I have added a self signed cert for cwa-proxy.champonthis.de. For using, copy or rename *components/ena-eke-proxy/certs/cwa-proxy.champonthis.de.pem* to *components/ena-eke-proxy/certs/cert.pem*.
> copy valid cert to *components/ena-eke-proxy/certs/cert.pem*
### Build and Flash
May flash partition table:
```
idf.py partition_table-flash -b 1500000
```
Build the project and flash it to the board, then run monitor tool to view serial output:
```
idf.py -p PORT flash -b 1500000 monitor
```
(Replace PORT with the name of the serial port to use.)
(To exit the serial monitor, type ``Ctrl-]``.)
## Structure
The project is divided in different components. The main.c just wrap up all components. The Exposure Notification API is in **ena** module.
### ena
The ena module contains the main functions of eps-ena with Bluetooth scanning and advertising, storing data, handle beacons and check exposure.
* *ena-beacons* handles scanned data by storing temporary beacons, check for threshold and store beacons permanently
* *ena-crypto* covers cryptography part (key creation, encryption etc.)
* *ena-storage* storage part to store own TEKs and beacons
* *ena-bluetooth-scan* BLE scans for detecting other beacons
* *ena-bluetooth-advertise* BLE advertising to send own beacons
* *ena-exposure* compare exposed keys with stored beacons, calculate score and risk
* *ena* run all together and timing for scanning and advertising
### ena-eke-proxy
This module is for connecting to an Exposure Key export proxy server. The server must provide daily (and could hourly) fetch of daily keys in binary blob batches with the following format
| Key Data | Rolling Start Interval Number | Rolling Period | Days Since Onset Of Symptoms |
| :------: | :---------------------------: | :------------: | :--------------------------: |
| 16 bytes | 4 bytes | 4 bytes | 4 bytes |
Request URL is parametrized with {day-string},({hour} in hourly mode,) {page}, {page-size}.
### interface
Adds interface functionality for control and setup.
#### interface/custom-input
Interface input with 7 button input.
#### interface/m5-input
Interface input for M5StickC (PLUS) with 2 button input and accelerometer as axis input.
#### interface-m5-mpu6886
I²C driver for MPU6886 6-Axis IMU of M5StickC (PLUS).
#### interface/ttgo-input \[in development\]
Interface input for TTGO T-Wristband with 1 button input and accelerometer as axis input.
#### interface/ttgo-lsm9ds1 \[in development\]
I²C driver for LSM9DS1 6-Axis IMU of TTGO T-Wristband.
### display
General module for display and gfx.
#### display/custom-ssd1306
I²C driver for a SSD1306 display, implementation of [display](#-display) module.
### display/m5-axp192
I²C driver for AXP192 PMU of M5StickC (PLUS).
#### display/m5-st7735s
SPI driver for a ST7735s display of M5StickC, implementation of [display](#-display) module.
#### display/m5-st7789
SPI driver for a ST7789 display of M5StickC PLUS, implementation of [display](#-display) module
#### display/ttgo-st7735
SPI driver for a ST7735 display of TTGO T-Wristband, implementation of [display](#-display) module.
### rtc
General module for set/get time from RTC.
#### rtc/custom-ds3231
I²C driver for a DS3231 RTC, implementation of [rtc](#-rtc) module.
#### rtc/m5-bm8563
I²C driver for BM8563 of M5StickC (PLUS), implementation of [rtc](#-rtc) module.
### i2c-main
Just start I²C driver.
### ena-binary-export \[deprecated\]
Module to decode Exposure Key export. \[Deprecated through ena-eke-proxy module\]
### ena-cwa \[deprecated\]
Connection to German Exposure App ([Corona Warn App](https://github.com/corona-warn-app)) for download Exposure Key export (and maybe later report infection). \[Deprecated through ena-eke-proxy module\]
### nanopb \[deprecated\]
[Nanopb](https://github.com/nanopb/nanopb) for reading Protocol Buffers of Exposure Key export. Including already generated Headers from *.proto files. \[Deprecated through ena-eke-proxy module\]
Reference in New Issue View Git Blame Copy Permalink