mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-16 19:00:14 +00:00
Fixed additional spelling errors
This commit is contained in:
parent
30e75b1bfb
commit
b230edd21d
188
README.md
188
README.md
@ -3,15 +3,34 @@ Reticulum Network Stack β
|
|||||||
|
|
||||||
<p align="center"><img width="200" src="https://unsigned.io/wp-content/uploads/2022/03/reticulum_logo_512.png"></p>
|
<p align="center"><img width="200" src="https://unsigned.io/wp-content/uploads/2022/03/reticulum_logo_512.png"></p>
|
||||||
|
|
||||||
Reticulum is the cryptography-based networking stack for wide-area networks built on readily available hardware. It can operate even with very high latency and extremely low bandwidth. Reticulum allows you to build wide-area networks with off-the-shelf tools, and offers end-to-end encryption and connectivity, initiator anonymity, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable delivery acknowledgements and more.
|
Reticulum is the cryptography-based networking stack for wide-area networks
|
||||||
|
built on readily available hardware. It can operate even with very high latency
|
||||||
|
and extremely low bandwidth. Reticulum allows you to build wide-area networks
|
||||||
|
with off-the-shelf tools, and offers end-to-end encryption and connectivity,
|
||||||
|
initiator anonymity, autoconfiguring cryptographically backed multi-hop
|
||||||
|
transport, efficient addressing, unforgeable delivery acknowledgements and
|
||||||
|
more.
|
||||||
|
|
||||||
The vision of Reticulum is to allow anyone to be their own network operator, and to make it cheap and easy to cover vast areas with a myriad of independent, inter-connectable and autonomous networks. Reticulum **is not** *one* network. It is **a tool** for building *thousands of networks*. Networks without kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate with each other, and require no central oversight. Networks for human beings. *Networks for the people*.
|
The vision of Reticulum is to allow anyone to be their own network operator,
|
||||||
|
and to make it cheap and easy to cover vast areas with a myriad of independent,
|
||||||
|
inter-connectable and autonomous networks. Reticulum **is not** *one* network.
|
||||||
|
It is **a tool** for building *thousands of networks*. Networks without
|
||||||
|
kill-switches, surveillance, censorship and control. Networks that can freely
|
||||||
|
interoperate, associate and disassociate with each other, and require no
|
||||||
|
central oversight. Networks for human beings. *Networks for the people*.
|
||||||
|
|
||||||
Reticulum is a complete networking stack, and does not rely on IP or higher layers, but it is possible to use IP as the underlying carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the Internet or private IP networks.
|
Reticulum is a complete networking stack, and does not rely on IP or higher
|
||||||
|
layers, but it is possible to use IP 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 frees up overhead that has been used to implement a networking stack built directly on cryptographic principles, allowing resilience and stable functionality, even in open and trustless networks.
|
Having no dependencies on traditional networking stacks frees up overhead that
|
||||||
|
has been used to implement a networking stack built directly on cryptographic
|
||||||
|
principles, allowing resilience and stable functionality, even 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.
|
No kernel modules or drivers are required. Reticulum runs completely in
|
||||||
|
userland, and can run on practically any system that runs Python 3.
|
||||||
|
|
||||||
## Read The Manual
|
## Read The Manual
|
||||||
The full documentation for Reticulum is available at [markqvist.github.io/Reticulum/manual/](https://markqvist.github.io/Reticulum/manual/).
|
The full documentation for Reticulum is available at [markqvist.github.io/Reticulum/manual/](https://markqvist.github.io/Reticulum/manual/).
|
||||||
@ -44,24 +63,44 @@ For more info, see [unsigned.io/projects/reticulum](https://unsigned.io/projects
|
|||||||
- Low cost of keeping links open at only 0.44 bits per second
|
- Low cost of keeping links open at only 0.44 bits per second
|
||||||
|
|
||||||
## Examples of Reticulum Applications
|
## Examples of Reticulum Applications
|
||||||
If you want to quickly get an idea of what Reticulum can do, take a look at the following resources.
|
If you want to quickly get an idea of what Reticulum can do, take a look at the
|
||||||
|
following resources.
|
||||||
|
|
||||||
- [LXMF](https://github.com/markqvist/lxmf) is a distributed, delay and disruption tolerant message transfer protocol built on Reticulum
|
- [LXMF](https://github.com/markqvist/lxmf) is a distributed, delay and disruption tolerant message transfer protocol built on Reticulum
|
||||||
- For an off-grid, encrypted and resilient mesh communications platform, see [Nomad Network](https://github.com/markqvist/NomadNet)
|
- For an off-grid, encrypted and resilient mesh communications platform, see [Nomad Network](https://github.com/markqvist/NomadNet)
|
||||||
- The Android, Linux and macOS app [Sideband](https://unsigned.io/sideband) has a graphical interface and focuses on ease of use.
|
- The Android, Linux and macOS app [Sideband](https://unsigned.io/sideband) has a graphical interface and focuses on ease of use.
|
||||||
|
|
||||||
## Where can Reticulum be used?
|
## Where can Reticulum be used?
|
||||||
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, WiFi and Ethernet devices, free-space optical links, and similar systems are all examples of the types of physical devices Reticulum can use.
|
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,
|
||||||
|
WiFi and Ethernet devices, free-space optical links, and similar systems are
|
||||||
|
all examples of the types of physical devices Reticulum can use.
|
||||||
|
|
||||||
An open-source LoRa-based interface called [RNode](https://markqvist.github.io/Reticulum/manual/hardware.html#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.
|
An open-source LoRa-based interface called
|
||||||
|
[RNode](https://markqvist.github.io/Reticulum/manual/hardware.html#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, your local WiFi network or the Internet, 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, using any available mixture of available infrastructure.
|
Reticulum can also be encapsulated over existing IP networks, so there's
|
||||||
|
nothing stopping you from using it over wired Ethernet, your local WiFi network
|
||||||
|
or the Internet, 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, using any available mixture of
|
||||||
|
available infrastructure.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
## How do I get started?
|
## How do I get started?
|
||||||
The best way to get started with the Reticulum Network Stack depends on what
|
The best way to get started with the Reticulum Network Stack depends on what
|
||||||
you want to do. For full details and examples, have a look at the [Getting Started Fast](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
you want to do. For full details and examples, have a look at the
|
||||||
|
[Getting Started Fast](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html)
|
||||||
|
section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
||||||
|
|
||||||
To simply install Reticulum and related utilities on your system, the easiest way is via pip:
|
To simply install Reticulum and related utilities on your system, the easiest way is via pip:
|
||||||
|
|
||||||
@ -69,31 +108,47 @@ To simply install Reticulum and related utilities on your system, the easiest wa
|
|||||||
pip3 install rns
|
pip3 install rns
|
||||||
```
|
```
|
||||||
|
|
||||||
You can then start any program that uses Reticulum, or start Reticulum as a system service with [the rnsd utility](https://markqvist.github.io/Reticulum/manual/using.html#the-rnsd-utility).
|
You can then start any program that uses Reticulum, or start Reticulum as a
|
||||||
|
system service with [the rnsd utility](https://markqvist.github.io/Reticulum/manual/using.html#the-rnsd-utility).
|
||||||
|
|
||||||
When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers that might be locally reachable. The default config file contains a few examples, and references for creating a more complex configuration.
|
When first started, Reticulum will create a default configuration file,
|
||||||
|
providing basic connectivity to other Reticulum peers that might be locally
|
||||||
|
reachable. The default config file contains a few examples, and references for
|
||||||
|
creating a more complex configuration.
|
||||||
|
|
||||||
For more detailed examples on how to expand communication over many mediums such as packet radio or LoRa, serial ports, or over fast IP links and the Internet using the UDP and TCP interfaces, take a look at the [Supported Interfaces](https://markqvist.github.io/Reticulum/manual/interfaces.html) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
For more detailed examples on how to expand communication over many mediums such
|
||||||
|
as packet radio or LoRa, serial ports, or over fast IP links and the Internet using
|
||||||
|
the UDP and TCP interfaces, take a look at the [Supported Interfaces](https://markqvist.github.io/Reticulum/manual/interfaces.html)
|
||||||
|
section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
||||||
|
|
||||||
## Included Utilities
|
## Included Utilities
|
||||||
Reticulum includes a range of useful utilities for managing your networks, viewing status and information, and other tasks. You can read more about these programs in the [Included Utility Programs](https://markqvist.github.io/Reticulum/manual/using.html#included-utility-programs) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
Reticulum includes a range of useful utilities for managing your networks,
|
||||||
|
viewing status and information, and other tasks. You can read more about these
|
||||||
|
programs in the [Included Utility Programs](https://markqvist.github.io/Reticulum/manual/using.html#included-utility-programs)
|
||||||
|
section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/).
|
||||||
|
|
||||||
- The system daemon `rnsd` for running Reticulum as an always-available service
|
- The system daemon `rnsd` for running Reticulum as an always-available service
|
||||||
- An interface status utility called `rnstatus`, that displays information about interfaces
|
- An interface status utility called `rnstatus`, that displays information about interfaces
|
||||||
- The path lookup and management tool `rnpath` letting you view and modify path tables
|
- The path lookup and management tool `rnpath` letting you view and modify path tables
|
||||||
- A diagnostics tool called `rnprobe` for checking connectivity to destinations
|
- A diagnostics tool called `rnprobe` for checking connectivity to destinations
|
||||||
- A simple file transfer program called `rncp` making it easy to copy files to remote systems
|
- A simple file transfer program called `rncp` making it easy to copy files to remote systems
|
||||||
- The remote command execution program `rnx` let's you run commands and programs and retrieve output from remote systems
|
- The remote command execution program `rnx` let's you run commands and
|
||||||
|
programs and retrieve output from remote systems
|
||||||
|
|
||||||
All tools, including `rnx` and `rncp`, work reliably and well even over very low-bandwidth links like LoRa or Packet Radio.
|
All tools, including `rnx` and `rncp`, work reliably and well even over very
|
||||||
|
low-bandwidth links like LoRa or Packet Radio.
|
||||||
|
|
||||||
## Supported interface types and devices
|
## 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. I will gratefully accept pull requests for custom interfaces if they are generally useful.
|
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. I will
|
||||||
|
gratefully accept pull requests for custom interfaces if they are generally
|
||||||
|
useful.
|
||||||
|
|
||||||
Currently, the following interfaces are supported:
|
Currently, the following interfaces are supported:
|
||||||
|
|
||||||
- Any ethernet device
|
- Any Ethernet device
|
||||||
- LoRa using [RNode](https://unsigned.io/projects/rnode/)
|
- LoRa using [RNode](https://unsigned.io/projects/rnode/)
|
||||||
- Packet Radio TNCs (with or without AX.25)
|
- Packet Radio TNCs (with or without AX.25)
|
||||||
- KISS-compatible hardware and software modems
|
- KISS-compatible hardware and software modems
|
||||||
@ -104,12 +159,21 @@ Currently, the following interfaces are supported:
|
|||||||
- Custom hardware via stdio or pipes
|
- Custom hardware via stdio or pipes
|
||||||
|
|
||||||
## Performance
|
## Performance
|
||||||
Reticulum targets a *very* wide usable performance envelope, but prioritises functionality and performance over low-bandwidth mediums. The goal is to provide a dynamic performance envelope from 250 bits per second, to 1 gigabit per second on normal hardware.
|
Reticulum targets a *very* wide usable performance envelope, but prioritises
|
||||||
|
functionality and performance over low-bandwidth mediums. The goal is to
|
||||||
|
provide a dynamic performance envelope from 250 bits per second, to 1 gigabit
|
||||||
|
per second on normal hardware.
|
||||||
|
|
||||||
Currently, the usable performance envelope is approximately 500 bits per second to 20 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised at this point in time.
|
Currently, the usable performance envelope is approximately 500 bits per second
|
||||||
|
to 20 megabits per second, with physical mediums faster than that not being
|
||||||
|
saturated. Performance beyond the current level is intended for future
|
||||||
|
upgrades, but not highly prioritised at this point in time.
|
||||||
|
|
||||||
## Current Status
|
## Current Status
|
||||||
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 relatively stable at the moment, but could change if warranted.
|
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 relatively stable at the moment, but could change if warranted.
|
||||||
|
|
||||||
## Development Roadmap
|
## Development Roadmap
|
||||||
- Version 0.4.0
|
- Version 0.4.0
|
||||||
@ -141,22 +205,48 @@ Reticulum should currently be considered beta software. All core protocol featur
|
|||||||
- Tor
|
- Tor
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
The installation of the default `rns` package requires the dependencies listed below. Almost all systems and distributions have readily available packages for these dependencies, and when the `rns` package is installed with `pip`, they will be downloaded and installed as well.
|
The installation of the default `rns` package requires the dependencies listed
|
||||||
|
below. Almost all systems and distributions have readily available packages for
|
||||||
|
these dependencies, and when the `rns` package is installed with `pip`, they
|
||||||
|
will be downloaded and installed as well.
|
||||||
|
|
||||||
- [PyCA/cryptography](https://github.com/pyca/cryptography)
|
- [PyCA/cryptography](https://github.com/pyca/cryptography)
|
||||||
- [netifaces](https://github.com/al45tair/netifaces)
|
- [netifaces](https://github.com/al45tair/netifaces)
|
||||||
- [pyserial](https://github.com/pyserial/pyserial)
|
- [pyserial](https://github.com/pyserial/pyserial)
|
||||||
|
|
||||||
On more unusual systems, and in some rare cases, it might not be possible to install or even compile one or more of the above modules. In such situations, you can use the `rnspure` package instead, which require no external dependencies for installation. Please note that the contents of the `rns` and `rnspure` packages are *identical*. The only difference is that the `rnspure` package lists no dependencies required for installation.
|
On more unusual systems, and in some rare cases, it might not be possible to
|
||||||
|
install or even compile one or more of the above modules. In such situations,
|
||||||
|
you can use the `rnspure` package instead, which require no external
|
||||||
|
dependencies for installation. Please note that the contents of the `rns` and
|
||||||
|
`rnspure` packages are *identical*. The only difference is that the `rnspure`
|
||||||
|
package lists no dependencies required for installation.
|
||||||
|
|
||||||
No matter how Reticulum is installed and started, it will load external dependencies only if they are *needed* and *available*. If for example you want to use Reticulum on a system that cannot support [pyserial](https://github.com/pyserial/pyserial), it is perfectly possible to do so using the `rnspure` package, but Reticulum will not be able to use serial-based interfaces. All other available modules will still be loaded when needed.
|
No matter how Reticulum is installed and started, it will load external
|
||||||
|
dependencies only if they are *needed* and *available*. If for example you want
|
||||||
|
to use Reticulum on a system that cannot support
|
||||||
|
[pyserial](https://github.com/pyserial/pyserial), it is perfectly possible to
|
||||||
|
do so using the `rnspure` package, but Reticulum will not be able to use
|
||||||
|
serial-based interfaces. All other available modules will still be loaded when
|
||||||
|
needed.
|
||||||
|
|
||||||
**Please Note!** If you use the `rnspure` package to run Reticulum on systems that do not support [PyCA/cryptography](https://github.com/pyca/cryptography), it is important that you read and understand the [Cryptographic Primitives](#cryptographic-primitives) section of this document.
|
**Please Note!** If you use the `rnspure` package to run Reticulum on systems
|
||||||
|
that do not support [PyCA/cryptography](https://github.com/pyca/cryptography),
|
||||||
|
it is important that you read and understand the [Cryptographic
|
||||||
|
Primitives](#cryptographic-primitives) section of this document.
|
||||||
|
|
||||||
## Public Testnet
|
## Public Testnet
|
||||||
If you just want to get started experimenting without building any physical networks, you are welcome to join the Unsigned.io RNS Testnet. The testnet is just that, an informal network for testing and experimenting. It will be up most of the time, and anyone can join, but it also means that there's no guarantees for service availability.
|
If you just want to get started experimenting without building any physical
|
||||||
|
networks, you are welcome to join the Unsigned.io RNS Testnet. The testnet is
|
||||||
|
just that, an informal network for testing and experimenting. It will be up
|
||||||
|
most of the time, and anyone can join, but it also means that there's no
|
||||||
|
guarantees for service availability.
|
||||||
|
|
||||||
The testnet runs the very latest version of Reticulum (often even a short while before it is publicly released). Sometimes experimental versions of Reticulum might be deployed to nodes on the testnet, which means strange behaviour might occur. If none of that scares you, you can join the testnet via either TCP or I2P. Just add one of the following interfaces to your Reticulum configuration file:
|
The testnet runs the very latest version of Reticulum (often even a short while
|
||||||
|
before it is publicly released). Sometimes experimental versions of Reticulum
|
||||||
|
might be deployed to nodes on the testnet, which means strange behaviour might
|
||||||
|
occur. If none of that scares you, you can join the testnet via either TCP or
|
||||||
|
I2P. Just add one of the following interfaces to your Reticulum configuration
|
||||||
|
file:
|
||||||
|
|
||||||
```
|
```
|
||||||
# TCP/IP interface to the Dublin Hub
|
# TCP/IP interface to the Dublin Hub
|
||||||
@ -205,10 +295,13 @@ You can help support the continued development of open, free and private communi
|
|||||||
```
|
```
|
||||||
- Ko-Fi: https://ko-fi.com/markqvist
|
- Ko-Fi: https://ko-fi.com/markqvist
|
||||||
|
|
||||||
Are certain features in the development roadmap are important to you or your organisation? Make them a reality quickly by sponsoring their implementation.
|
Are certain features in the development roadmap are important to you or your
|
||||||
|
organisation? Make them a reality quickly by sponsoring their implementation.
|
||||||
|
|
||||||
## Cryptographic Primitives
|
## Cryptographic Primitives
|
||||||
Reticulum uses a simple suite of efficient, strong and modern cryptographic primitives, with widely available implementations that can be used both on general-purpose CPUs and on microcontrollers. The necessary primitives are:
|
Reticulum uses a simple suite of efficient, strong and modern cryptographic
|
||||||
|
primitives, with widely available implementations that can be used both on
|
||||||
|
general-purpose CPUs and on microcontrollers. The necessary primitives are:
|
||||||
|
|
||||||
- Ed25519 for signatures
|
- Ed25519 for signatures
|
||||||
- X22519 for ECDH key exchanges
|
- X22519 for ECDH key exchanges
|
||||||
@ -220,7 +313,13 @@ Reticulum uses a simple suite of efficient, strong and modern cryptographic prim
|
|||||||
- SHA-256
|
- SHA-256
|
||||||
- SHA-512
|
- SHA-512
|
||||||
|
|
||||||
In the default installation configuration, the `X25519`, `Ed25519` and `AES-128-CBC` primitives are provided by [OpenSSL](https://www.openssl.org/) (via the [PyCA/cryptography](https://github.com/pyca/cryptography) package). The hashing functions `SHA-256` and `SHA-512` are provided by the standard Python [hashlib](https://docs.python.org/3/library/hashlib.html). The `HKDF`, `HMAC`, `Fernet` primitives, and the `PKCS7` padding function are always provided by the following internal implementations:
|
In the default installation configuration, the `X25519`, `Ed25519` and
|
||||||
|
`AES-128-CBC` primitives are provided by [OpenSSL](https://www.openssl.org/)
|
||||||
|
(via the [PyCA/cryptography](https://github.com/pyca/cryptography) package).
|
||||||
|
The hashing functions `SHA-256` and `SHA-512` are provided by the standard
|
||||||
|
Python [hashlib](https://docs.python.org/3/library/hashlib.html). The `HKDF`,
|
||||||
|
`HMAC`, `Fernet` primitives, and the `PKCS7` padding function are always
|
||||||
|
provided by the following internal implementations:
|
||||||
|
|
||||||
- [HKDF.py](RNS/Cryptography/HKDF.py)
|
- [HKDF.py](RNS/Cryptography/HKDF.py)
|
||||||
- [HMAC.py](RNS/Cryptography/HMAC.py)
|
- [HMAC.py](RNS/Cryptography/HMAC.py)
|
||||||
@ -228,16 +327,33 @@ In the default installation configuration, the `X25519`, `Ed25519` and `AES-128-
|
|||||||
- [PKCS7.py](RNS/Cryptography/PKCS7.py)
|
- [PKCS7.py](RNS/Cryptography/PKCS7.py)
|
||||||
|
|
||||||
|
|
||||||
Reticulum also includes a complete implementation of all necessary primitives in pure Python. If OpenSSL & PyCA are not available on the system when Reticulum is started, Reticulum will instead use the internal pure-python primitives. A trivial consequence of this is performance, with the OpenSSL backend being *much* faster. The most important consequence however, is the potential loss of security by using primitives that has not seen the same amount of scrutiny, testing and review as those from OpenSSL.
|
Reticulum also includes a complete implementation of all necessary primitives
|
||||||
|
in pure Python. If OpenSSL & PyCA are not available on the system when
|
||||||
|
Reticulum is started, Reticulum will instead use the internal pure-python
|
||||||
|
primitives. A trivial consequence of this is performance, with the OpenSSL
|
||||||
|
backend being *much* faster. The most important consequence however, is the
|
||||||
|
potential loss of security by using primitives that has not seen the same
|
||||||
|
amount of scrutiny, testing and review as those from OpenSSL.
|
||||||
|
|
||||||
If you want to use the internal pure-python primitives, it is **highly advisable** that you have a good understanding of the risks that this pose, and make an informed decision on whether those risks are acceptable to you.
|
If you want to use the internal pure-python primitives, it is **highly
|
||||||
|
advisable** that you have a good understanding of the risks that this pose, and
|
||||||
|
make an informed decision on whether those risks are acceptable to you.
|
||||||
|
|
||||||
Reticulum is relatively young 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 or security breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.
|
Reticulum is relatively young 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 or security breaking bugs. If you want to help out, or help sponsor an
|
||||||
|
audit, please do get in touch.
|
||||||
|
|
||||||
## Acknowledgements & Credits
|
## Acknowledgements & Credits
|
||||||
Reticulum can only exist because of the mountain of Open Source work it was built on top of, the contributions of everyone involved, and everyone that has supported the project through the years. To everyone who has helped, thank you so much.
|
Reticulum can only exist because of the mountain of Open Source work it was
|
||||||
|
built on top of, the contributions of everyone involved, and everyone that has
|
||||||
|
supported the project through the years. To everyone who has helped, thank you
|
||||||
|
so much.
|
||||||
|
|
||||||
A number of other modules and projects are either part of, or used by Reticulum. Sincere thanks to the authors and contributors of the following projects:
|
A number of other modules and projects are either part of, or used by
|
||||||
|
Reticulum. Sincere thanks to the authors and contributors of the following
|
||||||
|
projects:
|
||||||
|
|
||||||
- [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD License*
|
- [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD License*
|
||||||
- [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner), *MIT License*
|
- [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner), *MIT License*
|
||||||
|
Loading…
Reference in New Issue
Block a user