mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-07 23:00:15 +00:00
252 lines
13 KiB
HTML
252 lines
13 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
||
<title>What is Reticulum? — Reticulum Network Stack 0.3.12 beta documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
|
||
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Getting Started Fast" href="gettingstartedfast.html" />
|
||
<link rel="prev" title="Reticulum Network Stack Manual" href="index.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="gettingstartedfast.html" title="Getting Started Fast"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="index.html" title="Reticulum Network Stack Manual"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.12 beta documentation</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="what-is-reticulum">
|
||
<h1>What is Reticulum?<a class="headerlink" href="#what-is-reticulum" title="Permalink to this heading">¶</a></h1>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<section id="current-status">
|
||
<h2>Current Status<a class="headerlink" href="#current-status" title="Permalink to this heading">¶</a></h2>
|
||
<p>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.</p>
|
||
</section>
|
||
<section id="what-does-reticulum-offer">
|
||
<h2>What does Reticulum Offer?<a class="headerlink" href="#what-does-reticulum-offer" title="Permalink to this heading">¶</a></h2>
|
||
<ul class="simple">
|
||
<li><p>Coordination-less globally unique addressing and identification</p></li>
|
||
<li><p>Fully self-configuring multi-hop routing</p></li>
|
||
<li><p>Complete initiator anonymity, communicate without revealing your identity</p></li>
|
||
<li><p>Asymmetric encryption based on X25519, and Ed25519 signatures as a basis for all communication</p></li>
|
||
<li><p>Forward Secrecy by using ephemeral Elliptic Curve Diffie-Hellman keys on Curve25519</p></li>
|
||
<li><p>Reticulum uses the <a class="reference external" href="https://github.com/fernet/spec/blob/master/Spec.md">Fernet</a> specification for on-the-wire / over-the-air encryption</p>
|
||
<ul>
|
||
<li><p>All keys are ephemeral and derived from an ECDH key exchange on Curve25519</p></li>
|
||
<li><p>AES-128 in CBC mode with PKCS7 padding</p></li>
|
||
<li><p>HMAC using SHA256 for authentication</p></li>
|
||
<li><p>IVs are generated through os.urandom()</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p>Unforgeable packet delivery confirmations</p></li>
|
||
<li><p>A variety of supported interface types</p></li>
|
||
<li><p>An intuitive and developer-friendly API</p></li>
|
||
<li><p>Efficient link establishment</p>
|
||
<ul>
|
||
<li><p>Total bandwidth cost of setting up a link is only 3 packets, totalling 297 bytes</p></li>
|
||
<li><p>Low cost of keeping links open at only 0.44 bits per second</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p>Reliable and efficient transfer of arbitrary amounts of data</p>
|
||
<ul>
|
||
<li><p>Reticulum can handle a few bytes of data or files of many gigabytes</p></li>
|
||
<li><p>Sequencing, transfer coordination and checksumming is automatic</p></li>
|
||
<li><p>The API is very easy to use, and provides transfer progress</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p>Authentication and virtual network segmentation on all supported interface types</p></li>
|
||
<li><p>Flexible scalability allowing extremely low-bandwidth networks to co-exist and interoperate with large, high-bandwidth networks</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="where-can-reticulum-be-used">
|
||
<h2>Where can Reticulum be Used?<a class="headerlink" href="#where-can-reticulum-be-used" title="Permalink to this heading">¶</a></h2>
|
||
<p>Over practically any medium that can support at least a half-duplex channel
|
||
with 500 bits per second throughput, and an MTU of 500 bytes. Data radios,
|
||
modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes,
|
||
ad-hoc WiFi, free-space optical links and similar systems are all examples
|
||
of the types of interfaces Reticulum was designed for.</p>
|
||
<p>An open-source LoRa-based interface called <a class="reference external" href="https://unsigned.io/rnode">RNode</a>
|
||
has been designed as an example transceiver that is very suitable for
|
||
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.</p>
|
||
<p>Reticulum can also be encapsulated over existing IP networks, so there’s
|
||
nothing stopping you from using it over wired Ethernet or your local WiFi
|
||
network, where it’ll work just as well. In fact, one of the strengths of
|
||
Reticulum is how easily it allows you to connect different mediums into a
|
||
self-configuring, resilient and encrypted mesh.</p>
|
||
<p>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
|
||
added, 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.</p>
|
||
</section>
|
||
<section id="interface-types-and-devices">
|
||
<h2>Interface Types and Devices<a class="headerlink" href="#interface-types-and-devices" title="Permalink to this heading">¶</a></h2>
|
||
<p>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:</p>
|
||
<ul class="simple">
|
||
<li><p>Any Ethernet device</p>
|
||
<ul>
|
||
<li><p>WiFi devices</p></li>
|
||
<li><p>Wired Ethernet devices</p></li>
|
||
<li><p>Fibre-optic transceivers</p></li>
|
||
<li><p>Data radios with Ethernet ports</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p>LoRa using <a class="reference external" href="https://unsigned.io/rnode">RNode</a></p>
|
||
<ul>
|
||
<li><p>Can be installed on <a class="reference external" href="https://github.com/markqvist/rnodeconfigutil#supported-devices">many popular LoRa boards</a></p></li>
|
||
<li><p>Can be purchased as a <a class="reference external" href="https://unsigned.io/rnode">ready to use transceiver</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p>Packet Radio TNCs, such as <a class="reference external" href="https://unsigned.io/openmodem">OpenModem</a></p>
|
||
<ul>
|
||
<li><p>Any packet radio TNC in KISS mode</p></li>
|
||
<li><p>Ideal for VHF and UHF radio</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p>Any device with a serial port</p></li>
|
||
<li><p>The I2P network</p></li>
|
||
<li><p>TCP over IP networks</p></li>
|
||
<li><p>UDP over IP networks</p></li>
|
||
<li><p>Anything you can connect via stdio</p>
|
||
<ul>
|
||
<li><p>Reticulum can use external programs and pipes as interfaces</p></li>
|
||
<li><p>This can be used to easily hack in virtual interfaces</p></li>
|
||
<li><p>Or to quickly create interfaces with custom hardware</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>For a full list and more details, see the <a class="reference internal" href="interfaces.html#interfaces-main"><span class="std std-ref">Supported Interfaces</span></a> chapter.</p>
|
||
</section>
|
||
<section id="caveat-emptor">
|
||
<h2>Caveat Emptor<a class="headerlink" href="#caveat-emptor" title="Permalink to this heading">¶</a></h2>
|
||
<p>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
|
||
privacy-breaking bugs. To be considered secure, Reticulum needs a thorough
|
||
security review by independent cryptographers and security researchers. If you
|
||
want to help out, or help sponsor an audit, please do get in touch.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<div>
|
||
<h3><a href="index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">What is Reticulum?</a><ul>
|
||
<li><a class="reference internal" href="#current-status">Current Status</a></li>
|
||
<li><a class="reference internal" href="#what-does-reticulum-offer">What does Reticulum Offer?</a></li>
|
||
<li><a class="reference internal" href="#where-can-reticulum-be-used">Where can Reticulum be Used?</a></li>
|
||
<li><a class="reference internal" href="#interface-types-and-devices">Interface Types and Devices</a></li>
|
||
<li><a class="reference internal" href="#caveat-emptor">Caveat Emptor</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="index.html"
|
||
title="previous chapter">Reticulum Network Stack Manual</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="gettingstartedfast.html"
|
||
title="next chapter">Getting Started Fast</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/whatis.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="gettingstartedfast.html" title="Getting Started Fast"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="index.html" title="Reticulum Network Stack Manual"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.12 beta documentation</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2022, Mark Qvist.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.2.
|
||
</div>
|
||
</body>
|
||
</html> |