Updated docs

2021-09-18 18:10:58 +02:00 · 2021-09-18 18:10:58 +02:00 · 6d6c91edaf
commit 6d6c91edaf
--- a/README.md
+++ b/README.md
@ -20,11 +20,11 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects
 - Fully self-configuring multi-hop routing
 - Asymmetric X25519 encryption and Ed25519 signatures as a basis for all communication
 - Forward Secrecy with ephemereal Elliptic Curve Diffie-Hellman keys on Curve25519
- - Reticulum uses the [Fernet](https://github.com/fernet/spec/blob/master/Spec.md) specification for encryption
+ - Reticulum uses the [Fernet](https://github.com/fernet/spec/blob/master/Spec.md) specification for on-the-wire / over-the-air encryption
+    - Keys are ephemeral and derived from an ECDH key exchange on Curve25519
    - AES-128 in CBC mode with PKCS7 padding
    - HMAC using SHA256 for authentication
    - IVs are generated through os.urandom()
-    - Keys are ephemeral and derived from an ECDH key exchange on Curve25519
 - Unforgeable packet delivery confirmations
 - A variety of supported interface types
 - An intuitive and easy-to-use API
--- a/docs/manual/.buildinfo
+++ b/docs/manual/.buildinfo
@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: eda3a1317314f558917722e3479f8836
+config: ca50760ac810704080bd9b8fd39823dc
 tags: 645f666f9bcd5a90fca523b33c5a78b7
--- a/docs/manual/_sources/whatis.rst.txt
+++ b/docs/manual/_sources/whatis.rst.txt
@ -31,7 +31,9 @@ What does Reticulum Offer?

 * Forward Secrecy with ephemereal Elliptic Curve Diffie-Hellman keys on Curve25519

-* Reticulum uses the `Fernet <https://github.com/fernet/spec/blob/master/Spec.md>`_ specification for encryption
+* Reticulum uses the `Fernet <https://github.com/fernet/spec/blob/master/Spec.md>`_ specification for on-the-wire / over-the-air encryption
+
+  * All keys are ephemeral and derived from an ECDH key exchange on Curve25519

  * AES-128 in CBC mode with PKCS7 padding

@ -39,8 +41,6 @@ What does Reticulum Offer?

  * IVs are generated through os.urandom()

-  * Keys are ephemeral and derived from an ECDH key exchange on Curve25519
-
 * Unforgeable packet delivery confirmations

 * A variety of supported interface types
--- a/docs/manual/_static/documentation_options.js
+++ b/docs/manual/_static/documentation_options.js
@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2.4 beta',
+    VERSION: '0.2.5 beta',
    LANGUAGE: 'None',
    COLLAPSE_INDEX: false,
    BUILDER: 'html',
--- a/docs/manual/examples.html
+++ b/docs/manual/examples.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Examples &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>Examples &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -27,7 +27,7 @@
        <li class="right" >
          <a href="reference.html" title="API Reference"
             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Examples</a></li> 
      </ul>
    </div>  
@ -2319,7 +2319,7 @@ interface to efficiently pass files of any size over a Reticulum <a class="refer
        <li class="right" >
          <a href="reference.html" title="API Reference"
             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Examples</a></li> 
      </ul>
    </div>
--- a/docs/manual/genindex.html
+++ b/docs/manual/genindex.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>Index &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -23,7 +23,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
@ -412,7 +412,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             >index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
--- a/docs/manual/gettingstartedfast.html
+++ b/docs/manual/gettingstartedfast.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Getting Started Fast &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>Getting Started Fast &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -31,7 +31,7 @@
        <li class="right" >
          <a href="whatis.html" title="What is Reticulum?"
             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Getting Started Fast</a></li> 
      </ul>
    </div>  
@ -174,7 +174,7 @@ don’t use pip, but try this recipe:</p>
        <li class="right" >
          <a href="whatis.html" title="What is Reticulum?"
             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Getting Started Fast</a></li> 
      </ul>
    </div>
--- a/docs/manual/index.html
+++ b/docs/manual/index.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Reticulum Network Stack Manual &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>Reticulum Network Stack Manual &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -27,7 +27,7 @@
        <li class="right" >
          <a href="whatis.html" title="What is Reticulum?"
             accesskey="N">next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Reticulum Network Stack Manual</a></li> 
      </ul>
    </div>  
@ -168,7 +168,7 @@ the development of Reticulum itself.</p>
        <li class="right" >
          <a href="whatis.html" title="What is Reticulum?"
             >next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Reticulum Network Stack Manual</a></li> 
      </ul>
    </div>
--- a/docs/manual/reference.html
+++ b/docs/manual/reference.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>API Reference &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>API Reference &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -31,7 +31,7 @@
        <li class="right" >
          <a href="understanding.html" title="Understanding Reticulum"
             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">API Reference</a></li> 
      </ul>
    </div>  
@ -1212,7 +1212,7 @@ will announce it.</p>
        <li class="right" >
          <a href="understanding.html" title="Understanding Reticulum"
             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">API Reference</a></li> 
      </ul>
    </div>
--- a/docs/manual/search.html
+++ b/docs/manual/search.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>Search &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -29,7 +29,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Search</a></li> 
      </ul>
    </div>  
@ -85,7 +85,7 @@
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Search</a></li> 
      </ul>
    </div>
--- a/docs/manual/searchindex.js
+++ b/docs/manual/searchindex.js
--- a/docs/manual/understanding.html
+++ b/docs/manual/understanding.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Understanding Reticulum &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>Understanding Reticulum &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -31,7 +31,7 @@
        <li class="right" >
          <a href="gettingstartedfast.html" title="Getting Started Fast"
             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Understanding Reticulum</a></li> 
      </ul>
    </div>  
@ -853,7 +853,7 @@ proof           11
        <li class="right" >
          <a href="gettingstartedfast.html" title="Getting Started Fast"
             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Understanding Reticulum</a></li> 
      </ul>
    </div>
--- a/docs/manual/whatis.html
+++ b/docs/manual/whatis.html
@ -5,7 +5,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>What is Reticulum? &#8212; Reticulum Network Stack 0.2.4 beta documentation</title>
+    <title>What is Reticulum? &#8212; Reticulum Network Stack 0.2.5 beta documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/classic.css" />
    
@ -31,7 +31,7 @@
        <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.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li> 
      </ul>
    </div>  
@ -62,12 +62,12 @@
 <li><p>Fully self-configuring multi-hop routing</p></li>
 <li><p>Asymmetric X25519 encryption and Ed25519 signatures as a basis for all communication</p></li>
 <li><p>Forward Secrecy with ephemereal 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 encryption</p>
+<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>
-<li><p>Keys are ephemeral and derived from an ECDH key exchange on Curve25519</p></li>
 </ul>
 </li>
 <li><p>Unforgeable packet delivery confirmations</p></li>
@ -182,7 +182,7 @@ network, and vice versa.</p>
        <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.2.4 beta documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.2.5 beta documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">What is Reticulum?</a></li> 
      </ul>
    </div>
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@ -22,7 +22,7 @@ copyright = '2021, Mark Qvist'
 author = 'Mark Qvist'

 # The full version, including alpha/beta/rc tags
-release = '0.2.4 beta'
+release = '0.2.5 beta'


 # -- General configuration ---------------------------------------------------
--- a/docs/source/whatis.rst
+++ b/docs/source/whatis.rst
@ -31,7 +31,9 @@ What does Reticulum Offer?

 * Forward Secrecy with ephemereal Elliptic Curve Diffie-Hellman keys on Curve25519

-* Reticulum uses the `Fernet <https://github.com/fernet/spec/blob/master/Spec.md>`_ specification for encryption
+* Reticulum uses the `Fernet <https://github.com/fernet/spec/blob/master/Spec.md>`_ specification for on-the-wire / over-the-air encryption
+
+  * All keys are ephemeral and derived from an ECDH key exchange on Curve25519

  * AES-128 in CBC mode with PKCS7 padding

@ -39,8 +41,6 @@ What does Reticulum Offer?

  * IVs are generated through os.urandom()

-  * Keys are ephemeral and derived from an ECDH key exchange on Curve25519
-
 * Unforgeable packet delivery confirmations

 * A variety of supported interface types