This maintenance release fixes a number of bugs, improves path requests and responses, and adds several useful features and capabilities. Thanks to @cobraPA, @jschulthess, @thiaguetz and @nothingbutlucas who contributed to this release!
This release adds the ability to specify custom firmware URLs for flashing boards with `rnodeconf`. Thanks to @attermann who contributed to this release!
**Changes**
- Added ability to specify custom firmware URLs for flashing boards with `rnodeconf`
This release adds support for RNodes based on SX1262, SX1268 and SX1280 modems, and fixes a number of bugs. Thanks to @jacobeva, who contributed to this release!
**Changes**
- Added support for SX1262, SX1268 and SX1280 based RNodes
- Updated `rnodeconf` to allow flashing T-Beam devices with SX126x chips
This release brings a series of under-the-hood reliability improvements and bugfixes. But most notably, Reticulum can now establish links over even ultra low bandwidth mediums, all the way down to 5 bits per second.
Thanks to @jschulthess, who contributed to this release!
**Changes**
- Implemented link establishment on ultra low bandwidth links
- Added link quality calculations to RNode interfaces
- Added physical layer link stats to Link and Packet classes
- Added userspace service documentation to the manual
- Improved path rediscovery in quickly changing topographies
- Improved shared interface reconnection on service restart
- Improved exception handling on interface detachment
- Updated formatted print functions
**Bugfixes**
- Fixed a missing USB command definition in the RNode interface driver
- Fixed a bug in link error handling that could cause an interface to detach
This maintenance release adds the ability to specify the shared instance RPC key in the Reticulum config file, making it possible to use all Reticulum functionality in the terminal on Android.
This release brings a number of bugfixes, along with useful new mechanisms for ensuring network stability under high, non-constructive and unusual announce load situation.
**Changes**
- Added announce ingress rate control for new and unknown destinations
- Added per-interface announce frequency monitoring to the transport engine
- Added per-interface announce burst hold queues
- Added announce frequency statistics to `rnstatus`
- Added option to sort `rnstatus` output according to various metrics
- Added timeout options to `rnprobe`
- Added ability to drop all paths via a specific transport instance to `rnpath`
- Added new options and features to documentation and manual
**Bugfixes**
- Fixed announce queue not clearing all announces with exceeded retry limit at the same time
- Fixed a bug that caused local packet RSSI and SNR cache to get stuck
- Fixed output formatting in `rncp`
- Fixed `rnid` not allowing single-aspect destination names
This release brings major efficiency improvements to `Channel` and `Buffer` classes, adds a range of usability improvements to the included utilities and fixes a number of bugs.
This maintenance release brings a number of bugfixes and improvements.
**Important!** This release breaks backwards compatibility with `Channel` and `Buffer` for all previous releases, due to the addition of compression and windowing.
**Changes**
- Added ability to trust external signing keys to `rnodeconf`
- Added basic windowing to `Channel` and `Buffer`, improving performance over faster links
- Added per-packet compression to `Channel`
- Added automatic multi-interface duplicate deque to AutoInterface
- Fixed received link packet proofs not resetting link watchdog stale timer
- Fixed a missing exception isolation of packet delivery callbacks
This release brings two major new additions to the Reticulum API: The Channel and Buffer classes, that provides reliable delivery, and streams over Reticulum. Thanks to @acehoss, @erethon, @gdt and @faragher, who contributed to this release!
**Changes**
- Added the Buffer class to the API
- Added the Channel class to the API
- Improved error messages for offline RNode flashing
- Improved RNode reconnection when serial device disappears
- Fixed embedded scope identifier handling for AutoInterface on BSD
- Fixed AutoInterface not ignoring lo0 on BSD
- Fixed a bug causing JSON output from rnstatus to fail
- Fixed invalid installation of test suite into root module path
This release introduces the useful `rnid` utility, which makes it possible to use Reticulum Identities for offline file encryption, decryption, signing and validation. The IFAC system has also been significantly improved, and several outdated parts of the documentation was updated and fixed. Thanks to @Erethon and @jooray who contributed to this release!
**Changes**
- Added header and payload masking to the IFAC system
- Added `rnid` utility for encrypting, decrypting, signing and validating with Reticulum Identities
- Added Bluetooth pairing PIN output to `rnodeconf` utility
- Fixed a bug in announce callback handling
- Fixed a inconsistency in header flag handling since IFACs were introduced
This maintenance release adds support for using the `rnodeconf` utility to replicate RNode devices, and bootstrap device creation using only tools and software packages obtained from an RNode Bootstrap Console.
**Changes**
- Added the ability to use rnodeconf to bootstrap RNode creation without needing a connection to the Internet
- Added ability for rnodeconf to extract firmwares from existing RNodes
- Added ability for rnodeconf to use extracted firmwares for autoinstaller and updates
This maintenance release significantly improves path rediscovery on roaming devices with multiple interfaces, and adds a few tweaks to interface handling, that are especially relevant on Android.
**Changes**
- Faster roaming path recovery for multiple interface non-transport instances
- Fixed AutoInterface multicast echoes failing on interfaces with rolling MAC addresses on every re-connect
- Added carrier change detection flag to AutoInterface
This maintenance release includes the `rnodeconf` utility directly in the `rns` package, and brings a few improvements to interface handling and hardware interfacing.
**Important!** The minimum supported RNode firmware version for this release is `1.51`, and the firmware will needs to be updated with `rnodeconf` version `2.0.0` or greater, since earlier versions won't be able to fetch the new release files.
**Changes**
- Added `rnodeconf` utility
- Added more options for controlling log output
- Added ability to write to the external framebuffer of RNode devices
This maintenance release primarily adds support for external hardware interfaces on Android. A number of bugs have also been fixed, and improvements made to logging output consistency.
**Changes**
- Added support for RNode interfaces on Android
- Added support for KISS interfaces on Android
- Added support for Serial interfaces on Android
- Added AutoInterface support for kernel network devices that rotate MAC addresses on roaming and/or reconnects
- Updated various helper functions
- Minor log output cleanup and fixes
- Fixed missing lookup for locally running destinations in Identity.recall() when running as a shared transport instance
- Fixed missing announce cap property on hot-plugged interfaces
- Fixed incorrect behaviour in announce processing for instance-local destinations to roaming- or boundary-mode interfaces
This maintenance release brings a few improvements, including optimised announce packet structure and updated documentation.
**Please note!** While this is a small maintenance release, it includes changes to packe structure that breaks backwards compatibility with all previous RNS versions.
**Changes**
- Optimised announce packet structure
- Reject mismatching public keys on hash collision.
This maintenance release includes a fix to the [serious security flaw discussed here](https://github.com/markqvist/Reticulum/discussions/103). **Please Note!** Updating to RNS 0.3.12 will intentionally break backwards compatibility with all previous verstions for link establishment. It is recommended to upgrade all your systems to 0.3.12 as soon as possible.
Additionally, this release brings a range of small, but very useful improvements to reliability and user experience, along with a significant update to the documentation material.
**Changes**
- Fixed a [serious security flaw](https://github.com/markqvist/Reticulum/discussions/103) in link establishment key exchanges
- Allow hot-plug of RNode devices
- Better detachment handler for TCP clients on shutdown
This release brings big improvements to compatibility with various system types, along with several convenient new features, and a lot of tuning, optimisation and stability improvements. In a continued effort, the documentation has also been updated, restructured, and had several new and informative sections added.
**Changes**
- Added ability to install and run RNS without any dependencies
- Added backend abstraction for cryptographic primitives
- Added pure-python implementations of all cryptographic primitives
- Added accept option to Link API
- Added several undocumented API calls to the documentation
- Added option to filter interfaces to rnstatus utility
- Added "Communications Hardware" chapter to the documentation
- Improved multiple chapters and restructured documentation
- Improved efficiency of Transport instances
- Improved performance of Resource transfers
- Improved Resource handling strategies over different physical link types
- Improved link capacity and speed estimation calculations
- Improved I2P interface error handling and stability
- Tuned Resource and Link timeouts
- Tuned TCP socket options for better reliability over intermittent links
- Tuned I2P interface timeouts for better reliability over intermittent links
- Fixed a missing check for zero-length packets on IFAC-enabled interfaces
- Fixed a socket allocation leak in I2P interfaces
- Added unit tests
- Added performance profiling tools
- Improved build system
Release SHA-256 for `rns-0.3.8-py3-none-any.whl` is `fdb53aba14840edf3d71dde1a745f319e7f60d6993851b7651bf8ba3d5c53ba7`
Release SHA-256 for `rnspure-0.3.8-py3-none-any.whl` is `b0eb004c3725bc20496b1c855e7d22729d8a39fd0cde957ab95aa8c7e13ee3a4`
### 2022-05-29: RNS β 0.3.7
This release comes with a big upgrade to reliability and resilience, with lots of small bug fixes and improvements, along with some significant new additions and features. The documentation and API reference has also seen several improvements for clarity.
Users of I2P interfaces will see big improvements in reliability with better handling of errors from the I2P SAM API, and much better automatic recovery when I2P connectivity is intermittent.
Reticulum is now able to perform network-wide discovery of unknown paths, using the new Gateway interface mode. The stability of established links has also been improved by using a better timeout calculation method.
It is also worth mentioning the addition of the two new utilities, `rncp` and `rnx`, that allow you to transfer files to remote systems, and perform remote command execution.
*Please Note!* For using 64-bit IFACs on RNode hardware, your RNodes must be running at least firmware version 1.28.
**Changes**
- Added gateway interface mode
- Added `rncp` utility for transferring files to remote destinations
- Added `rnx` utility for remotely executing commands and returning output
- Implemented bandwidth cap for recursive path requests
- Improved Link authentication callbacks
- Improved Link stale time calculations and process
- Improved error detection and handling in I2P interfaces
- Improved automatic recovery and reliability on intermittent I2P interfaces
- Added request size to receipts, and updated relevant API documentation
- Added default identity storage folder
- Fixed deprecated options in libi2p's asyncio calls
- Fixed I2P controller startup when event loop is not immediately ready
- Fixed bug in conditional resource acceptance callback
- Fixed an invalid interface mode check
- Fixed missing recursive progress callback allocation in segmented resource transfer
- Fixed expired AP and Roaming interface mode paths not being removed at the correct time
- Fixed announce rate targets not being set on I2PInterface peers
- Fixed naming conflict in resource advertisements
- Fixed link stale time calculation on newly created links without any actual traffic
- Fixed a bug that caused large packets (over 492 bytes) with IFAC enabled to be dropped on RNode hardware
- Improved output of `rnstatus` utility
- Improved Destination and Link API documentation
- Updated documentation and readme
Release SHA-256 for Python Wheel is `2cd9a584d6b13bb478a43b49b7de3f2a8270c4b8979666b1ca40cd81daacbf42`
### 2022-05-17: RNS β 0.3.6
This release adds a number of improvements, a new interface type, and some very useful new interface modes.
**Changes**
- Added PipeInterface, create interfaces with any program over stdio
- Added "roaming" and "boundary" interface modes
- Added per-interface announce rate control
- Added ability to drop announce queues to rnpath utility
- Added announce rate information output to rnpath utility
- Improved announce queue processing
- Improved several documentation chapters
- Improved logging output
### 2022-04-28: RNS β 0.3.5
This release brings major improvements and upgrades to Reticulum, along with better documentation and improved usability of the bundled utilities.
**Changes**
- Greatly improved convergence time. Even on huge networks, newly created destinations become globally reachable in less than a minute.
- New announce propagation mechanism allows flexible scalability. Extremely slow network segments can now interconnect seamlessly with huge, high-bandwidth networks while still prioritising end-to-end connectivity for local nodes.
- Reticulum can now scale to huge and complex networks with up to 128 hops, and billions of active endpoints.
- Added virtual network segmentation for running multiple virtual networks over the same physical channel.
- Added interface authentication for creating private access network interfaces and access points.
- Updated documentation in accordance with current implementation of announce propagation mechanism.
- Updated several outdated documentation chapters.
- Added documentation for new interface features.
- The output display of the rnstatus utility has been greatly improved.
- Added ability to drop paths to the rnpath utility.
- Added path table display to rnpath utility.
- Added interface rate determination and estimation.
- Added configurable bandwidth allocation for announce traffic.
- Improved and cleaned logging output.
- Various Transport optimisations.
- Improved AutoInterface peering timing.
- Updated manual in accordance with release.
- Fixed a possible race condition in Transport startup when a local shared instance was restarted and apps reconnected.
### 2022-03-28: RNS β 0.3.4
This is a small maintenance release with a bugfix and some documentation and reliability improvements.
**Changes**
- Fixed https://github.com/markqvist/Reticulum/issues/18 that could potentially cause a routing loop if the API was used in an unintended way
- Improved cryptography API compatibility
- Improved documentation
### 2022-02-26: RNS β 0.3.3
This release adds major new functionality to Reticulum, including new connectivity options, improves stability, simplifies configuration and fixes a few bugs.
**Improvements**
- Added the I2P Interface to Reticulum
- Added I2P tunneling support for TCP interfaces
- Improved recovery of AutoInterface on underlying medium carrier loss
- Improved AutoInterface timeouts and timing
- Enabled the "outbound" interface option as on by default
- Added the "Access Point" interface mode
- Simplified default configuration
- Added verbose configuration example to the "rnsd" program
- Improved documentation and manual
- Fixed a potential race condition in resource assembly
- Fixed a reference error in TCP interfaces
- Fixed a configuration keyword error
### 2022-01-28: RNS β 0.3.2
This maintenance release adds support for using a much wider range of devices as RNode LoRa interfaces with Reticulum, and also contains a few bugfixes and improvements.
**Important!** From this release, RNodes used with Reticulum must have at least firmware version 1.26 installed, due to the new multiplatform RNode support.
**Improvements**
- Added full support for RNodes based on ESP32 and ATmega2560 boards
- Fixed a bug in TCP interfaces on macOS
- Updated documentation and manual
### 2022-01-26: RNS β 0.3.1
This is a small maintenance and update release of Reticulum, including a few improvements. It also adds support for using ESP32-based T-Beam devices.
Improvements:
- Added support for using T-Beam devices using the RNodeInterface
- Improved AutoInterface on Android
- Improved platform handling
- Improved malformed packet handling
### 2021-12-11: RNS β 0.3.0
This is a major release of Reticulum, including a range of stability and performance improvements, along with important new features, expanding the connectivity of Reticulum.
An important improvement in this release is the addition of the AutoInterface, that will now be configured as the default interface on new installs. This interface automatically meshes with other Reticulum peers over any available system network devices, and doesn't require any existing IP infrastructure like a DHCP server or a router. For more information, consult the relevant section of the manual.
**Improvements**
- Added new AutoInterface as default interface for new installs
- Serial port interfaces now automatically attempt to reconnect devices that are unplugged and replugged
- Added support for KISS over TCP in the TCPClientInterface
- Added support for running Reticulum as a systemd service
- Initial support for the Android operating system
- Added documentation for installing Reticulum on Android in Termux
- Improved documentation and manual
- Better path request handling for shared instances
- Better shutdown handling on external interrupts
- Many small stability and reliability improvements
- Fine-tuned various timing parameters for different link types
### 2021-10-15: RNS β 0.2.9
This beta release adds the fundamentals of RSSI and SNR functionality. It also implements timing improvements, allowing Reticulum to function on even lower bitrate physical links.
**Improvements**
- Added RSSI and SNR reporting on supported interfaces
- Added RSSI and SNR to rnprobe utility
- Added RSSI and SNR to Echo example
- Support for physical layer throughput down to 500 bits per second.
- Improved callback handling
### 2021-10-10: RNS β 0.2.8
This beta release brings a single, but important improvement. Paths are now updated much more fluidly for peers moving around the network.
Since updates were made to how tunnels and path table entries are represented in this release, it is recommended to delete the following files on Transport Nodes:
~/.reticulum/storage/destination_table
~/.reticulum/storage/packet_hashlist
~/.reticulum/storage/tunnels
~/.reticulum/storage/cache/*
The files will be recreated when Reticulum is started.
**Improvements**
- Improved path updates for peers moving around the network
### 2021-10-08: RNS β 0.2.7
This beta release brings a range of stability improvements and one bugfix.
**Improvements**
- Improved output of the rnstatus utility
- Improved shared instance and local client handling
- Improved documentation
- Improved path restoration on tunnels
- Added log rotation
**Fixed bugs**
- Fixed incorrect interface detachment on TCP client interfaces
### 2021-09-25: RNS β 0.2.6
This beta release brings a range of improvements and a few bugfixes.
**Improvements**
- Added the "rnsd" utility for running Reticulum as a service
- Added the "rnstatus" utility for viewing interface status
- Added the "rnpath" utility for path lookups
- Added the "rnprobe" utility for testing connectivity
- Documentation has been improved and expanded
- Improved shutdown handling for shared instances
- Improved default configuration
- Improved recovery of TCP interfaces over unreliable links
**Fixed bugs**
- Fixed a bug in reverse table culling
- Fixed a regression in TCP interface client spawner
### 2021-09-18: RNS β 0.2.5
This beta release brings a range of improvements and bugfixes.
**Improvements**
- Added endpoint tunneling for path restoration over intermittent or roving link layer connections.
- Added ability for TCP client interfaces to automatically reconnect if TCP socket drops.
- Improved link teardown handling.
- Improved interface error handling on non-recoverable / hardware errors.
**Fixed bugs**
- Fixed a bug that could cause path table entries to be culled two times in rare cases.
- Fixed a bug that could lead to the "outgoing" directive of interface configuration entries not being parsed correctly.
### 2021-09-11: RNS β 0.2.4
This beta release brings a range of improvements and bugfixes.
**Improvements**
- Increased link MDU from 415 to 431 bytes by optimising transfer of Fernet tokens.
- All data lengths are now calculated dynamically from Reticulums base MTU, laying the groundwork for dynamic MTU interoperability.
- Disabled option to allow unencrypted links.
- Improved documentation.
- Improved request timeouts and handling.
- Improved link establishment.
- Improved resource transfer timing.
**Fixed bugs**
- Fixed a race condition in inbound proof handling.
- Fixed sequencing errors caused by duplicate HMU/request packets not being filtered.
### 2021-08-29: RNS β 0.2.3
This beta release brings a range of improvements and bugfixes.
**Improvements**
- Improved resource handling.
- Improved timeout calculation for packets, links, resources and requests.
- Improved announce handling for shared instances.
- Improved default configuration template.
- Added example "Speedtest".
**Fixed bugs**
- Fixed an issue that caused request timeout even though response had occurred.
- Fixed an issue that caused identity files to be written incorrectly.
- Fixed resource sequencing errors not being handled gracefully.
### 2021-08-21: RNS β 0.2.2
This beta release brings several new features to Reticulum along with two bugfixes.
IMPORTANT! This version breaks wire-format compatibility with all previous versions of Reticulum. You must update *all* of your nodes at the same time.
**New features**
- Link initiators can now identify to the remote peer over the link, once it has been set up. This can be used for authentication, amongst other things.
- Requests and responses of arbitrary sizes can now be carried out over links.
- UDP and TCP interfaces can now be bound to network device names (eth0, wlan0, etc.) instead of manually specifying listen IPs.
**Fixed bugs**
- Fixed a race condition in outbound transport packet filtering.
- Fixed an issue where local UDP broadcast echoes could get processed as inbound packets.
### 2021-05-20: RNS β 0.2.1
This beta release sees significant improvements to bandwidth utilization and efficiency, while improving security by dropping RSA and moving completely to Curve25519.
- All asymmetric cryptography migrated to X25519/Ed25519. This has greatly improved efficiency and reduced protocol overhead significantly.
- Work has continued on the documentation, and the "Understanding Reticulum" chapters have been improved significantly in this release.
- Class methods dealing with setting callbacks have been renamed to be more intuitive.
As a few examples of the improved efficiency, a complete link establishment now only costs 240 bytes, down from 409 in the previous RSA version. An announce takes up 151 bytes vs 323.
### 2021-05-18: RNS β 0.2.0
This is the first beta release of RNS. This release also marks the publication of the Reticulum documentation, manual, and API documentation. All core features of Reticulum are now implemented, functional and ready to use in external programs. The wire-format and API will only change if there is a very good reason, though internals are still likely to be altered and optimised, and features are likely to be added.
### 2021-05-13: RNS α 0.1.9
This was a pre-release alpha version. No changelog available.
### 2020-08-13: RNS α 0.1.8
This was a pre-release alpha version. No changelog available.
### 2020-08-13: RNS α 0.1.7
This was a pre-release alpha version. No changelog available.
### 2020-06-10: RNS α 0.1.6
This was a pre-release alpha version. No changelog available.
### 2020-06-09: RNS α 0.1.5
This was a pre-release alpha version. No changelog available.
### 2020-05-29: RNS α 0.1.4
This was a pre-release alpha version. No changelog available.
### 2020-05-21: RNS α 0.1.3
This was a pre-release alpha version. No changelog available.
### 2020-05-15: RNS α 0.1.2
This was a pre-release alpha version. No changelog available.
### 2020-05-14: RNS α 0.1.1
This was a pre-release alpha version. No changelog available.
### 2020-05-12: RNS α 0.1.0
This was a pre-release alpha version. No changelog available.
### 2020-04-28: RNS α 0.0.9
This was a pre-release alpha version. No changelog available.
The first commit to the Reticulum reference implementation was 9a9630cfd29e11ace3f12716ddb4dff0e5419b4b, which occurred on Sunday, the 29th of May 2016.
