From 88a956b4f5bf8b72571ca7fc077fad5099228e35 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 13 Aug 2020 12:56:39 +0200 Subject: [PATCH] Updated readme, version bump --- README.html | 1037 ++++++++++++++++++--------------------------------- README.md | 21 +- setup.py | 2 +- 3 files changed, 377 insertions(+), 683 deletions(-) diff --git a/README.html b/README.html index 588b1ef..875a415 100644 --- a/README.html +++ b/README.html @@ -1,34 +1,43 @@ -README

Reticulum Network Stack α

-

Reticulum is a cryptography-based networking stack for high-latency, wide-area networks built on readily available hardware. Reticulum allows you to build very 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 use IP or higher layers, although it is easy to utilise IP (with TCP or UDP) as the underlying carrier for Reticulum.

+README

+Reticulum Network Stack α

+

Reticulum is a cryptography-based networking stack for wide-area networks built on readily available hardware, and can operate even with very high latency and extremely low bandwidth. Reticulum allows you to build very 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 use 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.

Having no dependencies on traditional networking stacks free up overhead that has been utilised to implement a networking stack 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.

-

For more info, see unsigned.io/projects/reticulum

-

Notable Features

+

For more info, see unsigned.io/projects/reticulum

+

+Notable Features

  • Coordination-less globally unique adressing and identification
  • Fully self-configuring multi-hop routing
  • Asymmetric RSA encryption and signatures as basis for all communication
  • Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on the SECP256R1 curve)
    • -
  • Reticulum uses the Fernet specification for encryption on links and to group destinations
      +
    • Reticulum uses the Fernet specification for encryption on links and to group destinations +
      • AES-128 in CBC mode with PKCS7 padding
      • HMAC using SHA256 for authentication
      • IVs are generated through os.urandom()
        • @@ -1075,83 +753,96 @@ body .markdown-body
      • Unforgeable packet delivery confirmations
      • A variety of supported interface types
        • -
      • Efficient and easy resource transfers
      • An intuitive and easy-to-use API
        • +
      • Reliable and efficient transfer of arbritrary amounts of data +
          +
        • Reticulum can handle a few bytes of data or files of many gigabytes
          • +
        • Sequencing, transfer coordination and checksumming is automatic
          • +
        • The API is very easy to use, and provides transfer progress
        -

        Where can Reticulum be used?

        -

        On practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for.

        -

        An open-source LoRa-based interface called RNode has been designed specifically for use with Reticulum. It is possible to build yourself, or can be purchased as a complete transceiver that just needs a USB connection to the host.

        -

        Reticulum can also be encapsulated over existing IP networks, so there’s nothing stopping you from using it over wired ethernet or your local WiFi network, where it’ll work just as well. In fact, one of the strengths of Reticulum is how easily it allows you to connect different mediums into a self-configuring, resilient and encrypted mesh.

        -

        As an example, it’s possible to set up a Raspberry Pi connected to both a LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are configured, Reticulum will take care of the rest, and any device on the WiFi network can communicate with nodes on the LoRa and packet radio sides of the network, and vice versa.

        -

        Current Status

        -

        Consider Reticulum experimental at this stage. Most features are implemented and working, but at this point the protocol may still change significantly, and is made publicly available for development collaboration, previewing and testing.

        -

        An API- and wireformat-stable alpha release is coming in the near future. Until then expect things to change unexpectedly if something warrants it.

        -

        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. Currently, the following interfaces are supported:

        +
        • +
      +

      +Where can Reticulum be used?

      +

      On practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, ad-hoc WiFi, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for.

      +

      An open-source LoRa-based interface called RNode has been designed specifically for use with Reticulum. It is possible to build yourself, or it can be purchased as a complete transceiver that just needs a USB connection to the host.

      +

      Reticulum can also be encapsulated over existing IP networks, so there's nothing stopping you from using it over wired ethernet or your local WiFi network, where it'll work just as well. In fact, one of the strengths of Reticulum is how easily it allows you to connect different mediums into a self-configuring, resilient and encrypted mesh.

      +

      As an example, it's possible to set up a Raspberry Pi connected to both a LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are configured, Reticulum will take care of the rest, and any device on the WiFi network can communicate with nodes on the LoRa and packet radio sides of the network, and vice versa.

      +

      +Current Status

      +

      Consider Reticulum in extended testing at this stage. All core protocol features are implemented and functioning, but additions and changes can still occur if it is warranted.

      +

      An API- and wireformat-stable beta is near at hand.

      +

      +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. Currently, the following interfaces are supported:

      • Any ethernet device
        • -
      • LoRa using RNode
        • +
      • LoRa using RNode +
      • Packet Radio TNCs (with or without AX.25)
      • Any device with a serial port
      • TCP over IP networks
      • UDP over IP networks
      -

      What is currently being worked on?

      +

      +What is currently being worked on?

      • Delay/disruption tolerance
      • API documentation
      • Useful example programs and utilities
        • -
      • A generic message transfer protocol built on Reticulum, see LXMF
        • +
      • A generic message transfer protocol built on Reticulum, see LXMF +
      • A few useful-in-the-real-world apps built with Reticulum
      -

      Can I use Reticulum on amateur radio spectrum?

      +

      +Can I use Reticulum on amateur radio spectrum?

      Some countries still ban the use of encryption when operating under an amateur radio license. Reticulum offers several encryptionless modes, while still using cryptographic principles for station verification, link establishment, data integrity verification, acknowledgements and routing. It is therefore perfectly possible to include Reticulum in amateur radio use, even if your country bans encryption.

      -

      Dependencies:

      +

      +Dependencies:

      • Python 3
      • cryptography.io
      • pyserial
      -

      How do I get started?

      -

      Full documentation and tutorials are coming with the stable alpha release. Until then, you are mostly on your own. If you want to experiment already, you could take a look in the “Examples” folder, for some well-documented example programs. The default configuration file created by Reticulum on the first run is also worth reading. Be sure to also read the Reticulum Overview Document.

      +

      +How do I get started?

      +

      Full documentation and tutorials are coming with the stable alpha release. Until then, you are mostly on your own. If you want to experiment already, you could take a look in the "Examples" folder, for some well-documented example programs. The default configuration file created by Reticulum on the first run is also worth reading. Be sure to also read the Reticulum Overview Document.

      If you just need Reticulum as a dependency for another application, the easiest way is probably via pip:

      -
      pip3 install rns
-
      - -

      For development, you might want to get the latest source from GitHub. In that case, don’t use pip, but try this recipe:

      -
      # Install dependencies
+
      pip3 install rns
      
+
      For Reticulum development, you might want to get the latest source from GitHub. In that case, don't use pip, but try this recipe:
      
+
      # Install dependencies
 pip3 install cryptography pyserial
 
-# Clone repository
+# Clone repository
 git clone https://github.com/markqvist/Reticulum.git
 
-# Move into Reticulum folder and symlink library to examples folder
-cd Reticulum
+# Move into Reticulum folder and symlink library to examples folder
+cd Reticulum
 ln -s ../RNS ./Examples/
 
-# Run an example
+# Run an example
 python3 Examples/Echo.py -s
 
-# Unless you've manually created a config file, Reticulum will do so now,
-# and immediately exit. Make any necessary changes to the file:
-nano ~/.reticulum/config
+# Unless you've manually created a config file, Reticulum will do so now,
+# and immediately exit. Make any necessary changes to the file:
+nano ~/.reticulum/config
 
-# ... and launch the example again.
+# ... and launch the example again.
 python3 Examples/Echo.py -s
 
-# You can now repeat the process on another computer,
-# and run the same example with -h to get command line options.
+# You can now repeat the process on another computer,
+# and run the same example with -h to get command line options.
 python3 Examples/Echo.py -h
 
-# Run the example in client mode to "ping" the server.
-# Replace the hash below with the actual destination hash of your server.
+# Run the example in client mode to "ping" the server.
+# Replace the hash below with the actual destination hash of your server.
 python3 Examples/Echo.py 3e12fc71692f8ec47bc5
 
-# Have a look at another example
-python3 Examples/Filetransfer.py -h
-
      
-
-
      The default config file contains examples for using Reticulum with LoRa transceivers (specifically RNode), packet radio TNCs/modems and UDP. By default a UDP interface is already enabled in the default config, which will enable Reticulum communication in your local ethernet broadcast domain.
      
-
      You can use the examples in the config file to expand communication over other mediums such as packet radio or LoRa, or over fast IP links using the UDP interface. I’ll add in-depth tutorials and explanations on these topics later. For now, the included examples will hopefully be enough to get started.
      
-
      Caveat Emptor
      
-
      Reticulum is alpha software, and should be considered experimental. 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. If you want to help out, or help sponsor an audit, please do get in touch.
\ No newline at end of file +# Have a look at another example +python3 Examples/Filetransfer.py -h +

The default config file contains examples for using Reticulum with LoRa transceivers (specifically RNode), packet radio TNCs/modems and UDP. By default a UDP interface is already enabled in the default config, which will enable Reticulum communication in your local ethernet broadcast domain.

+

You can use the examples in the config file to expand communication over other mediums such as packet radio or LoRa, or over fast IP links using the UDP interface. I'll add in-depth tutorials and explanations on these topics later. For now, the included examples will hopefully be enough to get started.

+

+Caveat Emptor

+

Reticulum is experimental 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-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.

+
\ No newline at end of file diff --git a/README.md b/README.md index c62658c..33410a5 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ Reticulum Network Stack α ========== -Reticulum is a cryptography-based networking stack for high-latency, wide-area networks built on readily available hardware. Reticulum allows you to build very 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 cryptography-based networking stack for wide-area networks built on readily available hardware, and can operate even with very high latency and extremely low bandwidth. Reticulum allows you to build very 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 use IP or higher layers, although it is easy to utilise IP (with TCP or UDP) as the underlying carrier for Reticulum. +Reticulum is a complete networking stack, and does not use 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. Having no dependencies on traditional networking stacks free up overhead that has been utilised to implement a networking stack built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks. @@ -22,22 +22,25 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects - IVs are generated through os.urandom() - Unforgeable packet delivery confirmations - A variety of supported interface types - - Efficient and easy resource transfers - An intuitive and easy-to-use API + - Reliable and efficient transfer of arbritrary amounts of data + - Reticulum can handle a few bytes of data or files of many gigabytes + - Sequencing, transfer coordination and checksumming is automatic + - The API is very easy to use, and provides transfer progress ## Where can Reticulum be used? -On practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for. +On practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, ad-hoc WiFi, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for. -An open-source LoRa-based interface called [RNode](https://unsigned.io/projects/rnode/) has been designed specifically for use with Reticulum. It is possible to build yourself, or 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://unsigned.io/projects/rnode/) has been designed specifically for use with Reticulum. It is possible to build yourself, or it can be purchased as a complete transceiver that just needs a USB connection to the host. Reticulum can also be encapsulated over existing IP networks, so there's nothing stopping you from using it over wired ethernet or your local WiFi network, where it'll work just as well. In fact, one of the strengths of Reticulum is how easily it allows you to connect different mediums into a self-configuring, resilient and encrypted mesh. As an example, it's possible to set up a Raspberry Pi connected to both a LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are configured, Reticulum will take care of the rest, and any device on the WiFi network can communicate with nodes on the LoRa and packet radio sides of the network, and vice versa. ## Current Status -Consider Reticulum experimental at this stage. Most features are implemented and working, but at this point the protocol may still change significantly, and is made publicly available for development collaboration, previewing and testing. +Consider Reticulum in extended testing at this stage. All core protocol features are implemented and functioning, but additions and changes can still occur if it is warranted. -An API- and wireformat-stable alpha release is coming in the near future. Until then expect things to change unexpectedly if something warrants it. +An API- and wireformat-stable beta is near at hand. ## Supported interface types and devices @@ -74,7 +77,7 @@ If you just need Reticulum as a dependency for another application, the easiest pip3 install rns ``` -For development, you might want to get the latest source from GitHub. In that case, don't use pip, but try this recipe: +For Reticulum development, you might want to get the latest source from GitHub. In that case, don't use pip, but try this recipe: ```bash # Install dependencies @@ -114,4 +117,4 @@ The default config file contains examples for using Reticulum with LoRa transcei You can use the examples in the config file to expand communication over other mediums such as packet radio or LoRa, or over fast IP links using the UDP interface. I'll add in-depth tutorials and explanations on these topics later. For now, the included examples will hopefully be enough to get started. ## Caveat Emptor -Reticulum is alpha software, and should be considered experimental. 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. If you want to help out, or help sponsor an audit, please do get in touch. \ No newline at end of file +Reticulum is experimental 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-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch. \ No newline at end of file diff --git a/setup.py b/setup.py index 357a8f7..699eb04 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ with open("README.md", "r") as fh: setuptools.setup( name="rns", - version="0.1.6", + version="0.1.7", author="Mark Qvist", author_email="mark@unsigned.io", description="Self-configuring, encrypted and resilient mesh networking stack for LoRa, packet radio, WiFi and everything in between",