##########################################################
@@ -806,7 +983,7 @@ the Packet interface.
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py.
-Link
+Link
The Link example explores establishing an encrypted link to a remote
destination, and passing traffic back and forth over the link.
##########################################################
@@ -1105,7 +1282,7 @@ destination, and passing traffic back and forth over the link.
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Link.py.
-Identification
+Identification
The Identify example explores identifying an intiator of a link, once
the link has been established.
##########################################################
@@ -1427,7 +1604,7 @@ the link has been established.
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Identify.py.
-Requests & Responses
+Requests & Responses
The Request example explores sendig requests and receiving responses.
##########################################################
# This RNS example demonstrates how to set perform #
@@ -1721,7 +1898,7 @@ the link has been established.
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Request.py.
-Filetransfer
+Filetransfer
The Filetransfer example implements a basic file-server program that
allow clients to connect and download files. The program uses the Resource
interface to efficiently pass files of any size over a Reticulum Link.
@@ -2336,16 +2513,62 @@ interface to efficiently pass files of any size over a Reticulum
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/genindex.html b/docs/manual/genindex.html
index 9747273..08f3cc2 100644
--- a/docs/manual/genindex.html
+++ b/docs/manual/genindex.html
@@ -1,454 +1,660 @@
+
+
+
+
+
-
-
-
-
-
-
-
Index — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
Index - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
Index
-
-
-
A
- |
C
- |
D
- |
E
- |
F
- |
G
- |
H
- |
I
- |
K
- |
L
- |
M
- |
N
- |
P
- |
R
- |
S
- |
T
- |
V
-
-
-
A
-
-
-
C
-
-
-
D
-
-
-
E
-
-
-
F
-
-
-
G
-
-
-
H
-
-
-
I
-
-
-
K
-
-
-
L
-
-
-
M
-
-
-
N
-
-
-
P
-
-
-
R
-
-
-
S
-
-
-
T
-
-
-
V
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/gettingstartedfast.html b/docs/manual/gettingstartedfast.html
index 07b78b6..a026b01 100644
--- a/docs/manual/gettingstartedfast.html
+++ b/docs/manual/gettingstartedfast.html
@@ -1,56 +1,233 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
Getting Started Fast — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
+
Getting Started Fast - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Getting Started Fast
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Getting Started Fast
The best way to get started with the Reticulum Network Stack depends on what
you want to do. This guide will outline sensible starting paths for different
scenarios.
-Try Using a Reticulum-based Program
+Try Using a Reticulum-based Program
If you simply want to try using a program built with Reticulum, a few different
programs exist that allow basic communication and a range of other useful functions
over even extremely low-bandwidth Reticulum networks.
@@ -62,7 +239,7 @@ transceivers or infrastructure just to try it out. Launching the programs on sep
devices connected to the same WiFi network is enough to get started, and physical
radio interfaces can then be added later.
-Nomad Network
+Nomad Network
The terminal-based program Nomad Network
provides a complete encrypted communications suite built with Reticulum. It features
encrypted messaging (both direct and delayed-delivery for offline users), file sharing,
@@ -86,7 +263,7 @@ available. If you get a “command not found” error or similar when running th
program, reboot your system and try again.
-Sideband
+Sideband
If you would rather use a program with a graphical user interface, you can take
a look at Sideband, which is available for Android,
Linux and macOS.
@@ -96,7 +273,7 @@ communication features, and interoperates with Nomad Network, or any other LXMF
-Using the Included Utilities
+Using the Included Utilities
Reticulum comes with a range of included utilities that make it easier to
manage your network, check connectivity and make Reticulum available to other
programs on your system.
@@ -107,7 +284,7 @@ network status and connectivity.
Using Reticulum on Your System chapter of this manual.
-Creating a Network With Reticulum
+Creating a Network With Reticulum
To create a network, you will need to specify one or more interfaces for
Reticulum to use. This is done in the Reticulum configuration file, which by
default is located at ~/.config/reticulum/config. You can edit this file by hand,
@@ -136,7 +313,7 @@ you want more information, you can read the Interfaces chapters of this manual.
-Connecting Reticulum Instances Over the Internet
+Connecting Reticulum Instances Over the Internet
Reticulum currently offers two interfaces suitable for connecting instances over the Internet: TCP
and I2P. Each interface offers a different set of features, and Reticulum
users should carefully choose the interface which best suites their needs.
@@ -164,7 +341,7 @@ instance, while preserving anonymity. If you care more about performance, and a
easier setup, use TCP.
-Connect to the Public Testnet
+Connect to the Public Testnet
An experimental public testnet has been made accessible over both I2P and TCP. You can join it
by adding one of the following interfaces to your .reticulum/config file:
# TCP/IP interface to the Dublin hub
@@ -194,7 +371,7 @@ topography, usage or what types of instances connect. It will also occasionally
to test various failure scenarios, and there are no availability or service guarantees.
-Adding Radio Interfaces
+Adding Radio Interfaces
Once you have Reticulum installed and working, you can add radio interfaces with
any compatible hardware you have available. Reticulum supports a wide range of radio
hardware, and if you already have any available, it is very likely that it will
@@ -220,7 +397,7 @@ you are welcome to head over to the
-Develop a Program with Reticulum
+Develop a Program with Reticulum
If you want to develop programs that use Reticulum, the easiest way to get
started is to install the latest release of Reticulum via pip:
pip3 install rns
@@ -236,7 +413,7 @@ likely be to look at some API Reference.
-Participate in Reticulum Development
+Participate in Reticulum Development
If you want to participate in the development of Reticulum and associated
utilities, you’ll want to get the latest source from GitHub. In that case,
don’t use pip, but try this recipe:
@@ -276,7 +453,7 @@ don’t use pip, but try this recipe:
Understanding Reticulum chapter.
-Reticulum on ARM64
+Reticulum on ARM64
On some architectures, including ARM64, not all dependencies have precompiled
binaries. On such systems, you will need to install python3-dev before
installing Reticulum or programs that depend on Reticulum.
@@ -290,7 +467,7 @@ installing Reticulum or programs that depend on Reticulum.
Reticulum on Android
+Reticulum on Android
Reticulum can be used on Android in different ways. The easiest way to get
started is using an app like Sideband.
For more control and features, you can use Reticulum and related programs via
@@ -332,7 +509,7 @@ Android APKs. A detailed tutorial and example source code will be included
here at a later point.
-Pure-Python Reticulum
+Pure-Python Reticulum
In some rare cases, and on more obscure system types, it is not possible to
install one or more dependencies
On more unusual systems, and in some rare cases, it might not be possible to
@@ -354,16 +531,62 @@ section of this manual.
-
-
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/hardware.html b/docs/manual/hardware.html
index e213462..b1464b7 100644
--- a/docs/manual/hardware.html
+++ b/docs/manual/hardware.html
@@ -1,51 +1,228 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
Communications Hardware — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
+
Communications Hardware - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Communications Hardware
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Communications Hardware
One of the truly valuable aspects of Reticulum is the ability to use it over
almost any conceivable kind of communications medium. The interface types
available for configuration in Reticulum are flexible enough to cover the use
@@ -68,7 +245,7 @@ and effort. Two fundamental devices categories will be covered, RNodes
networks, knowing how to employ just these two will make it possible to build
a wide range of useful networks with little effort.
-RNode
+RNode
Reliable and general-purpose long-range digital radio transceiver systems are
commonly either very expensive, difficult to set up and operate, hard to source,
power-hungry, or all of the above at the same time. In an attempt to alleviate
@@ -87,7 +264,7 @@ used for centrally controlled IoT devices. RNodes use raw LoRa modulation
-Creating RNodes
+Creating RNodes
RNode has been designed as a system that is easy to replicate across time and
space. You can put together a functioning transceiver using commonly available
components, and a few open source software tools. While you can design and build RNodes
@@ -104,11 +281,11 @@ The device can be used with Reticulum by adding an
-Supported Boards
+Supported Boards
To create one or more RNodes, you will need to obtain supported development
boards. The following boards are supported by the auto-installer.
-LilyGO LoRa32 v2.1
+LilyGO LoRa32 v2.1
-LilyGO LoRa32 v2.0
+LilyGO LoRa32 v2.0
-LilyGO T-Beam
+LilyGO T-Beam
-Heltec LoRa32 v2.0
+Heltec LoRa32 v2.0
-Unsigned RNode v2.x
+Unsigned RNode v2.x
-Unsigned RNode v1.x
+Unsigned RNode v1.x
-Installation
+Installation
Once you have obtained compatible boards, you can install the RNode Firmware
using the RNode Configuration Utility.
Make sure that Python3 and pip is installed on your system, and then install
@@ -191,7 +368,7 @@ considered an experimental pre-release. Only use the v2.x firmware line if you w
out the absolutely newest version, and don’t care about stability.
-Usage with Reticulum
+Usage with Reticulum
When the devices have been installed and provisioned, you can use them with Reticulum
by adding the relevant interface section to the configuration
file of Reticulum. For v1.x firmwares, you will have to specify all interface parameters,
@@ -200,13 +377,13 @@ the Connection ID of the RNode, and Reticulum will automatically locate and conn
RNode, using the parameters stored in the RNode itself.
-Suppliers
+Suppliers
Get in touch if you want to have your RNode supplier listed here, or if you want help to
get started with producing RNodes.
-WiFi-based Hardware
+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
WiFi interface will work with the AutoInterface in Reticulum.
@@ -230,7 +407,7 @@ networks. As in all other cases, it is also possible for Reticulum to co-exist w
networks running concurrently on such devices.
-Combining Hardware Types
+Combining Hardware Types
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)
@@ -239,16 +416,62 @@ connectivity for client devices.
-
-
+
+
+
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-Reticulum Network Stack Manual
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Reticulum Network Stack Manual
This manual aims to provide you with all the information you need to
understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself.
+
+
-Indices and Tables
+Indices and Tables
Index
Search Page
-
-
+
+
+
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-Supported Interfaces
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Supported Interfaces
Reticulum supports using many kinds of devices as networking interfaces, and
allows you to mix and match them in any way you choose. The number of distinct
network topologies you can create with Reticulum is more or less endless, but
@@ -57,7 +234,7 @@ and gives example configurations for the respective interface types.
types, have a look at the Building Networks chapter of this
manual.
-Auto Interface
+Auto Interface
The Auto Interface enables communication with other discoverable Reticulum
nodes over autoconfigured IPv6 and UDP. It does not need any functional IP
infrastructure like routers or DHCP servers, but will require at least some
@@ -111,7 +288,7 @@ the discovery scope by setting it to one of
-I2P Interface
+I2P Interface
The I2P interface lets you connect Reticulum instances over the
Invisible Internet Protocol. This can be
especially useful in cases where you want to host a globally reachable
@@ -164,7 +341,7 @@ of flexibility in network setup, while retaining ease of use in simpler
use-cases.
-TCP Server Interface
+TCP Server Interface
The TCP Server interface is suitable for allowing other peers to connect over
the Internet or private IP networks. When a TCP server interface has been
configured, other Reticulum peers can connect to it with a TCP Client interface.
@@ -207,7 +384,7 @@ you must use the i2p_tunneled option:
control, and using I2P routers running on external systems, this option also exists.
-TCP Client Interface
+TCP Client Interface
To connect to a TCP server interface, you would naturally use the TCP client
interface. Many TCP Client interfaces from different peers can connect to the
same TCP Server interface at the same time.
@@ -256,7 +433,7 @@ you must use the i2p_tunneled option:
UDP Interface
+UDP Interface
A UDP interface can be useful for communicating over IP networks, both
private and the internet. It can also allow broadcast communication
over IP networks, so it can provide an easy way to enable connectivity
@@ -311,7 +488,7 @@ easier to use.
RNode LoRa Interface
+RNode LoRa Interface
To use Reticulum over LoRa, the RNode interface
can be used, and offers full control over LoRa parameters.
# Here's an example of how to add a LoRa interface
@@ -362,7 +539,7 @@ can be used, and offers full control over LoRa parameters.
Serial Interface
+Serial Interface
Reticulum can be used over serial ports directly, or over any device with a
serial port, that will transparently pass data. Useful for communicating
directly over a wire-pair, or for using devices such as data radios and lasers.
@@ -383,7 +560,7 @@ directly over a wire-pair, or for using devices such as data radios and lasers.<
Pipe Interface
+Pipe Interface
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.
@@ -403,7 +580,7 @@ continuously read and scan its stdout for Reticulum packets. If respawn_interval seconds.
-KISS Interface
+KISS Interface
With the KISS interface, you can use Reticulum over a variety of packet
radio modems and TNCs, including OpenModem.
KISS interfaces can also be configured to periodically send out beacons
@@ -455,7 +632,7 @@ for station identification purposes.
AX.25 KISS Interface
+AX.25 KISS Interface
If you’re using Reticulum on amateur radio spectrum, you might want to
use the AX.25 KISS interface. This way, Reticulum will automatically
encapsulate it’s traffic in AX.25 and also identify your stations
@@ -511,7 +688,7 @@ beaconing functionality described above.
Common Interface Options
+Common Interface Options
A number of general configuration options are available on most interfaces.
These can be used to control various aspects of interface behaviour.
@@ -607,7 +784,7 @@ option, to set the interface speed in bits per second.
Interface Modes
+Interface Modes
The optional mode setting is available on all interfaces, and allows
selecting the high-level behaviour of the interface from a number of modes.
These modes affect how Reticulum selects paths in the network, how announces
@@ -699,7 +876,7 @@ connecting over the Internet should be set to Announce Propagation Rules section.
-Announce Rate Control
+Announce Rate Control
The built-in announce control mechanisms and the default announce_cap
option described above are sufficient most of the time, but in some cases, especially on fast
interfaces, it may be useful to control the target announce rate. Using the
@@ -748,16 +925,62 @@ that a large span of network types can seamlessly co-exist and intercon
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/networks.html b/docs/manual/networks.html
index 45c41ed..a9f45c0 100644
--- a/docs/manual/networks.html
+++ b/docs/manual/networks.html
@@ -1,51 +1,228 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
Building Networks — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
+
Building Networks - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Building Networks
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Building Networks
This chapter will provide you with the knowledge needed to build networks with
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
@@ -54,7 +231,7 @@ Reticulum, you can simply add more segments to your network when it becomes
necessary, and Reticulum will handle the convergence of the entire network
automatically.
-Concepts & Overview
+Concepts & Overview
There are important points that need to be kept in mind when building networks
with Reticulum:
@@ -149,11 +326,11 @@ decide which are suitable to use in any given situation, depending on where
traffic needs to flow.
-Example Scenarios
+Example Scenarios
This section illustrates a few example scenarios, and how they would, in general
terms, be planned, implemented and configured.
-Interconnected LoRa Sites
+Interconnected LoRa Sites
An organisation wants to provide communication and information services to it’s
members, which are located mainly in three separate areas. Three suitable hill-top
locations are found, where the organisation can install equipment: Site A, B and C.
@@ -182,7 +359,7 @@ communicating with the LoRa radios installed at the gateway sites.
else across all three sites.
-Bridging Over the Internet
+Bridging Over the Internet
As the organisation grows, several new communities form in places too far away
from the core network to be reachable over WiFi links. New gateways similar to those
previously installed are set up for the new communities at the new sites D and E, but
@@ -199,7 +376,7 @@ combined users of sites A, B and C. She then enables transport on her node, and
traffic from site D can now reach everyone at site A, B and C, and vice versa.
-Growth and Convergence
+Growth and Convergence
As the organisation grows, more gateways are added to keep up with the growing user
base. Some local gateways even add VHF radios and packet modems to reach outlying users
and communities that are out of reach for the LoRa radios and WiFi backhauls.
@@ -215,16 +392,62 @@ connected outliers are now an integral part of the network.
-
-
+
+
+
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-API Reference
-This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their methods and usage. It can be used as a reference while writing applications that utilise Reticulum, or read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
-
-Classes
-Communication over a Reticulum network is achieved using a set of classes exposed by the RNS API.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+API Reference
+Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API.
+This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
Reticulum
-
-class RNS.Reticulum(configdir=None, loglevel=None, logdest=None)
+class RNS.Reticulum(configdir=None, loglevel=None, logdest=None)
This class is used to initialise access to Reticulum within a
program. You must create exactly one instance of this class before
carrying out any other RNS operations, such as creating destinations
@@ -76,7 +251,7 @@ it will be advantageous to run a master RNS instance as a daemon for
other programs to use on demand.
-
-MTU = 500
+MTU = 500
The MTU that Reticulum adheres to, and will expect other peers to
adhere to. By default, the MTU is 507 bytes. In custom RNS network
implementations, it is possible to change this value, but doing so will
@@ -88,7 +263,7 @@ the default value.
-
-ANNOUNCE_CAP = 2
+ANNOUNCE_CAP = 2
The maximum percentage of interface bandwidth that, at any given time,
may be used to propagate announces. If an announce was scheduled for
broadcasting on an interface, but doing so would exceed the allowed
@@ -105,10 +280,10 @@ but it can be configured individually on a per-interface basis.
-
-static should_use_implicit_proof()
+static should_use_implicit_proof()
Returns whether proofs sent are explicit or implicit.
-- Returns:
+- Returns
True if the current running configuration specifies to use implicit proofs. False if not.
@@ -116,14 +291,14 @@ but it can be configured individually on a per-interface basis.
-
-static transport_enabled()
+static transport_enabled()
Returns whether Transport is enabled for the running
instance.
When Transport is enabled, Reticulum will
route traffic for other peers, respond to path requests
and pass announces over the network.
-- Returns:
+- Returns
True if Transport is enabled, False if not.
@@ -134,43 +309,43 @@ and pass announces over the network.
Identity
-
-class RNS.Identity(create_keys=True)
+class RNS.Identity(create_keys=True)
This class is used to manage identities in Reticulum. It provides methods
for encryption, decryption, signatures and verification, and is the basis
for all encrypted communication over Reticulum networks.
-- Parameters:
+- Parameters
create_keys – Specifies whether new encryption and signing keys should be generated.
-
-CURVE = 'Curve25519'
+CURVE = 'Curve25519'
The curve used for Elliptic Curve DH key exchanges
-
-KEYSIZE = 512
+KEYSIZE = 512
X25519 key size in bits. A complete key is the concatenation of a 256 bit encryption key, and a 256 bit signing key.
-
-TRUNCATED_HASHLENGTH = 128
+TRUNCATED_HASHLENGTH = 128
Constant specifying the truncated hash length (in bits) used by Reticulum
for addressable hashes and other purposes. Non-configurable.
-
-static recall(destination_hash)
+static recall(destination_hash)
Recall identity for a destination hash.
-- Parameters:
+- Parameters
destination_hash – Destination hash as bytes.
- Returns:
+- Returns
An RNS.Identity instance that can be used to create an outgoing RNS.Destination, or None if the destination is unknown.
@@ -178,13 +353,13 @@ for addressable hashes and other purposes. Non-configurable.
-
-static recall_app_data(destination_hash)
+static recall_app_data(destination_hash)
Recall last heard app_data for a destination hash.
-- Parameters:
+- Parameters
destination_hash – Destination hash as bytes.
- Returns:
+- Returns
Bytes containing app_data, or None if the destination is unknown.
@@ -192,13 +367,13 @@ for addressable hashes and other purposes. Non-configurable.
-
-static full_hash(data)
+static full_hash(data)
Get a SHA-256 hash of passed data.
-- Parameters:
+- Parameters
data – Data to be hashed as bytes.
- Returns:
+- Returns
SHA-256 hash as bytes
@@ -206,13 +381,13 @@ for addressable hashes and other purposes. Non-configurable.
-
-static truncated_hash(data)
+static truncated_hash(data)
Get a truncated SHA-256 hash of passed data.
-- Parameters:
+- Parameters
data – Data to be hashed as bytes.
- Returns:
+- Returns
Truncated SHA-256 hash as bytes
@@ -220,13 +395,13 @@ for addressable hashes and other purposes. Non-configurable.
-
-static get_random_hash()
+static get_random_hash()
Get a random SHA-256 hash.
-- Parameters:
+- Parameters
data – Data to be hashed as bytes.
- Returns:
+- Returns
Truncated SHA-256 hash of random data as bytes
@@ -234,14 +409,14 @@ for addressable hashes and other purposes. Non-configurable.
-
-static from_bytes(prv_bytes)
+static from_bytes(prv_bytes)
Create a new RNS.Identity instance from bytes of private key.
Can be used to load previously created and saved identities into Reticulum.
-- Parameters:
+- Parameters
prv_bytes – The bytes of private a saved private key. HAZARD! Never use this to generate a new key by feeding random data in prv_bytes.
- Returns:
+- Returns
A RNS.Identity instance, or None if the bytes data was invalid.
@@ -249,14 +424,14 @@ Can be used to load previously created and saved identities into Reticulum.
-
-static from_file(path)
+static from_file(path)
Create a new RNS.Identity instance from a file.
Can be used to load previously created and saved identities into Reticulum.
-- Parameters:
+- Parameters
path – The full path to the saved RNS.Identity data
- Returns:
+- Returns
A RNS.Identity instance, or None if the loaded data was invalid.
@@ -264,15 +439,15 @@ Can be used to load previously created and saved identities into Reticulum.
-
-to_file(path)
+to_file(path)
Saves the identity to a file. This will write the private key to disk,
and anyone with access to this file will be able to decrypt all
communication for the identity. Be very careful with this method.
-- Parameters:
+- Parameters
path – The full path specifying where to save the identity.
- Returns:
+- Returns
True if the file was saved, otherwise False.
@@ -280,9 +455,9 @@ communication for the identity. Be very careful with this method.
-
-get_private_key()
+get_private_key()
-- Returns:
+- Returns
The private key as bytes
@@ -290,9 +465,9 @@ communication for the identity. Be very careful with this method.
-
-get_public_key()
+get_public_key()
-- Returns:
+- Returns
The public key as bytes
@@ -300,13 +475,13 @@ communication for the identity. Be very careful with this method.
-
-load_private_key(prv_bytes)
+load_private_key(prv_bytes)
Load a private key into the instance.
-- Parameters:
+- Parameters
prv_bytes – The private key as bytes.
- Returns:
+- Returns
True if the key was loaded, otherwise False.
@@ -314,13 +489,13 @@ communication for the identity. Be very careful with this method.
-
-load_public_key(pub_bytes)
+load_public_key(pub_bytes)
Load a public key into the instance.
-- Parameters:
+- Parameters
pub_bytes – The public key as bytes.
- Returns:
+- Returns
True if the key was loaded, otherwise False.
@@ -328,16 +503,16 @@ communication for the identity. Be very careful with this method.
-
-encrypt(plaintext)
+encrypt(plaintext)
Encrypts information for the identity.
-- Parameters:
+- Parameters
plaintext – The plaintext to be encrypted as bytes.
- Returns:
+- Returns
Ciphertext token as bytes.
- Raises:
+- Raises
KeyError if the instance does not hold a public key.
@@ -345,16 +520,16 @@ communication for the identity. Be very careful with this method.
-
-decrypt(ciphertext_token)
+decrypt(ciphertext_token)
Decrypts information for the identity.
-- Parameters:
+- Parameters
ciphertext – The ciphertext to be decrypted as bytes.
- Returns:
+- Returns
Plaintext as bytes, or None if decryption fails.
- Raises:
+- Raises
KeyError if the instance does not hold a private key.
@@ -362,16 +537,16 @@ communication for the identity. Be very careful with this method.
-
-sign(message)
+sign(message)
Signs information by the identity.
-- Parameters:
+- Parameters
message – The message to be signed as bytes.
- Returns:
+- Returns
Signature as bytes.
- Raises:
+- Raises
KeyError if the instance does not hold a private key.
@@ -379,19 +554,19 @@ communication for the identity. Be very careful with this method.
-
-validate(signature, message)
+validate(signature, message)
Validates the signature of a signed message.
-- Parameters:
+- Parameters
-
-- Returns:
+- Returns
True if the signature is valid, otherwise False.
- Raises:
+- Raises
KeyError if the instance does not hold a public key.
@@ -402,7 +577,7 @@ communication for the identity. Be very careful with this method.
Destination
-
-class RNS.Destination(identity, direction, type, app_name, *aspects)
+class RNS.Destination(identity, direction, type, app_name, *aspects)
A class used to describe endpoints in a Reticulum Network. Destination
instances are used both to create outgoing and incoming endpoints. The
destination type will decide if encryption, and what type, is used in
@@ -410,7 +585,7 @@ communication with the endpoint. A destination can also announce its
presence on the network, which will also distribute necessary keys for
encrypted communication with it.
-- Parameters:
+- Parameters
identity – An instance of RNS.Identity. Can hold only public keys for an outgoing destination, or holding private keys for an ingoing.
direction – RNS.Destination.IN or RNS.Destination.OUT.
-
-static full_name(app_name, *aspects)
+static full_name(app_name, *aspects)
-- Returns:
+- Returns
A string containing the full human-readable name of the destination, for an app_name and a number of aspects.
@@ -432,9 +607,9 @@ encrypted communication with it.
-
-static app_and_aspects_from_name(full_name)
+static app_and_aspects_from_name(full_name)
-- Returns:
+- Returns
A tuple containing the app name and a list of aspects, for a full-name string.
@@ -442,9 +617,9 @@ encrypted communication with it.
-
-static hash_from_name_and_identity(full_name, identity)
+static hash_from_name_and_identity(full_name, identity)
-- Returns:
+- Returns
A destination name in adressable hash form, for a full name string and Identity instance.
@@ -452,9 +627,9 @@ encrypted communication with it.
-
-static hash(app_name, *aspects)
+static hash(app_name, *aspects)
-- Returns:
+- Returns
A destination name in adressable hash form, for an app_name and a number of aspects.
@@ -462,11 +637,11 @@ encrypted communication with it.
-
-announce(app_data=None, path_response=False)
+announce(app_data=None, path_response=False)
Creates an announce packet for this destination and broadcasts it on all
relevant interfaces. Application specific data can be added to the announce.
-- Parameters:
+- Parameters
-
-
+
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
Search
-
-
-
-
-
- Searching for multiple words only shows matches that contain
- all words.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Support Reticulum
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Support Reticulum
You can help support the continued development of open, free and private communications
systems by donating, providing feedback and contributing code and learning resources.
-Donations
+Donations
Donations are gratefully accepted via the following channels:
Monero:
84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
@@ -64,7 +245,7 @@ https://ko-fi.com/markqvist
organisation? Make them a reality quickly by sponsoring their implementation.
-Provide Feedback
+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, telemetry, error
@@ -72,22 +253,68 @@ reporting or statistics is collected and reported by Reticulum under any
circumstances, so we rely on old-fashioned human feedback.
-Contribute Code
+Contribute Code
Join us on the GitHub repository to
report issues, suggest functionality and contribute code to Reticulum.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/understanding.html b/docs/manual/understanding.html
index 114c2ea..1782edd 100644
--- a/docs/manual/understanding.html
+++ b/docs/manual/understanding.html
@@ -1,51 +1,228 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
Understanding Reticulum — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
+
Understanding Reticulum - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Understanding Reticulum
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Understanding Reticulum
This chapter will briefly describe the overall purpose and operating principles of Reticulum.
It should give you an overview of how the stack works, and an understanding of how to
develop networked applications using Reticulum.
@@ -60,7 +237,7 @@ development, this is also the place to start, since it will provide a pretty cle
sentiments and the philosophy behind Reticulum, what problems it seeks to solve, and how it
approaches those solutions.
-Motivation
+Motivation
The primary motivation for designing and implementing Reticulum has been the current lack of
reliable, functional and secure minimal-infrastructure modes of digital communication. It is my
belief that it is highly desirable to create a reliable and efficient way to set up long-range digital
@@ -88,7 +265,7 @@ kill-switches, surveillance, censorship and control. Networks that can freely in
with each other, and require no central oversight. Networks for human beings. Networks for the people.
-Goals
+Goals
To be as widely usable and efficient to deploy as possible, the following goals have been used to
guide the design of Reticulum:
@@ -159,7 +336,7 @@ needs to be purchased.
-Introduction & Basic Functionality
+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 all nodes are within range of each other, as well as scenarios where packets need
@@ -193,7 +370,7 @@ unencrypted packets for local broadcast purposes.
and offers the possibility to easily tunnel Reticulum traffic over IP links such as the Internet or
private IP networks.
-Destinations
+Destinations
To receive and send data with the Reticulum stack, an application needs to create one or more
destinations. Reticulum uses three different basic destination types, and one special:
@@ -236,7 +413,7 @@ out requests and responses, large data transfers and more.
-Destination Naming
+Destination Naming
Destinations are created and named in an easy to understand dotted notation of aspects, and
represented on the network as a hash of this value. The hash is a SHA-256 truncated to 128 bits. The
top level aspect should always be a unique identifier for the application using the destination.
@@ -303,7 +480,7 @@ if there is not a very good reason for doing it differently.
-Public Key Announcements
+Public Key Announcements
An announce will send a special packet over any relevant interfaces, containing all needed
information about the destination hash and public key, and can also contain some additional,
application specific data. The entire packet is signed by the sender to ensure authenticity. It is not
@@ -337,7 +514,7 @@ networks it is part of. After a short while, it will be globally reachable in th
Seeing how single destinations are always tied to a private/public key pair leads us to the next topic.
-Identities
+Identities
In Reticulum, an identity does not necessarily represent a personal identity, but is an abstraction that
can represent any kind of verifiable entity. This could very well be a person, but it could also be the
control interface of a machine, a program, robot, computer, sensor or something else entirely. In
@@ -355,7 +532,7 @@ Reticulum Identity securely and privately, since obtaining access to the identit
obtaining access and controlling reachability to any destinations created by that identity.
-Getting Further
+Getting Further
The above functions and principles form the core of Reticulum, and would suffice to create
functional networked applications in local clusters, for example over radio links where all interested
nodes can directly hear each other. But to be truly useful, we need a way to direct traffic over multiple
@@ -364,7 +541,7 @@ hops in the network.
-Reticulum Transport
+Reticulum Transport
The methods of routing used in traditional networks are fundamentally incompatible with the physical medium
types and circumstances that Reticulum was designed to handle. These mechanisms mostly assume trust at the physical layer,
and often needs a lot more bandwidth than Reticulum can assume is available. Since Reticulum is designed to
@@ -375,7 +552,7 @@ destination. It is important to note that no single node in a Reticulum network
path to a destination. Every Transport node participating in a Reticulum network will only
know the most direct way to get a packet one hop closer to it’s destination.
-Node Types
+Node Types
Currently, Reticulum distinguishes between two types of network nodes. All nodes on a Reticulum network
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.
@@ -387,7 +564,7 @@ is the default setting.
If it is a Transport Node, it should be given the configuration directive enable_transport = Yes.
-The Announce Mechanism in Detail
+The Announce Mechanism in Detail
When an announce for a destination is transmitted by from a Reticulum instance, it will be forwarded by
any transport node receiving it, but according to some specific rules:
@@ -452,7 +629,7 @@ end-to-end connectivity in about one minute, given there is enough bandwidth ava
the required amount of announces.
-Reaching the Destination
+Reaching the Destination
In networks with changing topology and trustless connectivity, nodes need a way to establish
verified connectivity with each other. Since the network is assumed to be trustless, Reticulum
must provide a way to guarantee that the peer you are communicating with is actually who you
@@ -559,7 +736,7 @@ by referring to this link id.
a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet
radio channel, 100 concurrent links will still leave 96% channel capacity for actual data.
-Link Establishment in Detail
+Link Establishment in Detail
After exploring the basics of the announce mechanism, finding a path through the network, and an overview
of the link establishment procedure, this section will go into greater detail about the Reticulum link
establishment process.
@@ -634,7 +811,7 @@ automate retransmissions if Resources are used.
-Resources
+Resources
For exchanging small amounts of data over a Reticulum network, the Packet interface
is sufficient, but for exchanging data that would require many packets, an efficient way to coordinate
the transfer is needed.
@@ -648,7 +825,7 @@ or stream data directly from files.
-Reference Setup
+Reference Setup
This section will detail a recommended Reference Setup for Reticulum. It is important to
note that Reticulum is designed to be usable on more or less any computing device, and over more
or less any medium that allows you to send and receive data, which satisfies some very low
@@ -716,18 +893,18 @@ even if you have none of the hardware already, and need to purchase everything.<
tailor it to your own specific needs, or whatever hardware you have available.
-Protocol Specifics
+Protocol Specifics
This chapter will detail protocol specific information that is essential to the implementation of
Reticulum, but non critical in understanding how the protocol works on a general level. It should be
treated more as a reference than as essential reading.
-Packet Prioritisation
+Packet Prioritisation
Currently, Reticulum is completely priority-agnostic regarding general traffic. All traffic is handled
on a first-come, first-serve basis. Announce re-transmission are handled according to the re-transmission
times and priorities described earlier in this chapter.
-Interface Access Codes
+Interface Access Codes
Reticulum can create named virtual networks, and networks that are only accessible by knowing a preshared
passphrase. The configuration of this is detailed in the Common Interface Options
section. To implement these feature, Reticulum uses the concept of Interface Access Codes, that are calculated
@@ -742,7 +919,7 @@ does not. This ensures that only packets sent with the correct naming and/or pas
pass onto the network.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/using.html b/docs/manual/using.html
index 8fd94f8..7a03860 100644
--- a/docs/manual/using.html
+++ b/docs/manual/using.html
@@ -1,51 +1,228 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
Using Reticulum on Your System — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
+
Using Reticulum on Your System - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Using Reticulum on Your System
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+Using Reticulum on Your System
Reticulum is not installed as a driver or kernel module, as one might expect
of a networking stack. Instead, Reticulum is distributed as a Python module.
This means that no special privileges are required to install or use it. It
@@ -60,7 +237,7 @@ instance is simply shared. This works for any number of programs running
concurrently, and is very easy to use, but depending on your use case, there
are other options.
-Configuration & Data
+Configuration & Data
A Reticulum stores all information that it needs to function in a single file-
system directory. By default, this directory is ~/.config/reticulum, but you can
use any directory you wish. You can also run multiple separate Reticulum
@@ -171,7 +348,7 @@ concepts you need to understand to configure your network. Once you have done th
take a look at the Interfaces chapter of this manual.
-Included Utility Programs
+Included Utility Programs
Reticulum includes a range of useful utilities, both for managing your Reticulum
networks, and for carrying out common tasks over Reticulum networks, such as
transferring files to remote systems, and executing commands and programs remotely.
@@ -180,7 +357,7 @@ Reticulum to stay available all the time, for example if you are hosting
a transport node, you might want to run Reticulum as a separate service that
other programs, applications and services can utilise.
-The rnsd Utility
+The rnsd Utility
It is very easy to run Reticulum as a service. Simply run the included rnsd command.
When rnsd is running, it will keep all configured interfaces open, handle transport if
it is enabled, and allow any other programs to immediately utilise the
@@ -209,7 +386,7 @@ optional arguments:
You can easily add rnsd as an always-on service by configuring a service.
-The rnstatus Utility
+The rnstatus Utility
Using the rnstatus utility, you can view the status of configured Reticulum
interfaces, similar to the ifconfig program.
# Run rnstatus
@@ -263,7 +440,7 @@ optional arguments:
The rnpath Utility
+The rnpath Utility
With the rnpath utility, you can look up and view paths for
destinations on the Reticulum network.
# Run rnpath
@@ -294,7 +471,7 @@ optional arguments:
The rnprobe Utility
+The rnprobe Utility
The rnprobe utility lets you probe a destination for connectivity, similar
to the ping program. Please note that probes will only be answered if the
specified destination is configured to send proofs for received packets. Many
@@ -325,7 +502,7 @@ optional arguments:
The rncp Utility
+The rncp Utility
The rncp utility is a simple file transfer tool. Using it, you can transfer
files through Reticulum.
# Run rncp on the receiving system, specifying which identities
@@ -362,7 +539,7 @@ optional arguments:
The rnx Utility
+The rnx Utility
The rnx utility is a basic remote command execution program. It allows you to
execute commands on remote systems over Reticulum, and to view returned command
output.
@@ -419,12 +596,12 @@ optional arguments:
-Improving System Configuration
+Improving System Configuration
If you are setting up a system for permanent use with Reticulum, there is a
few system configuration changes that can make this easier to administrate.
These changes will be detailed here.
-Fixed Serial Port Names
+Fixed Serial Port Names
On a Reticulum instance with several serial port based interfaces, it can be
beneficial to use the fixed device names for the serial ports, instead
of the dynamically allocated shorthands such as /dev/ttyUSB0. Under most
@@ -452,7 +629,7 @@ might be plugged and unplugged in different orders, or when device name
assignment varies from one boot to another.
-Reticulum as a System Service
+Reticulum as a System Service
Instead of starting Reticulum manually, you can install rnsd as a system
service and have it start automatically at boot.
If you installed Reticulum with pip, the rnsd program will most likely
@@ -498,16 +675,62 @@ WantedBy=multi-user.target
-
-
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/manual/whatis.html b/docs/manual/whatis.html
index 83ce1da..48830c7 100644
--- a/docs/manual/whatis.html
+++ b/docs/manual/whatis.html
@@ -1,51 +1,228 @@
+
+
+
+
+
+
-
-
-
-
-
-
-
-
What is Reticulum? — Reticulum Network Stack 0.3.12 beta documentation
-
-
+
+
What is Reticulum? - Reticulum Network Stack 0.3.12 beta documentation
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-What is Reticulum?
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+
+
+
+
+
+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.
@@ -63,14 +240,14 @@ networks.
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
+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.
-What does Reticulum Offer?
+What does Reticulum Offer?
-Where can Reticulum be Used?
+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,
@@ -128,7 +305,7 @@ network can communicate with nodes on the LoRa and packet radio sides of the
network, and vice versa.
-Interface Types and Devices
+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:
-Caveat Emptor
+Caveat Emptor
Reticulum is an experimental networking stack, 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
@@ -176,16 +353,62 @@ want to help out, or help sponsor an audit, please do get in touch.
-
-
+
+
+
-
-
-
-
+
+
+
+
+