Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

hivemind-rendezvous

A store-and-forward dead drop for HiveMind nodes that are never online at the same time. One node deposits an encrypted message addressed to another node's public key; the recipient collects it whenever it next connects.

A rendezvous node is an ordinary hivemind-core node that holds mail. It speaks the normal HiveMind protocol over the listener that is already accepting clients, using the RENDEZVOUS message type. There is no second service, no second port, and no second set of credentials.

Enable it

Install the package on the node that should hold mail, and switch it on in the hivemind-core config, the same way hivemind-presence is enabled:

pip install hivemind-rendezvous
{
  "rendezvous": {
    "enabled": true,
    "max_pending_per_mailbox": 256
  }
}

Nodes without the package installed, or with enabled false, answer RENDEZVOUS with not_a_rendezvous_node. A peer can therefore tell "no mail" apart from "not a rendezvous node" and move on to one that is.

How it works

Node A (sender)      Rendezvous node        Node B (recipient)
     │                      │                      │
     │-- RENDEZVOUS ------->│                      │
     │   cmd=deposit        │                      │
     │   target=B.pubkey    │   (stored, TTL ≤7d)  │
     │                      │                      │
     │              (time passes)                  │
     │                      │<---- RENDEZVOUS -----│
     │                      │      cmd=collect     │
     │                      │--- messages -------->│
     │                      │<---- RENDEZVOUS -----│
     │                      │      cmd=ack         │
     │                      │  (deleted)           │

Three commands, all carried in the RENDEZVOUS payload:

cmd Fields Reply
deposit target_key, payload (a serialised INTERCOM message), optional ttl deposit_id
collect none messages: a list of {deposit_id, payload}
ack deposit_ids removed: how many were deleted

Only INTERCOM may be deposited: it is the one type the relay has no reason to look inside.

What the hive already provides

The relay has no authentication code of its own, because the connection is already authenticated:

  • A caller cannot name a mailbox. collect and ack operate on the access key this connection authenticated with. Asking for another node's mail is not something the wire can express, so there is no ownership proof to sign, no timestamp to check, and no replay window. It is deliberately not addressed by public key: that is announced in HELLO with no proof of possession.
  • Confidentiality is the link (wss, or the Noise transport on protocol v3), on top of the end-to-end encryption the deposited envelope carries.
  • Admission and flood control belong to the listener. An unknown client never reaches the mailbox.

Delivery

Delivery is at-least-once. collect returns messages and leaves them stored; they are deleted only when the recipient acks the deposit ids it actually received. A reply lost in transit therefore costs a redelivery rather than the message.

That trade is deliberate. The recipient may occasionally see a message twice, which it can detect. The alternative — deleting on read — loses the message permanently whenever a response goes missing, and the peer this system exists for is, by definition, unreachable for a resend.

Messages expire after seven days.

Storage

Mail is kept in a json_database.JsonStorageXDG file, keyed by the SHA-256 fingerprint of the recipient's public key. Expiry is enforced whenever a mailbox is read, and the whole store is swept for expired entries at most once every five minutes, so request cost tracks the mailbox being touched rather than total stored volume.

The store holds everything in memory. That is fine for the volume a dead drop between a handful of hives sees, and is the first thing to replace with a hivemind-plugin-manager database backend if that stops being true.

Docs

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hivemind_rendezvous-2.0.0a1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hivemind_rendezvous-2.0.0a1-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file hivemind_rendezvous-2.0.0a1.tar.gz.

File metadata

  • Download URL: hivemind_rendezvous-2.0.0a1.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for hivemind_rendezvous-2.0.0a1.tar.gz
Algorithm Hash digest
SHA256 60b2c5a62af4d1398f6c63b0f39a06ce1dc5b23b8dbc30ac1f5a6693ef611657
MD5 5553b4bc539c31b5bf7fbf3e15810274
BLAKE2b-256 19a3eabb375449dfed90efa8e88d3d0317332b14c05b0e7784ee53cde3436c02

See more details on using hashes here.

File details

Details for the file hivemind_rendezvous-2.0.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for hivemind_rendezvous-2.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 94c33b8a76815071c07cd5b5cff981f87d964f9d2668138d3c277e9985fae1ae
MD5 b96c25722103ee2560d535f69e6e17e6
BLAKE2b-256 ce370380ba7b587572e72caba13a6f5c183fa4640034fc1691db4be868b980c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page