Ядро steer 2.1 говорит steer-api 1.1. Это прибавка к steer-api.md (1.0), а не новый
договор: программа, написанная по 1.0, работает, если не опиралась на снятое (раздел «Снято»). Плагин,
которому нужно новое, пишет compat.steer-api: "^1.1"; ядро 2.1 отвечает steer version --json с
"api":"1.1". Тест совместимости программы с ядром 2.1 — sh tests/compat/run.sh --steer <каталог плагина>
(заглушка ядра tests/compat/steer-2.1/host.py).
Официальные плагины протоколов (vless, hysteria2, proxy, xsteer, warpbox, obfs) написаны только на этом API:
в ядре 2.1 нет ни их видов, ни их команд. Сторона плагина в исходниках ядра — steer/src/plugkit
(pk_conf_load, pk_main, PK_PROGRAM) — образец разбора {conf} и точки входа.
- Виды
tunnel:<протокол>иxsteer, подкоманды и команды сокета протоколов — только из манифестов. Без плагина выход такого вида —unavailс причиной «нужен плагин — поставить», аapply— отказ с той же причиной; кто даёт вид, ядро узнаёт изprovides.kindsиндекса семени (/usr/share/steer/seed/index.json, index.md). Вида нет ни у кого — «протокол не знаю» / «неизвестный kind». kinds[].description— строка для человека: её берётsteer spec-schemaв описание варианта вида.
commands[].conf: true— первое слово подкоманды — имя выхода: ядро находит его в спеке и передаёт программе--conf <файл>с {conf} этого выхода (memfd/proc/self/fd/N, иначе файл помощника). Слово с/— путь, передаётся как есть.--specпрограммам протоколов больше не передаётся (снято).- {conf} выхода, развёрнутого хуком
expandс помощником (группаkind: warp), несёт вид и ключи, с которыми выход записал человек (output.kind: "warp",output.keys), а не группу, которой он стал, иoutput.members[]— выходы, заведённые разворотом:name,kind,device,mark,table,ipv6,over,sock_mark,sock_mark_required. - У выхода вида ядра с помощником от плагина (
impl: core,helper.when)output.keys— ключи, которые печатает вид ядра (уinterfaceсobfs—obfs). ctl.args— объект{"kind": "int", "flag": "--node", "min": -1, "max": 9999}: число в пределах, которое ядро передаёт флагом;ctl.body: "file"иctl.body_max— тело запроса временным файлом, путь — последним словом;ctl.lock.ctl.specснято (manifest.md,steer.commands[]).
- Вход
checkиexpandнесётoutput.common— общие ключи выхода (on_fail,over,ipv6,device…), кромеkind,protocolиowner. expandвида с помощником: развёрнутая группа получаетownerна себя, и её помощник — помощник вида.
helloобязателен первым и несётapi(steer-api программы: major как у ядра, minor не новее) иmod— id плагина. Иначе процесс гасится, причина — вlast_downиrejected(steer ctl helper). Версию плагина (ver) с версией ядра ядро не сверяет.state— файл состояния<state>/plugin/<id>/<выход>.status.jsonпереписан: ядро шлёт подписчикам сокета событиеplugin-state({"id","out"});statusпечатает файл полемplugin.stateвыхода, у видаtunnel:<протокол>— ещё прежним полем"<протокол>". Файл мёртвого процесса (pid) не печатается.- В файле состояния
diag— строки{"id","verdict","what","why"}дляsteer diag;probe— ход проверки узла{"state","node","total"}. revive(прежнее имяawg) — файл члена развёрнутой группы переписан, перенастроить устройство.kinds[].health: "events"— здоровье выхода поup/down(иnode/nonode) помощника, без пробы ядра.helper.when: "<ключ>"у видаimpl: core— помощник выходу вида ядра, у которого есть этот ключ (плагин obfs: видinterface, ключobfs).x-watch: trueу ключа-пути в схеме — содержимое файла входит в подпись перезапуска помощника.
ctl.specи--spec/--state-dirу подкоманд протоколов: выход — только {conf}.- Встроенные виды
vless,hysteria2, протоколы прокси иxsteerв ядре и шовsteer-<id>рядом соsteerd.
В статической сборке телефона плагинов на диске нет (open.md, О-13): программы vless, xsteer и obfs
слинкованы в бинарник (PK_PROGRAM), их манифесты — строками в нём; ядро запускает тот же бинарник с
STEER_PK_BUILTIN=<id>. Договор с программой тот же.