VNOX-Server/docs/design/social-presence-sharing.md

59 lines
13 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Vnox: активность, профиль, демонстрация, языки и вебхуки
Статус: продуктовый план по обратной связи пользователя, не заявление о готовых функциях. Логотип утверждён: «Связь», простой V (`brand/vnox-link.svg`). Текущий UI/Hub groundwork проверяется и коммитится отдельными изменениями.
## Активность и присутствие
В протоколе уже есть ONLINE/IDLE/DND/OFFLINE/INVISIBLE и типы playing/listening/watching/streaming/custom. Это заготовка; текущие broadcast и сериализация требуют согласования, а приватность ещё не реализована как законченный контракт.
Первый этап: статус, ручной текст, автоматический idle и отображение факта трансляции/звонка с отдельной видимостью. Автоопределение игры — opt-in, с выключателем для конкретных приложений. Пользователь выбирает аудиторию: никто, друзья, участники выбранных сообществ. DND управляет уведомлениями; Invisible означает offline для остальных и скрывает активность. Подписки и выдача API фильтруются сервером, а не только интерфейсом.
Процессы определяются локально; в Hub отправляются только выбранные сведения известного приложения, не полный список процессов/путей/заголовков окон. Закрытый сервер/канал не раскрывается посторонним через «сейчас в голосе». Активность имеет TTL и исчезает после потери устройства. Несколько устройств агрегируются, отключение одного не ставит пользователя offline при другом активном.
Rich Presence SDK — последующий этап: зарегистрированные application_id, проверяемый издатель, ограниченная локальная IPC-интеграция, allowlist полей/кнопок и явный пользовательский контроль. Нельзя позволять любому локальному процессу незаметно выдавать себя за другую игру.
## Социальные ссылки в профиле
В карточке: аватар, имя/handle, краткое «О себе», активность и компактный ряд социальных ссылок с узнаваемой иконкой и показом домена. Начальные типы GitHub, Telegram, YouTube, Twitch, Steam и собственный сайт; список расширяемый. До6 ссылок с порядком, подписью и настройкой видимости профиля/друзей/сообщества.
В первой версии это явно пользовательские ссылки, не доказательство владения аккаунтом. Значок подтверждённого владения появляется только после отдельного OAuth/проверки. GitHub, использованный для входа, не публикуется автоматически без выбора пользователя.
Разрешены проверенные HTTPS URL с ограниченными длинами, без javascript/data/file/custom-scheme и пользовательского HTML. Открытие в системном браузере, внешний домен виден до перехода. Сервер не выполняет запрос к произвольному URL ради превью по умолчанию; это предотвращает SSRF/трекинг. Изменения доступны только владельцу профиля, конфликты версий решаются явно.
## Демонстрация экрана
Диалог разделяет три выбора: видео (окно/экран), звук (выключен/конкретное приложение/весь системный звук) и параметры качества. Микрофон остаётся самостоятельным голосовым источником. Выключение микрофона не выключает звук приложения, остановка демки не завершает голосовой звонок. У зрителя отдельная громкость трансляции и голоса.
Режим по умолчанию для окна — звук того же приложения, только когда доступно надёжное сопоставление. Нельзя молча переключать отсутствующий per-app capture на запись всего устройства: уведомления и другие программы могут содержать приватные данные. Если сопоставления нет, показать «звук приложения недоступен» и предложить явный выбор. Захват процесса может включать несколько окон/дочерних процессов, особенно браузера; не обещать изоляцию отдельной вкладки без соответствующего API.
Windows: process loopback WASAPI (ActivateAudioInterfaceAsync) поддерживает выбранный процесс и его дерево на поддерживаемых версиях Windows. Проверять capability ОС, не предполагать наличие по общему названию Windows10.
Linux Wayland: видео через системный ScreenCast portal с пользовательским выбором; PipeWire для потоков. Audio per-app — отдельная работа с доступными PipeWire streams и политикой session manager. ScreenCast portal сам по себе не гарантирует per-app audio. Нельзя менять пользовательский PipeWire config ради запуска Vnox. X11/macOS получают отдельные adapters и проверку разрешений; первая цель — Linux/Windows.
Видео, звук демонстрации и микрофон имеют разные media tracks. Собственный голос/принимаемый Vnox звук исключаются из захвата по возможности, чтобы не создавать петлю; невозможность исключить источник отражается в UI. Синхронизация A/V, bitrate adaptation, потеря пакетов и ключевые кадры — обязательная часть медиа-протокола.
Для транспорта рассмотреть готовый WebRTC стек и встроенный SFU/relay модуль на том же сервере сообщества вместо самостоятельного изобретения видео-протокола. Отдельной голосовой/видео машины нет. Hop-by-hop media encryption не называть E2EE через сервер. Выбор Rust-библиотеки, codecs и hardware encoding подтверждается прототипом и тестами; новые зависимости в текущий groundwork не добавляются.
MVP: одна трансляция пользователя, ручной выбор зрителя, доступ по комнате и праву STREAM, смена источника/остановка/отзыв доступа. Качество по умолчанию до1080p30 с адаптацией; gaming60fps и несколько одновременных трансляций — после измерений. Отсутствие поддержки должно быть явным, а не кнопкой без результата.
## Языки клиента
Первый полноценный набор ru/en, включая ошибки, настройки, письма и формы входа. Выбор при первом запуске по системной locale с ручным переопределением. Далее uk, pl, de, es, fr и pt-BR по готовности качественных переводов; не показывать язык с половиной непереведённых строк как поддержанный.
Использовать native Slint @tr/gettext catalogs, извлечение строк, plural forms, стабильные контексты и общий подход для Rust errors/backend error codes. В протоколе передаются коды ошибок и параметры, а не готовая русская фраза. Протестировать длины переводов и форматирование дат/чисел; выбор языка независим от timezone. Сообщения пользователей не переводятся через внешний сервис без согласия.
## Вебхуки
Первыми — входящие вебхуки конкретного сервера в выбранный текстовый канал: GitHub/GitLab CI, игровые серверы, мониторинг. Создать/посмотреть/перевыпустить/отключить может роль с MANAGE_WEBHOOKS. Сообщения имеют отдельную webhook identity/метку и не могут незаметно имитировать человека. Разрешения не дают global DM, server administration или массовых mentions автоматически.
Endpoint принимает ограниченный JSON, с отдельным высокоэнтропийным секретом на hook, rate limits и idempotency/delivery_id. Секрет показывается владельцу при создании и может быть отозван. Не помещать его в обычные access logs; предпочтителен Authorization header, а провайдерские форматы валидируются адаптером. GitHub HMAC проверяется по исходным байтам тела до парсинга.
Исходящие hooks — второй этап: только явно выбранные события/каналы, HTTPS, HMAC подпись тела с event_id/timestamp, ограниченные повторы/таймауты и журнал доставки. Дубликаты возможны, потребитель должен дедуплицировать. Адреса назначения проверяются против SSRF, DNS rebinding и редиректов в локальную инфраструктуру. Содержимое закрытого канала не уходит по webhook без соответствующих прав и предупреждения администратора.
Вебхуки живут у сервера сообщества. Центральный Hub не проксирует всю интеграционную переписку. Discord-compatible payload adapter возможен позже, но совместимость с Discord API целиком не обещается.
## Очерёдность
Сначала закончить текущие UI/dependency/Hub deploy/commits, затем согласовать общий клиент-серверный протокол, права и auth. После этого ru/en infrastructure и профиль со ссылками, приватное присутствие, входящие hooks; демка — отдельный медиа-этап с реальными Linux/Windows тестами.
Источники: [Windows process loopback](https://learn.microsoft.com/en-us/samples/microsoft/windows-classic-samples/applicationloopbackaudio-sample/), [ScreenCast portal](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.ScreenCast.html), [PipeWire loopback](https://docs.pipewire.org/page_module_loopback.html), [Slint translations](https://docs.slint.dev/latest/docs/slint/guide/development/translations/), [GitHub webhook signatures](https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries), [OWASP SSRF](https://cheatsheetseries.owasp.org/cheatsheets/Server_Side_Request_Forgery_Prevention_Cheat_Sheet.html).