mirror of
https://github.com/Govor-team/Govor.git
synced 2026-11-18 13:24:59 +00:00
Add forwarding, friend controls, and benefits
Add message forwarding and reply lookup, friend removal and blocking endpoints, and database-backed Govor+ privileges with customizable profile tags. Include migrations, integration tests, and updated API and operations documentation.
This commit is contained in:
+27
-29
@@ -1,41 +1,39 @@
|
||||
# Govor.API — обзор
|
||||
# Govor — документация сервера
|
||||
|
||||
Govor — мессенджер на ASP.NET Core и .NET MAUI. Эта документация описывает сервер Govor.API и его контракт с клиентом. Стек сервера: .NET 10, EF Core, PostgreSQL, JWT, SignalR, Firebase и локальное хранилище файлов.
|
||||
Govor — мессенджер с сервером ASP.NET Core и отдельным клиентом .NET MAUI. Здесь описаны запуск сервера, HTTP API, SignalR, шифрование, восстановление доступа и эксплуатация.
|
||||
|
||||
## Что реализовано
|
||||
Документация сверена с серверным `master`, коммит `a3401ce`, 30 октября 2026 года. Описанное поведение относится к этой версии; установленный сервер может быть старше. Адреса и секреты в примерах условные.
|
||||
|
||||
Изменения рабочей копии сервера описаны в [исправлениях](server-fixes.md), включая [API прочтения](endpoints/message-read.md). Страницы со ссылками на commit `4603be9` описывают исходную версию до этих исправлений.
|
||||
## С чего начать
|
||||
|
||||
| Область | Состояние по коду |
|
||||
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Регистрация и вход | Регистрация по приглашению, BCrypt, открытие сессии и пара токенов |
|
||||
| Сессии | Список, отзыв одной или всех сессий, обновление токенов |
|
||||
| Друзья | Поиск, списки, отправка/принятие/отклонение заявок через SignalR |
|
||||
| Личные чаты | Создание между друзьями, история, отправка и редактирование |
|
||||
| Прочтение и удаление | HTTP/SignalR, видимые сообщения/граница/весь чат, квитанции и счётчики; удаление с проверкой прав |
|
||||
| Реакции | [HTTP/SignalR, базовые эмодзи, общие паки картинок/GIF, административный API и выбор разрешённых реакций канала](endpoints/reactions.md) |
|
||||
| Профиль | Описание, аватар, загрузка профиля и события изменений |
|
||||
| Присутствие | События подключения/отключения; исправлены зависимости HTTP status |
|
||||
| Медиа и push | Доступ к вложениям, привязка FCM к сессии, очередь и повторные попытки |
|
||||
| Группы и каналы | [Публичный поиск, приватные приглашения, владелец/админы/участники, баны, модерация и обязательный канал](groups.md) |
|
||||
| Шифрование | Есть хранение публичных ключей, но готового E2EE нет |
|
||||
| Задача | Раздел |
|
||||
| --- | --- |
|
||||
| Запустить API локально | [Быстрый старт](getting-started.md) |
|
||||
| Подключить собственный клиент | [Путь интеграции](client-integration.md), [карта HTTP API](api-reference.md) |
|
||||
| Разобраться с входом и токенами | [Аутентификация](endpoints/authentication/README.md) |
|
||||
| Восстановить историю или сменить пароль | [Пароли и восстановление](password-recovery.md) |
|
||||
| Понять шифрование | [E2EE](e2ee.md), [API устройств и архивов](endpoints/e2ee.md) |
|
||||
| Настроить сервер на Timeweb | [VPS](vps-deployment.md) или [App Platform](timeweb-deployment.md) |
|
||||
| Найти причину ошибки | [Диагностика](diagnostics.md), [частые вопросы](faq.md) |
|
||||
| Проверить изменения | [Тестирование](testing.md) |
|
||||
|
||||
## Как читать
|
||||
## Возможности
|
||||
|
||||
Начните с «Запуск и конфигурация» и «Аутентификация». Для чатов используйте HTTP для истории и SignalR для команд и событий. Раздел «Диагностика» описывает ограничения, которые нельзя считать рабочими гарантиями API.
|
||||
- Регистрация по приглашению, вход с доказательством пароля SRP, access/refresh токены и управление сессиями.
|
||||
- Друзья, заявки, личные чаты, группы и каналы с отдельными ролями, приглашениями и модерацией.
|
||||
- История, отправка и редактирование сообщений, прочтение, удаление, реакции и паки.
|
||||
- E2EE сообщений и вложений, сертификаты устройств, ротация ключей, зашифрованный архив и восстановление по паролю/коду.
|
||||
- Профили, аватары, присутствие, SignalR-события и очередь push через Firebase.
|
||||
- PostgreSQL, миграции, Docker и GitHub Actions для развёртывания.
|
||||
|
||||
Имена `userId`, `friendId`, `chatId` обозначают разные сущности. В сообщениях личного чата `recipientId` — ID записи PrivateChat, а не ID собеседника.
|
||||
## Что важно знать до интеграции
|
||||
|
||||
## Границы готовности
|
||||
`userId` — пользователь, `sessionId` — сеанс входа, `chatId` — чат. Для личного сообщения `recipientId` означает **PrivateChat.Id**, а не ID собеседника. `recipientType`: `0` — личный чат, `1` — группа/канал.
|
||||
|
||||
Документация новых групп и реакций описывает рабочую серверную копию с исправлениями доступа. Проверки HTTP/JWT, SQL и прав выполняются автоматическими тестами; реальная доставка на устройства и производственное развёртывание требуют отдельной проверки. Страницы с commit `4603be9` фиксируют старую диагностику и не описывают все текущие исправления.
|
||||
HTTP загружает состояние, SignalR передаёт команды и события. После переподключения клиент перечитывает состояние через HTTP. События могут повторяться или пропускаться; push не подтверждает прочтение.
|
||||
|
||||
Эффект стекла относится к MAUI-интерфейсу. API передаёт данные и события; производительность размытия, контрастность и анимации нужно проверять отдельно на устройствах.
|
||||
E2EE реализовано прикладным протоколом JOSE. Он не предоставляет forward secrecy, post-compromise security и прозрачность ключей; первая встреча и состав групп доверяют серверу. [Модель доверия](e2ee.md) обязательна к прочтению перед реализацией другого клиента.
|
||||
|
||||
Регистрация сейчас требует код приглашения. Обещание отключить приглашения после релиза является продуктовым планом, а не поведением текущего кода.
|
||||
В проверке этой ревизии прошли 735 серверных тестов на SQLite. Это не подтверждение доставки Firebase на устройство или состояния production-инсталляции. [Ограничения проверки](testing.md).
|
||||
|
||||
***
|
||||
|
||||
Проверено по исходникам на 03.10.2026, commit `4603be9`. Описано текущее поведение; успешная сборка не означает проверку работающего сервера.
|
||||
|
||||
Источник: [Govor.API/Program.cs](https://github.com/Govor-team/Govor/blob/4603be9f714135e0af72d505d17f3d1709834bea/Govor.API/Program.cs).
|
||||
Исходный код: [Govor, a3401ce](https://github.com/stalcker2288969/Govor/tree/a3401ceedf30c2eb6167f7ef6e4ae820883d2de2).
|
||||
|
||||
Reference in New Issue
Block a user