The Secret Pangolin Code
_{Fastest Proximity Tracing in the West (FPTW)}

💾 Install • 🎮 Quick start • 🐝 API • 📋 Testing • 😍 Acknowledgements • 🌐 Links • 👤 Contributing • 💼 License

Proximity tracing (proxtrax) with blazing fast speed, developed with the embedded first mindset.

Our benchmarks report that for 20.000 entries of DP3T Ephemeral IDs, ~5MB or RAM used and 0.02s of execution.

🚧 Pangolin is friend of the DECODE project about data-ownership and technological sovereignty. Our effort is that of improving people's awareness of how their data is processed by algorithms, as well facilitate the work of developers to create along privacy by design principles using algorithms that can be deployed in any situation without any change.

🚩 Table of Contents (click to expand)

Install
Quick start
API
Testing
Troubleshooting & debugging
Acknowledgements
Links
Contributing
License

💾 Install

Simply run the default target of Makefile

make

🎮 Quick start

To start using Pangolin your best move is to run the tests like

make check

🐝 API

TODO lib signatures here

📋 Testing

Running the test with

make check

🐛 Troubleshooting & debugging

Nothing to report as per now

If you find any problem or suspitious behaviours please open an issue

😍 Acknowledgements

Designed, written and maintained by Daniele Lacamera & Denis "Jaromil" Roio with contributions by Puria Nafisi Azizi

wolfSSL/wolfCrypt for TLS and crypto

Icon made by Freepik from www.flaticon.com

Name inspiration comes from the Secret Rabbit Code

🌐 Links

https://dyne.org/

👥 Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

🔀 FORK IT
Create your feature branch git checkout -b feature/branch
Commit your changes git commit -am 'Add some fooBar'
Push to the branch git push origin feature/branch
Create a new Pull Request
🙏 Thank you

💼 License

Pangolin - Fastest Proximity Tracing in the West
Copyright (c) 2020 Dyne.org foundation, Amsterdam

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 <http://www.gnu.org/licenses/>.

🔝 back to top

danielinux/pangolin

The Secret Pangolin Code Fastest Proximity Tracing in the West (FPTW)