Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2025-08-09 23:13:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs

Browse source
This commit is contained in:
Mark Qvist 2025-04-16 00:35:56 +02:00
parent dba6cd8393
commit eff0c91ed0
2 changed files with 24 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -312,7 +312,15 @@ organisation? Make them a reality quickly by sponsoring their implementation.
## Cryptographic Primitives ## Cryptographic Primitives
Reticulum uses a simple suite of efficient, strong and well-tested cryptographic Reticulum uses a simple suite of efficient, strong and well-tested cryptographic
primitives, with widely available implementations that can be used both on primitives, with widely available implementations that can be used both on
general-purpose CPUs and on microcontrollers. The utilised primitives are: general-purpose CPUs and on microcontrollers.
One of the primary considerations for choosing this particular set of primitives is
that they can be implemented *safely* and with relatively few pitfalls, on practically
all current computing platforms.
The primitives listed here *are authoritative*. Anything claiming to be Reticulum,
but not using these exact primitives **is not** Reticulum, and possibly an
intentionally compromised or weakened clone. The utilised primitives are:
- Reticulum Identity Keys are 512-bit Curve25519 keysets - Reticulum Identity Keys are 512-bit Curve25519 keysets
- A 256-bit Ed25519 key for signatures - A 256-bit Ed25519 key for signatures
@ -320,9 +328,9 @@ general-purpose CPUs and on microcontrollers. The utilised primitives are:
- HKDF for key derivation - HKDF for key derivation
- Encrypted tokens are based on the [Fernet spec](https://github.com/fernet/spec/) - Encrypted tokens are based on the [Fernet spec](https://github.com/fernet/spec/)
- Ephemeral keys derived from an ECDH key exchange on Curve25519 - Ephemeral keys derived from an ECDH key exchange on Curve25519
- AES-128 in CBC mode with PKCS7 padding
- HMAC using SHA256 for message authentication - HMAC using SHA256 for message authentication
- IVs are generated through os.urandom() - IVs must be generated through `os.urandom()` or better
- AES-128 or AES-256 in CBC mode with PKCS7 padding
- No Fernet version and timestamp metadata fields - No Fernet version and timestamp metadata fields
- SHA-256 - SHA-256
- SHA-512 - SHA-512

18
docs/source/understanding.rst
View file

@ -858,9 +858,17 @@ of the different interface modes, and how they are configured.
Cryptographic Primitives Cryptographic Primitives
------------------------ ------------------------
Reticulum has been designed to use a simple suite of efficient, strong and modern Reticulum uses a simple suite of efficient, strong and well-tested cryptographic
cryptographic primitives, with widely available implementations that can be used primitives, with widely available implementations that can be used both on
both on general-purpose CPUs and on microcontrollers. The necessary primitives are: general-purpose CPUs and on microcontrollers.
One of the primary considerations for choosing this particular set of primitives is
that they can be implemented *safely* and with relatively few pitfalls, on practically
all current computing platforms.
The primitives listed here *are authoritative*. Anything claiming to be Reticulum,
but not using these exact primitives **is not** Reticulum, and possibly an
intentionally compromised or weakened clone. The utilised primitives are:
* Ed25519 for signatures * Ed25519 for signatures
@ -872,11 +880,11 @@ both on general-purpose CPUs and on microcontrollers. The necessary primitives a
* Ephemeral keys derived from an ECDH key exchange on Curve25519 * Ephemeral keys derived from an ECDH key exchange on Curve25519
* AES-128 in CBC mode with PKCS7 padding * AES-128 or AES-256 in CBC mode with PKCS7 padding
* HMAC using SHA256 for message authentication * HMAC using SHA256 for message authentication
* IVs are generated through os.urandom() * IVs must be generated through ``os.urandom()`` or better
* No Fernet version and timestamp metadata fields * No Fernet version and timestamp metadata fields