Транспорт, маршруты и размещение файлов

Три входа

Основная служба Altera слушает Unix-сокет /run/altera/.socket. По нему передаются сообщения JSON Lines с обязательным LF, формат — UTF-8, лимит строки — 8 МиБ. Клиент идентифицируется через определение UID/GID подключившегося процесса.

Служба сессий Altera слушает Unix-сокет /run/altera/sessions.socket. Управляющий запрос передаётся как JSON Lines с лимитом строки 8 МиБ. После открытия канала данные пересылаются побайтово; лимит управляющей строки к ним не применяется. Для backend передаётся JSON Lines, для upload — JSON-заголовки и бинарные данные.

Веб-сервер слушает веб-сокет (по умолчанию 127.0.0.1:2003). При включённом TLS используются HTTPS/WSS; иначе HTTP/WS. Проверка Bearer-сессии выполняется до WebSocket Upgrade. В Sec-WebSocket-Protocol клиент предлагает altera и bearer.<token>, а сервер возвращает только altera. Передача токена через WebSocket subprotocol — соглашение Altera; токен не возвращается в ответном заголовке.

Маршруты

ВходМетод / транспортПутьНазначение и доступ
WebGET, HEAD/ui/<module>/...Статические ресурсы UI; токен не требуется
WebPOST/auth/loginJSON с логином/паролем → PAM → Bearer-токен
WebPOST/auth/logoutОтзыв сессии по Authorization: Bearer <token>
WebGET + WebSocket Upgrade/wsНесколько модулей через один CLI; Bearer-токен обязателен
WebGET + WebSocket Upgrade/backend3/<module>Один backend3; Bearer-токен обязателен
WebGET + WebSocket Upgrade/backend4/<module>Один backend4; Bearer-токен обязателен
WebGET + WebSocket Upgrade/uploadПротокол загрузки файлов; Bearer-токен обязателен
WebOPTIONSЛюбой путьПредварительный запрос CORS (preflight)
UnixJSON Lines поверх Unix stream/run/altera/sessions.socketДоступ только у процессов с UID пользователя altera
UnixJSON Lines поверх Unix stream/run/altera/.socketНесколько модулей через одно соединение; модуль задаётся ключом /backend3/<module> или /backend4/<module> в JSON; идентичность по Unix-peer, доступ — root либо Polkit

/upload в этой реализации — не HTTP POST для файла и не backend-модуль. altera-cli /upload также не устанавливает Unix-соединение: он запускает файловый обработчик в собственном процессе.

Пути установки

РесурсПуть
Основная служба Altera/usr/bin/altera
Служба сессий Altera/usr/bin/altera-sessions
Altera Web/usr/bin/altera-web
CLI/usr/bin/altera-cli
Unix-сокет/run/altera/.socket
Unix-сокет сессий/run/altera/sessions.socket
Backend3/usr/lib/alterator/backend3/<module>
Backend4/usr/lib/alterator/backend4/<module>
UI/usr/share/alterator/ui/<module>/react/
Главная страница UIindex.html в указанном каталоге
PAM service/etc/pam.d/altera
Политики Polkit/usr/share/polkit-1/actions/*.policy
Сертификат TLS/etc/alterator/altera/tls/fullchain.pem
Ключ TLS/etc/alterator/altera/tls/privkey.pem

Каталог react — текущая договорённость размещения файлов. Сервер отдаёт HTML/JS/CSS и не исполняет React на серверной стороне. Для отсутствующего ресурса UI предусмотрен переход к index.html.

Имя модуля <module> допускает ASCII-буквы, цифры, -, _; имя только из - и _ отвергается.

Источники