Skip to content
katzenpostPublic

About

A Lean TUI group chat over the Katzenpost mixnet that speaks katzenqt's group chat

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

jam

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: three groups, four members, talking over the namenlos mixnet

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.

Quick start

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.

Documentation

What is here

Boxes are read and written through the Lean thin client; jam logs with Logger.

Status

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.

Testing

make test                # the screen, keys, commands and security tests, in one process
./test-integration.sh    # two members over the docker mixnet

Licence

AGPL-3.0-only. Contributions are welcome as pull requests.

About

A Lean TUI group chat over the Katzenpost mixnet that speaks katzenqt's group chat

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages