Frieren: Микро-фреймворк для security-гаджетов

Описание

Frieren — это фреймворк для запуска security-инструментов на роутерах OpenWrt и одноплатных компьютерах (SBC). Он предоставляет веб-панель с управлением WiFi, устанавливаемыми модулями, встроенным терминалом и менеджером пакетов. Стек состоит из PHP-бэкенда API и React-фронтенда, спроектирован достаточно лёгким для встраиваемых устройств, оставаясь расширяемым через сторонние модули.

Возможности

• Управление WiFi — Создание, редактирование и удаление беспроводных интерфейсов. Сканирование сетей, настройка радио, редактирование сырых UCI-конфигов.
• Сеть — Управление сетевыми интерфейсами, просмотр DHCP-аренд и запуск диагностики подключения.
• Система модулей — Установка, удаление и закрепление сторонних модулей из удалённого репозитория. Модули загружаются динамически как UMD-бандлы.
• Менеджер пакетов — Установка и удаление opkg-пакетов прямо из веб-панели.
• Встроенный терминал — Веб-терминал (ttyd), доступный из панели.
• Системные инструменты — Дашборд со статистикой системы, список USB-устройств, использование файловой системы, просмотрщик syslog, диагностика и управление службами init.d.
• Настройки — Конфигурирование имени хоста, часового пояса, пароля пользователя и темы панели.
• Расширяемость — Создание новых модулей с помощью frieren-module-template. PHP-контроллер + React-фронтенд для каждого модуля.

Компоненты

• frieren-back — PHP-микрофреймворк. JSON POST API с сессионной аутентификацией, CSRF, интеграцией UCI-конфигов и мини-ORM.
• frieren-front — React SPA (Vite, Wouter, Jotai, React Query). Поддерживает динамическую загрузку UMD-модулей.
• frieren-module-template — Инструмент для создания каркаса сторонних модулей с общими зависимостями через window-глобалы.
• frieren-terminal — @frieren/terminal-core, библиотека TypeScript/xterm.js, встраиваемая во фронтенд. Предоставляет живого клиента ttyd-терминала, просмотрщик логов только для чтения и общие темы терминала.
• tools — Инструменты разработки: dev-прокси для API, скрипт развёртывания на устройстве, тестовый API-клиент и PHP-минификатор.

Связанные репозитории

• Frieren Modules: Содержит модули, разработанные сообществом на основе frieren-module-template. Этот репозиторий — ресурс для пользователей, желающих расширить функциональность своей установки Frieren дополнительными возможностями.
• Frieren Release: Содержит установщики для развёртывания предкомпилированных версий Frieren. Этот репозиторий идеально подходит для пользователей, которые хотят быстро и легко установить Frieren, не проходя процесс сборки.
• Frieren Modules Release: Пайплайн сборки каталога модулей — генерирует индекс modules.json и tarball-архивы релизов для каждого модуля, из которых панель выполняет установку.

Установка

Frieren работает на OpenWrt (официальные сборки, не форки). Его можно установить с помощью автоматизированного скрипта или скомпилировать вручную.

Быстрая установка

Для быстрой и лёгкой установки выполните следующую команду в вашем терминале. Этот скрипт выполнит все необходимые настройки и шаги установки:

wget -qO- https://raw.githubusercontent.com/xchwarze/frieren-release/master/install/install-openwrt.sh | sh

Впервые здесь? Начните отсюда. Если вы не уверены, что такое OpenWrt, как его прошить или как потом открыть панель, следуйте пошаговому руководству для новичков FAQ по установке — оно проведёт вас через весь путь от чистого устройства до входа в систему.

Ручная сборка

Каждый компонент проекта Frieren (frieren-back, frieren-front и frieren-module-template) имеет собственный подробный файл README.md с инструкциями по сборке и установке. Обратитесь к этим файлам в соответствующих каталогах для получения более детальных указаний.

Разработка модулей

Используйте frieren-module-template для создания каркаса новых модулей. Запустите yarn wizard, чтобы настроить новый модуль, разработайте свою функцию, затем yarn build для компиляции UMD-бандла. Подробности см. в README шаблона модуля.

Лицензия

Этот проект лицензирован под PolyForm Noncommercial License 1.0.0.

Некоммерческое использование разрешено. Коммерческое использование не разрешено в рамках этой лицензии. Коммерческое использование требует отдельной коммерческой лицензии от автора.

По вопросам коммерческого лицензирования обращайтесь: [email protected]

Участие в разработке

Приветствуются любые вклады — новые функции, исправления ошибок или модули. Инструкции по сборке см. в README каждого компонента.

Авторы

• Ведущий разработчик: DSR! - [email protected]

Поддержка разработки

Если вы считаете Frieren полезным, подумайте о поддержке разработки. Пожертвования финансируют тестовое оборудование и текущую работу. Отправляйте через Binance или присоединяйтесь к Patreon для получения эксклюзивных обновлений и сборок.