https://github.com/markqvist/Reticulum Skip to content Sign up * Product + Features + Mobile + Actions + Codespaces + Packages + Security + Code review + Issues + Integrations + GitHub Sponsors + Customer stories * Team * Enterprise * Explore + Explore GitHub + Learn and contribute + Topics + Collections + Trending + Learning Lab + Open source guides + Connect with others + The ReadME Project + Events + Community forum + GitHub Education + GitHub Stars program * Marketplace * Pricing + Plans + Compare plans + Contact Sales + Education [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this user All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} markqvist / Reticulum Public * Notifications * Fork 16 * Star 280 Self-configuring, encrypted and resilient mesh for LoRa, packet radio, WiFi and everything in between unsigned.io/projects/reticulum/ MIT License 280 stars 16 forks Star Notifications * Code * Issues 2 * Pull requests 0 * Discussions * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 1 branch 24 tags Code Latest commit @markqvist markqvist Update README.md ... 82fc872 Mar 26, 2022 Update README.md 82fc872 Git stats * 501 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time Examples Updated example Jan 11, 2022 RNS Updated filtering rules. Fixes #18. Mar 15, 2022 docs Updated docs and manual Feb 26, 2022 .gitignore Improved shutdown handling on interrupt. Updated gitignore. Nov 4, 2021 LICENSE Updated license Mar 25, 2022 Makefile Added makefile Dec 1, 2021 README.md Update README.md Mar 26, 2022 setup.py Preliminary I2P Interface support Feb 23, 2022 View code [ ] Reticulum Network Stack b Read The Manual Notable Features Examples of Reticulum Applications Where can Reticulum be used? How do I get started? Current Status Supported interface types and devices Planned Features Dependencies: Support Reticulum Caveat Emptor README.md Reticulum Network Stack b [68747470733a2f2f756e7369676] Reticulum is the cryptography-based networking stack for wide-area networks built on readily available hardware. It can operate even with very high latency and extremely low bandwidth. Reticulum allows you to build wide-area networks with off-the-shelf tools, and offers end-to-end encryption, initiator anonymity, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable packet acknowledgements and more. Reticulum is a complete networking stack, and does not need IP or higher layers, although it is easy to use IP (with TCP or UDP) as the underlying carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the Internet or private IP networks. Having no dependencies on traditional networking stacks free up overhead that has been utilised to implement a networking stack built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks. No kernel modules or drivers are required. Reticulum runs completely in userland, and can run on practically any system that runs Python 3. Read The Manual The full documentation for Reticulum is available at markqvist.github.io/Reticulum/manual/. You can also download the Reticulum manual as a PDF For more info, see unsigned.io/projects/reticulum Notable Features * Coordination-less globally unique adressing and identification * Fully self-configuring multi-hop routing * Complete initiator anonymity, communicate without revealing your identity * Asymmetric X25519 encryption and Ed25519 signatures as a basis for all communication * Forward Secrecy with ephemereal Elliptic Curve Diffie-Hellman keys on Curve25519 * Reticulum uses the Fernet specification for on-the-wire / over-the-air encryption + Keys are ephemeral and derived from an ECDH key exchange on Curve25519 + AES-128 in CBC mode with PKCS7 padding + HMAC using SHA256 for authentication + IVs are generated through os.urandom() * Unforgeable packet delivery confirmations * A variety of supported interface types * An intuitive and easy-to-use API * Reliable and efficient transfer of arbritrary amounts of data + Reticulum can handle a few bytes of data or files of many gigabytes + Sequencing, transfer coordination and checksumming is automatic + The API is very easy to use, and provides transfer progress * Lightweight, flexible and expandable Request/Response mechanism * Efficient link establishment + Total bandwidth cost of setting up a link is 3 packets totalling 237 bytes + Low cost of keeping links open at only 0.62 bits per second Examples of Reticulum Applications If you want to quickly get an idea of what Reticulum can do, take a look at the following resources. * LXMF is a distributed, delay and disruption tolerant message transfer protocol built on Reticulum * For an off-grid, encrypted and resilient mesh communications platform, see Nomad Network * The Android, Linux and macOS app Sideband has a graphical interface and focuses on ease of use. Where can Reticulum be used? Over practically any medium that can support at least a half-duplex channel with 500 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, ad-hoc WiFi, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for. An open-source LoRa-based interface called RNode has been designed specifically for use with Reticulum. It is possible to build yourself, or it can be purchased as a complete transceiver that just needs a USB connection to the host. Reticulum can also be encapsulated over existing IP networks, so there's nothing stopping you from using it over wired ethernet or your local WiFi network, where it'll work just as well. In fact, one of the strengths of Reticulum is how easily it allows you to connect different mediums into a self-configuring, resilient and encrypted mesh. As an example, it's possible to set up a Raspberry Pi connected to both a LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are configured, Reticulum will take care of the rest, and any device on the WiFi network can communicate with nodes on the LoRa and packet radio sides of the network, and vice versa. How do I get started? The best way to get started with the Reticulum Network Stack depends on what you want to do. For full details and examples, have a look at the Getting Started Fast section of the Reticulum Manual. To simply install Reticulum and related utilities on your system, the easiest way is via pip: pip3 install rns You can then start any program that uses Reticulum, or start Reticulum as a system service with the rnsd utility. When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers. The default config file contains examples for using Reticulum with LoRa transceivers (specifically RNode), packet radio TNCs/modems, TCP and UDP. You can use the examples in the config file to expand communication over many mediums such as packet radio or LoRa (with RNode), serial ports, or over fast IP links and the Internet using the UDP and TCP interfaces. For more detailed examples, take a look at the Supported Interfaces section of the Reticulum Manual. Current Status Reticulum should currently be considered beta software. All core protocol features are implemented and functioning, but additions will probably occur as real-world use is explored. There will be bugs. The API and wire-format can be considered relatively stable at the moment, but could change if warranted. Supported interface types and devices Reticulum implements a range of generalised interface types that covers most of the communications hardware that Reticulum can run over. If your hardware is not supported, it's relatively simple to implement an interface class. Currently, the following interfaces are supported: * Any ethernet device * LoRa using RNode * Packet Radio TNCs (with or without AX.25) * Any device with a serial port * TCP over IP networks * UDP over IP networks Planned Features * More interface types for even broader compatibility + ESP32 devices (ESP-Now, Bluetooth, etc.) + More LoRa transceivers + AT-compatible modems + AWDL / OWL + HF Modems + CAN-bus + ZeroMQ + MQTT + SPI + i2c * Globally routable multicast Dependencies: * Python 3.6 * cryptography.io * netifaces * pyserial Support Reticulum You can help support the continued development of open, free and private communications systems by donating via one of the following channels: * Ethereum: 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a * Bitcoin: 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq * Ko-Fi: https://ko-fi.com/markqvist Are certain features in the development roadmap are important to you or your organisation? Make them a reality quickly by sponsoring their implementation. Caveat Emptor Reticulum is relatively young software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it has not been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch. About Self-configuring, encrypted and resilient mesh for LoRa, packet radio, WiFi and everything in between unsigned.io/projects/reticulum/ Topics mesh-networks lora networking-stack packet-radio Resources Readme License MIT License Stars 280 stars Watchers 25 watching Forks 16 forks Releases 15 RNS b 0.3.4 Latest Mar 28, 2022 + 14 releases Used by 3 * @HarlekinSimplex @HarlekinSimplex / nexus * @markqvist @markqvist / NomadNet * @markqvist @markqvist / LXMF Contributors 3 * * * Languages * Python 99.9% * Makefile 0.1% * (c) 2022 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.