From 7d98decf7a431b4a2e34f139d56cf8d9c0242c77 Mon Sep 17 00:00:00 2001 From: Lurkars Date: Sat, 11 Jul 2020 12:11:34 +0200 Subject: [PATCH] initial commit --- .gitignore | 89 +++++ CMakeLists.txt | 6 + LICENSE | 661 +++++++++++++++++++++++++++++++++ README.md | 120 ++++++ main/CMakeLists.txt | 4 + main/component.mk | 5 + main/ena-bluetooth-advertise.c | 74 ++++ main/ena-bluetooth-advertise.h | 28 ++ main/ena-bluetooth-scan.c | 91 +++++ main/ena-bluetooth-scan.h | 39 ++ main/ena-crypto.c | 84 +++++ main/ena-crypto.h | 60 +++ main/ena-detection.c | 94 +++++ main/ena-detection.h | 19 + main/ena-storage.c | 449 ++++++++++++++++++++++ main/ena-storage.h | 107 ++++++ main/ena.c | 118 ++++++ main/ena.h | 16 + main/main.c | 44 +++ partitions.csv | 6 + 20 files changed, 2114 insertions(+) create mode 100644 .gitignore create mode 100644 CMakeLists.txt create mode 100644 LICENSE create mode 100644 README.md create mode 100644 main/CMakeLists.txt create mode 100644 main/component.mk create mode 100644 main/ena-bluetooth-advertise.c create mode 100644 main/ena-bluetooth-advertise.h create mode 100644 main/ena-bluetooth-scan.c create mode 100644 main/ena-bluetooth-scan.h create mode 100644 main/ena-crypto.c create mode 100644 main/ena-crypto.h create mode 100644 main/ena-detection.c create mode 100644 main/ena-detection.h create mode 100644 main/ena-storage.c create mode 100644 main/ena-storage.h create mode 100644 main/ena.c create mode 100644 main/ena.h create mode 100644 main/main.c create mode 100644 partitions.csv diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..791c6c9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,89 @@ +.config +*.o +*.pyc + +# gtags +GTAGS +GRTAGS +GPATH + +# emacs +.dir-locals.el + +# emacs temp file suffixes +*~ +.#* +\#*# + +# eclipse setting +.settings + +# MacOS directory files +.DS_Store + +# Example project files +examples/**/sdkconfig +examples/**/sdkconfig.old +examples/**/build + +# Doc build artifacts +docs/_build/ +docs/doxygen_sqlite3.db + +# Downloaded font files +docs/_static/DejaVuSans.ttf +docs/_static/NotoSansSC-Regular.otf + +# Unit test app files +tools/unit-test-app/sdkconfig +tools/unit-test-app/sdkconfig.old +tools/unit-test-app/build +tools/unit-test-app/builds +tools/unit-test-app/output +tools/unit-test-app/test_configs + +# Unit Test CMake compile log folder +log_ut_cmake + +# test application build files +tools/test_apps/**/build +tools/test_apps/**/sdkconfig +tools/test_apps/**/sdkconfig.old + +# IDF monitor test +tools/test_idf_monitor/outputs + +TEST_LOGS + +# gcov coverage reports +*.gcda +*.gcno +coverage.info +coverage_report/ + +test_multi_heap_host + +# VS Code Settings +.vscode/ + +# VIM files +*.swp +*.swo + +# Clion IDE CMake build & config +.idea/ +cmake-build-*/ + +# Results for the checking of the Python coding style and static analysis +.mypy_cache +flake8_output.txt + +# ESP-IDF default build directory name +build + +# lock files for examples and components +dependencies.lock + +build/ +sdkconfig +sdkconfig.old \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..217aed1 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,6 @@ +# The following lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.5) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(esp-ena) \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..45088ea --- /dev/null +++ b/README.md @@ -0,0 +1,120 @@ +# esp-ena + +Implementation of the Covid19 Exposure Notification API by Apple and Google on an ESP32. +More information about the Covid19 Exposure Notification at [Apple](https://www.apple.com/covid19/contacttracing/) and [Google](https://www.google.com/covid19/exposurenotifications/). This is meant for people without smartphone or without smartphones with Apples/Googles implementation. + +This implementation covers for now the BLE part including the cryptography specifications needed (see Bluetooth Specifications and Cryptography Specifications documents in the links above): +* send tokens +* store send tokens on flash (last 14 tokens) +* receive tokens +* received tokens are stored after 5 minutes threshold (storage is limited, ~100k tokens can be stored) + +Features missing for now are: +* compare received tokens with infected list +* calculating risks scores + +Extensions planned: +* add RTC (will test DS3231) +* add display (will test SSD1306) +* interface to + * set time + * delete tokens + * show status + * report infection? +* receive infected token list for Germany (will test [Corona Warn App](https://github.com/corona-warn-app)) +* send infected status (will test [Corona Warn App](https://github.com/corona-warn-app)) +* battery support +* 3d print case + +Limitations/Problems +* storage only ~2.8mb available +* WiFi or other external connection needed for infections status (auto-connect to open WiFis?) +* obtaining accessibility +* all parameters (scanning time, thresholds etc.) + +The following acronyms will be used in code and comments: +* *ENA* Exposure Notification Api +* *ENIN* ENIntervalNumber - timestamp with 10 minutes resolution +* *TEK* Temporary Exposure Key - personal secret key changed every 24h, published when infected +* *RPI* Rolling Proximity Identifier - send and received identifer changed every 10 minutes +* *AEM* Associated Encrypted Metadata - send and received metadata + +Open questions +* now save ENIN for stored detection (documentation says timestamp), but for infection status ENIN should be enough!? +* service UUID is send reversed, must RPI and AEM also beeing send in reverse? Don't know BLE specification enough +* fixed change of advertise payload every 10 minutes, random value between ~15 minutes better? + +## How to use + +### Hardware Required + +For now just an ESP32 is required. For full device later RTC (DS3231) and Display (SSD1306) will be required. + +### Configure the project + +``` +idf.py menuconfig +``` + +required +* enable bluetooth (BLE) +* add partition-table for storage (currently hardcoded name "ena") +* mbedTLS enable HKDF + +recommended +* BLE Scan Duplicate (By Device Address and Advertising Data) + + +### Build and Flash + +Build the project and flash it to the board, then run monitor tool to view serial output: + +``` +idf.py -p PORT flash monitor +``` + +(Replace PORT with the name of the serial port to use.) + +(To exit the serial monitor, type ``Ctrl-]``.) + +## Example Output + +For now some debug outputs are set. Besides, after each scan a CSV output is printed with stored TEKs, temporary detections (RPI) and full detections (RPI) + +``` +I (1201484) ESP-ENA-advertise: payload for ENIN 2657432 +D (1201494) ESP-ENA-advertise: 0x3ffbb6c4 02 01 1a 03 03 6f fd 17 16 6f fd 9a ee 95 9a 24 |.....o...o.....$| +D (1201494) ESP-ENA-advertise: 0x3ffbb6d4 f0 f9 8e 56 0f 6d 68 5f ac 12 e5 7f 94 a1 47 |...V.mh_......G| +I (1201524) ESP-ENA-scan: start scanning... +D (1202224) ESP-ENA-detection: New temporary detection at 0 with timestamp 1594459201 +D (1202224) ESP-ENA-detection: 19 05 e3 3a 73 16 4e 74 2d 48 fc 0c 41 f6 26 3b +D (1202234) ESP-ENA-detection: 5e 7d a9 48 +D (1202234) ESP-ENA-detection: RSSI -79 +#,enin,tek +0,2657430,d5 13 92 b2 44 e4 7e b6 ca a7 20 c4 f 37 c0 1c +#,timestamp,rpi,aem,rssi +0,1594459201,19 5 e3 3a 73 16 4e 74 2d 48 fc c 41 f6 26 3b,5e 7d a9 48,-79 +#,enin,rpi,aem,rssi +0,2657430,c7 2e b6 66 af 84 42 db b d1 a 0 f1 fd 86 2,4d 1 b2 d1,-76 +1,2657431,19 5 e3 3a 73 16 4e 74 2d 48 fc c 41 f6 26 3b,5e 7d a9 48,-76 +I (1231754) ESP-ENA-scan: finished scanning... +``` + +## Troubleshooting + +Sometimes I get errors from BT-stack of ESP-IDF printed. Didn't affect functionality for now, but I also could not find out what it caused and what it means. + +``` +E (909164) BT_HCI: btu_hcif_hdl_command_complete opcode 0x2005 status 0xc +``` + +## Structure + +The project is divided in different files +* *ena-crypto* covers cryptography part (key creation, encryption etc.) +* *ena-storage* storage part to store own TEKs and detections +* *ena-detection* handles scanned data by storing temporary detections, check for threshold and store full detections +* *ena-bluetooth-scan* BLE scans for detecting other tokens +* *ena-bluetooth-advertise* BLE advertising to send own tokens +* *ena* run all together and timing for scanning and advertising +* *main* start and run main program \ No newline at end of file diff --git a/main/CMakeLists.txt b/main/CMakeLists.txt new file mode 100644 index 0000000..6f979d3 --- /dev/null +++ b/main/CMakeLists.txt @@ -0,0 +1,4 @@ +idf_component_register( + SRCS "ena-detection.c" "ena-storage.c" "ena-crypto.c" "main.c" "ena.c" "ena-bluetooth-scan.c" "ena-bluetooth-advertise.c" "ena-detection.c" + INCLUDE_DIRS "" +) diff --git a/main/component.mk b/main/component.mk new file mode 100644 index 0000000..cee4d3c --- /dev/null +++ b/main/component.mk @@ -0,0 +1,5 @@ + +# +# "main" pseudo-component makefile. +# +# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.) \ No newline at end of file diff --git a/main/ena-bluetooth-advertise.c b/main/ena-bluetooth-advertise.c new file mode 100644 index 0000000..d5a2215 --- /dev/null +++ b/main/ena-bluetooth-advertise.c @@ -0,0 +1,74 @@ +#include "esp_log.h" +#include "esp_bt.h" + +#include "ena-crypto.h" + +#include "ena-bluetooth-advertise.h" + +static esp_ble_adv_params_t ena_adv_params = { + .adv_int_min = 0x140, // 200 ms + .adv_int_max = 0x190, // 250 ms + .adv_type = ADV_TYPE_NONCONN_IND, + .own_addr_type = BLE_ADDR_TYPE_RANDOM, + .channel_map = ADV_CHNL_ALL, + .adv_filter_policy = ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY, +}; + +void ena_bluetooth_advertise_start(void) +{ + ESP_ERROR_CHECK(esp_ble_gap_start_advertising(&ena_adv_params)); +} + +void ena_bluetooth_advertise_set_payload(uint32_t enin, uint8_t tek[]) +{ + uint8_t rpik[ENA_KEY_LENGTH] = {0}; + uint8_t rpi[ENA_KEY_LENGTH] = {0}; + uint8_t aemk[ENA_KEY_LENGTH] = {0}; + uint8_t aem[ENA_AEM_METADATA_LENGTH] = {0}; + + ena_crypto_rpik(rpik, tek); + + ena_crypto_rpi(rpi, rpik, enin); + + ena_crypto_aemk(aemk, tek); + + ena_crypto_aem(aem, aemk, rpi, esp_ble_tx_power_get(ESP_BLE_PWR_TYPE_ADV)); + + uint8_t adv_raw_data[31]; + // FLAG??? skipped on sniffed android packages!? + adv_raw_data[0] = 0x02; + adv_raw_data[1] = 0x01; + adv_raw_data[2] = ENA_BLUETOOTH_TAG_DATA; + + // SERVICE UUID + adv_raw_data[3] = 0x03; + adv_raw_data[4] = 0x03; + adv_raw_data[5] = 0x6F; + adv_raw_data[6] = 0xFD; + + // SERVICE DATA + adv_raw_data[7] = 0x17; + adv_raw_data[8] = 0x16; + + adv_raw_data[9] = 0x6F; + adv_raw_data[10] = 0xFD; + + for (int i = 0; i < ENA_KEY_LENGTH; i++) + { + adv_raw_data[i + 11] = rpi[i]; + } + for (int i = 0; i < ENA_AEM_METADATA_LENGTH; i++) + { + adv_raw_data[i + ENA_KEY_LENGTH + 11] = aem[i]; + } + + esp_ble_gap_config_adv_data_raw(adv_raw_data, sizeof(adv_raw_data)); + + ESP_LOGI(ENA_ADVERTISE_LOG, "payload for ENIN %u", enin); + ESP_LOG_BUFFER_HEXDUMP(ENA_ADVERTISE_LOG, adv_raw_data, sizeof(adv_raw_data), ESP_LOG_DEBUG); +} + +void ena_bluetooth_advertise_stop(void) +{ + ESP_ERROR_CHECK(esp_ble_gap_stop_advertising()); +} \ No newline at end of file diff --git a/main/ena-bluetooth-advertise.h b/main/ena-bluetooth-advertise.h new file mode 100644 index 0000000..a8fc89d --- /dev/null +++ b/main/ena-bluetooth-advertise.h @@ -0,0 +1,28 @@ +/** + * provide bluetooth part of Exposure Notification API v1.2 as defined by Apple/Google + * + * Source documents: + * + * https://blog.google/documents/70/Exposure_Notification_-_Bluetooth_Specification_v1.2.2.pdf + * + * https://covid19-static.cdn-apple.com/applications/covid19/current/static/detection-tracing/pdf/ExposureNotification-BluetoothSpecificationv1.2.pdf + * + * + * + */ + +#ifndef _ena_BLUETOOTH_ADVERTISE_H_ +#define _ena_BLUETOOTH_ADVERTISE_H_ + +#include "esp_gap_ble_api.h" + +#define ENA_ADVERTISE_LOG "ESP-ENA-advertise" // TAG for Logging +#define ENA_BLUETOOTH_TAG_DATA 0x1A + +void ena_bluetooth_advertise_start(void); + +void ena_bluetooth_advertise_set_payload(uint32_t enin, uint8_t tek[]); + +void ena_bluetooth_advertise_stop(void); + +#endif \ No newline at end of file diff --git a/main/ena-bluetooth-scan.c b/main/ena-bluetooth-scan.c new file mode 100644 index 0000000..35cf167 --- /dev/null +++ b/main/ena-bluetooth-scan.c @@ -0,0 +1,91 @@ + +#include +#include + +#include "esp_log.h" + +#include "ena-detection.h" + +#include "ena-bluetooth-scan.h" + +static int scan_status = ENA_SCAN_STATUS_NOT_SCANNING; + +static esp_ble_scan_params_t ena_scan_params = { + .scan_type = BLE_SCAN_TYPE_ACTIVE, + .own_addr_type = BLE_ADDR_TYPE_RANDOM, + .scan_filter_policy = BLE_SCAN_FILTER_ALLOW_ALL, + .scan_interval = 0x50, // don't know good parameters, just copied + .scan_window = 0x30, // don't know good parameters, just copied + .scan_duplicate = BLE_SCAN_DUPLICATE_ENABLE, +}; + +void ena_bluetooth_scan_event_callback(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) +{ + esp_ble_gap_cb_param_t *p = (esp_ble_gap_cb_param_t *)param; + switch (event) + { + case ESP_GAP_BLE_SCAN_START_COMPLETE_EVT: + ESP_LOGI(ENA_SCAN_LOG, "start scanning..."); + break; + case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT: + ESP_LOGI(ENA_SCAN_LOG, "stopped scanning..."); + ena_detections_temp_refresh((uint32_t)time(NULL)); + break; + case ESP_GAP_BLE_SCAN_RESULT_EVT: + if (p->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_RES_EVT) + { + // check for ENA Service UUID: + if (p->scan_rst.ble_adv[0] == 0x3 && p->scan_rst.ble_adv[1] == 0x3 && p->scan_rst.ble_adv[2] == 0x6f && p->scan_rst.ble_adv[3] == 0xfd) + { + uint8_t rpi[ENA_KEY_LENGTH] = {0}; + for (int i = 0; i < ENA_KEY_LENGTH; i++) + { + rpi[i] = p->scan_rst.ble_adv[8 + i]; + } + + uint8_t aem[ENA_AEM_METADATA_LENGTH] = {0}; + for (int i = 0; i < ENA_AEM_METADATA_LENGTH; i++) + { + aem[i] = p->scan_rst.ble_adv[8 + ENA_KEY_LENGTH + i]; + } + + ena_detection((uint32_t)time(NULL), rpi, aem, p->scan_rst.rssi); + } + } + else if (p->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT) + { + scan_status = ENA_SCAN_STATUS_NOT_SCANNING; + ena_detections_temp_refresh((uint32_t)time(NULL)); + ESP_LOGI(ENA_SCAN_LOG, "finished scanning..."); + } + break; + default: + // nothing + break; + } +} + +void ena_bluetooth_scan_init(void) +{ + ESP_ERROR_CHECK(esp_ble_gap_set_scan_params(&ena_scan_params)); + ESP_ERROR_CHECK(esp_ble_gap_register_callback(ena_bluetooth_scan_event_callback)); + // init temporary detections + ena_detections_temp_refresh((uint32_t)time(NULL)); +} + +void ena_bluetooth_scan_start(uint32_t duration) +{ + scan_status = ENA_SCAN_STATUS_SCANNING; + ESP_ERROR_CHECK(esp_ble_gap_start_scanning(duration)); +} + +void ena_bluetooth_scan_stop(void) +{ + scan_status = ENA_SCAN_STATUS_WAITING; + ESP_ERROR_CHECK(esp_ble_gap_stop_scanning()); +} + +int ena_bluetooth_scan_get_status(void) +{ + return scan_status; +} diff --git a/main/ena-bluetooth-scan.h b/main/ena-bluetooth-scan.h new file mode 100644 index 0000000..c83c03d --- /dev/null +++ b/main/ena-bluetooth-scan.h @@ -0,0 +1,39 @@ +/** + * provide bluetooth scanning part of Exposure Notification API v1.2 as defined by Apple/Google + * + * Source documents: + * + * https://blog.google/documents/70/Exposure_Notification_-_Bluetooth_Specification_v1.2.2.pdf + * + * https://covid19-static.cdn-apple.com/applications/covid19/current/static/detection-tracing/pdf/ExposureNotification-BluetoothSpecificationv1.2.pdf + * + * + * + */ + +#ifndef _ena_BLUETOOTH_SCAN_H_ +#define _ena_BLUETOOTH_SCAN_H_ + +#define ENA_SCAN_LOG "ESP-ENA-scan" // TAG for Logging + +#define ENA_SCANNING_TIME 30 // scan for 30 seconds +#define ENA_SCANNING_INTERVAL 300 // scan every 5 minutes + +#include "esp_gap_ble_api.h" + +typedef enum +{ + ENA_SCAN_STATUS_SCANNING = 0, + ENA_SCAN_STATUS_NOT_SCANNING, + ENA_SCAN_STATUS_WAITING, +} ena_bluetooth_scan_status; + +void ena_bluetooth_scan_init(void); + +void ena_bluetooth_scan_start(uint32_t duration); + +void ena_bluetooth_scan_stop(void); + +int ena_bluetooth_scan_get_status(void); + +#endif \ No newline at end of file diff --git a/main/ena-crypto.c b/main/ena-crypto.c new file mode 100644 index 0000000..65f05e1 --- /dev/null +++ b/main/ena-crypto.c @@ -0,0 +1,84 @@ + +#include "mbedtls/md.h" +#include "mbedtls/aes.h" +#include "mbedtls/hkdf.h" +#include "mbedtls/entropy.h" +#include "mbedtls/ctr_drbg.h" + +#include "esp_log.h" + +#include "ena-crypto.h" + +#define ESP_CRYPTO_LOG "ESP-CRYPTO" + +static mbedtls_ctr_drbg_context ctr_drbg; + +void ena_crypto_init(void) +{ + mbedtls_entropy_context entropy; + uint8_t pers[] = "Exposure Notifcation API esp32"; + int ret; + + mbedtls_entropy_init(&entropy); + mbedtls_ctr_drbg_init(&ctr_drbg); + + if ((ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy, pers, sizeof(pers))) != 0) + { + ESP_LOGE(ESP_CRYPTO_LOG, " failed\n ! mbedtls_ctr_drbg_init returned -0x%04x\n", -ret); + } +} + +uint32_t ena_crypto_enin(uint32_t unix_epoch_time) +{ + return unix_epoch_time / ENA_TIME_WINDOW; +} + +void ena_crypto_tek(uint8_t tek[]) +{ + int ret; + if ((ret = mbedtls_ctr_drbg_random(&ctr_drbg, tek, ENA_KEY_LENGTH)) != 0) + { + ESP_LOGE(ESP_CRYPTO_LOG, " failed\n ! mbedtls_ctr_drbg_random returned -0x%04x\n", -ret); + } +} + +void ena_crypto_rpik(uint8_t rpik[], uint8_t tek[]) +{ + const uint8_t rpik_info[] = "EN-RPIK"; + mbedtls_hkdf(mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), NULL, 0, tek, ENA_KEY_LENGTH, rpik_info, sizeof(rpik_info), rpik, ENA_KEY_LENGTH); +} + +void ena_crypto_rpi(uint8_t rpi[], uint8_t rpik[], uint32_t enin) +{ + uint8_t padded_data[ENA_KEY_LENGTH] = "EN-RPI"; + padded_data[12] = (enin & 0x000000ff); + padded_data[13] = (enin & 0x0000ff00) >> 8; + padded_data[14] = (enin & 0x00ff0000) >> 16; + padded_data[15] = (enin & 0xff000000) >> 24; + + mbedtls_aes_context aes; + mbedtls_aes_init(&aes); + mbedtls_aes_setkey_enc(&aes, rpik, ENA_KEY_LENGTH * 8); + mbedtls_aes_crypt_ecb(&aes, MBEDTLS_AES_ENCRYPT, padded_data, rpi); + mbedtls_aes_free(&aes); +} + +void ena_crypto_aemk(uint8_t aemk[], uint8_t tek[]) +{ + uint8_t aemkInfo[] = "EN-AEMK"; + mbedtls_hkdf(mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), NULL, 0, tek, ENA_KEY_LENGTH, aemkInfo, sizeof(aemkInfo), aemk, ENA_KEY_LENGTH); +} + +void ena_crypto_aem(uint8_t aem[], uint8_t aemk[], uint8_t rpi[], uint8_t power_level) +{ + uint8_t metadata[ENA_AEM_METADATA_LENGTH]; + metadata[0] = 0b01000000; + metadata[1] = power_level; + size_t count = 0; + uint8_t sb[16] = {0}; + mbedtls_aes_context aes; + mbedtls_aes_init(&aes); + mbedtls_aes_setkey_enc(&aes, aemk, ENA_KEY_LENGTH * 8); + mbedtls_aes_crypt_ctr(&aes, ENA_AEM_METADATA_LENGTH, &count, rpi, sb, metadata, aem); + mbedtls_aes_free(&aes); +} \ No newline at end of file diff --git a/main/ena-crypto.h b/main/ena-crypto.h new file mode 100644 index 0000000..b552f19 --- /dev/null +++ b/main/ena-crypto.h @@ -0,0 +1,60 @@ + +/** + * provide cryptographic part of Exposure Notification API v1.2 as defined by Apple/Google + * + * Source documents: + * + * https://blog.google/documents/69/Exposure_Notification_-_Cryptography_Specification_v1.2.1.pdf + * + * https://covid19-static.cdn-apple.com/applications/covid19/current/static/detection-tracing/pdf/ExposureNotification-CryptographySpecificationv1.2.pdf + * + * + * + */ + +#ifndef _ena_CRYPTO_H_ +#define _ena_CRYPTO_H_ + +#define ENA_TIME_WINDOW 600 // time window every 10 minutes +#define ENA_KEY_LENGTH 16 // key length +#define ENA_AEM_METADATA_LENGTH 4 // size of metadata +#define ENA_TEK_ROLLING_PERIOD 144 // TEKRollingPeriod + +#include + +/** + * initialize crypto (setup entropy for key generation) + */ +void ena_crypto_init(void); + +/** + * Calculate ENIntervalNumber (ENIN) for given UNIX timestamp + */ +uint32_t ena_crypto_enin(uint32_t seconds); + +/** + * calculate a new random Temporary Exposure Key (TEK) + */ +void ena_crypto_tek(uint8_t tek[]); + +/** + * calculate a new Rolling Proximity Identifier Key (RPIK) with given TEK + */ +void ena_crypto_rpik(uint8_t rpik[], uint8_t tek[]); + +/** + * calculate a new Rolling Proximity Identifier with given RPIK and ENIN + */ +void ena_crypto_rpi(uint8_t rpi[], uint8_t rpik[], uint32_t enin); + +/** + * calculate a new Associated Encrypted Metadata Key (AEMK) with given TEK + */ +void ena_crypto_aemk(uint8_t aemk[], uint8_t tek[]); + +/** + * create Associated Encrypted Metadata (AEM) with given AEMK along the RPI + */ +void ena_crypto_aem(uint8_t aem[], uint8_t aemk[], uint8_t rpi[], uint8_t power_level); + +#endif \ No newline at end of file diff --git a/main/ena-detection.c b/main/ena-detection.c new file mode 100644 index 0000000..10e3c5a --- /dev/null +++ b/main/ena-detection.c @@ -0,0 +1,94 @@ +#include + +#include "esp_log.h" +#include "ena-crypto.h" +#include "ena-storage.h" + +#include "ena-detection.h" + +static uint32_t temp_detections_count = 0; +static uint8_t temp_detection_rpi[ENA_STOARGE_TEMP_DETECTIONS_MAX][ENA_KEY_LENGTH] = {{0}}; +static uint8_t temp_detection_aem[ENA_STOARGE_TEMP_DETECTIONS_MAX][ENA_AEM_METADATA_LENGTH] = {{0}}; +static uint32_t temp_detection_timestamp_first[ENA_STOARGE_TEMP_DETECTIONS_MAX] = {0}; +static uint32_t temp_detection_timestamp_last[ENA_STOARGE_TEMP_DETECTIONS_MAX] = {0}; +static int temp_detection_rssi_last[ENA_STOARGE_TEMP_DETECTIONS_MAX] = {0}; + +int ena_get_temp_detection_index(uint8_t rpi[], uint8_t aem[]) +{ + for (int i = 0; i < temp_detections_count; i++) + { + if (memcmp(temp_detection_rpi[i], rpi, sizeof(ENA_KEY_LENGTH)) == 0 && + memcmp(temp_detection_aem[i], aem, sizeof(ENA_AEM_METADATA_LENGTH)) == 0) + { + return i; + } + } + return -1; +} + +void ena_detections_temp_refresh(uint32_t unix_timestamp) +{ + for (int i = 0; i < temp_detections_count; i++) + { + // check for treshold and add permanent detection + if (temp_detection_timestamp_last[i] - temp_detection_timestamp_first[i] >= ENA_DETECTION_TRESHOLD) + { + ESP_LOGD(ENA_DETECTION_LOG, "create detection after treshold"); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, temp_detection_rpi[i], ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ena_storage_write_detection(ena_crypto_enin(temp_detection_timestamp_first[i]), temp_detection_rpi[i], + temp_detection_aem[i], temp_detection_rssi_last[i]); + ena_storage_remove_temp_detection(i); + } + else + // delete temp detections older than two times time window (two times to be safe, one times time window enough?!) + if (unix_timestamp - temp_detection_timestamp_first[i] > (ENA_TIME_WINDOW * 2)) + { + ESP_LOGD(ENA_DETECTION_LOG, "remove old temporary detection %u", i); + ena_storage_remove_temp_detection(i); + } + } + + // update detections + temp_detections_count = ena_storage_temp_detections_count(); + for (int i = 0; i < temp_detections_count; i++) + { + ena_storage_read_temp_detection(i, &temp_detection_timestamp_first[i], temp_detection_rpi[i], temp_detection_aem[i], &temp_detection_rssi_last[i]); + } + + // DEBUG dump + ena_storage_dump_tek(); + ena_storage_dump_temp_detections(); + ena_storage_dump_detections(); +} + +void ena_detection(uint32_t unix_timestamp, uint8_t rpi[], uint8_t aem[], int rssi) +{ + uint32_t detection_index = ena_get_temp_detection_index(rpi, aem); + + if (detection_index == -1) + { + temp_detection_timestamp_first[temp_detections_count] = unix_timestamp; + memcpy(temp_detection_rpi[temp_detections_count], rpi, ENA_KEY_LENGTH); + memcpy(temp_detection_aem[temp_detections_count], aem, ENA_AEM_METADATA_LENGTH); + temp_detection_rssi_last[temp_detections_count] = rssi; + temp_detection_timestamp_last[temp_detections_count] = unix_timestamp; + detection_index = ena_storage_write_temp_detection(unix_timestamp, rpi, aem, rssi); + + ESP_LOGD(ENA_DETECTION_LOG, "New temporary detection at %d with timestamp %u", temp_detections_count, unix_timestamp); + ESP_LOG_BUFFER_HEX_LEVEL(ENA_DETECTION_LOG, rpi, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOG_BUFFER_HEX_LEVEL(ENA_DETECTION_LOG, aem, ENA_AEM_METADATA_LENGTH, ESP_LOG_DEBUG); + ESP_LOGD(ENA_DETECTION_LOG, "RSSI %d", rssi); + + if (detection_index != temp_detections_count) + { + ESP_LOGW(ENA_DETECTION_LOG, "last temporary detection index does not match array index!"); + } + temp_detections_count++; + } + else + { + temp_detection_rssi_last[detection_index] = rssi; + temp_detection_timestamp_last[detection_index] = unix_timestamp; + ESP_LOGD(ENA_DETECTION_LOG, "New Timestamp for temporary detection %d: %u", detection_index, unix_timestamp); + } +} \ No newline at end of file diff --git a/main/ena-detection.h b/main/ena-detection.h new file mode 100644 index 0000000..a0caa7e --- /dev/null +++ b/main/ena-detection.h @@ -0,0 +1,19 @@ +/** + * combine bluetooth and crypto parts to build EXPOSURE NOTIFICATION + * + */ + +#ifndef _ena_DETECTION_H_ +#define _ena_DETECTION_H_ + +#define ENA_DETECTION_LOG "ESP-ENA-detection" // TAG for Logging + +#define ENA_DETECTION_TRESHOLD 300 // meet for longer than 5 minutes + +#include "ena-crypto.h" + +void ena_detections_temp_refresh(uint32_t unix_timestamp); + +void ena_detection(uint32_t unix_timestamp, uint8_t rpi[], uint8_t aem[], int rssi); + +#endif \ No newline at end of file diff --git a/main/ena-storage.c b/main/ena-storage.c new file mode 100644 index 0000000..46155af --- /dev/null +++ b/main/ena-storage.c @@ -0,0 +1,449 @@ +#include +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "esp_partition.h" +#include "esp_spi_flash.h" +#include "esp_log.h" + +#include "ena-storage.h" +#include "ena-crypto.h" + +#define BLOCK_SIZE 4096 + +void ena_storage_read(size_t address, uint8_t *data, size_t size) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_read"); + const esp_partition_t *partition = esp_partition_find_first( + ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, PARTITION_NAME); + assert(partition); + ESP_ERROR_CHECK(esp_partition_read(partition, address, data, size)); + vTaskDelay(1); + ESP_LOGD(ENA_STORAGE_LOG, "read data at %u", address); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, data, size, ESP_LOG_DEBUG); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_read"); +} + +void ena_storage_write(size_t address, uint8_t data[], size_t size) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_write"); + const esp_partition_t *partition = esp_partition_find_first( + ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, PARTITION_NAME); + assert(partition); + + const int block_num = address / BLOCK_SIZE; + + // split if size extends block + if (address + size > (block_num + 1) * BLOCK_SIZE) + { + + ESP_LOGI(ENA_STORAGE_LOG, "overflow block at address %u with size %d (block %d)", address, size, block_num); + const size_t block1_address = address; + const size_t block2_address = (block_num + 1) * BLOCK_SIZE; + const size_t data2_size = address + size - block2_address; + const size_t data1_size = size - data2_size; + ESP_LOGD(ENA_STORAGE_LOG, "block1_address %d, block1_size %d (block %d)", block1_address, data1_size, block_num); + ESP_LOGD(ENA_STORAGE_LOG, "block2_address %d, block2_size %d (block %d)", block2_address, data2_size, block_num + 1); + uint8_t *data1 = malloc(data1_size); + for (int i = 0; i < data1_size; i++) + { + data1[i] = data[i]; + } + uint8_t *data2 = malloc(data2_size); + for (int i = 0; i < data2_size; i++) + { + data2[i] = data[data1_size + i]; + } + + ena_storage_write(block1_address, data1, data1_size); + free(data1); + ena_storage_write(block2_address, data2, data2_size); + free(data2); + } + else + { + const int block_start = block_num * BLOCK_SIZE; + const int block_address = address - block_start; + uint8_t *buffer = malloc(BLOCK_SIZE); + if (buffer == NULL) + { + ESP_LOGE(ENA_STORAGE_LOG, "Warning %s malloc low memory", "buffer"); + return; + } + ESP_LOGD(ENA_STORAGE_LOG, "read block %d buffer: start %d size %u", block_num, block_start, BLOCK_SIZE); + ESP_ERROR_CHECK(esp_partition_read(partition, block_start, buffer, BLOCK_SIZE)); + vTaskDelay(1); + ESP_ERROR_CHECK(esp_partition_erase_range(partition, block_start, BLOCK_SIZE)); + + for (int i = 0; i < size; i++) + { + buffer[block_address + i] = data[i]; + } + ESP_ERROR_CHECK(esp_partition_write(partition, block_start, buffer, BLOCK_SIZE)); + free(buffer); + ESP_LOGD(ENA_STORAGE_LOG, "write data at %u", address); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, data, size, ESP_LOG_DEBUG); + } + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_write"); +} + +void ena_storage_shift_delete(size_t address, size_t size) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_shift_delete"); + const esp_partition_t *partition = esp_partition_find_first( + ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, PARTITION_NAME); + assert(partition); + + const int block_num = address / BLOCK_SIZE; + + // split if size extends block TODO this does not work like this!!! Shift puts data back to first block! + if (address + size > (block_num + 1) * BLOCK_SIZE) + { + const int block1_address = address; + const int block2_address = (block_num + 1) * BLOCK_SIZE; + const int data2_size = address + size - block2_address; + const int data1_size = size - data2_size; + ena_storage_shift_delete(block1_address, data1_size); + ena_storage_shift_delete(block2_address, data2_size); + } + else + { + const int block_start = block_num * BLOCK_SIZE; + const int block_address = address - block_start; + uint8_t *buffer = malloc(BLOCK_SIZE); + ESP_ERROR_CHECK(esp_partition_read(partition, block_start, buffer, BLOCK_SIZE)); + vTaskDelay(1); + ESP_LOGD(ENA_STORAGE_LOG, "shift block from %u to %u with size %u (move %u)", block_address, block_address + size, size, BLOCK_SIZE - address + size); + // shift manually + for (int i = block_address + size; i < BLOCK_SIZE; i++) + { + buffer[i - size] = buffer[i]; + } + + for (int i = BLOCK_SIZE - size; i < BLOCK_SIZE; i++) + { + buffer[i] = 0; + } + // memmove seems to lead to corrupt heap memory! + // memmove(&buffer[block_address], &buffer[block_address + size], BLOCK_SIZE - address + size); + ESP_ERROR_CHECK(esp_partition_erase_range(partition, block_start, BLOCK_SIZE)); + ESP_ERROR_CHECK(esp_partition_write(partition, block_start, buffer, BLOCK_SIZE)); + free(buffer); + } + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_shift_delete"); +} + +void ena_storage_write_tek(uint32_t enin, uint8_t tek[]) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_write_tek"); + uint8_t tek_count = ena_storage_read_u8(ENA_STORAGE_TEK_COUNT_ADDRESS); + size_t address = ENA_STORAGE_TEK_START_ADDRESS + (tek_count * ENA_STORAGE_TEK_LENGTH); + ena_storage_write_u32(address, enin); + ena_storage_write(address + 4, tek, ENA_KEY_LENGTH); + + tek_count++; + if (tek_count > ENA_STOARGE_TEK_STORE_PERIOD) + { + tek_count = 0; + } + ena_storage_write_u8(ENA_STORAGE_TEK_COUNT_ADDRESS, tek_count); + + ESP_LOGD(ENA_STORAGE_LOG, "write tek: ENIN %u", enin); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, tek, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_write_tek"); +} + +uint32_t ena_storage_read_enin(void) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_read_enin"); + uint8_t tek_count = ena_storage_read_u8(ENA_STORAGE_TEK_COUNT_ADDRESS); + if (tek_count < 1) + { + return 0; + } + size_t address = ENA_STORAGE_TEK_START_ADDRESS + (tek_count - 1) * ENA_STORAGE_TEK_LENGTH; + uint32_t result = ena_storage_read_u32(address); + + ESP_LOGD(ENA_STORAGE_LOG, "read last ENIN: %u", result); + + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_read_enin"); + return result; +} + +void ena_storage_read_tek(uint8_t tek[]) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_read_tek"); + uint8_t tek_count = ena_storage_read_u8(ENA_STORAGE_TEK_COUNT_ADDRESS); + if (tek_count < 1) + { + return; + } + size_t address = ENA_STORAGE_TEK_START_ADDRESS + (tek_count - 1) * ENA_STORAGE_TEK_LENGTH + 4; + ena_storage_read(address, tek, ENA_KEY_LENGTH); + + ESP_LOGD(ENA_STORAGE_LOG, "read last tek:"); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, tek, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_read_tek"); +} + +uint32_t ena_storage_temp_detections_count(void) +{ + + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_temp_detections_count"); + uint32_t count = ena_storage_read_u32(ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS); + ESP_LOGD(ENA_STORAGE_LOG, "read temp contancts count: %u", count); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_temp_detections_count"); + return count; +} + +uint32_t ena_storage_write_temp_detection(uint32_t timestamp, uint8_t rpi[], uint8_t aem[], int rssi) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_write_temp_detection"); + uint32_t count = ena_storage_temp_detections_count() + 1; + + // start overwriting temporay detections?! + if (count > ENA_STOARGE_TEMP_DETECTIONS_MAX) + { + count = 1; + } + + size_t address = ENA_STORAGE_TEMP_DETECTIONS_START_ADDRESS + (count - 1) * ENA_STORAGE_DETECTION_LENGTH; + ena_storage_write_u32(address, timestamp); + address += 4; + ena_storage_write(address, rpi, ENA_KEY_LENGTH); + address += ENA_KEY_LENGTH; + ena_storage_write(address, aem, ENA_AEM_METADATA_LENGTH); + address += ENA_AEM_METADATA_LENGTH; + ena_storage_write_int(address, rssi); + ena_storage_write_u32(ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS, count); + + ESP_LOGD(ENA_STORAGE_LOG, "write temp detection: timestamp %u and rssi %d", timestamp, rssi); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, rpi, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, aem, ENA_AEM_METADATA_LENGTH, ESP_LOG_DEBUG); + + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_write_temp_detection"); + return count - 1; +} + +void ena_storage_read_temp_detection(uint32_t index, uint32_t *timestamp, uint8_t rpi[], uint8_t aem[], int *rssi) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_read_temp_detection"); + size_t address = ENA_STORAGE_TEMP_DETECTIONS_START_ADDRESS + index * ENA_STORAGE_DETECTION_LENGTH; + *timestamp = ena_storage_read_u32(address); + address += 4; + ena_storage_read(address, rpi, ENA_KEY_LENGTH); + address += ENA_KEY_LENGTH; + ena_storage_read(address, aem, ENA_AEM_METADATA_LENGTH); + address += 4; + *rssi = ena_storage_read_int(address); + + ESP_LOGD(ENA_STORAGE_LOG, "read temp detection: timestamp %u and rssi %d", *timestamp, *rssi); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, rpi, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, aem, ENA_AEM_METADATA_LENGTH, ESP_LOG_DEBUG); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_read_temp_detection"); +} + +void ena_storage_remove_temp_detection(uint32_t index) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_remove_temp_detection"); + size_t address = ENA_STORAGE_TEMP_DETECTIONS_START_ADDRESS + index * ENA_STORAGE_DETECTION_LENGTH; + + ena_storage_shift_delete(address, ENA_STORAGE_DETECTION_LENGTH); + + uint32_t count = ena_storage_temp_detections_count(); + count--; + ena_storage_write_u32(ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS, count); + ESP_LOGD(ENA_STORAGE_LOG, "remove temp detection: %u", index); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_remove_temp_detection"); +} + +uint32_t ena_storage_detections_count(void) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_detections_count"); + uint32_t count = ena_storage_read_u32(ENA_STORAGE_DETECTIONS_COUNT_ADDRESS); + ESP_LOGD(ENA_STORAGE_LOG, "read contancts count: %u", count); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_detections_count"); + return count; +} + +void ena_storage_write_detection(uint32_t timestamp, uint8_t rpi[], uint8_t aem[], int rssi) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_write_detection"); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, rpi, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + uint32_t count = ena_storage_detections_count() + 1; + size_t address = ENA_STORAGE_DETECTIONS_START_ADDRESS + (count - 1) * ENA_STORAGE_DETECTION_LENGTH; + ena_storage_write_u32(address, timestamp); + address += 4; + ena_storage_write(address, rpi, ENA_KEY_LENGTH); + address += ENA_KEY_LENGTH; + ena_storage_write(address, aem, ENA_AEM_METADATA_LENGTH); + address += ENA_AEM_METADATA_LENGTH; + ena_storage_write_int(address, rssi); + ena_storage_write_u32(ENA_STORAGE_DETECTIONS_COUNT_ADDRESS, count); + + ESP_LOGD(ENA_STORAGE_LOG, "write detection: timestamp %u and rssi %d", timestamp, rssi); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, rpi, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, aem, ENA_AEM_METADATA_LENGTH, ESP_LOG_DEBUG); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_write_detection"); +} + +void ena_storage_read_detection(uint32_t index, uint32_t *timestamp, uint8_t rpi[], uint8_t aem[], int *rssi) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_read_detection"); + size_t address = ENA_STORAGE_DETECTIONS_START_ADDRESS + index * ENA_STORAGE_DETECTION_LENGTH; + *timestamp = ena_storage_read_u32(address); + address += 4; + ena_storage_read(address, rpi, ENA_KEY_LENGTH); + address += ENA_KEY_LENGTH; + ena_storage_read(address, aem, ENA_AEM_METADATA_LENGTH); + address += 4; + *rssi = ena_storage_read_int(address); + + ESP_LOGD(ENA_STORAGE_LOG, "read detection: timestamp %u and rssi %d", *timestamp, *rssi); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, rpi, ENA_KEY_LENGTH, ESP_LOG_DEBUG); + ESP_LOG_BUFFER_HEXDUMP(ENA_STORAGE_LOG, aem, ENA_AEM_METADATA_LENGTH, ESP_LOG_DEBUG); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_read_detection"); +} + +uint8_t ena_storage_read_u8(size_t address) +{ + uint8_t data[1] = {0}; + ena_storage_read(address, (uint8_t *)&data, 1); + return data[0]; +} + +uint32_t ena_storage_read_u32(size_t address) +{ + uint8_t data[4] = {0}; + ena_storage_read(address, (uint8_t *)&data, 4); + + uint32_t result = data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24); + return result; +} + +void ena_storage_write_u8(size_t address, uint8_t byte) +{ + uint8_t data[1] = {byte}; + ena_storage_write(address, data, 1); +} + +void ena_storage_write_u32(size_t address, uint32_t value) +{ + uint8_t *data = malloc(4); + data[0] = (value & 0x000000ff); + data[1] = (value & 0x0000ff00) >> 8; + data[2] = (value & 0x00ff0000) >> 16; + data[3] = (value & 0xff000000) >> 24; + ena_storage_write(address, data, 4); + free(data); +} + +int ena_storage_read_int(size_t address) +{ + uint8_t data[sizeof(int)] = {0}; + ena_storage_read(address, (uint8_t *)&data, sizeof(int)); + int result = 0; + memcpy((int *)&result, (int *)&data, sizeof(int)); + return result; +} + +void ena_storage_write_int(size_t address, int value) +{ + + uint8_t data[sizeof(int)] = {0}; + memcpy((int *)&data, (int *)&value, sizeof(int)); + ena_storage_write(address, data, sizeof(int)); +} + +void ena_storage_erase(void) +{ + ESP_LOGD(ENA_STORAGE_LOG, "START ena_storage_erase"); + const esp_partition_t *partition = esp_partition_find_first( + ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, PARTITION_NAME); + assert(partition); + ESP_ERROR_CHECK(esp_partition_erase_range(partition, 0, partition->size)); + ESP_LOGI(PARTITION_NAME, "erase partition!"); + + uint8_t *tek_zeros = calloc(ENA_STORAGE_TEK_LENGTH + 1, sizeof(uint8_t)); + ena_storage_write(ENA_STORAGE_TEK_COUNT_ADDRESS, tek_zeros, ENA_STORAGE_TEK_LENGTH + 1); + + uint8_t *temp_detection_zeros = calloc(ENA_STORAGE_DETECTION_LENGTH + 4, sizeof(uint8_t)); + ena_storage_write(ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS, temp_detection_zeros, ENA_STORAGE_DETECTION_LENGTH + 4); + + uint8_t *detection_zeros = calloc(ENA_STORAGE_DETECTION_LENGTH + 4, sizeof(uint8_t)); + ena_storage_write(ENA_STORAGE_DETECTIONS_COUNT_ADDRESS, detection_zeros, ENA_STORAGE_DETECTION_LENGTH + 4); + ESP_LOGD(ENA_STORAGE_LOG, "END ena_storage_erase"); +} + +void ena_storage_dump_hash_array(uint8_t data[], size_t size) +{ + for (int i = 0; i < size; i++) + { + if (i == 0) + { + printf("%0x", data[i]); + } + else + { + printf(" %0x", data[i]); + } + } +} + +void ena_storage_dump_tek(void) +{ + uint32_t timestamp; + uint8_t tek[ENA_KEY_LENGTH] = {0}; + uint8_t tek_count = ena_storage_read_u8(ENA_STORAGE_TEK_COUNT_ADDRESS); + ESP_LOGD(ENA_STORAGE_LOG, "%u TEKs\n", tek_count); + printf("#,enin,tek\n"); + for (int i = 0; i < tek_count; i++) + { + + size_t address = ENA_STORAGE_TEK_START_ADDRESS + i * ENA_STORAGE_TEK_LENGTH; + timestamp = ena_storage_read_u32(address); + ena_storage_read(address + 4, tek, ENA_KEY_LENGTH); + printf("%d,%u,", i, timestamp); + ena_storage_dump_hash_array(tek, ENA_KEY_LENGTH); + printf("\n"); + } +} + +void ena_storage_dump_temp_detections(void) +{ + uint32_t timestamp; + uint8_t rpi[ENA_KEY_LENGTH] = {0}; + uint8_t aem[ENA_AEM_METADATA_LENGTH] = {0}; + int rssi; + uint32_t detection_count = ena_storage_read_u32(ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS); + ESP_LOGD(ENA_STORAGE_LOG, "%u temporary detections\n", detection_count); + printf("#,timestamp,rpi,aem,rssi\n"); + for (int i = 0; i < detection_count; i++) + { + ena_storage_read_temp_detection(i, ×tamp, rpi, aem, &rssi); + printf("%d,%u,", i, timestamp); + ena_storage_dump_hash_array(rpi, ENA_KEY_LENGTH); + printf(","); + ena_storage_dump_hash_array(aem, ENA_AEM_METADATA_LENGTH); + printf(",%d\n", rssi); + } +} + +void ena_storage_dump_detections(void) +{ + uint32_t enin; + uint8_t rpi[ENA_KEY_LENGTH] = {0}; + uint8_t aem[ENA_AEM_METADATA_LENGTH] = {0}; + int rssi; + uint32_t detection_count = ena_storage_read_u32(ENA_STORAGE_DETECTIONS_COUNT_ADDRESS); + ESP_LOGD(ENA_STORAGE_LOG, "%u detections\n", detection_count); + printf("#,enin,rpi,aem,rssi\n"); + for (int i = 0; i < detection_count; i++) + { + ena_storage_read_detection(i, &enin, rpi, aem, &rssi); + printf("%d,%u,", i, enin); + ena_storage_dump_hash_array(rpi, ENA_KEY_LENGTH); + printf(","); + ena_storage_dump_hash_array(aem, ENA_AEM_METADATA_LENGTH); + printf(",%d\n", rssi); + } +} \ No newline at end of file diff --git a/main/ena-storage.h b/main/ena-storage.h new file mode 100644 index 0000000..3a5d68f --- /dev/null +++ b/main/ena-storage.h @@ -0,0 +1,107 @@ +#ifndef _ena_STORAGE_H_ +#define _ena_STORAGE_H_ + +#include "ena-crypto.h" + +#define ENA_STORAGE_LOG "ESP-ENA-storage" // TAG for Logging +#define PARTITION_NAME "ena" +#define ENA_STOARGE_TEK_STORE_PERIOD (14) // Period of storing TEKs +#define ENA_STORAGE_TEK_COUNT_ADDRESS (0) // starting address for TEK COUNT +#define ENA_STORAGE_TEK_START_ADDRESS (ENA_STORAGE_TEK_COUNT_ADDRESS + 1) // starting address for TEKs +#define ENA_STORAGE_TEK_LENGTH (ENA_KEY_LENGTH + 4) // length of a stored TEK -> TEK keysize + 4 Bytes for ENIN +#define ENA_STORAGE_DETECTION_LENGTH (ENA_KEY_LENGTH + ENA_AEM_METADATA_LENGTH + 4 + sizeof(int)) // length of a stored detection -> RPI keysize + AEM size + 4 Bytes for ENIN + 4 Bytes for RSSI +#define ENA_STOARGE_TEMP_DETECTIONS_MAX (1000) // Maximum number of temporary stored detections +#define ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS (ENA_STORAGE_TEK_START_ADDRESS + ENA_STORAGE_TEK_LENGTH * ENA_STOARGE_TEK_STORE_PERIOD) // starting address for temporary detections COUNT (offset from max. stored TEKs) +#define ENA_STORAGE_TEMP_DETECTIONS_START_ADDRESS (ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS + 4) // starting address for temporary detections +#define ENA_STORAGE_DETECTIONS_COUNT_ADDRESS (ENA_STORAGE_TEMP_DETECTIONS_COUNT_ADDRESS + ENA_STORAGE_DETECTION_LENGTH * ENA_STOARGE_TEMP_DETECTIONS_MAX) // starting address for detections COUNT (offset from max. stored temporary detections) +#define ENA_STORAGE_DETECTIONS_START_ADDRESS (ENA_STORAGE_DETECTIONS_COUNT_ADDRESS + 4) // starting address of detections + + +/** + * read bytes at given address + */ +void ena_storage_read(size_t address, uint8_t *data, size_t size); + +/** + * store bytes at given address + */ +void ena_storage_write(size_t address, uint8_t data[], size_t size); + +/** + * deletes bytes at given address and shift other data back + */ +void ena_storage_shift_delete(size_t address, size_t size); + +/** + * store TEK with ENIN + */ +void ena_storage_write_tek(uint32_t enin, uint8_t tek[]); + +/** + * get last stored ENIN + */ +uint32_t ena_storage_read_enin(void); + +/** + * get last stored TEK + */ +void ena_storage_read_tek(uint8_t tek[]); + +/** + * get number of stored temporary detections + */ +uint32_t ena_storage_temp_detections_count(void); + +/** + * store temporary detection (RPI + AEM + RSSI with UNIX timestamp) + * + * returns index + */ +uint32_t ena_storage_write_temp_detection(uint32_t timestamp, uint8_t rpi[], uint8_t aem[], int rssi); + +/** + * get temporary detection (RPI + AEM + RSSI with UNIX timestamp) at given index + */ +void ena_storage_read_temp_detection(uint32_t index, uint32_t *timestamp, uint8_t rpi[], uint8_t aem[], int *rssi); + +/** + * remove temporary detection at given index + */ +void ena_storage_remove_temp_detection(uint32_t index); + +/** + * get number of stored detections + */ +uint32_t ena_storage_detections_count(void); + +/** + * store detection (RPI + AEM + RSSI with ENIN) + */ +void ena_storage_write_detection(uint32_t timestamp, uint8_t rpi[], uint8_t aem[], int rssi); + +/** + * get detection (RPI + AEM + RSSI with ENIN) at given index + */ +void ena_storage_read_detection(uint32_t index, uint32_t *enin, uint8_t rpi[], uint8_t aem[], int *rssi); + +uint8_t ena_storage_read_u8(size_t address); + +uint32_t ena_storage_read_u32(size_t address); + +void ena_storage_write_u8(size_t address, uint8_t byte); + +void ena_storage_write_u32(size_t address, uint32_t value); + +int ena_storage_read_int(size_t address); + +void ena_storage_write_int(size_t address, int value); + +void ena_storage_erase(void); + +void ena_storage_dump_tek(void); + +void ena_storage_dump_temp_detections(void); + +void ena_storage_dump_detections(void); + +#endif \ No newline at end of file diff --git a/main/ena.c b/main/ena.c new file mode 100644 index 0000000..113e160 --- /dev/null +++ b/main/ena.c @@ -0,0 +1,118 @@ + +#include +#include + +#include "esp_system.h" +#include "esp_log.h" +#include "esp_bt.h" +#include "esp_bt_main.h" +#include "esp_gap_ble_api.h" + +#include "nvs_flash.h" + +#include "ena-crypto.h" +#include "ena-storage.h" +#include "ena-bluetooth-scan.h" +#include "ena-bluetooth-advertise.h" + +#include "ena.h" + +static uint32_t last_enin; // last ENIN +static uint8_t tek[ENA_KEY_LENGTH] = {0}; // current TEK + +void ena_init(void) +{ + // init NVS for BLE + esp_err_t ret; + ret = nvs_flash_init(); + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) + { + ESP_ERROR_CHECK(nvs_flash_erase()); + ESP_ERROR_CHECK(nvs_flash_init()); + } + + // init BLE + esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT(); + ESP_ERROR_CHECK(esp_bt_controller_init(&bt_cfg)); + ESP_ERROR_CHECK(esp_bt_controller_enable(ESP_BT_MODE_BLE)); + ESP_ERROR_CHECK(esp_bluedroid_init()); + ESP_ERROR_CHECK(esp_bluedroid_enable()); + + ESP_ERROR_CHECK(esp_ble_tx_power_set(ESP_BLE_PWR_TYPE_DEFAULT, ESP_PWR_LVL_P9)); + ESP_ERROR_CHECK(esp_ble_tx_power_set(ESP_BLE_PWR_TYPE_ADV, ESP_PWR_LVL_P9)); + ESP_ERROR_CHECK(esp_ble_tx_power_set(ESP_BLE_PWR_TYPE_SCAN, ESP_PWR_LVL_P9)); + ESP_ERROR_CHECK(esp_ble_gap_config_local_privacy(true)); + + /* nesseccary? + // new bluetooth address + uint8_t bt_address[ESP_BD_ADDR_LEN]; + esp_fill_random(bt_address, ESP_BD_ADDR_LEN); + bt_address[0] |= 0xC0; + + ESP_ERROR_CHECK(esp_ble_gap_set_rand_addr(bt_address)); +*/ + // init ENA + ena_crypto_init(); + + uint32_t current_enin = ena_crypto_enin((uint32_t)time(NULL)); + + last_enin = ena_storage_read_enin(); + + // read last TEK or create new + if (ena_storage_read_u8(ENA_STORAGE_TEK_COUNT_ADDRESS) > 0 && (current_enin - last_enin) < ENA_TEK_ROLLING_PERIOD) + { + ena_storage_read_tek(tek); + } + else + { + ena_crypto_tek(tek); + ena_storage_write_tek(ena_crypto_enin((uint32_t)time(NULL)), tek); + last_enin = ena_storage_read_enin(); + } + + // init scan + ena_bluetooth_scan_init(); + + // init and start advertising + ena_bluetooth_advertise_set_payload(current_enin, tek); + ena_bluetooth_advertise_start(); + // initial scan on every start + ena_bluetooth_scan_start(ENA_SCANNING_TIME); +} + +void ena_run(void) +{ + uint32_t unix_timestamp = (uint32_t)time(NULL); + uint32_t current_enin = ena_crypto_enin(unix_timestamp); + if (current_enin - last_enin >= ENA_TEK_ROLLING_PERIOD) + { + ena_crypto_tek(tek); + ena_storage_write_tek(current_enin, tek); + last_enin = current_enin; + } + + // change RPI + if (unix_timestamp % ENA_TIME_WINDOW == 0) + { + + // + + if (ena_bluetooth_scan_get_status() == ENA_SCAN_STATUS_SCANNING) + { + ena_bluetooth_scan_stop(); + } + ena_bluetooth_advertise_stop(); + ena_bluetooth_advertise_set_payload(current_enin, tek); + ena_bluetooth_advertise_start(); + if (ena_bluetooth_scan_get_status() == ENA_SCAN_STATUS_WAITING) + { + ena_bluetooth_scan_start(ENA_SCANNING_TIME); + } + } + + // scan + if (unix_timestamp % ENA_SCANNING_INTERVAL == 0 && ena_bluetooth_scan_get_status() == ENA_SCAN_STATUS_NOT_SCANNING) + { + ena_bluetooth_scan_start(ENA_SCANNING_TIME); + } +} diff --git a/main/ena.h b/main/ena.h new file mode 100644 index 0000000..ab53df2 --- /dev/null +++ b/main/ena.h @@ -0,0 +1,16 @@ +/** + * combine bluetooth and crypto parts to build EXPOSURE NOTIFICATION + * + */ + +#ifndef _ena_H_ +#define _ena_H_ + + +#define ENA_LOG "ESP-ENA" // TAG for Logging + +void ena_init(void); + +void ena_run(void); + +#endif \ No newline at end of file diff --git a/main/main.c b/main/main.c new file mode 100644 index 0000000..4c57fac --- /dev/null +++ b/main/main.c @@ -0,0 +1,44 @@ +/** + * provide bluetooth part of Exposure Notification API v1.2 as defined by Apple/Google + * + * Source documents: + * + * https://blog.google/documents/70/Exposure_Notification_-_Bluetooth_Specification_v1.2.2.pdf + * + * https://covid19-static.cdn-apple.com/applications/covid19/current/static/detection-tracing/pdf/ExposureNotification-BluetoothSpecificationv1.2.pdf + * + * + * + */ + +#include +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include +#include +#include "esp_system.h" +#include "esp_log.h" + +#include "ena.h" +#include "ena-storage.h" + +#include "sdkconfig.h" + +void app_main(void) +{ + // DEBUG set time + struct timeval tv = {1594459800, 0}; // current hardcoded timestamp (2020-07-11 09:30:00) ¯\_(ツ)_/¯ + settimeofday(&tv, NULL); + + esp_log_level_set(ENA_STORAGE_LOG, ESP_LOG_INFO); + // ena_storage_erase(); + + ena_init(); + + // one second loop enough? + while (1) + { + ena_run(); + vTaskDelay(1000 / portTICK_PERIOD_MS); + } +} diff --git a/partitions.csv b/partitions.csv new file mode 100644 index 0000000..fc77773 --- /dev/null +++ b/partitions.csv @@ -0,0 +1,6 @@ +# ESP-IDF Partition Table +# Name, Type, SubType, Offset, Size, Flags +nvs, data, nvs, 0x9000, 0x6000, +phy_init, data, phy, 0xf000, 0x1000, +factory, app, factory, 0x10000, 1M, +ena, data, nvs, 0x110000,0x2C0000, \ No newline at end of file