Updated roadmap

2022-12-29 14:33:08 +01:00 · 2022-12-29 14:33:08 +01:00 · 4ab3074d30
commit 4ab3074d30
parent 4de612e2fb
1 changed files with 508 additions and 1 deletions
--- a/Roadmap.md
+++ b/Roadmap.md
@ -258,4 +258,511 @@ This maintenance release includes the `rnodeconf` utility directly in the `rns`
 ```
 dc0c56950b85be763270695faf441029f7e6c31cdc44447c6c470e09c734aa45 rns-0.3.18-1-py3-none-any.whl
 760bfc52419a8c45a420df41c40a1bf96bd494dabd7efe461c7907b152bbf39c rnspure-0.3.18-1-py3-none-any.whl
-```
+```
 ### 2022-11-03: RNS β 0.3.17
 This maintenance release fixes a regression in the 0.3.16 release.
 **Changes**
 - Fixed an incorrect import that inadverdently caused Android-specific interfaces to be used on non Android operating systems.
 **Release Hashes**
 ```
 SHA256 0e8327461e2d39f859059cc14e94fb33f21e1186c422bb766950f42ca1387656 rns-0.3.17-py3-none-any.whl
 SHA256 9e31160cc38e0d5531460d5eca7b3f6e6d8c3b2a7afb04338ee72cc488a2ba18 rnspure-0.3.17-py3-none-any.whl
 ```
 ### 2022-10-20: RNS β 0.3.16
 This maintenance release fixes a single bug that prevented running RNS in Termux (and similar) on Android.
 **Changes**
 - Fixed missing imports and module checks for API-limited environments on Android
 **Release Hashes**
 ```
 SHA256 dc4202302b1f1503a0f1c8fef7123b31f7d5d7131ae5b9f988064ebe22e29ed8 rns-0.3.16-py3-none-any.whl
 SHA256 127624d2592745602d4a056c347fa6f5989f049275a5b8bfa97c296af9bc497f rnspure-0.3.16-py3-none-any.whl
 ```
 ### 2022-10-20: RNS β 0.3.15
 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
 **Release Hashes**
 ```
 SHA256 c56f32dbfd10fae1b5d2dddafe7d2a0f2127908827a71fce9e43fd051ea453bc rns-0.3.15-py3-none-any.whl
 SHA256 597d6df05b3586eaa1515c0215cec30d7a018a209e7900634345c39514efcd18 rnspure-0.3.15-py3-none-any.whl
 ```
 ### 2022-10-07: RNS β 0.3.14
 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.
 - Minor updates to documentation
 **Release Hashes**
 ```
 SHA256 b761efc24d20c5719817bfefbbe8ce69f7c91d65bb8273cb02578f77d6f88bc5 rns-0.3.14-py3-none-any.whl
 SHA256 cc24a1f010431c8f193ec0ffc6dccade614a5be40c47ac12e3e9ae60b52f046e rnspure-0.3.14-py3-none-any.whl
 ```
 ### 2022-10-04: RNS β 0.3.13
 This maintenance release includes a single but important bugfix.
 **Changes**
 - Fixed missing hash construction step in announce emission and validation
 **Release Hashes**
 ```
 SHA256 d6c8a7cb8ea7edc99800df92abff246e8159f2d9c9f1a2b57672385d49647c90 rns-0.3.13-py3-none-any.whl
 SHA256 c07c28942e374342c4e807a0b6e81d831737b87cf59651670b8c1c191030a326 rnspure-0.3.13-py3-none-any.whl
 ```
 ### 2022-09-30: RNS β 0.3.12
 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
 - Implemented better config directory path handling
 - Clarifications and improvements to various documentation chapters
 - Improved writing quality of documentation, courtesy of @huyndao
 - Improved overall presentation of documentation and manual
 - Improved reliability of data persistence in case of unexpected shutdowns or hardware crashes
 - Added rnsd warning on start as client
 - Fixed a rendering bug in the rnpath utility
 - Added initial connection timeout configuration option to TCP Client interfaces
 - Brought deprecated native python API calls up to date
 **Release Hashes**
 ```
 SHA256 74a4881ebf8d805bffb43efef91769b1cbb87affe56ac630355946c7484cffbf rns-0.3.12-py3-none-any.whl
 SHA256 03429122b3b4133667632ba2404df7bbf57ea5df1b9c815d7608b1d59cd29a76 rnspure-0.3.12-py3-none-any.whl
 ```
 ### 2022-07-09: RNS β 0.3.11
 This maintenance release contains a single but important bug fix in resource transfers.
 **Changes**
 - Fixed a an incorrect size calculation for resource advertisements, that would lead to resources of specific sizes failing with an MTU error.
 **Release Hashes**
 ```
 SHA256 7c03a003326bcd127226414b08cf48f87bcc6b88a7279c52e28415315668543c rns-0.3.11-py3-none-any.whl
 SHA256 1a6aaa3ba370ece28cc975ba94b0461c61497cf0797f92662472e0ec20576cb1 rnspure-0.3.11-py3-none-any.whl
 ```
 ### 2022-07-08: RNS β 0.3.10
 This maintenance release contains a single but important bug fix for systems running Reticulum Transport Instances.
 **Changes**
 - Fixed a potential race condition in link establishment flow, that could lead to links not being established over hops with very low latency.
 **Release Hashes**
 ```
 SHA256 1c9fb56b967aed507694e6b5d5fca7a89b022cad9fa2058d248e359dc150fba7 rns-0.3.10-py3-none-any.whl
 SHA256 8eae07f9e6241ea1f3778430456225dee3ef73bb1c4df5e5362dd00226404628 rnspure-0.3.10-py3-none-any.whl
 ```
 ### 2022-07-05: RNS β 0.3.9
 This release expands the address space of Reticulum to 128 bits, and brings improvements to the documentation, along with a few bugfixes and updates.
 **Changes**
 - Expanded address space to 128 bits
 - Updated documentation
 - Improved rnx interactive mode
 - Improved readme file
 - Added reticulum.network website
 - Added periodic cache cleaning
 - Fixed a bug in the --no-auth option in rncp
 **Release Hashes**
 ```
 SHA256 892005e95fc9eda4c4c5d9f94dd33cdc27d3ac6e228d1b0b2519e35069951b86 rns-0.3.9-1-py3-none-any.whl
 SHA256 cb7d873c51c746ecdb8963a6a7a0e8d010fb6c61ee785c5e97376d3779a7bae8 rnspure-0.3.9-1-py3-none-any.whl
 ```
 ### 2022-06-22: RNS β 0.3.8
 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 unknown path discovery
 - Implemented recursive path request loop avoidance
 - 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.
 ### 2020-04-28: RNS α 0.0.8
 This was a pre-release alpha version. No changelog available.