A terminal group chat over the Katzenpost mixnet, written in Lean, that speaks katzenqt's group chat: a jam member and a katzenqt member can be in one group.
jam is for people who want that group chat in a terminal, and secondarily for those working on
its Lean code. It does not reach the mixnet itself: it talks to the client daemon, kpclientd,
which does the networking. It does not yet show a message too long for one box, nor files. For a
graphical client, use katzenqt.
You need elan, rustup (cargo on the
PATH; Lake runs it), git and about 8 GB of disk.
git clone https://github.com/katzenpost/jam
cd jam
lake exe cache get
lake build jam
Start kpclientd with this repository's namenlos configuration, config/client.toml, and leave
it running (how). Then:
.lake/build/bin/jam --name alice
Type /new friends to start a group. Someone else types /join friends and gives you the
voucher code jam shows them; you type /invite CODE, and a few minutes later they are in.
- docs/building.md: building, and verifying a release's reproducible binaries
- docs/running.md: the daemon, jam's options, how groups work, katzenqt
- docs/using.md: the screen, the commands and the keys
- docs/security.md: what jam does with untrusted text, input and state
Jam/Main.lean: the program; it drives Cryptlib's member state machine (Cryptlib/Protocols/GroupComm/GroupChatKatzenqt1/Member, through group_chat_client) and does the IOJam/Ui.lean,Jam/Presentation.lean,Jam/Display.lean,Jam/Theme.lean: the screen, drawn with Tessera, and what may reach itJam/Args.lean: the command lineJam/Tests:jam-test,jam-integrationandjam-interopconfig/client.toml: the namenloskpclientdconfigurationscripts: the katzenqt interop run and the reproducible release build
Boxes are read and written through the Lean thin client; jam logs with Logger.
Version 0.2.1. jam writes and mints group chat wire version 4 by default and reads 3 and 4;
--wire-version 3 talks to a katzenqt older than version 4. It interoperates with katzenqt's main
branch; scripts/interop-katzenqt.sh runs both directions against katzenqt-headless.
make test # the screen, keys, commands and security tests, in one process
./test-integration.sh # two members over the docker mixnet
AGPL-3.0-only. Contributions are welcome as pull requests.
