diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ebc5872 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +## Code of Conduct + +This Code of Conduct is adapted from the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +Instances of abusive, harassing, or otherwise unacceptable behavior across GitHub [SafeSafe-app](https://github.com/SafeSafe-app) organization may be reported by contacting the SafeSafe-app Code of Conduct Committee via community@safesafe.app. For other projects, please contact apropriate project maintainer or our mediator - Mateusz Romanów mr@safesafe.app. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..df455b4 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,9 @@ +## Contributing +Our guidelines are mostly located around [.github](/.github/) directory of the project. + +### ToC for contributors +- [Code of Conduct](CODE_OF_CONDUCT.md) +- [Issues & Support](SUPPORT.md) +- [License](/LICENSE) +- [Security](SECURITY.md) +- [Pull request](PULL_REQUEST_TEMPLATE/README.md) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE/README.md b/.github/PULL_REQUEST_TEMPLATE/README.md new file mode 100644 index 0000000..e5d3e96 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/README.md @@ -0,0 +1,24 @@ +## Pull Requests +Use apropriate template and don't forget about [DISCLAIMER](#DISCLAIMER) +- [Pull Request Template](pull_request_template.md) +- [Personal License Disclaimer Form](https://github.com/SafeSafe-app/pwa) + +## DISCLAIMER +We require Digitally Signed Personal Agreement for Contributors collaborating on the project to accept their Pull Requests - it's Public Health so We need Public Trust thus introducing digital two-factor authentication for The Makers - also Apple doesn't go well with GNU so We make them do so manually by following these steps: +1. Remember SafeSafe-app software is being released on [GNU GENERAL PUBLIC LICENSE](https://github.com/SafeSafe-app/pwa/blob/master/LICENSE) +2. If You would like to contribute any changes to our project repositories You are the author and the owner of these changes, by the law of [GitHub Terms of Use](https://help.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license) You automatically grant license for these changes . +3. Mitigating any kind of misunderstanding around copyrights as well as lack of trust for unknown entities in public sector we ask that every Pull Request author verify aforementioned license grants for proposed changes through : + * [Downloading personal license disclaimer form](/DISCLAIMER.pdf) which states that the author: + * confirms GPL license grant for proposed changes + * permits everyone and anyone who agrees with the license statements to distribute this software freely in any form or format even in public software providers such as Apple's App Store, Google's Play Store, GitHub, etc. + * commits the author of changes not to execute his personal copyrights to dismiss them or their license for any reason + * Digitally signing the completed license statement form with compatible digital signature: + * [Trusted digital signature](https://www.gov.pl/web/gov/podpisz-dokument-elektronicznie-wykorzystaj-podpis-zaufany) + * [Qualified digital signature](https://pl.wikipedia.org/wiki/Podpis_kwalifikowany) + * [Personal digital signature](https://www.gov.pl/web/e-dowod/podpis-osobisty) + * Sending completed and signed license disclaimer form to [protego@mc.gov.pl](mailto:protego@mc.gov.pl) with: + * Title: `Oświadczenie GitHub` + * Note: Ministry of Digitalization will become your administrator of personal data submitted during process (Szczegóły przetwarzania danych przez każdą z jednostek znajdują się w ich politykach przetwarzania danych osobowych.) +4. After sending completed and signed license disclaimer form You will be added to [CONTRIBUTORS.md](/CONTRIBUTORS.md) file on the first merged Pull Request. +5. Then since We accept Pull Requests from new contributors only if they've already sent their completed and signed license disclaimer form thus are present on this list [CONTRIBUTORS.md](/CONTRIBUTORS.md) we should process Your future requests much, much faster. Thank You. +6. Last and at least we'd like You to know We're very sorry as We also wish there was a simpler way to do all this and promise to look for it in the future. diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..dd1722f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,5 @@ +Which issue(s) this PR fixes: + +Fixes # + +@gh-username diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..84840f3 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,43 @@ +# Security Policies and Procedures + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 2.0.1 | :white_check_mark: | +| 1.x.x | :white_check_mark: | + +This document outlines Security Procedures and General Policies for this Project. + + * [Reporting a Bug](#reporting-a-bug) + * [Disclosure Policy](#disclosure-policy) + * [Comments on this Policy](#comments-on-this-policy) + +## Reporting a Bug + +Report security bugs by emailing the lead maintainer at security@safesafe.app. + +The lead maintainer will acknowledge your email within 48 hours, and will send a +more detailed response within 48 hours indicating the next steps in handling +your report. After the initial reply to your report, the security team will +endeavor to keep you informed of the progress towards a fix and full +announcement, and may ask for additional information or guidance. + +Report security bugs in third-party software to the person or team maintaining +that software. + +## Disclosure Policy + +When the security team receives a security bug report, they will assign it to a +primary handler. This person will coordinate the fix and release process, +involving the following steps: + + * Confirm the problem and determine the affected versions. + * Audit code to find any potential similar problems. + * Prepare fixes for all releases still under maintenance. These fixes will be + released as fast as possible to all distribution providers. + +## Comments on this Policy + +If you have suggestions on how this process could be improved please submit a +pull request. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..11da362 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,25 @@ +## Issues - Features, Bugs and Security: + +Please create new Issues in apropriate repository only using the correct issue template type: +- [Features](ISSUE_TEMPLATE/feature_request.md) +- [Bugs](ISSUE_TEMPLATE/bug_report.md) +- [Security](SECURITY.md) + +New GitHub issues may be automatically closed/deleted if not related or not compatible with the templates provided. + +## New Issue templates: + +If you would like to provide a new Issue template please create a [Pull Request](PULL_REQUEST_TEMPLATE/README.md) relating to at least one Issue. + +## Community support +**Please do not use GitHub Issues for generic support questions or unreleated discussions. Instead please use Stack Overflow:** + +- https://stackoverflow.com/questions/tagged/ios +- https://stackoverflow.com/questions/tagged/android +- https://stackoverflow.com/questions/tagged/chrome +- https://stackoverflow.com/questions/tagged/firefox +- https://stackoverflow.com/questions/tagged/ProteGO-Safe +- https://stackoverflow.com/questions/tagged/ProteGO-Safe-ios +- https://stackoverflow.com/questions/tagged/ProteGO-Safe-android +- https://stackoverflow.com/questions/tagged/ProteGO-Safe-web +- https://stackoverflow.com/questions/tagged/ProteGO-Safe-backend diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6800692..bed9a83 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,78 +2,17 @@ Zapraszamy wszystkich do współpracy nad projektem: -1. [Zasady ogólne](Zasady-ogólne) -2. [Chcę zgłosić błąd w działaniu aplikacji.](#Chcę-zgłosić-błąd-w-działaniu-aplikacji) -3. [Chcę zgłosić błąd dotyczący bezpieczeństwa.](#Chcę-zgłosić-błąd-dotyczący-bezpieczeństwa) +1. [Zasady ogólne.](.github/CODE_OF_CONDUCT.md) +2. [Chcę zgłosić pomysł dotyczący aplikacji.](.github/SUPPORT.md) +3. [Chcę zgłosić błąd dotyczący bezpieczeństwa.](.github/SECURITY.md) 4. [Programuję, jak mogę pomóc?](#Programuję-jak-mogę-pomóc) -5. [Zajmuję się UX/UI, jak mogę pomóc?](#Zajmuję-się-uxui-jak-mogę-pomóc) -6. [Chcę pomóc testować nowe wersje aplikacji.](#Chcę-pomóc-testować-nowe-wersje-aplikacji) -7. [Chcę zaproponować nową funkcjonalność.](#Chcę-zaproponować-nową-funkcjonalność) -8. [Jak jeszcze mogę pomóc?](#Jak-jeszcze-moge-pomoc) - -## Zasady ogólne - -### Język komunikacji - -Komunikujemy się po polsku, ponieważ jednym z głównych celów tego projektu jest zbudowanie zaufania do użytkowników aplikacji ProteGO, którymi będą głównie osoby mówiące po polsku. Wiele tematów które poruszamy na GitHub jest czytelnych dla osób nietechnicznych. Nie chcemy zabierać im możliwości partycypacji. Komunikacja po angielsku jest OK, odpowiadamy wtedy po angielsku. - -Kod i komentarze w kodzie piszemy po angielsku. Commity po polsku lub angielsku. - -### Kto podejmuje decyzje w tym projekcie? - -ProteGO ma jedynie sens jeśli zostanie stworzone we współpracy z administracją. Potrzebujemy połączenia z zaufanym źródłem informacji dotyczącym tego czy ktoś został zakażony SARS-CoV-2. Taki rejestr jest prowadzony przez stronę rządową. Ministerstwo Cyfryzacji (MC) zdecydowało się wydać i promować tę aplikację. Oznacza to jednak również to, że ostatecznie to MC decyduje o tym czy aplikacja i jej kolejne wersje będą wydane. Potrzebujemy więc współpracy i dialogu, który połączy potrzeby i obawy każdej ze stron. **Aktualnie** łącznikiem między MC i projektem jest Mateusz Romanów [@MateuszRomanow](https://github.com/MateuszRomanow). - -### Jaki jest "roadmap" projektu? - -Poza wydaniem wersji `1.0` opisanej [tutaj](https://github.com/ProteGO-app/specs/blob/master/specs/README.md) nie ma jeszcze decyzji co dalej. Na pewno będziemy chcieli zachęcić użytkowników do częstszego zaglądania do aplikacji? Masz pomysł jak to zrobić - napisz. - -### Jaki mamy "branching strategy"? - -Mamy `mastera` i dla każdej nowej funkcjonalności/usprawnienia/poprawki błędu robimy `brancha`. Jeśli jest gotowy to `mergowany` jest bezpośrednio do `mastera`. Gdy zbliżymy się do wejścia na produkcję lub będziemy prowadzili rozbudowane testy z użytkownikami wtedy mamy plan przejść na [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). Dzięki temu będziemy mieli możliwość zamrażania wersji do wydania, wprowadzania `hotfixów` przy utrzymaniu intensywnego rozwoju nowych funkcjonalności. - -## Chcę zgłosić błąd w działaniu aplikacji - -Używamy `GitHub issues` do śledzenia postępów i błędów. Wypełnij formularz błędu w [aplikacji iOS](https://github.com/anna-app/ios/issues/new?assignees=&labels=&template=bug_report.md&title=), w [aplikacji Android](https://github.com/anna-app/android/issues/new?assignees=&labels=&template=bug_report.md&title=) lub [na serwerze](https://github.com/anna-app/backend/issues/new?assignees=&labels=&template=bug_report.md&title=). Pamiętaj o podaniu wszystkich wymaganych informacji. Zanim zgłosisz coś nowego, sprawdź czy nie ma już wcześniejszego podobnego zgłoszenia. - -## Chcę zgłosić błąd dotyczący bezpieczeństwa - -Zanim zgłosisz błąd dotyczący bezpieczeństwa aplikacji sprawdź naszą [listę znanych zagadnień dotyczących bezpieczeństwa](specs/security.md). Jeśli chcesz zgłosić coś nowego i jest to krytyczne skontaktuj się z nami bezpośrednio. W przeciwnym wypadku zgłoś błąd przez [`GitHub issues`](#Chcę-zgłosić-błąd-w-działaniu-aplikacji) ## Programuję, jak mogę pomóc? Jest mnóstwo sposobów w jaki możesz nam pomóc: -* Zrób nam audyt kodu. -* Przeglądnij listę zadań nad którymi pracujemy. -* Dodaj swój `Pull Request`. -* Przeglądnij istniejące `Pull Request`y. -Komunikuj się z nami przez GitHub. - -### Oświadczenie o udzieleniu licencji -Abyśmy mogli akceptować Twoje Pull Request'y zapoznaj się z zasadami poniżej: -1. ProteGO tworzone jest na licencjach Affero GPL (backend) i GPL (pozostałe komponenty) -2. Jeśli dodajesz jakąś zmianę do któregoś repozytorium **pozostajesz jej autorem i właścicielem**, a na mocy *GitHub Terms of Use* automatycznie [udzielasz licencji na swoje zmiany](https://help.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license). -3. Dla uniknięcia nieporozumień prosimy każdego twórcę Pull Request'a o potwierdzenie udzielenia licencji na swoje zmiany poprzez: - * pobranie i wypełnienie [oświadczenia](files/oswiadczenie_licencja_GPL_AGPL.pdf), które: - * potwierdza udzielenie licencji GPL/AGPL na swoje zmiany - * zezwala każdemu kto stosuje się do postanowień licencji na dystrybucję binarnych plików przez App Store firmy Apple - * zobowiązuje autora zmian do niewykonywania swoich osobistych praw autorskich i do nieodwoływania swojej licencji - * podpisanie go [podpisem zaufanym](https://www.gov.pl/web/gov/podpisz-dokument-elektronicznie-wykorzystaj-podpis-zaufany), [podpisem osobistym](https://www.gov.pl/web/e-dowod/podpis-osobisty) lub [podpisem kwalifikowanym](https://pl.wikipedia.org/wiki/Podpis_kwalifikowany) - * przesłanie podpisanego dokumentu na adres [protego@mc.gov.pl](mailto:protego@mc.gov.pl). Jako tytuł wiadomości wpisz `Oświadczenie GitHub`. Administratorem Twoich danych osobowych jest Ministerstwo Cyfryzacji. -4. Po podpisaniu i przesłaniu dokumentu, wraz z pierwszym Pull Request'em dodamy Cię do pliku [CONTRIBUTORS.md](CONTRIBUTORS.md). Dzięki temu każdy Twój kolejny Pull Request zostanie zaakceptowany szybciej. -5. Przyjmujemy Pull Request'y tylko od osób, które przesłały oświadczenie. - -## Zajmuję się UX/UI, jak mogę pomóc? - -Udostępniamy [pliki źródłowe dotyczące UX i UI](https://drive.google.com/drive/folders/1n2-dFkdkJWnezX3RjN1kaSOzHQiUg4iQ?usp=sharing). Jeśli chcesz coś zaproponować jakieś zmiany zgłoś je [tutaj](https://github.com/ProteGO-app/specs/issues) - -## Chcę pomóc testować nowe wersje aplikacji - -Instrukcja dotycząca tego jak dołączyć do zespołu testerów znajduje się [tutaj](specs/testing.md). - -## Chcę zaproponować nową funkcjonalność. - -Nowe funkcjonalności planujemy w [GitHub issues](https://github.com/anna-app/specs/issues). Sprawdź wcześniej czy ktoś nie zgłosił czegoś podobnego. - -## Jak jeszcze mogę pomóc? - -Używaj aplikacji, promuj wśród znajomych, zainstaluj rodzicom. Śledź nas na profilach społecznościowych. +* Rób razem z nami audyt kodu. +* Dodawaj swoje `Pull Request`y. +* Przeglądaj istniejące `Pull Request`y. +* Pomagaj innym użytkownikom. +Komunikuj się z nami przez GitHub i Stackoverflow. +Więcej informacji w temacie komunikacji znajdziesz [tutaj](.github/SUPPORT.md) diff --git a/DISCLAIMER.pdf b/DISCLAIMER.pdf new file mode 100644 index 0000000..3585f71 Binary files /dev/null and b/DISCLAIMER.pdf differ diff --git a/README-en.md b/README-en.md deleted file mode 100644 index f8f4819..0000000 --- a/README-en.md +++ /dev/null @@ -1,38 +0,0 @@ -# ProteGO application - -For version in Polish click [here](README.md) - -## Table of Contents - -1. [Introduction](#introduction) -2. [How does the app work?](specs/README-en.md) -3. TBD: [FAQ](FAQ-en.md) -4. [I'd like to contribute, report a bug, have an idea](CONTRIBUTING-en.md) - -## Introduction - -The purpose of the application is to help move from a nationwide to a selective quarantine of people who may have been exposed to the risk of SARS-CoV-2 infection by enabling contact tracing. - -The application is built by the community of citizens in cooperation the Polish Ministry of Digital Affairs, the publisher of the application. - -The application balances the need to preserve the privacy of citizens with the need to collect information about those who could be at risk of being infected. - -The application can be used anonymously. In this case, all communication with the user is conducted using the application. - -Optionally, the user can enter his phone number and confirm it by a text message (SMS). In this case, the phone number can be used by GIS (the Polish Chief Sanitary Inspectorate, Główny Inspektorat Sanitarny) to contact a user who has been exposed to a contact with person identified as ill. - -After installing, the app securely connects with other users via Bluetooth. It records a 2 weeks history of all the devices encountered. This data is stored only on citizens' devices and is not sent to any central server. Data is deleted after 2 weeks. - -Each person diagnosed with SARS-CoV-2 is asked to send the history of devices encountered during the previous 14 days to the server. - -The data is then sent to a server where the administrator, based on their analysis (length of contact, frequency of contacts, proximity in accordance with WHO standards) decides which of the people he met with should receive information about the potential threat. In the case of people who have not registered using the telephone number, the administrator is not able to know their personal data. - -After opening the application, each user can check their personalized status: - -* Green - you can go out freely and keep the applicable regulations -* Orange - two weeks have not yet passed since the application was installed, we do not have enough data to determine the status. Be careful. -* Red - you should contact the health authorities and subject to self isolation (home quarantine) - -Ultimately, the application should be installed by every citizen. We should start creating a culture of using the application, e.g. by showing each other your green status upon meeting each other. - -Due to understandable social resistance to the risk of surveillance, we place great emphasis on ensuring privacy. The application code is hence made public (open source) and we encourage independent audit by experts. diff --git a/README.md b/README.md index ef2e055..081019a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ -# Aplikacja ProteGO Safe +## Table of Contents -W przygotowaniu. +1. [Introduction](#introduction) +2. [I'd like to contribute, report a bug, have an idea](.github/SUPPORT.md) -Dotychczasowa dokumentacja aplikacji SafeSafe przebrandowana na ProteGO Safe -> https://koronazglowy.com/ +## Introduction + +The purpose of the application is to help move from a nationwide to a selective quarantine of people who may have been exposed to the risk of SARS-CoV-2 infection by reasonable means. + +The application is built by the community of citizens in cooperation with the Polish Ministry of Digital Affairs, the publisher of the application. + +The application balances the need to preserve the privacy of citizens with the need to collect information about those who could be at risk of being infected. + +The application can be used anonymously. In this case, all communication with the user is conducted using the application. + +Currently the application is designed to be a prevention tool with daily health journal functions and has **no contact tracing** capabilities. + +In the future implementiation after installing the app it will securely connect with other users via Bluetooth to enable contact tracing. It will record a 2 weeks history of all the devices encountered. This data is stored only on citizens' device and is not sent to any central server. Data is deleted after 2 weeks. Each person diagnosed with SARS-CoV-2 is asked to send the history of devices encountered during the previous 14 days to the server. The data is then sent to a server where the administrator, based on their analysis (length of contact, frequency of contacts, proximity in accordance with WHO standards) decides which of the people he met with should receive information about the potential threat of being exposed to SARS-CoV-2. + +Due to understandable social resistance to the risk of surveillance, we place great emphasis on ensuring privacy. We won't let anyone to use this extraordinary circumstances of the pandemic to break everyones rights to privacy. The application code is hence made public (open source) and we encourage independent audit by experts. diff --git a/files/oswiadczenie_licencja_GPL_AGPL.pdf b/files/oswiadczenie_licencja_GPL_AGPL.pdf deleted file mode 100644 index 25e11b2..0000000 Binary files a/files/oswiadczenie_licencja_GPL_AGPL.pdf and /dev/null differ diff --git a/files/regulamin_protego.pdf b/files/regulamin_protego.pdf deleted file mode 100644 index 9494a2d..0000000 Binary files a/files/regulamin_protego.pdf and /dev/null differ diff --git a/specs/README.md b/specs/README.md deleted file mode 100644 index 82afaf4..0000000 --- a/specs/README.md +++ /dev/null @@ -1,73 +0,0 @@ -# Podstawowy opis aplikacji ProteGO - -## Rodzaje użytkowników - -**Użytkownik** - -Każda osoba instalująca aplikację - -**Lekarz** - -Lekarz, diagnostyk lub pracownik GIS, który przekazuje informację Użytkownikowi o tym, że zdiagnozowano u niego SARS-CoV-2 i instruuje jak przekazać dane o dwutygodniowej historii spotkanych osób na serwer centralny. - -**Administrator** - -Administrator systemu - -## Działanie aplikacji - -### Instalacja i sprawdzenie wersji - -Użytkownik instaluje i uruchamia aplikację. - -### Każde uruchomienie - -W przypadku braku dostępu do Internetu, aplikacja informuje o tym i nie pozwala przejść dalej. - -Po uruchomieniu, aplikacja sprawdza czy zainstalowana wersja jest najnowsza i w przeciwnym wypadku Użytkownik proszony jest o zainstalowanie nowszej wersji i przekierowany jest do odpowiedniego sklepu z aplikacjami. - -### Pierwsze uruchomienie - -W przypadku kiedy aplikacja uruchamiana jest po raz pierwszy (nie mamy `user_id`), następuje rejestracja aplikacji. Użytkownikowi pokazywane są ekrany startowe: - -* Powitanie w aplikacji -* Wyjaśnienie jak działa aplikacja (może być kilka ekranów) -* Prośba o włączenie Bluetooth. Aplikacja nie przechodzi dalej bez włączenia Bluetooth (chyba że nie da się skutecznie sprawdzić stanu Bluetooth, wtedy przechodzi). -* Wybór czy użytkownik chce podać numer telefonu czy korzystać z aplikacji anonimowo. W tym drugi przypadku dwa następne kroki są pomijane. -* Prośba o podanie numeru telefonu. Na stałe umieszczony jest przedrostek +48. Informacja o tym, że rejestrując się ackeptuje się regulamin -* Po potwierdzeniu, użytkownik otrzymuje wiadomość SMS na podany numer i wpisuje 6-cyfrowy kod z wiadomości. - -### Kolejne uruchomienie - -Aplikacja sprawdza czy Bluetooth jest włączony. Jeśli nie, użytkownik proszony jest o włączenie Bluetooth. Aplikacja nie pozwala pójść dalej bez włączenia Bluetooth (chyba że nie da się skutecznie sprawdzić stanu Bluetooth, wtedy tylko przypomina i przechodzi). - -Aplikacja odpytuje serwer i pokazuje Użytkownikowi jeden z trzech statusów: - -* W przypadku jeśli wykryto interakcje z osobą zakażoną - Czerwony - - Mogłeś przebywać blisko osób u których wykryliśmy SARS-Cov-2. Zadzwoń do najbliższego GIS. Poddaj się domowej kwarantannie. -* W przypadku zainstalowania aplikacji mniej niż 2 tygodnie temu - Pomarańczowy - - Nie mamy wystarczających danych aby określić czy przebywałeś w okolicach osób zakażonych. Kontynuuj używanie aplikacji. Obowiązuje Cię zachowanie ostrożności i ograniczenie wyjść do minimum. -* W przeciwnym wypadku - Zielony - - Zachowaj standardową ostrożność. Zgodnie z naszymi informacjami nie przebywałeś w obszarach o podwyższonym ryzyku. - -### Działanie w tle - -Aplikacja działa w tle i na bieżąco zapisuje informacje o wykrytych urządzeniach. Zapisy starsze niż 2 tygodnie są na bieżąco usuwane. W przypadku jeśli aplikacja zostanie wyłączona podejmuje próbę włączenia się ponownie. - -### Okno O Aplikacji - -Użytkownik może otworzyć okno O Aplikacji. Znajdzie tam następujące dane: -* Logo aplikacji, jej wersję -* Identyfikator użytkownika (Jest to pierwsza połowa `user_id`, 8 pierwszych bajtów w formacie hex np. `Identyfikator użytkownika: a809-8c1a-f86e-11da`) -* Przycisk `Wyślij dane`, który kieruje do wysyłki danych. - -[Wysyłanie danych na serwer](data_sharing.md) - - - - - - diff --git a/specs/api-en.md b/specs/api-en.md deleted file mode 100644 index fdcb200..0000000 --- a/specs/api-en.md +++ /dev/null @@ -1,235 +0,0 @@ -# Server API Specification - -## API Format - -API endpoints are invoked with a POST request with the parameters in a JSON body. Each of them returns a JSON response. - -## Common parameters -The following parameters are included in every single request: - -`platform` : `string ("ios"|"android")` - -`os_version` : `string` - -`device_type` : `string` - -`app_version` : `int` - -`api_version` : `int` - -`user_id` : `string` - -`lang` : `string` - -Description of parameters: - -`platform` - platform identifier. Currently one of `“android”` and `“ios”` - -`os_version` - operating system version - -`device_type` - device type (e.g. `"iPhone X"` or `"Android Galaxy"`) - -`app_version` - currently installed app version - -`api_version` - API version supported by the application (by default 1) - -`user_id` - user identifier assigned by server. Can be empty if user is not yet registered - -`lang` - two-letter code for the language of the phone - -## `/check_version` - -Check if an update is needed for the application to work correctly - -### Request parameters: -Common parameters - -### Response: - -`upgrade_required` : `bool` - -`upgrade_url` : `string` - -If `upgrade_required` is `true`, the application informs the user that to keep using the application they need to download a newer version of the application. In that case, `upgrade_url` contains a link to appropriate App Store where the user should be redirected. -In case `upgrade_required` is `false`, the application is started. - -## `/register` - -Register a new device in the application. - -### Request parameters: -Common parameters and the following: - -`msisdn` : `string` prefix `+48` + 9 digits - -`send_sms` : `bool` allows to obtain the verification code in the response instead of text message. Available only in the development environment. - -### Response: -`registration_id` : `string` - -`code` : `string` optional, when requested `send_sms: False` Available only in the development environment. - -Server returns an error if `msisdn` is not from Poland (i.e. it doesn't start with `+48`). -A verification code is generated and sent to the phone number provided with an SMS. -Following data is stored: -- timestamp of the moment when the registration is started -- the telephone number -- verification code sent -There should be restrictions that limit abuse of this service. - -## `/confirm_registration` - -Confirm the registration. - -### Request parameters: -Common parameters and the following: - -`registration_id` : `string` - -`code` : `string` - -`registration_id` - registration identifier returned by `/register` - -`code` - the verification code obtained by the user - -### Response: - -`user_id` : `string` - -`error_msg` : `string` - -Server checks if the registration exists. If so, the user is registered and stored and the endpoint returns the `user_id`. If not, `error_msg` is returned. - -## `/register_no_msisdn` - -Register a device without passing phone number. - -### Request parameters: -Common parameters - -### Response: -`user_id` : `string` - -Server registers new user and returns `user_id`. - -## `/get_status` - -Check your status and obtain `beacon_ids`. - -### Request parameters: -Common parameters and the following: - -`last_beacon_date` : `string` - -`last_beacon_date` is the date and time of the latest `beacon_id` that is already stored on the device. - -### Response: - -`status` : `string` - -`beacon_ids` : `[ {“date”: date, “beacon_id”:beacon_id}, ...]` - -`date` : `datetime in the following format - "YYYYmmddHH"` - -The server returns the user's status: `"green"`, `"orange"` or `"red"`. The status is `"orange"` if 14 days haven't passed since the installation. - -The server returns a list of `beacon_id`s to use for broadcasting at specified times for the following 21 days. Each element of the list has a `beacon_id` to broadcast and a `date` in this format: `YYYYmmddHH`. The server will only return new ids taking into account the `last_beacon_date` passed. There may be no `beacon_ids` returned if the application is deemed to have enough `beacon_ids` stored. - -## `/send_encounters` - -Send a list of encountered devices to the server. - -### Request parameters: -Common parameters and the following: - -`proof` : `string` - -`encounters` : `[{“encounters_date”: datetime, “beacon_id”, “signal_strength”}, …]` - -`proof` - `identification number provided to positively diagnosed user` - -`encounters` - `a list of encountered devices` - - -`encounter_date` - `date and time of encounter` - -`beacon_id` - `id of the encountered device` - -`signal_strength` - `strength of the signal during the encounter (optional)` - -The server stores the data in the `Encounters` table with the appropriate `user_id`. - -# Data stored in the server - -## GCP Datastore - -### `Users` - -`platform` : `string ("ios"|"android")` - -`os_version` : `string` - -`device_type` : `string` - -`app_version` : `int` - -`api_version` : `int` - -`user_id` : `string` - -`lang` : `string` - -`msisdn` : `string` - -`reg_date` : `datetime` - -`last_status_requested` : `datetime` - -`status` : `string` - - -### `Registrations` -`registration_date` : `datatime` - -`registration_id` : `string` - -`msisdn` : `string` - -`code` : `string` - -`is_expired` : `bool` - - -### `Encounter Uploads` - -`upload_id` : `string` - -`user_id` : `string` - -`date` : `datatime` - -`processed_by_health_authority` : `bool` - -`confirmed_by_health_authority` : `bool` - -## GCP BigQuery - -### `Beacons` - -`user_id` : `string` - -`beacon_id` : `string` - -`date` : `string in format "YYYYmmddhh" in the CET timezone` - -### `Encounters` - -`upload_id` : `string` - -`user_id` : `string` - -`beacon_id` : `string` - -`encounter_date` : `datetime` - -`signal_strength` : `float` diff --git a/specs/api.md b/specs/api.md deleted file mode 100644 index af6b52e..0000000 --- a/specs/api.md +++ /dev/null @@ -1,236 +0,0 @@ -# Specyfikacja API serwerowego - -## Format API - -Parametry do każdej funkcji API przesyłamy w formacie JSON poprzez wywołanie POST. Każda z funkcji zwraca wynik w postaci JSON. - -## Parametry wspólne - -Każdy wywołanie zawiera zawsze następujące parametry: - -`platform` : `string ("ios"|"android")` - -`os_version` : `string` - -`device_type` : `string` - -`app_version` : `int` - -`api_version` : `int` - -`user_id` : `string` - -`lang` : `string` - -Objaśnienie: - -`platform` - identyfikator platformy. Aktualnie `"android"` lub `"ios"` - -`os_version` - wersja systemu operacyjnego platformy - -`device_type` - typ urządzenia (np. `"iPhone X"` lub `"Android Galaxy"`) - -`app_version` - numer wersji zainstalowanej aplikacji - -`api_version` - wersja API którą wspiera aplikacja (domyślnie 1) - -`user_id` - identyfikator użytkownika przyznany przez serwer. Może być pusty jeśli użytkownik nie jest jeszcze zarejestrowany. - -`lang` - dwuliterowy identyfikator języka telefonu - -## Funkcja `/check_version` - -Aplikacja sprawdza czy do poprawnego jej działania jest wymagana aktualizacja aplikacji. - -### Parametry: -standardowe - -### Wynik: - -`upgrade_required` : `bool` - -`upgrade_url` : `string` - -Jeśli `upgrade_required` jest `true` to aplikacja informuje użytkownika, że do dalszego działania musi zainstalować nowszą wersję. `upgrade_url` zawiera w takiim wypadku `url` do odpowiedniego App Store do którego należy przekierować użytkownika. Jeśli `upgrade_required` jest `false`, aplikacja zostaje uruchomiona. - -## Funkcja `/register` - -Aplikacja rejestruje nowe urządzenie - -### Parametry: -standardowe - -`msisdn` : `string` przedrostek `+48` + 9 cyfr - -`send_sms` : `bool` pozwala zwrócić kod weryfikacyjny w odpowiedzi zamiast wysyłać sms. -Działa tylko w środowisku deweloperskim. - -### Wynik: -`registration_id` : `string` - -`code` : `string` opcjonalnie, jeśli podano `send_sms: False` Działa tylko w środowisku deweloperskim. - -Serwer zwraca błąd jeśli msisdn nie jest z Polski (nie zaczyna się od 48). -Serwer generuje kod rejestracyjny, wysyła go wiadomością SMS na podany numer przez bramkę SMS. Zapamiętuje datę i czas rozpoczęcia procesu rejestracji, numer telefonu i wysłany kod. Należy zrobić zabezpieczenia przed nadużywaniem serwisu. - -## Funkcja `/confirm_registration` - -Aplikacja potwierdza rejestrację. - -### Parametry: - -standardowe - -`registration_id` : `string` - -`code` : `string` - -`registration_id` - identyfikator rejestracji zwrócony przez `/register` - -`code` - kod SMS odebrany przez użytkownika - -### Wynik: - -`user_id` : `string` - -`error_msg` : `string` - -Serwer sprawdza czy istnieje bieżąca rejestracja zgodna z parametrami. Jeśli tak, rejestruje użytkownika, zapisuje i zwraca `user_id`. Jeśli nie, zwraca `error_msg`. - - -## Funkcja `/register_no_msisdn` - -Aplikacja rejestruje nowe urządzenie bez konieczności podania numeru telefonu. - -### Parametry: -standardowe - -### Wynik: -`user_id` : `string` - -Serwer rejestruje użytkownika zwracając `user_id`. - -## Funkcja `/get_status` - -Sprawdzenie swojego statusu i pobranie `beacon_ids`. - -### Parametry: - -standardowe - -`last_beacon_date` : `string` - -`last_beacon_date` to data i godzina najstarszego `beacon_id` które jest już przechowywane na urządzeniu. - -### Wynik: - -`status` : `string` - -`beacon_ids` : `[ {"date": date, "beacon_id":beacon_id}, ...]` - -`date` : `data i godzina w formacie "YYYYmmddHH"` - -Serwer zwraca status użytkownika: `"greeen"`, `"orange"` lub `"red"`. Jeśli nie minęło 14 dni od zainstalowania aplikacji, status jest pomarańczowy (`"orange"`). - -Serwer zwraca identyfikatory którymi ma się rozgłaszać w określonych dniach i godzinach na 21 dni do przodu. Każdy `beacon_id` to identyfikator do rozgłaszania. Każdy `date` to data i godzina w formacie `YYYYmmddHH` określająca którym identyfikatorem `beacon_id` powinien rozgłaszać się telefon w dniu i godzinie określonej przez `date`. Serwer zwraca tylko nowe identyfikatory biorąc pod uwagę `last_beacon_date`. Serwer może nie zwrócić żadnych `beacon_ids` jeśli uzna, że aplikacja ma ich wystarczająco dużo. - -## Funkcja `/send_encounters` - -Wysłanie listy napotkanych urządzeń na serwer. - -### Parametry: -standardowe - -`proof` : `string` - -`encounters` : `[{"encounters_date": datetime, "beacon_id", "signal_strength"}, …]` - -`proof` : `identyfikator przekazany zdiagnozowanemy użytkownikowi` - -`encounters` - `lista napotkanych urządzeń` - - -`encounter_date` - `data i godzina spotkania` - -`beacon_id` - `id napotkanego urządzenia` - -`signal_strength` - `siła sygnału przy napotkaniu urządzenia (opcjonalne)` - -Serwer zapisuje dane do tabeli `Encounters` wraz z odpowiednim `user_id`. - -# Dane przechowywane na serwerze - -## GCP Datastore - -### `Users` - -`platform` : `string ("ios"|"android")` - -`os_version` : `string` - -`device_type` : `string` - -`app_version` : `int` - -`api_version` : `int` - -`user_id` : `string` - -`lang` : `string` - -`msisdn` : `string` - -`reg_date` : `datetime` - -`last_status_requested` : `datetime` - -`status` : `string` - - -### `Registrations` -`registration_date` : `datatime` - -`registration_id` : `string` - -`msisdn` : `string` - -`code` : `string` - -`is_expired` : `bool` - - -### `Encounter Uploads` - -`upload_id` : `string` - -`proof` : `string` - -`user_id` : `string` - -`date` : `datatime` - -`processed_by_health_authority` : `bool` - -`confirmed_by_health_authority` : `bool` - -## GCP BigQuery - -### `Beacons` - -`user_id` : `string` - -`beacon_id` : `string` - -`date` : `string w formacie YYYYmmddhh w czasie CET` - -### `Encounters` - -`upload_id` : `string` - -`user_id` : `string` - -`beacon_id` : `string` - -`encounter_date` : `datetime` - -`signal_strength` : `float` diff --git a/specs/app_versions.md b/specs/app_versions.md deleted file mode 100644 index ab2666e..0000000 --- a/specs/app_versions.md +++ /dev/null @@ -1,92 +0,0 @@ -# Środowiska i wersje aplikacji - -## Środowiska pracy - -Utrzymujemy trzy środowiska pracy nad aplikacją: - -### `Dev` - środowisko rozwojowe - -Środowisko do bieżącej pracy nad aplikacją. - -#### iOS - -Nowe wersje do testowania budowane są przez programistów i testowane lokalnie lub budowane przez CI i dystrybuowane do testerów przy pomocy [Shuttle](https://www.polidea.com/blog/our-app-distribution-tool-open-sourced-shuttle-case-study/). - -Wersje `dev` zawierają w sobie następujące narzędzia i biblioteki: -* Menu deweloperskie dostępne po potrząśnięciu telefonem ([SwiftTweaks](https://github.com/Khan/SwiftTweaks)), -* Integrację z serwisem Firebase Crashlytics, -* Integrację z serwisem Bugfender -* Szczegółowe logi na konsolę - -#### Android - -Nowe wersje do testowania budowane są przez programistów i testowane lokalnie lub budowane przez CI i dystrybuowane do testerów przy pomocy [Shuttle](https://www.polidea.com/blog/our-app-distribution-tool-open-sourced-shuttle-case-study/). - -Wersje `dev` zawierają w sobie następujące narzędzia i biblioteki: -* Menu deweloperskie dostępne po potrząśnięciu telefonem ([Cockpit](https://www.polidea.com/blog/cockpit-22new-features-of-android-debug-menu/)), -* Integrację z serwisem Firebase Crashlytics, -* Integrację z serwisem Bugfender -* Szczegółowe logi na konsolę - -#### Backend - -Wersje `dev` łączą się z serwerem pod adresem: - -https://europe-west3-protego-dev.cloudfunctions.net/ - -### `Stg` - środowisko przedprodukcyjne - -Środowisko przedprodukcyjne do testowania wersji przed publikacją. - -#### iOS - -Nowe wersje do testowania budowane są przez CI i dystrybuowane do testerów przy pomocy TestFlight. - -Wersje `stg` nie zawierają żadnych zewnętrznych bibliotek. - -#### Android - -Nowe wersje do testowania budowane są przez CI i dystrybuowane do testerów przy pomocy Google Play. - -Wersje `stg` nie zawierają żadnych zewnętrznych bibliotek. - -#### Backend - -Wersje `stg` łączą się z serwerem pod adresem: - -https://europe-west3-protego-stag.cloudfunctions.net/ - -### `Prod` - środowisko produkcyjne - -Środowisko produkcyjne. - -#### iOS - -Nowe wersje do testowania budowane są przez CI i dystrybuowane do testerów przy pomocy TestFlight. - -Wersje `prod` nie zawierają żadnych zewnętrznych bibliotek. - -#### Android - -Nowe wersje do testowania budowane są przez CI i dystrybuowane do testerów przy pomocy Google Play. - -Wersje `prod` nie zawierają żadnych zewnętrznych bibliotek. - -#### Backend - -Wersje `prod` łączą się z serwerem pod adresem: - -TBD - -## Wersjonowanie aplikacji - -Dla iOS i Android obowiązuje wersjonowanie w postaci: `X.Y.Z` gdzie: -* `X` - główny numer wersji -* `Y` - mniejszy numer wersji -* `Z` - kolejny numer budowy (ang. build) aplikacji. - -Numer wersji ustawiany jest przez programistów jako `tag` w repozytorium. Ustawienie `tag` wywołuje budowę projektu. Tagi i wersje mogą być różne dla iOS i Android. - -Pierwsza wersja w sklepie może mieć więc numer np. `1.0.127` a kolejna `1.1.234`. - -Aplikacje przesyłają do serwera całość `X.Y.Z` jako `app_version`. diff --git a/specs/bluetooth.md b/specs/bluetooth.md deleted file mode 100644 index 5b559e8..0000000 --- a/specs/bluetooth.md +++ /dev/null @@ -1,165 +0,0 @@ -# Komunikacja Bluetooth w ProteGO - -Niniejszy dokument opisuje pełną specyfikację urządzenia komunikującego się po -Bluetooth Low Energy zgodnego z aplikacją ProteGO. Zawarte są również -informacje o ograniczeniach napotkanych na platformach iOS oraz Android, które -wpłynęły na ostateczną implementację. - -Aplikacje rozgłaszają się identyfikatorami `beacon_id`. Aplikacja zmienia -`beacon_id` co godzinę. Aplikacja uzupełnia pulę identyfikatorów `beacon_id` -tak aby mieć zapas na kolejne 21 dni za każdym uruchomieniem funkcji API -`/get_status`. - -Podstawowe założenia: - -* Możliwość wymieniania się `beacon_id` w czasie działania aplikacji oraz w tle. -* Przesyłanie tylko `beacon_id` oraz informacji o mocy sygnału. - -## Format ramki rozgłoszeniowej (Advertisement Data) - -Urządzenie ProteGO powinno rozgłaszać następujące dane: - -* Flags (CSS v9, Part A, 1.3) (wymagane) -* Tx Power (CSS v9, Part A, 1.5) (opcjonalne) -* Manufacturer Specific Data (CSS v9, Part A, 1.4) (opcjonalne, patrz uwaga #2)) - * Pierwsze 2 bajty to Company ID o wartości `0x08AF` - [(Polidea)](https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers/) - zapisane w formacie little-endian. - * Kolejny bajt to wersja. Stała wartość `0x00` dla ProteGO. - * Kolejne 16 bajtów to `beacon_id`. -* 16-bit UUID (CSS v9, Part A, 1.0) (wymagane) - * Dwubajtowa wartość `FD6E` - [(ProteGO)](https://www.bluetooth.com/specifications/assigned-numbers/16-bit-uuids-for-members/) zapisana w formacie little-endian. - -Przykładowa ramka może wyglądać następująco: - -``` -02 01 1A | 02 0A 0C | 03 03 6E FD | 13 FF AF 08 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 | -``` - -Oznaczająca: - -* Flags: - * LE General Discoverable Mode - * Simultaneous LE and BR/EDR (Controller) - * Simultaneous LE and BR/EDR (Host) -* Tx Power: - * 12 dB -* UUID: - * 16 bitowe, zarezerowane UUID o wartości `FD6E` (ProteGO) -* Manufacturer Specific Data: - * Company Id `08AF` (Polidea) - * Wersja `00` (ProteGO) - * 16 bajtowy `beacon_id` `01020304050607080910111213141516` - -Zakładając, że wszystkie powyższe pola są zawarte limit 31 bajtów dla -Advertisement Data jest wyczerpany. - -### Uwagi - -1. W momencie wygaśnięcia `beacon_id`, aplikacja powinna zaprzestać rozgłaszania - się ze starym `beacon_id` i rozpocząć nowe rozgłaszanie. - -2. iOS pozwala jedynie na rozgłaszanie lokalnej nazwy (tylko gdy aplikacja jest - aktywna) oraz UUID rozgłaszanego serwisu. W momencie gdy aplikacja przechodzi - do tła "rozgłaszane" jest tylko UUID w formacie znanym urządzeniom Apple - (tzw. overflow UUID). - -3. Wcześniej rozważano użycie pola `Service Data`, które nie wymaga rejestracji - UUID, jednak napotkano problem w wykrywaniu takich urządzeń w tle przez - aplikację iOS. - -4. Podanie pola UUID jest wymagane, gdyż iOS bez niego nie jest w stanie - wykrywać urządzeń w tle. - -5. Android w momencie połączenia z `GattServer` natychmiast generuje nowy MAC - address co zmienia zawartość rozgłoszenia. Dlatego też by ograniczyć napływ - nowych, sztucznych kontaktów, wymagane jest zawarcie unikalnego (na czas - jednej godziny) pola w manufacturer data. - -6. Na chwilę obecną tylko telefony z Androidem pozwalają na rozgłaszanie - własnego Manufacturer Specific Data (iOS pozwala tylko na UUID i to z - ograniczeniami). Takie połączenie powinno być traktowane jako jednorazowe, - gdyż kolejne połączenie będzie miało inny MAC address. Na podstawie zawartego - `beacon_id` w Manufacturer Specific Data można agregować urządzenia z innym - MAC address. - -## Format tabeli atrybutów (GATT) - -Ze względu na ograniczenia po stronie aplikacji iOS, do specyfikacji dodano -serwis oraz charakterystykę ProteGO, która pozwala na odebranie oraz przesłanie -swojego `beacon_id`: - -* Serwis ProteGO: - * 16 bitowe UUID: `FD6E` - * 128 bitowe UUID: `0000FD6E-0000-1000-8000-00805F9B34FB` - * Zarezerwowane dla aplikacji ProteGO. - -* Charakterystyka ProteGO: - * 128 bitowe UUID: `89a60001-4f57-4c1b-9042-7ed87d723b4e` - * Obsługuje operacje: `Read`, `Write`, `WriteWithoutResponse`. - * Format danych to 16 bajtowy `beacon_id`. - -### Uwagi - -1) W momencie gdy `beacon_id` stracił ważność lub aplikacja go nie posiada - wszystkie operacje powinny zwrócić: `ReadNotPermitted` lub `WriteNotPermitted` - w zależności od rodzaju zapytania. - -2) Inne aplikacje mają możliwość zapisania swojego `beacon_id` poprzez operację - `Write`. Jest to użyteczne w momencie, gdy dane urządzenie nie obsługuje roli - rozgłoszeniowej. - -## Uwagi implementacyjne dla GATT serwera (moduł rozgłaszający) - -1) Gdy aplikacja jest aktywna, rozgłaszanie powinno być włączone z możliwie - niskimi parametrami mocy rozgłaszania. - -2) Gdy aplikacja pracuje w tle, rozgłaszanie powinno zostać ograniczone, tak aby - zużycie baterii było jak najmniejsze oraz planer systemu operacyjnego nie - usunął aplikacji ze względu na duże zużycie zasobów. - -3) W momencie wygaśnięcia `beacon_id`, rozgłaszanie z jego wartością powinno - zostać przerwane. - -4) Ze względu na ograniczenia związane z rozgłaszaniem na iOS oraz możliwością - braku obsługi rozgłaszania po stronie Androida zalecane jest przyjmowanie - połączeń w celu wymiany `beacon_id` poprzez charakterystykę ProteGO. - -5) Charakterystyki nie powinny przechowywać żadnych wartości. - -## Uwagi implementacyjne dla GATT klienta (moduł skanujący) - -1) W momencie, gdy wykryto urządzenie z poprawnym `beacon_id` w ramce - rozgłoszeniowej: - * Jeżeli aplikacja także wspiera rozgłaszanie, można zapisać informacje - o kontakcie oraz zrezygnować z wykonania połączenia (założenie, że druga - strona także mogła zeskanować kontakt – nie są znane przypadki urządzeń - które wspierają rolę peryferium `BLE Peripheral` lecz nie wspierają - centrali `BLE Central`). - - * Jeżeli aplikacja nie wspiera rozgłaszania, należy połączyć się z serwerem - i wymienić `beacon_id`. - - * Do wykrytego urządzenia z `beacon_id` należy się łączyć maksymalnie raz. - Na chwilę obecną są to tylko telefony z Androidem, które dla każdego - połączenia generują inny MAC address. - -2) W momencie, gdy wykryto urządzenie bez `beacon_id` ale z UUID ProteGO: - - * Należy połączyć się z urządzeniem - - * Odkryć serwisy oraz charakterystyki ProteGO. - - * Pobrać wartość `beacon_id` poprzez odczyt charakterystyki ProteGO. - - * Przesłać swój `beacon_id` poprzez zapis do charakterystyki ProteGO. - (opcjonalnie) - -3) W momencie, gdy wykryto inne urządzenie: - - * Można spróbować połączyć się z urządzeniem by zobaczyć, czy zawiera ono - serwisy oraz charakterystyki ProteGO. - - * Sytuacja ta ma miejsce w przypadku iOS działającego w tle (urządzenie - rozgłaszające) oraz Androida (urządzenie skanujące). diff --git a/specs/data_sharing-en.md b/specs/data_sharing-en.md deleted file mode 100644 index e91e507..0000000 --- a/specs/data_sharing-en.md +++ /dev/null @@ -1,13 +0,0 @@ -# Uploading data from ProteGO to the server - -Identifiers of other devices on which the application is also installed and which are located nearby are collected and stored locally (on the device) by ProteGO. The identifiers are randomly generated, they change every hour and hence do not reveal the identities of the owners of nearby devices. ProteGO stores information on the nearby devices for the last 2 weeks. Older data is deleted on an ongoing basis. - -Upon identification of a new infected case, employees of the Polish Chief Sanitary Inspectorate (Główny Inspektor Sanitarny, GIS) or the Polish Central Registry of Infections (CRZ) send a request to every newly identified patient. Messages are sent to every newly identified patient, as it is not known who uses the application and who does not. - -``` If you are ProteGO user, please send information about people who were nearby to warn them of possible infection. Nobody will know about your illness. Open ProteGO, select About application -> Send data. Please insert the code 1234-5678 and confirm. Thank you.```' - -After sending the patient's data, the GIS / CRZ employee has access to a 2-week history of all users who were near the infected person. Each user is represented by a random, anonymous identifier. For each user (ID) who was nearby, he can see dates, frequency of contacts and signal strength (proximity). On this basis, the employee decides which users to change the status. - -The employee can also decide that one of the non-anonymous users should be contacted using their known mobile phone number, e.g. by sending an SMS or by making an automatic phone call. - -The above process can be (semi) automated over time. diff --git a/specs/data_sharing.md b/specs/data_sharing.md deleted file mode 100644 index 776bedd..0000000 --- a/specs/data_sharing.md +++ /dev/null @@ -1,11 +0,0 @@ -# Przesyłanie danych z aplikacji ProteGO na serwer - -Aplikacja zbiera i przechowuje na telefonie identyfikatory innych urządzeń na których również zainstalowana jest aplikacja i które znajdują się w pobliżu. Identyfikatory są losowe, zmieniają się co godzinę i nie pozwalają ujawnić do kogo należy napotkane urządzenia. Aplikacja przechowuje informacje z ostatnich 2 tygodni. Starsze informacje są usuwane na bieżąco. - -Pracownicy GIS / Centralnego Rejestru Zakażeń (CRZ) do każdej nowo-zakażonej osoby wysyłają prośbę i instrukcję przesłania danych z aplikacji ProteGO. Wiadomości wysyłane są do wszystkich zakażonych, ponieważ nie wiadomo kto jest użytkownikiem aplikacji. Przykład wiadomości: - -```Jeśli jesteś użytkownikiem ProteGO, prześlij informacje o osobach które były w pobliżu, aby ostrzec je przed ewentualnym zakażeniem. Nikt nie dowie się o Twojej chorobie. Otwórz Protego i wybierz O aplikacji -> Prześlij dane. Wprowadź kod 1234-5678 i potwierdź wysyłkę. Dziękujemy.``` - -Po przesłaniu danych chorego pracownik GIS/CRZ ma dostęp do 2-tygodniowej historii wszystkich użytkowników, którzy byli w pobliżu zakażonej osoby. Każdy użytkownik reprezentowany jest przez losowy, anonimowy identyfikator. Dla każdego użytkownika (identyfikatora), który był w pobliżu, może zobaczyć daty, częstotliwość kontaktów i siłę sygnału (bliskość). Na tej podstawie pracownik decyduje, którym użytkownikom zmienić status. Pracownik może również zadecydować, że z którymś z użytkowników nieanonimowych należy skontaktować się telefonicznie np. poprzez wysłanie wiadomości SMS lub wykonanie automatycznego połączenia telefonicznego. - -Powyższy proces z czasem może być (pół)automatyczny. diff --git a/specs/security.md b/specs/security.md deleted file mode 100644 index 8c2d12d..0000000 --- a/specs/security.md +++ /dev/null @@ -1,21 +0,0 @@ -# Lista znanych nam zagadnień dotyczących bezpieczeństwa - -### Aplikacje mają zaszyte adresy do serwera Google zamiast CNAME, który można kontrolować. - -Wiemy. Podmienimy to jak tylko dostaniemy odpowiedni adres w domenie gov.pl. Tu jest odpowiednie [zadanie](https://github.com/ProteGO-app/specs/issues/11). - -### Aplikacja nie weryfikuje wystawcy certyfikatu SSL serwera do którego się łączy. - -Wiemy. Poprawimy wkrótce. Odpowiednie zadania są [tutaj](https://github.com/ProteGO-app/ios/issues/22) i [tutaj](https://github.com/ProteGO-app/android/issues/18). - -### Aplikacja jest open-source. Mogę ją zmodyfikować i zainstalować na swoim telefonie wersję, która zawsze będzie pokazywać zielony status. - -Jest wiele sposobów na które można oszukiwać innych ludzi. Aplikacja jest open-source aby każdy mógł zweryfikować jak działa i jakie dane przetwarza. - -### Czy dobrze rozumiem, że wystarczy wyłączyć Bluetooth i aplikacja przestaje działać? - -Aplikacja wymaga włączenia Bluetooth aby móc rozgłaszać się i widzieć urządzenia innych użytkowników. - -### Serwer w żaden sposób nie weryfikuje czy rozmawia z nim Aplikacja czy może ktoś się pod nią podszywa. - -Weryfikacja wiarygodności aplikacji klienckiej po stronie serwera jest nietrywialna. Rozważamy użycie [SafetyNet mobile attestation](https://developer.android.com/training/safetynet/attestation) dla Android i [DeviceCheck](https://developer.apple.com/documentation/devicecheck) dla iOS. Chętnie przyjmiemy sugestie lub Pull Request w tym temacie. diff --git a/specs/testing.md b/specs/testing.md deleted file mode 100644 index 165263e..0000000 --- a/specs/testing.md +++ /dev/null @@ -1,26 +0,0 @@ -# Beta testy aplikacji - -Testy aplikacji ProteGO odbywają się na [środowisku przedprodukcyjnym](app_versions.md#stg---%C5%9Brodowisko-przedprodukcyjne) w wersji aplikacji `stg`. - -Uczestnicząc w testach odgrywasz bardzo ważną rolę w rozwoju aplikacji ProteGO. Dzięki Twojemu udziałowi w testowaniu aplikacja stanie się jeszcze lepsza. Dlatego prosimy o udział w testach osoby, które w realny i zaangażowany sposób będą używać aplikacji i publikować zgłoszenia błędów. - -Przed rozpoczęciem testów uważnie przeczytaj informacje o aplikacji [ProteGO](https://github.com/ProteGO-app/specs/blob/master/README.md). - -Uwaga: Wersje testowe aplikacji mogą być niestabilne. - -## Zapisy do testów - -Zapisy do testów aplikacji odbywają się poprzez wypełnienie [formularza zgłoszeniowego](https://forms.gle/ZUnGwQiBxRV4fKjt5). -W formularzu należy wybrać model i system operacyjny telefonu lub tabletu oraz adres email konta Gmail lub konta Apple ID. - -### Android - -Do testów aplikacji używamy oficjalnego programu dystrybucyjnego Google Play Beta. Po zapisaniu się do testów otrzymasz email z instrukcjami. - -### iOS - -Do testów aplikacji używamy oficjalnego programu dystrybucyjnego TestFlight. Wymagana jest instalacja [aplikacji TestFlight dostępnej w sklepie App Store](https://apps.apple.com/us/app/testflight/id899247664). Po zapisaniu się do testów otrzymasz email z instrukcjami jak zainstalować aplikację. - -### Zgłoszenia błędów podczas testów - -Używamy `GitHub issues` do śledzenia postępów i błędów. Wypełnij formularz błędu w [aplikacji iOS](https://github.com/anna-app/ios/issues/new?assignees=&labels=&template=bug_report.md&title=), w [aplikacji Android](https://github.com/anna-app/android/issues/new?assignees=&labels=&template=bug_report.md&title=) lub [na serwerze](https://github.com/anna-app/backend/issues/new?assignees=&labels=&template=bug_report.md&title=). Pamiętaj o podaniu wszystkich wymaganych informacji. Zanim zgłosisz coś nowego, sprawdź czy nie ma już wcześniejszego podobnego zgłoszenia.