Skip to content

Latest commit

 

History

History
123 lines (104 loc) · 12.7 KB

steer-ui.md

File metadata and controls

123 lines (104 loc) · 12.7 KB

Steer UI и inbound: границы следующего этапа

Этот документ фиксирует требования владельца и результат проверки SDK перед разработкой Steer UI. Это проект контракта, а не описание уже работающей панели или серверной поддержки протоколов. Текущие версии осей API и матрица совместимости этим документом не повышаются.

Решение о продукте

  • Один плагин Steer UI содержит новый блочный интерфейс, сходный по устройству с Andromeda, и все пользовательские сценарии управления, включая WARP UI.
  • Первая платформа — Linux-сервер. OpenWrt следует позже; платформенные операции отделяются сразу. Наличие systemd, LuCI, rpcd, UCI и netifd не предполагается.
  • В Steer остаются ядро, протокольные и feature-плагины, в том числе WARP. UI не реализует протоколы и не становится вторым менеджером плагинов.
  • Исполняемый код новых плагинов — C или Rust. Браузерные ресурсы интерфейса остаются браузерным кодом; они поставляются вместе с Steer UI.
  • Все поддерживаемые протоколы должны получить входящую сторону, а не только SOCKS. В первую очередь явно названы SOCKS, VLESS, Hysteria2 и WireGuard через модуль ядра Linux. Поддержка исходящего протокола сама по себе не подтверждает наличие его серверной реализации.

Что уже даёт SDK

Потребность Действующий контракт Ограничение
Установка, обновление, отключение, удаление .s2p, подписи, compat, requires, менеджер Steer Не писать свой установщик или реестр состояния
Процесс HTTP-хоста Steer UI steer.services[] hello и ready через s2p/evline.h; процесс ведёт супервизор ядра
Переносимый C-бинарник s2p.json.cc, s2p cc, libc, musl Таблица целей сейчас состоит из архитектур OpenWrt; Linux-поставка требует проверки ELF и установки на стенде
Пути и состояние UI STEER_PLUGIN_DIR, STEER_PLUGIN_CONF, STEER_PLUGIN_STATE, STEER_CTL_SOCK, STEER_PLATFORM Не обращаться к внутренним файлам splify2 и не полагаться на init-систему
Применение спеки, диагностика и плагины Управляющий сокет Steer Использовать существующий транспорт и проверку ядра; не писать конфигурацию в обход apply
Проверка ключей протокола kinds[].keys, kind-keys.schema.json Сейчас это схема выхода, не inbound
Схема настроек плагина settings.schema, прежнее splify2.settings.schema, steer.settings: restart Нейтральные метаданные добавлены в рабочем дереве SDK; старые хосты читают прежнее поле. Форма нового хоста ещё не реализована
UI-расширения Andromeda host-api, @splify2/plugin-api Контракт Preact-хоста Andromeda; новая панель не объявляет совместимость без реализации адаптера
Публикация CGI под OpenWrt splify2.cgi Требует хоста splify2; это не независимый Linux-хост

Проверенные места реализации SDK: cmd/s2p/manifest.go, lint.go, project.go, cc.go, schema/plugin.schema.json, schema/kind-keys.schema.json, include/s2p/evline.h, tests/compat/steer-2.1/host.py. Сторона ядра: src/kinds/plugin.c, src/daemon/helpers.c, src/daemon/supd.c, src/daemon/ctl.c в репозитории Steer.

Чего пока нет

Документация раньше перечисляла linux среди значений STEER_PLATFORM, но реестр src/platform/platform.c ядра содержит только openwrt и android. На обычном Linux выбирается профиль OpenWrt. Это не отдельный Linux-адаптер. Установка requires.system в src/pluginmgr/pminst.c также опирается на apk/opkg; имя kmod-wireguard нельзя считать переносимым именем пакета Ubuntu. Проверка возможностей ядра Linux, загрузка модуля и установка пакета должны быть разделены. Механизм requires.kernel уже описывает проверку наличия путей, но сам по себе не реализует установку или настройку WireGuard.

Служба steer.services[] живёт вместе с steerd. При выборе этого способа размещения хоста нужно отдельно проверить остановку маршрутизации, отказ конфигурации при старте и восстановление доступа к панели. Запущенная служба под супервизором ещё не доказывает доступность UI при остановленном ядре.

В действующем SDK нет регистрации вида inbound. steer.kinds[] регистрирует выходы; helper.per допускает только output, {conf} содержит output, STEER_OUT обозначает выход. steer.services[] запускает службу на весь плагин, но не создаёт модель именованных входов, проверку ссылок, ресурсы, помощник на каждый вход или его состояние.

В текущей спеке Steer нет раздела inbounds. lan.devices обозначает захват трафика сетевых интерфейсов. Это не SOCKS-, VLESS- или Hysteria2-слушатель. Нельзя сохранять придуманный раздел в UI и сообщать, что ядро его применило.

Кроме регистрации нужны серверные реализации протоколов. Их доступность проверяется отдельно от клиентских kinds: создание формы не добавляет серверную половину VLESS/Reality или Hysteria2.

Порядок расширения SDK

  1. Согласовать платформенный контракт Linux: явный профиль, пути, проверку возможностей ядра и адаптер системных зависимостей с сохранением OpenWrt. Не менять глобальное умолчание для существующих установок без проверки.
  2. Описать отдельную регистрацию inbound в манифесте и её минимальную версию steer-api. Не расширять значение steer.kinds[] с потерей старого смысла. Старое ядро должно отказать по совместимости до установки и изменения данных.
  3. Определить схему именованного входа: общие поля, протокольные ключи, ссылки на выходы, включение, адреса прослушивания и конфликты TCP/UDP-портов. Проверить IPv4/IPv6, wildcard-адреса и пересечение портов разных плагинов.
  4. Определить файл настройки и процесс помощника на вход: идентичность, версия API, параметры, пути, выделенные ресурсы, готовность, отказ, перезапуск при изменении ключей и завершение при отключении. Помощник не должен самостоятельно читать всю спеку.
  5. Зафиксировать передачу принятого трафика в маршрутизацию Steer. Для прокси нужны TCP/UDP, доменное назначение, DNS, выбор выхода/группы и поведение при отказе. Для WireGuard нужны управление устройством через kernel/netlink, peers, адреса и направление расшифрованного трафика в правила ядра. Независимая отправка через обычный default route не считается интеграцией.
  6. Разделить проверку/план и сетевые изменения: check не открывает порт и не меняет WireGuard; apply, rollback, reload и удаление имеют явные гарантии. Защита от открытого прокси и обращение с ключами входят в контракт протокола.
  7. Расширить схему манифеста, разбор SDK, lint, ссылки на файлы, подстановки, provides индекса и проверку совместимости. Проверить отсутствие помощника, некорректную схему, повтор имени и слишком старую API.
  8. Добавить C-заготовку inbound и стенд жизненного цикла SDK. Заготовка проверяет контракт; она не выдаётся за реализацию сетевого протокола.
  9. Реализовать этот же контракт в ядре и протокольных плагинах; подтвердить на Linux реальное соединение, отказ проверки без изменений, обновление, отключение и восстановление. Только затем обновлять объявляемую API и матрицу подтверждённой совместимости.

Номер новой версии API назначается вместе с реализацией. Один лишь новый JSON-ключ в схеме SDK не делает старое ядро способным исполнять этот контракт.

Порядок Steer UI после контракта

Хост поставляется обычным плагином SDK; браузерная часть и платформенный адаптер отделены от команд ядра. Все WARP-формы, мастера, диагностика и прочие экраны принадлежат Steer UI, а не распределяются по протокольным пакетам.

Первый сквозной сценарий: установка плагина, подключение к ядру, чтение состояния, создание inbound и выхода, проверка, применение, реальное подключение клиента, отображение ошибки и отключение плагина с сохранением конфигурации. Стенд Linux не подтверждает переносимость OpenWrt.

Оставшиеся сценарии splify2 переносятся с учётом владельцев API: списки, подписки, backup, проверка узлов и обновление сейчас частично живут в отдельных плагинах. Их UI переносится в Steer UI; серверные операции нельзя молча считать уже перенесёнными или копировать в ядро.