Git-Mirrors/LXMF
1
0
Fork 0
mirror of https://github.com/markqvist/LXMF.git synced 2024-12-26 23:59:34 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation to match reality

Browse Source
This commit is contained in:
Dionysis Grigoropoulos 2023-01-26 02:56:20 +02:00
parent 8c94118e07
commit 5b81ecce04
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
LXMF/LXMessage.py
View File

@ -33,9 +33,9 @@ class LXMessage:
DESTINATION_LENGTH = RNS.Identity.TRUNCATED_HASHLENGTH//8 DESTINATION_LENGTH = RNS.Identity.TRUNCATED_HASHLENGTH//8
SIGNATURE_LENGTH = RNS.Identity.SIGLENGTH//8 SIGNATURE_LENGTH = RNS.Identity.SIGLENGTH//8
# LXMF overhead is 99 bytes per message: # LXMF overhead is 111 bytes per message:
# 10 bytes for destination hash # 16 bytes for destination hash
# 10 bytes for source hash # 16 bytes for source hash
# 64 bytes for Ed25519 signature # 64 bytes for Ed25519 signature
# 8 bytes for timestamp # 8 bytes for timestamp
# 7 bytes for msgpack structure # 7 bytes for msgpack structure
@ -53,7 +53,7 @@ class LXMessage:
# field of the packet, therefore we also add the length # field of the packet, therefore we also add the length
# of a destination hash to the calculation. With default # of a destination hash to the calculation. With default
# RNS and LXMF parameters, the largest single-packet # RNS and LXMF parameters, the largest single-packet
# LXMF message we can send is 294 bytes. If a message # LXMF message we can send is 288 bytes. If a message
# is larger than that, a Reticulum link will be used. # is larger than that, a Reticulum link will be used.
ENCRYPTED_PACKET_MAX_CONTENT = ENCRYPTED_PACKET_MDU - LXMF_OVERHEAD + DESTINATION_LENGTH ENCRYPTED_PACKET_MAX_CONTENT = ENCRYPTED_PACKET_MDU - LXMF_OVERHEAD + DESTINATION_LENGTH
@ -63,13 +63,13 @@ class LXMessage:
LINK_PACKET_MDU = RNS.Link.MDU LINK_PACKET_MDU = RNS.Link.MDU
# Which means that we can deliver single-packet LXMF # Which means that we can deliver single-packet LXMF
# messages with content of up to 332 bytes over a link. # messages with content of up to 320 bytes over a link.
# If a message is larger than that, LXMF will sequence # If a message is larger than that, LXMF will sequence
# and transfer it as a RNS resource over the link instead. # and transfer it as a RNS resource over the link instead.
LINK_PACKET_MAX_CONTENT = LINK_PACKET_MDU - LXMF_OVERHEAD LINK_PACKET_MAX_CONTENT = LINK_PACKET_MDU - LXMF_OVERHEAD
# For plain packets without encryption, we can # For plain packets without encryption, we can
# fit up to 388 bytes of content. # fit up to 369 bytes of content.
PLAIN_PACKET_MDU = RNS.Packet.PLAIN_MDU PLAIN_PACKET_MDU = RNS.Packet.PLAIN_MDU
PLAIN_PACKET_MAX_CONTENT = PLAIN_PACKET_MDU - LXMF_OVERHEAD + DESTINATION_LENGTH PLAIN_PACKET_MAX_CONTENT = PLAIN_PACKET_MDU - LXMF_OVERHEAD + DESTINATION_LENGTH

4
README.md
View File

@ -32,7 +32,7 @@ LXMF messages are stored in a simple and efficient format, that's easy to parse
In some cases the actual message-id cannot be inferred, for example when a Propagation Node is storing an encrypted message for an offline user. In theses cases a _transient-id_ is used to identify the message while in storage or transit. In some cases the actual message-id cannot be inferred, for example when a Propagation Node is storing an encrypted message for an offline user. In theses cases a _transient-id_ is used to identify the message while in storage or transit.
2. __Destination__, __Source__, __Signature__ and __Payload__ parts are mandatory, as is the __Timestamp__ part of the payload. 2. __Destination__, __Source__, __Signature__ and __Payload__ parts are mandatory, as is the __Timestamp__ part of the payload.
- The __Destination__ and __Source__ fields are 10-byte Reticulum destination hashes - The __Destination__ and __Source__ fields are 16-byte Reticulum destination hashes
- The __Signature__ field is a 64-byte Ed25519 signature of the __Destination__, __Source__, __Payload__ and __message-id__ - The __Signature__ field is a 64-byte Ed25519 signature of the __Destination__, __Source__, __Payload__ and __message-id__
- The __Payload__ part is a [msgpacked](https://msgpack.org) list containing four items: - The __Payload__ part is a [msgpacked](https://msgpack.org) list containing four items:
1. The __Timestamp__ is a double-precision floating point number representing the number of seconds since the UNIX epoch. 1. The __Timestamp__ is a double-precision floating point number representing the number of seconds since the UNIX epoch.
@ -100,7 +100,7 @@ Assuming the default Reticulum configuration, the binary wire-format is as follo
- 64 bytes Ed25519 signature - 64 bytes Ed25519 signature
- Remaining bytes of [msgpack](https://msgpack.org) payload data, in accordance with the structure defined above - Remaining bytes of [msgpack](https://msgpack.org) payload data, in accordance with the structure defined above
The complete message overhead for LXMF is only 99 bytes, which in return gives you timestamped, digitally signed, infinitely extensible, end-to-end encrypted, zero-conf routed, minimal-infrastructure messaging that's easy to use and build applications with. The complete message overhead for LXMF is only 111 bytes, which in return gives you timestamped, digitally signed, infinitely extensible, end-to-end encrypted, zero-conf routed, minimal-infrastructure messaging that's easy to use and build applications with.
## Example Paper Message ## Example Paper Message