diff --git a/README.md b/README.md index 6720ed7..ad902c0 100755 --- a/README.md +++ b/README.md @@ -3,15 +3,34 @@ Reticulum Network Stack β

-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. +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, inter-connectable 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*. +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, +inter-connectable 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. +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. +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. +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/). @@ -44,24 +63,44 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects - Low cost of keeping links open at only 0.44 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. +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, WiFi and Ethernet devices, free-space optical links, and similar systems are all examples of the types of physical devices Reticulum can use. +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, +WiFi and Ethernet devices, free-space optical links, and similar systems are +all examples of the types of physical devices Reticulum can use. -An open-source LoRa-based interface called [RNode](https://markqvist.github.io/Reticulum/manual/hardware.html#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. +An open-source LoRa-based interface called +[RNode](https://markqvist.github.io/Reticulum/manual/hardware.html#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, your local WiFi network or the Internet, 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, using any available mixture of available infrastructure. +Reticulum can also be encapsulated over existing IP networks, so there's +nothing stopping you from using it over wired Ethernet, your local WiFi network +or the Internet, 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, using any available mixture of +available infrastructure. -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. +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/). +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: @@ -69,31 +108,47 @@ To simply install Reticulum and related utilities on your system, the easiest wa 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). +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 that might be locally reachable. The default config file contains a few examples, and references for creating a more complex configuration. +When first started, Reticulum will create a default configuration file, +providing basic connectivity to other Reticulum peers that might be locally +reachable. The default config file contains a few examples, and references for +creating a more complex configuration. -For more detailed examples on how to expand communication over many mediums such as packet radio or LoRa, serial ports, or over fast IP links and the Internet using the UDP and TCP interfaces, 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/). +For more detailed examples on how to expand communication over many mediums such +as packet radio or LoRa, serial ports, or over fast IP links and the Internet using +the UDP and TCP interfaces, 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/). +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 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 it easy to copy files to remote systems -- The remote command execution program `rnx` let's you run commands and programs and retrieve output from remote systems +- The remote command execution program `rnx` 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. +All tools, including `rnx` and `rncp`, work reliably and well even over very +low-bandwidth links like LoRa or Packet Radio. ## 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. +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 +- 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 @@ -104,12 +159,21 @@ Currently, the following interfaces are supported: - Custom hardware via stdio or pipes ## Performance -Reticulum targets a *very* wide usable performance envelope, but prioritises functionality and performance over low-bandwidth mediums. The goal is to provide a dynamic performance envelope from 250 bits per second, to 1 gigabit per second on normal hardware. +Reticulum targets a *very* wide usable performance envelope, but prioritises +functionality and performance over low-bandwidth mediums. The goal is to +provide a dynamic performance envelope from 250 bits per second, to 1 gigabit +per second on normal hardware. -Currently, the usable performance envelope is approximately 500 bits per second to 20 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised at this point in time. +Currently, the usable performance envelope is approximately 500 bits per second +to 20 megabits per second, with physical mediums faster than that not being +saturated. Performance beyond the current level is intended for future +upgrades, but not highly prioritised at this point in time. ## 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. +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. ## Development Roadmap - Version 0.4.0 @@ -141,22 +205,48 @@ Reticulum should currently be considered beta software. All core protocol featur - Tor ## Dependencies -The installation of the default `rns` package requires the dependencies listed below. Almost all systems and distributions have readily available packages for these dependencies, and when the `rns` package is installed with `pip`, they will be downloaded and installed as well. +The installation of the default `rns` package requires the dependencies listed +below. Almost all systems and distributions have readily available packages for +these dependencies, and when the `rns` package is installed with `pip`, they +will 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. +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. +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. +**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. +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 either TCP or I2P. Just add one of the following interfaces to your Reticulum configuration file: +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 either TCP or +I2P. Just add one of the following interfaces to your Reticulum configuration +file: ``` # TCP/IP interface to the Dublin Hub @@ -205,10 +295,13 @@ You can help support the continued development of open, free and private communi ``` - 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. +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 uses 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: +Reticulum uses 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 @@ -220,7 +313,13 @@ Reticulum uses a simple suite of efficient, strong and modern cryptographic prim - SHA-256 - SHA-512 -In the default installation configuration, the `X25519`, `Ed25519` and `AES-128-CBC` primitives are provided by [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](https://docs.python.org/3/library/hashlib.html). The `HKDF`, `HMAC`, `Fernet` primitives, and the `PKCS7` padding function are always provided by the following internal implementations: +In the default installation configuration, the `X25519`, `Ed25519` and +`AES-128-CBC` primitives are provided by [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](https://docs.python.org/3/library/hashlib.html). The `HKDF`, +`HMAC`, `Fernet` primitives, and the `PKCS7` padding function are always +provided by the following internal implementations: - [HKDF.py](RNS/Cryptography/HKDF.py) - [HMAC.py](RNS/Cryptography/HMAC.py) @@ -228,16 +327,33 @@ In the default installation configuration, the `X25519`, `Ed25519` and `AES-128- - [PKCS7.py](RNS/Cryptography/PKCS7.py) -Reticulum also includes a complete implementation of all necessary primitives in pure Python. If OpenSSL & PyCA 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. +Reticulum also includes a complete implementation of all necessary primitives +in pure Python. If OpenSSL & PyCA 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 want to use the internal pure-python primitives, it is **highly advisable** that you have a good understanding of the risks that this pose, and make an informed decision on whether those risks are acceptable to you. +If you want to use the internal pure-python primitives, it is **highly +advisable** that you have a good understanding of the risks that this pose, and +make an informed decision on whether those risks are acceptable to you. -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. +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. ## Acknowledgements & Credits -Reticulum can only exist because of the mountain of Open Source work it was built on top of, the contributions of everyone involved, and everyone that has supported the project through the years. To everyone who has helped, thank you so much. +Reticulum can only exist because of the mountain of Open Source work it was +built on top of, the contributions of everyone involved, and everyone that has +supported the project through the years. To everyone who has helped, thank you +so much. -A number of other modules and projects are either part of, or used by Reticulum. Sincere thanks to the authors and contributors of the following projects: +A number of other modules and projects are either part of, or used by +Reticulum. Sincere thanks to the authors and contributors of the following +projects: - [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD License* - [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner), *MIT License* diff --git a/docs/source/gettingstartedfast.rst b/docs/source/gettingstartedfast.rst index 99390f2..b13e02b 100644 --- a/docs/source/gettingstartedfast.rst +++ b/docs/source/gettingstartedfast.rst @@ -16,7 +16,7 @@ over even extremely low-bandwidth Reticulum networks. These programs will let you get a feel for how Reticulum works. They have been designed to run well over networks based on LoRa or packet radio, but can also be used completely -over local WiFi, wired ethernet, the Internet, or any combination. +over local WiFi, wired Ethernet, the Internet, or any combination. As such, it is easy to get started experimenting, without having to set up any radio transceivers or infrastructure just to try it out. Launching the programs on separate @@ -91,7 +91,7 @@ or use the interactive ``rnsconfig`` utility. When Reticulum is started for the first time, it will create a default configuration file, with one active interface. This default interface uses -your existing ethernet and WiFi networks (if any), and only allows you to +your existing Ethernet and WiFi networks (if any), and only allows you to communicate with other Reticulum peers within your local broadcast domains. To communicate further, you will have to add one or more interfaces. The default @@ -106,7 +106,7 @@ Once Reticulum knows which interfaces it should use, it will automatically discover topography and configure transport of data to any destinations it knows about. -In situations where you already have an established WiFi or ethernet network, and +In situations where you already have an established WiFi or Ethernet network, and many devices that want to utilise the same external Reticulum network paths (for example over LoRa), it will often be sufficient to let one system act as a Reticulum gateway, by adding any external interfaces to the configuration of this system, and then enabling transport on it. Any @@ -131,7 +131,7 @@ TCP connections reveal the IP address of both your instance and the server to an inspect the connection. Someone could use this information to determine your location or identity. Adversaries inspecting your packets may be able to record packet metadata like time of transmission and packet size. Even though Reticulum encrypts traffic, TCP does not, so an adversary may be able to use -packet inspection to learn that a system is running Reticulum, and what other IP adresses connect to it. +packet inspection to learn that a system is running Reticulum, and what other IP addresses connect to it. Hosting a publicly reachable instance over TCP also requires a publicly reachable IP address, which most Internet connections don't offer anymore. @@ -145,9 +145,9 @@ will also relay other I2P user's encrypted packets, which will use extra bandwidth and compute power, but also makes timing attacks and other forms of deep-packet-inspection much more difficult. -I2P also allows users to host globally available Reticulum instances from non-public IPs and behind firewalls and NAT. +I2P also allows users to host globally available Reticulum instances from non-public IP's and behind firewalls and NAT. -In general it is recommended to use an I2P node if you want to host a publically accessible +In general it is recommended to use an I2P node if you want to host a publicly accessible instance, while preserving anonymity. If you care more about performance, and a slightly easier setup, use TCP. @@ -367,4 +367,4 @@ 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 `_, it is important that you read and understand the :ref:`Cryptographic Primitives ` -section of this manual. \ No newline at end of file +section of this manual. diff --git a/docs/source/hardware.rst b/docs/source/hardware.rst index e86c47e..f751d33 100644 --- a/docs/source/hardware.rst +++ b/docs/source/hardware.rst @@ -52,7 +52,7 @@ the discussion to RNodes using *LoRa* modulation in common ISM bands. **Avoid Confusion!** RNodes can use LoRa as a *physical-layer modulation*, but it does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly used for centrally controlled IoT devices. RNodes use *raw LoRa modulation*, without -any additional protocol overhead. All high-level protocol funcionality is handled +any additional protocol overhead. All high-level protocol functionality is handled directly by Reticulum. .. _rnode-creating: @@ -205,8 +205,8 @@ get started with producing RNodes. WiFi-based Hardware =================== -It is possible to use all kinds of both short- and long-range Wifi-based hardware -with Reticulum. Any kind of hardware that fully supports bridged ethernet over the +It is possible to use all kinds of both short- and long-range WiFi-based hardware +with Reticulum. Any kind of hardware that fully supports bridged Ethernet over the WiFi interface will work with the :ref:`AutoInterface` in Reticulum. Most devices will behave like this by default, or allow it via configuration options. @@ -242,4 +242,4 @@ It is useful to combine different link and hardware types when designing and building a network. One useful design pattern is to employ high-capacity point-to-point links based on WiFi or millimeter-wave radios (with high-gain directional antennas) for the network backbone, and using LoRa-based RNodes for covering large areas with -connectivity for client devices. \ No newline at end of file +connectivity for client devices. diff --git a/docs/source/interfaces.rst b/docs/source/interfaces.rst index c15aed4..3c2d12a 100644 --- a/docs/source/interfaces.rst +++ b/docs/source/interfaces.rst @@ -98,13 +98,13 @@ and persistent I2P address that your Reticulum instance can be reached at. To use the I2P interface, you must have an I2P router running -on your system. The easiest way to acheive this is to download and +on your system. The easiest way to achieve this is to download and install the `latest release `_ of the ``i2pd`` package. For more details about I2P, see the `geti2p.net website `_. When an I2P router is running on your system, you can simply add -an I2P interface to reticulum: +an I2P interface to Reticulum: .. code:: @@ -270,7 +270,7 @@ with all other peers on a local area network. *Please Note!* Using broadcast UDP traffic has performance implications, especially on WiFi. If your goal is simply to enable easy communication -with all peers in your local ethernet broadcast domain, the +with all peers in your local Ethernet broadcast domain, the :ref:`Auto Interface` performs better, and is even easier to use. @@ -404,7 +404,7 @@ directly over a wire-pair, or for using devices such as data radios and lasers. Pipe Interface ============== -Using this interface, reticulum can use any program as an interface via `stdin` and +Using this interface, Reticulum can use any program as an interface via `stdin` and `stdout`. This can be used to easily create virtual interfaces, or to interface with custom hardware or other systems. @@ -421,7 +421,7 @@ custom hardware or other systems. respawn_delay = 5 Reticulum will write all packets to `stdin` of the ``command`` option, and will -continously read and scan its `stdout` for Reticulum packets. If ``EOF`` is reached, +continuously read and scan its `stdout` for Reticulum packets. If ``EOF`` is reached, Reticulum will try to respawn the program after waiting for ``respawn_interval`` seconds. .. _interfaces-kiss: diff --git a/docs/source/networks.rst b/docs/source/networks.rst index 3919918..f818771 100644 --- a/docs/source/networks.rst +++ b/docs/source/networks.rst @@ -9,7 +9,7 @@ Reticulum, which can often be easier than using traditional stacks, since you don't have to worry about coordinating addresses, subnets and routing for an entire network that you might not know how will evolve in the future. With Reticulum, you can simply add more segments to your network when it becomes -necesarry, and Reticulum will handle the convergence of the entire network +necessary, and Reticulum will handle the convergence of the entire network automatically. Concepts & Overview @@ -18,13 +18,13 @@ Concepts & Overview There are important points that need to be kept in mind when building networks with Reticulum: - * | In a Reticulum network, any node can autonomously generate as many adresses + * | In a Reticulum network, any node can autonomously generate as many addresses (called *destinations* in Reticulum terminology) as it needs, which become globally reachable to the rest of the network. There is no central point of - control over the adress space. + control over the address space. * | Reticulum was designed to handle both very small, and very large networks. - While the adress space can support billions of endpoints, Reticulum is + While the address space can support billions of endpoints, Reticulum is also very useful when just a few devices needs to communicate. * | Low-bandwidth networks, like LoRa and packet radio, can interoperate and @@ -113,8 +113,8 @@ WiFi based radios for interconnecting the sites. At each site, a Raspberry Pi is installed to function as a gateway. A LoRa radio is connected to the Pi with a USB cable, and the WiFi radio is connected to the -ethernet port of the Pi. At site B, two WiFi radios are needed to be able to reach -both site A and site C, so an extra ethernet adapter is connected to the Pi in +Ethernet port of the Pi. At site B, two WiFi radios are needed to be able to reach +both site A and site C, so an extra Ethernet adapter is connected to the Pi in this location. Once the hardware has been installed, Reticulum is installed on all the Pis, and at diff --git a/docs/source/support.rst b/docs/source/support.rst index d64d277..a8e0470 100644 --- a/docs/source/support.rst +++ b/docs/source/support.rst @@ -32,11 +32,11 @@ Provide Feedback ================ All feedback on the usage, functioning and potential dysfunctioning of any and all components of the system is very valuable to the continued development and -improvement of Reticulum. Absolutely no automated analytics, telemetly, error +improvement of Reticulum. Absolutely no automated analytics, telemetry, error reporting or statistics is collected and reported by Reticulum under any circumstances, so we rely on old-fashioned human feedback. Contribute Code =============== Join us on `the GitHub repository `_ to -report issues, suggest functionality and contribute code to Reticulum. \ No newline at end of file +report issues, suggest functionality and contribute code to Reticulum. diff --git a/docs/source/understanding.rst b/docs/source/understanding.rst index 942bb49..50c0081 100644 --- a/docs/source/understanding.rst +++ b/docs/source/understanding.rst @@ -70,7 +70,7 @@ guide the design of Reticulum: * **Hardware layer agnosticism** Reticulum must be fully hardware agnostic, and shall be useable over a wide range of physical networking layers, such as data radios, serial lines, modems, handheld transceivers, - wired ethernet, wifi, or anything else that can carry a digital data stream. Hardware made for + wired Ethernet, WiFi, or anything else that can carry a digital data stream. Hardware made for dedicated Reticulum use shall be as cheap as possible and use off-the-shelf components, so it can be easily modified and replicated by anyone interested in doing so. * **Very low bandwidth requirements** @@ -109,7 +109,7 @@ Introduction & Basic Functionality Reticulum is a networking stack suited for high-latency, low-bandwidth links. Reticulum is at it’s core a *message oriented* system. It is suited for both local point-to-point or point-to-multipoint -scenarios where alle nodes are within range of each other, as well as scenarios where packets need +scenarios where all nodes are within range of each other, as well as scenarios where packets need to be transported over multiple hops in a complex network to reach the recipient. Reticulum does away with the idea of addresses and ports known from IP, TCP and UDP. Instead @@ -121,14 +121,14 @@ All destinations in Reticulum are _represented_ as a 16 byte hash. This hash is SHA-256 hash of identifying characteristics of the destination. To users, the destination addresses will be displayed as 16 hexadecimal bytes, like this example: ``<13425ec15b621c1d928589718000d814>``. -The truncation size of 16 bytes (128 bits) for destinations has been choosen as a reasonable tradeoff +The truncation size of 16 bytes (128 bits) for destinations has been chosen as a reasonable trade-off between address space -and packet overhead. The address space accomodated by this size can support many billions of +and packet overhead. The address space accommodated by this size can support many billions of simultaneously active devices on the same network, while keeping packet overhead low, which is essential on low-bandwidth networks. In the very unlikely case that this address space nears congestion, a one-line code change can upgrade the Reticulum address space all the way up to 256 bits, ensuring the Reticulum address space could potentially support galactic-scale networks. -This is obviusly complete and ridiculous over-allocation, and as such, the current 128 bits should +This is obviously complete and ridiculous over-allocation, and as such, the current 128 bits should be sufficient, even far into the future. By default Reticulum encrypts all data using elliptic curve cryptography. Any packet sent to a @@ -163,7 +163,7 @@ destinations. Reticulum uses three different basic destination types, and one sp A *plain* destination type is unencrypted, and suited for traffic that should be broadcast to a number of users, or should be readable by anyone. Traffic to a *plain* destination is not encrypted. Generally, *plain* destinations can be used for broadcast information intended to be public. - Plain destinations are only reachable directly, and packets adressed to plain destinations are + Plain destinations are only reachable directly, and packets addressed to plain destinations are never transported over multiple hops in the network. To be transportable over multiple hops in Reticulum, information *must* be encrypted, since Reticulum uses the per-packet encryption to verify routing paths and keep them alive. @@ -219,10 +219,10 @@ packet. In actual use of *single* destination naming, it is advisable not to use any uniquely identifying features in aspect naming. Aspect names should be general terms describing what kind of destination -is represented. The uniquely identifying aspect is always acheived by the appending the public key, -which expands the destination into a uniquely identifyable one. Reticulum does this automatically. +is represented. The uniquely identifying aspect is always achieved by the appending the public key, +which expands the destination into a uniquely identifiable one. Reticulum does this automatically. -Any destination on a Reticulum network can be addressed and reached simply by knowning its +Any destination on a Reticulum network can be addressed and reached simply by knowing its destination hash (and public key, but if the public key is not known, it can be requested from the network simply by knowing the destination hash). The use of app names and aspects makes it easy to structure Reticulum programs and makes it possible to filter what information and data your program @@ -349,7 +349,7 @@ Node Types ---------- Currently, Reticulum distinguishes between two types of network nodes. All nodes on a Reticulum network -are *Reticulum Instances*, and some are alo *Transport Nodes*. If a system running Reticulum is fixed in +are *Reticulum Instances*, and some are also *Transport Nodes*. If a system running Reticulum is fixed in one place, and is intended to be kept available most of the time, it is a good contender to be a *Transport Node*. Any Reticulum Instance can become a Transport Node by enabling it in the configuration. @@ -485,13 +485,18 @@ For exchanges of larger amounts of data, or when longer sessions of bidirectiona the destination using a Reticulum Identity. This authentication is happening inside the encrypted link, and is only revealed to the verified destination, and no intermediaries. -In a moment, we will discuss the details of how this methodology is implemented, but let’s first -recap what purposes this methodology serves. We first ensure that the node answering our request -is actually the one we want to communicate with, and not a malicious actor pretending to be so. -At the same time we establish an efficient encrypted channel. The setup of this is relatively cheap in -terms of bandwidth, so it can be used just for a short exchange, and then recreated as needed, which will -also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is -more suitable to the application. The procedure also inserts the *link id* , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this *link id*. +In a moment, we will discuss the details of how this methodology is +implemented, but let’s first recap what purposes this methodology serves. We +first ensure that the node answering our request is actually the one we want to +communicate with, and not a malicious actor pretending to be so. At the same +time we establish an efficient encrypted channel. The setup of this is +relatively cheap in terms of bandwidth, so it can be used just for a short +exchange, and then recreated as needed, which will also rotate encryption keys. +The link can also be kept alive for longer periods of time, if this is more +suitable to the application. The procedure also inserts the *link id* , a hash +calculated from the link request packet, into the memory of forwarding nodes, +which means that the communicating nodes can thereafter reach each other simply +by referring to this *link id*. The combined bandwidth cost of setting up a link is 3 packets totalling 265 bytes (more info in the :ref:`Binary Packet Format` section). The amount of bandwidth used on keeping @@ -544,7 +549,7 @@ an arbitrary number of hops, where information will be exchanged between two nod * | By verifying this *link proof* packet, all nodes that originally transported the *link request* packet to the destination from the originator can now verify that the intended destination received the request and accepted it, and that the path they chose for forwarding the request was valid. - In sucessfully carrying out this verification, the transporting nodes marks the link as active. + In successfully carrying out this verification, the transporting nodes marks the link as active. An abstract bi-directional communication channel has now been established along a path in the network. * | When the source receives the *proof* , it will know unequivocally that a verified path has been @@ -887,4 +892,4 @@ testing and review as those from OpenSSL. If you want to use the internal pure-python primitives, it is **highly advisable** that you have a good understanding of the risks that this pose, and make an informed decision on whether -those risks are acceptable to you. \ No newline at end of file +those risks are acceptable to you. diff --git a/docs/source/whatis.rst b/docs/source/whatis.rst index f726a4f..7941ba1 100644 --- a/docs/source/whatis.rst +++ b/docs/source/whatis.rst @@ -2,23 +2,38 @@ What is Reticulum? ****************** -Reticulum is a cryptography-based networking stack for building wide-area networks with readily available hardware, that can continue to operate even with extremely low bandwidth and very high latency. +Reticulum is a cryptography-based networking stack for building wide-area +networks with readily available hardware, that can continue to operate even +with extremely low bandwidth and very high latency. -Reticulum allows you to build wide-area networks with off-the-shelf tools, and offers end-to-end encryption, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable packet acknowledgements and more. +Reticulum allows you to build wide-area networks with off-the-shelf tools, and +offers end-to-end encryption, 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 utilise 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. Reticulum is built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks. +Reticulum is a complete networking stack, and does not need IP or higher +layers, although it is easy to utilise 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. Reticulum is 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. Reticulum runs well even on small single-board computers like the Pi Zero. +No kernel modules or drivers are required. Reticulum runs completely in +userland, and can run on practically any system that runs Python 3. Reticulum +runs well even on small single-board computers like the Pi Zero. 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 stable at the moment, but could change if absolutely warranted. +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 stable at the moment, but could change if absolutely warranted. What does Reticulum Offer? ========================== -* Coordination-less globally unique adressing and identification +* Coordination-less globally unique addressing and identification * Fully self-configuring multi-hop routing @@ -26,7 +41,7 @@ What does Reticulum Offer? * Asymmetric encryption based on X25519, and Ed25519 signatures as a basis for all communication -* Forward Secrecy by using ephemereal Elliptic Curve Diffie-Hellman keys on Curve25519 +* Forward Secrecy by using ephemeral Elliptic Curve Diffie-Hellman keys on Curve25519 * Reticulum uses the `Fernet `_ specification for on-the-wire / over-the-air encryption @@ -77,7 +92,7 @@ Reticulum. It is possible to build it yourself, to transform a common LoRa development board into one, or it can be purchased as a complete transceiver. 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 +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. @@ -92,15 +107,15 @@ Interface Types and Devices =========================== Reticulum implements a range of generalised interface types that covers the communications hardware that Reticulum can run over. If your hardware is not supported, it's relatively simple to implement an interface class. Currently, Reticulum can use the following devices and communication mediums: -* Any ethernet device +* Any Ethernet device * WiFi devices - * Wired ethernet devices + * Wired Ethernet devices * Fibre-optic transceivers - * Data radios with ethernet ports + * Data radios with Ethernet ports * LoRa using `RNode `_ @@ -135,4 +150,9 @@ For a full list and more details, see the :ref:`Supported Interfaces