termchat.app

Свой relay

English: self-host.md.

Relay пересылает зашифрованные конверты. Он никогда не видит содержимое сообщений, ники и списки контактов. Что он всё-таки видит, описано в threat-model.ru.md.

Нужен небольшой Linux-сервер с доменом (для HTTPS) и, по желанию, Tor (чтобы дать ещё и onion-адрес).

Что хранит relay

Всё в папке данных, права 0600 (ADR-005):

Файл Содержимое Сколько хранится
termchat-relay.db (+ -wal, -shm) анонимные очереди (ADR-023): у каждой два случайных ID и SHA-256 токена владельца, когда создана и когда использовалась, адрес UnifiedPush, если владелец его задал; prekeys, опубликованные на очередях; недоставленный шифртекст с его очередью и временем прихода. Ни ключей пользователей, ни отправителей, ни аккаунтов конверты до доставки или 14 дней; очереди до 90 дней без использования
termchat-reports.log жалобы, которые пользователи сами решили вам отправить (ADR-006): время и раскрытый ими текст пока вы не удалите

Больше ничего: ни IP-адресов, ни журнала доступа, ни истории сообщений.

Вариант А: Docker + Caddy (проще всего)

git clone https://github.com/prophecy1345/termchat && cd termchat/deploy
# впишите свой домен в Caddyfile вместо relay.example.org
docker compose up -d

Caddy получает сертификат Let’s Encrypt и пересылает WebSocket-трафик relay, который слушает только внутри сети Docker. Caddyfile намеренно выбрасывает журнал доступа. Пользователи при первом запуске вводят wss://relay.example.org/.

Вариант Б: бинарник + systemd

Скачайте релиз для своего сервера (termchat-…-x86_64-unknown-linux-musl.tar.gz), проверьте его (см. README), затем:

sudo install -m 755 termchat-relay /usr/local/bin/

/etc/systemd/system/termchat-relay.service:

[Unit]
Description=termchat.app relay
After=network-online.target

[Service]
ExecStart=/usr/local/bin/termchat-relay --trust-proxy --listen 127.0.0.1:8080
DynamicUser=yes
StateDirectory=termchat-relay
WorkingDirectory=/var/lib/termchat-relay
NoNewPrivileges=yes
ProtectSystem=strict
ProtectHome=yes
PrivateTmp=yes
Restart=on-failure

[Install]
WantedBy=multi-user.target
sudo systemctl enable --now termchat-relay

Поставьте перед ним Caddy (или nginx), который завершает TLS и проксирует на 127.0.0.1:8080:

relay.example.org {
    reverse_proxy 127.0.0.1:8080
    log {
        output discard
    }
}

Флаг --trust-proxy нужен, только если впереди стоит прокси, который ставит X-Forwarded-For. Иначе любой сможет подделать свой IP и обойти лимиты по IP.

Onion-адрес (Tor)

Поставьте Tor из пакетов дистрибутива (apt install tor; в пакете Debian/Ubuntu есть защита proof-of-work). Добавьте в /etc/tor/torrc:

HiddenServiceDir /var/lib/tor/termchat/
HiddenServicePort 80 127.0.0.1:8081
HiddenServicePoWDefensesEnabled 1

В сборке Homebrew и некоторых других модуля proof-of-work нет (нужна сборка с --enable-gpl); там уберите последнюю строку, иначе tor не запустится.

sudo systemctl restart tor
sudo cat /var/lib/tor/termchat/hostname   # xxxx.onion

Затем запустите relay с onion-портом (--host с версии 0.7.0 не нужен, ADR-023; старые файлы служб с ним продолжают работать):

termchat-relay --trust-proxy \
  --listen 127.0.0.1:8080 --onion-listen 127.0.0.1:8081

Пользователи вводят ws://xxxx.onion/ как onion-адрес и отвечают «y» на «Use Tor?». У подключений через onion-порт общий бюджет (ADR-004), поэтому лимиты по IP не отрезают пользователей Tor.

Ваш relay и публичный

Люди на разных relay общаются друг с другом: в приглашении записан адрес его relay, а приложение подключается к тем relay, где лежат очереди его контактов. Ваши очереди остаются на вашем relay; друг на публичном relay держит свои там, и ваше приложение пишет туда.

Поэтому ни один сервер не видит обе стороны разговора. Ваш relay видит, когда в ваши очереди пишут и когда их читают; публичный — то же для очередей друга. Чтобы сопоставить их по времени, нужны оба оператора или тот, кто наблюдает за обоими серверами. Если же друзья укажут своим ваш relay, обе стороны снова окажутся на одном сервере — вашем.

Самый сильный вариант — у каждого из двоих свой relay:

Алиса Боб
Её или его relay wss://relay.alice.example/ wss://relay.bob.example/
Своя очередь лежит на relay Алисы relay Боба
Пишет в очередь другого на relay Боба relay Алисы

Каждый указывает свой relay при первом запуске, и они обмениваются приглашениями как обычно; больше ничего настраивать не нужно. Сервер Алисы видит только, когда в её очередь пишут и когда её читают, сервер Боба — только его. Ни у одного оператора нет обеих сторон, и каждый контролирует лишь свой сервер. Два relay одного человека на двух серверах этого не дают: оператор по-прежнему один и видит обе стороны; это помогает, только если один из серверов изымут или взломают.

Эксплуатация

  • Резервные копии. Потеря базы — это потеря недоставленных сообщений и prekeys (клиенты опубликуют ключи заново при следующем подключении). Копия: sqlite3 termchat-relay.db ".backup backup.db". В копии те же метаданные, защищайте её так же.
  • Жалобы. Читайте termchat-reports.log, принимайте меры и удаляйте разобранные строки. В жалобе только время и текст: relay не знает, кто его написал, поэтому банить некого (ADR-023). Клиент пожаловавшегося уже удалил очередь этого контакта.
  • Шифрование диска. Включите полное шифрование диска на сервере: удалённые строки могут оставаться на SSD до TRIM.
  • Обновление. Остановить, заменить бинарник, запустить. Версия схемы хранится в базе (PRAGMA user_version); версия 3 (0.7.0, анонимные очереди) начинает с пустой базы и при первом запуске стирает всё, что было раньше (ADR-023). Клиенты сравнивают свою версию с той, что сообщает ваш relay, и говорят пользователю, если она новее (ADR-010), поэтому обновляйте relay: старый relay о новых релизах молчит.
  • Закрыть навсегда. systemctl stop termchat-relay, затем удалить папку данных. С Docker: docker compose down -v.