206 lines
15 KiB
Markdown
Executable File
206 lines
15 KiB
Markdown
Executable File
Reticulum Network Stack β
|
|
==========
|
|
|
|
<p align="center"><img width="200" src="https://unsigned.io/wp-content/uploads/2022/03/reticulum_logo_512.png"></p>
|
|
|
|
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 and connectivity, initiator anonymity, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable delivery acknowledgements and more.
|
|
|
|
The vision of Reticulum is to allow anyone to be their own network operator, and to make it cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks. Reticulum **is not** *one* network. It is **a tool** for building *thousands of networks*. Networks without kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate with each other, and require no central oversight. Networks for human beings. *Networks for the people*.
|
|
|
|
Reticulum is a complete networking stack, and does not rely on IP or higher layers, but it is possible to use IP 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 frees up overhead that has been used to implement a networking stack built directly on cryptographic principles, allowing resilience and stable functionality, even 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/](https://markqvist.github.io/Reticulum/manual/).
|
|
|
|
You can also [download the Reticulum manual as a PDF](https://github.com/markqvist/Reticulum/raw/master/docs/Reticulum%20Manual.pdf)
|
|
|
|
For more info, see [unsigned.io/projects/reticulum](https://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](https://github.com/fernet/spec/blob/master/Spec.md) 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 an encrypted 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](https://github.com/markqvist/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](https://github.com/markqvist/NomadNet)
|
|
- The Android, Linux and macOS app [Sideband](https://unsigned.io/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](https://unsigned.io/projects/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](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
|
|
|
To simply install Reticulum and related utilities on your system, the easiest way is via pip:
|
|
|
|
```bash
|
|
pip3 install rns
|
|
```
|
|
|
|
You can then start any program that uses Reticulum, or start Reticulum as a system service with [the rnsd utility](https://markqvist.github.io/Reticulum/manual/using.html#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](https://unsigned.io/projects/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](https://unsigned.io/projects/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](https://markqvist.github.io/Reticulum/manual/interfaces.html) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
|
|
|
## Included Utilities
|
|
Reticulum includes a range of useful utilities for managing your networks, viewing status and information, and other tasks. You can read more about these programs in the [Included Utility Programs](https://markqvist.github.io/Reticulum/manual/using.html#included-utility-programs) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
|
|
|
- The system daemon `rnsd` for running Reticulum as an always-available service
|
|
- An interface status utility called `rnstatus`, that displays information about interfaces
|
|
- The path lookup and and management tool `rnpath` letting you view and modify path tables
|
|
- A diagnostics tool called `rnprobe` for checking connectivity to destinations
|
|
- A simple file transfer program called `rncp` making easy to copy files to remote systems
|
|
- The remote command execution program `rnx` that let's you run commands and programs and retrieve output from remote systems
|
|
|
|
All tools, including `rnx` and `rncp`, work reliably and well even over very low-bandwidth links like LoRa or Packet Radio.
|
|
|
|
## 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. I will gratefully accept pull requests for custom interfaces if they are generally useful.
|
|
|
|
Currently, the following interfaces are supported:
|
|
|
|
- Any ethernet device
|
|
- LoRa using [RNode](https://unsigned.io/projects/rnode/)
|
|
- Packet Radio TNCs (with or without AX.25)
|
|
- KISS-compatible hardware and software modems
|
|
- Any device with a serial port
|
|
- TCP over IP networks
|
|
- UDP over IP networks
|
|
- External programs via stdio or pipes
|
|
- Custom hardware via stdio or pipes
|
|
|
|
## Development Roadmap
|
|
- Version 0.3.8
|
|
- Improving [the manual](https://markqvist.github.io/Reticulum/manual/) with sections specifically for beginners
|
|
- Utilities for managing identities, signing and encryption
|
|
- Support for radio and modem interfaces on Android
|
|
- User friendly interface configuration tool
|
|
- Easy way to share interface configurations, see [#19](https://github.com/markqvist/Reticulum/discussions/19)
|
|
- More interface types for even broader compatibility
|
|
- Plain ESP32 devices (ESP-Now, WiFi, Bluetooth, etc.)
|
|
- More LoRa transceivers
|
|
- AT-compatible modems
|
|
- IR Transceivers
|
|
- AWDL / OWL
|
|
- HF Modems
|
|
- CAN-bus
|
|
- ZeroMQ
|
|
- MQTT
|
|
- IrDA / IrPHY
|
|
- SPI
|
|
- i²c
|
|
- Version 0.3.9
|
|
- A portable cryptography core, supporting multiple backends
|
|
- Performance optimisations
|
|
- Memory optimisations
|
|
- Planned, but not yet scheduled
|
|
- Globally routable multicast
|
|
- Bindings for other programming languages
|
|
- A portable Reticulum implementation in C, see [#21](https://github.com/markqvist/Reticulum/discussions/21)
|
|
|
|
|
|
|
|
## Dependencies:
|
|
The installation of the default `rns` package requires the dependencies listed below. Almost all systems and distributions have readily available packages for the above dependencies, and when the `rns` package is installed with `pip`, the dependencies will automatically be downloaded and installed as well.
|
|
|
|
- [PyCA/cryptography](https://github.com/pyca/cryptography)
|
|
- [netifaces](https://github.com/al45tair/netifaces)
|
|
- [pyserial](https://github.com/pyserial/pyserial)
|
|
|
|
On more unusual systems, and in some rare cases, it might not be possible to install or even compile one or more of the above modules. In such situations, you can use the `rnspure` package instead, which require no external dependencies for installation. Please note that the contents of the `rns` and `rnspure` packages are *identical*. The only difference is that the `rnspure` package lists no dependencies required for installation.
|
|
|
|
No matter how Reticulum is installed and started, it will load external dependencies only if they are *needed* and *available*. If for example you want to use Reticulum on a system that cannot support [pyserial](https://github.com/pyserial/pyserial), it is perfectly possible to do so using the `rnspure` package, but Reticulum will not be able to use serial-based interfaces. All other available modules will still be loaded when needed.
|
|
|
|
**Please Note!** If you use the `rnspure` package to run Reticulum on systems that do not support [PyCA/cryptography](https://github.com/pyca/cryptography), it is important that you read and understand the [Cryptographic Primitives](#cryptographic-primitives) section of this document.
|
|
|
|
## Public Testnet
|
|
If you just want to get started experimenting without building any physical networks, you are welcome to join the Unsigned.io RNS Testnet. The testnet is just that, an informal network for testing and experimenting. It will be up most of the time, and anyone can join, but it also means that there's no guarantees for service availability.
|
|
|
|
The testnet runs the very latest version of Reticulum (often even a short while before it is publicly released). Sometimes experimental versions of Reticulum might be deployed to nodes on the testnet, which means strange behaviour might occur. If none of that scares you, you can join the testnet via eihter TCP or I2P. Just add one of the following interfaces to your Reticulum configuration file:
|
|
|
|
```
|
|
# For connecting over TCP/IP:
|
|
|
|
[[RNS Testnet Frankfurt]]
|
|
type = TCPClientInterface
|
|
interface_enabled = yes
|
|
outgoing = True
|
|
target_host = frankfurt.rns.unsigned.io
|
|
target_port = 4965
|
|
|
|
|
|
# For connecting over I2P:
|
|
|
|
[[RNS Testnet I2P Node A]]
|
|
type = I2PInterface
|
|
interface_enabled = yes
|
|
peers = ykzlw5ujbaqc2xkec4cpvgyxj257wcrmmgkuxqmqcur7cq3w3lha.b32.i2p
|
|
```
|
|
|
|
The testnet also contains a number of [Nomad Network](https://github.com/markqvist/nomadnet) nodes, and LXMF propagation nodes.
|
|
|
|
## 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.
|
|
|
|
## Cryptographic Primitives
|
|
Reticulum has been designed to use a simple suite of efficient, strong and modern cryptographic primitives, with widely available implementations that can be used both on general-purpose CPUs and on microcontrollers. The necessary primitives are:
|
|
|
|
- Ed25519 for signatures
|
|
- X22519 for ECDH key exchanges
|
|
- HKDF for key derivation
|
|
- Fernet for encrypted tokens
|
|
- AES-128 in CBC mode
|
|
- HMAC for message authentication
|
|
- SHA-256
|
|
- SHA-512
|
|
|
|
In the default installation configuration, Reticulum primarily uses cryptograhic primitives from [OpenSSL](https://www.openssl.org/) (via the [PyCA/cryptography](https://github.com/pyca/cryptography) package). The hashing functions `SHA-256` and `SHA-512` are provided by the standard Python `hashlib`, and `Fernet` is provided by [an internal implementation](blob/master/RNS/Cryptography/Fernet.py). All other primitives are provided by [OpenSSL](https://www.openssl.org/) & [PyCA](https://github.com/pyca/cryptography).
|
|
|
|
Reticulum also includes a complete implementation of all necessary primitives in pure Python. If [OpenSSL](https://www.openssl.org/) & [PyCA](https://github.com/pyca/cryptography) are *not* available on the system when Reticulum is started, Reticulum will instead use the internal pure-python primitives. A trivial consequence of this is performance, with the OpenSSL backend being *much* faster. The most important consequence however, is the potential loss of security by using primitives that has not seen the same amount of scrutiny, testing and review as those from OpenSSL. If you still want to use the internal pure-python primitives, it is highly advisable that you have a good understanding of which risks this pose, and make a decision on whether those are acceptable in your usage scenario.
|
|
|
|
## 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 or security breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.
|