6 Commits

Author SHA1 Message Date
5661de72b7 Add UI DNS challenge issuance and automatic home NPM renewal
All checks were successful
Test and publish Homegate / checks (push) Successful in 29s
Test and publish Homegate / publish (push) Successful in 12m43s
2026-10-15 05:42:15 +03:00
eeffcfb616 Add NPM certificate selection and read-only VDS certificate renewal sync
All checks were successful
Test and publish Homegate / checks (push) Successful in 28s
Test and publish Homegate / publish (push) Successful in 12m47s
2026-10-15 05:12:03 +03:00
b305cc1ba8 Support passwordless Pi-hole authentication and UI settings
All checks were successful
Test and publish Homegate / publish (push) Successful in 12m49s
Test and publish Homegate / checks (push) Successful in 29s
2026-10-14 18:12:10 +03:00
a83d897b70 Add first-run web setup and Compose without environment or secrets
All checks were successful
Test and publish Homegate / checks (push) Successful in 29s
Test and publish Homegate / publish (push) Successful in 12m46s
2026-10-14 03:26:50 +03:00
6844ccf0b9 Fix inline configs and secrets in registry Compose deployment
All checks were successful
Test and publish Homegate / checks (push) Successful in 28s
Test and publish Homegate / publish (push) Has been skipped
2026-10-14 02:54:23 +03:00
dd0f4ff8a8 Explain missing registry secrets before publishing
All checks were successful
Test and publish Homegate / checks (push) Successful in 26s
Test and publish Homegate / publish (push) Has been skipped
2026-10-14 02:02:16 +03:00
30 changed files with 2703 additions and 100 deletions

View File

@@ -4,8 +4,12 @@
!homegate.py
!sync_ssh.py
!homegate_ui.py
!dns_challenge.py
!dns-providers-legacy.json
!THIRD_PARTY_NOTICES.md
!ui/
!ui/dist/
!ui/dist/**
!bootstrap.py
!standalone.py
!VERSION

View File

@@ -33,6 +33,9 @@ jobs:
- name: JavaScript and shell syntax
run: |
node --check ui/dist/app.js
node --check ui/dist/settings.js
node --check ui/dist/certificates.js
node --check ui/dist/dns-challenge.js
for script in setup.sh run-local.sh ci/smoke_image.sh; do sh -n "$script"; done
- name: Compose contracts
env:
@@ -60,6 +63,23 @@ jobs:
DOCKER_BUILD_SUMMARY: "false"
DOCKER_BUILD_RECORD_UPLOAD: "false"
steps:
- name: Validate registry credentials
shell: bash
env:
REGISTRY_USERNAME: ${{ secrets.REGISTRY_USERNAME }}
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
run: |
set -euo pipefail
missing=0
if [ -z "${REGISTRY_USERNAME:-}" ]; then
echo "::error::Missing Actions secret REGISTRY_USERNAME. Set it in Repository Settings > Actions > Secrets to the Gitea username that owns REGISTRY_TOKEN."
missing=1
fi
if [ -z "${REGISTRY_TOKEN:-}" ]; then
echo "::error::Missing Actions secret REGISTRY_TOKEN. Set it in Repository Settings > Actions > Secrets to a Gitea personal access token with write:package permission. Actions Variables and runner environment variables do not populate secrets.REGISTRY_TOKEN."
missing=1
fi
exit "$missing"
- name: Checkout release
uses: https://github.com/actions/checkout@v4
with:

138
CERTIFICATES.md Normal file
View File

@@ -0,0 +1,138 @@
# Один домен дома и в интернете
Пример: мобильное приложение использует `https://disk.hyperdog.dev`.
Снаружи публичный DNS ведёт на VDS. Дома Pi-hole возвращает LAN-IP домашнего NPM,
а домашний NPM направляет запрос в локальный Nextcloud и предъявляет публичный сертификат.
Установка корневого CA на телефон для такого сертификата не требуется.
## Выпуск и автопродление через DNS challenge
Этот вариант не зависит от VDS: сертификат выпускает и продлевает **домашний NPM**.
Нужен зарегистрированный публичный домен и API-доступ к его DNS-провайдеру.
Публичные A/AAAA-записи продолжают указывать на VDS; для проверки владения доменом
NPM временно создаёт TXT-запись `_acme-challenge`. Открывать домашние порты в интернет
не требуется. Зоны `.home`, `.local` и другие внутренние имена для Let's Encrypt не подходят.
1. В **Настройки → Доменные зоны** добавьте `hyperdog.dev`.
2. Добавьте сервис с доменом `disk.hyperdog.dev` и локальным адресом Nextcloud.
3. В **HTTPS-сертификат → Источник** выберите **Let’s Encrypt — DNS challenge**.
4. Укажите домены сертификата и выберите DNS-провайдера. Скопируйте показанный шаблон
в поле **API-доступ DNS-провайдера**, заменив значения своим токеном.
Для Cloudflare используйте API Token с разрешением **Zone:DNS:Edit**, ограниченный нужной зоной.
5. При необходимости задайте время ожидания DNS; пустое поле оставляет значение плагина.
Подтвердите условия Let's Encrypt и нажмите **Выпустить сертификат**.
6. Дождитесь результата. Форма сама выберет полученный сертификат домашнего NPM.
Нажмите **Добавить сервис** или **Сохранить** — Homegate создаст локальный DNS и прокси.
Отдельный выпуск доступен в **Сертификаты → Выпустить Let’s Encrypt**. Можно указать
несколько имён или wildcard, например `*.hyperdog.dev`. Он покрывает `disk.hyperdog.dev`,
но не `hyperdog.dev` и не `deep.disk.hyperdog.dev`. После отдельного выпуска выберите
сертификат в карточках нужных сервисов.
### Продление и хранение токена
Домашний NPM сохраняет DNS credentials и автоматически использует их при продлении.
Homegate передаёт их только в запросе выпуска и не сохраняет в своих файлах,
YAML, состоянии задания или логах. В Compose и env добавлять ничего не нужно.
Сертификат остаётся под тем же ID; Homegate не заменяет его сертификатом локального CA.
Резервируйте данные домашнего NPM, включая `/data` и `/etc/letsencrypt`.
Для выпуска и продления домашнему NPM нужен исходящий доступ к интернету, DNS-провайдеру
и Let's Encrypt. При временном отсутствии интернета уже выпущенный сертификат работает
до истечения срока; локальный Nextcloud остаётся доступен. Подключение к NPM на VDS
не используется и его production-конфигурация не меняется.
Современный NPM возвращает список провайдеров через API и использует email своей
учётной записи. Для старых версий без этого API Homegate показывает каталог NPM 2.12.6
и дополнительное поле email. Доступность конкретного плагина зависит от версии домашнего NPM.
Выпуск идёт в фоне и может занять до 15 минут. Если соединение прервалось или Homegate
перезапустился, нажмите **Проверить результат**: это только чтение списка сертификатов.
Повторный выпуск автоматически не отправляется. Уже существующий действующий сертификат
с тем же набором доменов и провайдером используется повторно. В этом случае новый токен
не записывается поверх старого; ротация credentials существующего сертификата выполняется в NPM.
Если выпуск отклонён, проверьте токен, права на зону и журнал домашнего NPM.
Протокол: [Let's Encrypt DNS-01](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge).
Права Cloudflare: [документация DNS-плагина Certbot](https://certbot-dns-cloudflare.readthedocs.io/en/stable/).
## Уже есть подходящий сертификат в домашнем NPM
1. В **Настройки → Доменные зоны** добавьте `hyperdog.dev`.
2. Добавьте или отредактируйте сервис: домен `disk.hyperdog.dev`, адрес локального
Nextcloud, например `http://192.168.0.20:8080`.
3. В **HTTPS-сертификат → Источник** выберите **Существующий сертификат домашнего NPM**.
4. Выберите сертификат из списка и сохраните. Homegate проверит срок и соответствие
домену, создаст локальную DNS-запись и прокси с выбранным ID сертификата.
В этом режиме Homegate не выпускает и не загружает сертификат вместо выбранного.
Let’s Encrypt автоматически продлевает домашний NPM по своей текущей конфигурации.
Для Custom сертификата обновлением занимается его издатель; для автоматического
копирования с VDS используйте следующий режим. Смена CA Homegate для новой зоны не нужна.
## Автоматическая копия сертификата с NPM на VDS
1. В **Настройки → Сертификаты с NPM на VDS** укажите HTTPS URL панели NPM на VDS
без `/api`, логин и пароль существующей учётной записи с доступом к чтению и скачиванию
нужного сертификата. Сохраните настройки. Пароль остаётся на сервере и не возвращается в UI.
2. В карточке сервиса выберите **Копия из NPM на VDS — автообновление**.
3. В списке **Сертификат на VDS** выберите существующий сертификат Let’s Encrypt.
4. В поле **Сертификат домашнего NPM** оставьте **Создать новую копию в домашнем NPM**
либо выберите существующий Custom, содержимое которого нужно обновлять этой копией.
5. Сохраните. После успешной синхронизации в разделе **Сертификаты** появятся срок действия,
источник и время проверки копии.
Оба NPM должны быть разными серверами. При первом успешном копировании Homegate скачивает
сертификат, цепочку и ключ с VDS и загружает их только в домашний NPM. Ключ обрабатывается
в памяти; он не появляется в логах, публичном API, YAML, SSH-конфиге или registry.json.
Сам домашний NPM сохраняет ключ для TLS, как при обычном импорте Custom сертификата.
### Production NPM на VDS: только чтение
Код отдельного клиента VDS разрешает только:
- `POST /api/tokens` — обычная авторизация;
- `GET /api/nginx/certificates` — список сертификатов;
- `GET /api/nginx/certificates/<id>/download` — скачивание выбранного сертификата.
Homegate не создаёт, не редактирует и не удаляет прокси, сертификаты или настройки
на VDS и не вызывает там renew. Выпуск и продление продолжаются по уже существующей
конфигурации NPM на VDS. Это ограничение проверяется автоматическими тестами.
Настраивать Actions, cron, SSH-доступ или скрипт на VDS для копирования не нужно.
### Как обновляется домашняя копия
Каждый цикл контроллер читает метаданные источника. При изменении сертификата он
скачивает новую версию; дополнительно содержимое проверяется скачиванием раз в сутки.
До загрузки проверяются домены всех локальных прокси, использующих копию, срок действия,
цепочка и соответствие приватного ключа. Обновление применяется к тому же Custom ID,
после чего домашний nginx перезагружается через API NPM. Неудачная перезагрузка повторяется.
Если интернет или API VDS недоступны, последняя копия остаётся в домашнем NPM.
Локальные DNS и прокси продолжают обслуживаться; ошибка копирования видна в UI.
HTTPS работает до истечения сохранённого сертификата. Для получения новой версии
с VDS нужен доступ к его API. Homegate не переходит на свой локальный CA при ошибке.
Штатный экспорт NPM поддерживает скачивание сертификатов **Let’s Encrypt**; Custom
сертификаты VDS в списке источников не показываются. Нельзя синхронизировать копию
поверх Let’s Encrypt сертификата домашнего NPM: для неё нужен отдельный Custom.
## DNS и Nextcloud
Телефон дома должен использовать Pi-hole как DNS. VPN, Private DNS/DoH и публичный
резервный DNS могут обходить локальную запись. Публичную DNS-запись на VDS менять не нужно.
Сам Nextcloud и его данные должны быть доступны дома без VDS; его `trusted_domains`
должен содержать выбранное имя, а настройки trusted proxies должны учитывать домашний NPM.
## Проверка реализации
Контракты списка, ZIP-экспорта и multipart-загрузки сверены с
[исходниками NPM 2.12.6](https://github.com/NginxProxyManager/nginx-proxy-manager/blob/v2.12.6/backend/internal/certificate.js).
Тесты используют изолированные HTTP-заглушки и настоящие X.509 сертификаты.
Реальные credentials и сертификаты production VDS для разработки не использовались.
DNS challenge проверен по контрактам NPM
[2.12.6](https://github.com/NginxProxyManager/nginx-proxy-manager/blob/v2.12.6/backend/routes/nginx/certificates.js)
и [2.16.0](https://github.com/NginxProxyManager/nginx-proxy-manager/blob/v2.16.0/backend/routes/nginx/certificates.js).
Тесты проверяют фоновый выпуск, восстановление после таймаута, отсутствие повторного
ACME-запроса, фильтрацию credentials и запрет записи на VDS. Интерфейс проверен
с локальной заглушкой NPM; реальный ACME-выпуск и изменение публичного DNS при разработке не выполнялись.

View File

@@ -2,12 +2,13 @@ FROM python:3.13-slim-bookworm
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY homegate.py sync_ssh.py homegate_ui.py bootstrap.py VERSION .
COPY homegate.py sync_ssh.py homegate_ui.py dns_challenge.py dns-providers-legacy.json THIRD_PARTY_NOTICES.md bootstrap.py standalone.py VERSION .
COPY ui/dist ./ui/dist
ARG VERSION=0.4.0
ARG VERSION=0.6.0
LABEL org.opencontainers.image.title="Homegate" \
org.opencontainers.image.description="LAN DNS, HTTPS and SSH management for Pi-hole and NPM" \
org.opencontainers.image.version=$VERSION
RUN mkdir -p /config /data /control && chown 1000:1000 /config /data /control
USER 1000:1000
ENTRYPOINT ["python", "/app/homegate.py"]
CMD ["run"]

View File

@@ -1,4 +1,4 @@
# Homegate 0.4
# Homegate 0.6.0
Дополнение к **существующим Pi-hole и Nginx Proxy Manager** для домашней сети:
@@ -6,23 +6,29 @@
https://pve.home → NPM:443 → https://192.168.0.137:8006
```
Вы описываете сервисы в `config/services.yaml`. Homegate создаёт локальные DNS-записи,
Вы добавляете сервисы в веб-панели. Homegate создаёт локальные DNS-записи,
сертификаты и Proxy Hosts, затем поддерживает их актуальными. Развёртывание — Docker Compose.
Веб-панель Homegate управляет сервисами, доменными зонами, SSH и настройками сети.
Отдельный контейнер публикует SSH-конфиг без авторизации для устройств домашней подсети.
SSH-конфиг публикуется без авторизации для устройств домашней подсети.
Новое в 0.4: [один Compose-файл, готовый образ и Gitea Actions](REGISTRY.md).
**Простой запуск 0.6.0: [Compose без env и secrets, вся настройка в UI](SIMPLE.md).**
Откройте `http://IP-СЕРВЕРА:8098` и заполните адреса NPM/Pi-hole в форме. Пароль панели не нужен.
Расширенный вариант с отдельными контейнерами: [Compose и Gitea Actions](REGISTRY.md).
Также доступны: [веб-панель и локальный запуск](WEB.md), [SSH-конфиг и скрипт для ПК](SSH.md), [кастомные доменные зоны и миграция CA](DOMAINS.md).
**Для HTTPS без предупреждений нужно один раз установить `root-ca.crt` на каждое
клиентское устройство.** Для внутренних имён `.home` публичный сертификат Let's Encrypt
**Для публичного домена можно выпустить Let's Encrypt через DNS challenge с автопродлением
в домашнем NPM, выбрать существующий сертификат или обновляемую копию с NPM на VDS —
без установки CA на телефон.** Настройка целиком через UI:
[DNS challenge, сертификаты NPM и синхронизация с VDS](CERTIFICATES.md).
Для режима **Homegate — локальный CA** нужно один раз установить `root-ca.crt` на каждое
клиентское устройство. Для внутренних имён `.home` публичный сертификат Let's Encrypt
не подходит. Установка корневого сертификата на сервер не устанавливает доверие на
телефонах и компьютерах. Доверие к локальному CA описано в
[документации Let's Encrypt](https://letsencrypt.org/docs/certificates-for-localhost/).
Зоны настраиваются списком `domain_zones`: например `home`, `home.arpa`, `lab.internal`,
`lab.example.net`. Поддерживаются несколько зон одновременно и несколько уровней
поддоменов; каждому имени выпускается отдельный сертификат. В примере сохранено `pve.home`.
поддоменов; источник сертификата выбирается для каждого сервиса. В примере сохранено `pve.home`.
Для новой домашней зоны стандарт рекомендует `home.arpa`:
[RFC 8375](https://www.rfc-editor.org/rfc/rfc8375.html).
@@ -45,7 +51,7 @@ DNS указывает на **NPM**, а не на Proxmox. Порт и прот
Сервис `ssh-export` публикует HTTP-порт `8099` на явно заданном LAN-IP и проверяет
клиента по `allowed_networks`. Он не имеет доступа к `state/` и паролям API.
Он может работать на отдельной Linux VM с доступом к API вашего Pi-hole и NPM.
Образ пока не опубликован. `compose.yaml` собирает его из исходников;
`compose.yaml` собирает образ из исходников;
`compose.registry.yaml` скачивает готовый образ после публикации через Gitea Actions.
Для запуска только по одному файлу, без исходников и setup.sh, см. [REGISTRY.md](REGISTRY.md).
@@ -63,12 +69,12 @@ DNS указывает на **NPM**, а не на Proxmox. Порт и прот
- Если Pi-hole и NPM на одном IP, их web-порты должны различаться: например NPM
`80/81/443`, Pi-hole web `8080`, DNS `53`. Homegate этот конфликт автоматически не исправляет.
Проверены Compose-конфигурация, shell-синтаксис и 55 тестов: сертификаты, настоящее TLS-рукопожатие
Проверяются Compose-конфигурация, shell-синтаксис и автоматические тесты: сертификаты, настоящее TLS-рукопожатие
в стандартных и кастомных зонах, продление, повторный запуск, конфликты, ошибки API,
смена CA, HTTP-обработчик выгрузки, LAN ACL и отказ опасных SSH-директив.
Подключение дополнительного файла также проверено настоящим `ssh -G` с сохранением личных настроек.
HTTP API в тестах имитируются по официальным контрактам. **Запуск образа, реальные API NPM/Pi-hole,
HTTPS-сервисы и noVNC на вашем сервере ещё не проверены:** локальная служба Docker при подготовке не работала.
HTTP API в тестах имитируются по официальным контрактам. Сборка и локальный запуск контейнеров
проверены отдельно. Реальные API NPM/Pi-hole, HTTPS-сервисы и noVNC на вашем сервере не проверены.
## Быстрый запуск из исходников

View File

@@ -1,5 +1,8 @@
# Один Compose-файл и Gitea Container Registry
Для запуска без environment, secrets и пароля панели используйте [compose.simple.yaml](SIMPLE.md):
все адреса и подключения задаются в UI. Ниже описан расширенный вариант с отдельными контейнерами.
Homegate 0.4 поддерживает два способа установки:
| Файл | Назначение |
@@ -7,8 +10,21 @@ Homegate 0.4 поддерживает два способа установки:
| `compose.registry.yaml` | Готовый образ из Gitea; именованные volumes, автоматическая первичная настройка |
| `compose.yaml` | Прежний запуск из исходников с `build`, `setup.sh` и каталогами на хосте |
Gitea здесь ещё не подключена, образ не опубликован. Workflow готов к запуску в вашем
репозитории. Имена `git.example.home` и `your-user` ниже — примеры.
Для установки дождитесь успешной публикации образа в Gitea Actions.
Имена `git.example.home` и `your-user` ниже — примеры.
В варианте с одним файлом Compose записывает `configs.content` и `secrets.environment`
в файловую систему контейнера до его запуска. Поэтому у `initialize`, `homegate` и `ui`
задано `read_only: false`; у `ssh-export` остаётся `read_only: true`. Иначе создание
контейнера завершается ошибкой `cannot create config/secret ... in read-only service`.
Это ограничение проверяется в `ci/check_compose.py` без запуска контейнеров.
Ограничения UID, capabilities и `no-new-privileges` сохраняются. В варианте установки
из исходников configs/secrets берутся из файлов на хосте и не требуют этого исключения.
Если скачали ранний `compose.registry.yaml` для `0.4.0`, добавьте `read_only: false`
в каждый из сервисов `initialize`, `homegate`, `ui` после `<<: *runtime`, затем выполните
`docker compose up -d`. Исправление совместимо с образом `0.4.0`; новый образ не нужен.
Сохраняйте прежнее имя Compose-проекта и volumes с настройками и CA.
## 1. Настройте репозиторий и runner один раз
@@ -42,10 +58,24 @@ Gitea здесь ещё не подключена, образ не опубли
обеспечивает совместимость с инсталляциями, где job token не может публиковать пакеты.
Не добавляйте сюда пароли NPM, Pi-hole или панели — они нужны только при развёртывании.
Если публикация завершается с `Password required`, шаг входа в registry получил пустой
`REGISTRY_TOKEN`. Предупреждение Node.js про `punycode` не является причиной этой ошибки.
В **User Settings → Applications → Manage Access Tokens** создайте токен с правом
`write:package`, затем сохраните его значение в **Repository Settings → Actions → Secrets**
под именем `REGISTRY_TOKEN`. `REGISTRY_USERNAME` должен содержать логин владельца токена.
Значения в **Actions → Variables**, `.env` production-сервера или окружении runner
не подставляются в `${{ secrets.REGISTRY_TOKEN }}`.
После сохранения secrets повторно запустите упавший workflow для того же тега через
**Re-run** в Actions. Для исправления credentials новый тег не нужен. Workflow проверяет
наличие обоих secrets в начале job публикации, не выводя их значения в лог.
Эта проверка не проверяет права токена: корректность credentials проверяет вход в registry,
а право на публикацию — push образа.
По умолчанию registry берётся из адреса Gitea, image — из `owner/repository` в нижнем регистре:
```text
git.example.home/your-user/homegate:0.4.0
git.example.home/your-user/homegate:0.6.0
```
Если registry доступен по другому имени/порту, задайте Actions **variable** `REGISTRY`,
@@ -59,16 +89,16 @@ git.example.home/your-user/homegate:0.4.0
## 2. Выпустите образ
Файл `VERSION` сейчас содержит `0.4.0`. После загрузки проверенного кода в Gitea:
Файл `VERSION` сейчас содержит `0.6.0`. После загрузки проверенного кода в Gitea:
```sh
git tag v0.4.0
git push origin v0.4.0
git tag v0.6.0
git push origin v0.6.0
```
При следующем выпуске измените `VERSION`, закоммитьте его вместе с изменениями и создайте
соответствующий тег. Тег должен совпасть с файлом `VERSION`: например `v0.4.1` и `0.4.1`.
Предварительные версии вида `v0.4.1-rc.1` также поддерживаются. Полный номер задаётся
соответствующий тег. Тег должен совпасть с файлом `VERSION`: например `v0.6.0` и `0.6.0`.
Предварительные версии вида `v0.6.0-rc.1` также поддерживаются. Полный номер задаётся
в `VERSION`; примеры в Compose, Dockerfile и документации при выпуске также обновите.
Workflow `.gitea/workflows/release.yaml` выполняет:
@@ -80,7 +110,7 @@ Workflow `.gitea/workflows/release.yaml` выполняет:
3. Только для push тега `v*`, после успешных проверок — проверку `VERSION`, сборку
`linux/amd64` + `linux/arm64` и публикацию в Gitea Container Registry.
Образ получает два тега: `0.4.0` и `sha-<полный SHA коммита>`. Тег `latest` не создаётся.
Образ получает два тега: `0.6.0` и `sha-<полный SHA коммита>`. Тег `latest` не создаётся.
`org.opencontainers.image.source` связывает метаданные образа с URL исходников.
Права на просмотр/скачивание пакета проверьте в Gitea Packages отдельно от доступа к коду.
Workflow не запускает контейнеры Homegate и не развёртывает приложение.
@@ -106,7 +136,7 @@ sh ci/smoke_image.sh homegate:test
В Bash укажите свои адреса. Здесь `.10`, `.11` и `.2` — примеры:
```bash
export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.4.0
export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.6.0
export HOMEGATE_LAN_IP=192.168.0.10
export HOMEGATE_PROXY_IP=192.168.0.11
export HOMEGATE_ALLOWED_NETWORKS='[192.168.0.0/24]'
@@ -184,7 +214,7 @@ CA самой VM для `upstream_ca_file` по-прежнему устанав
Обновление до уже опубликованной версии:
```sh
export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.4.1
export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.6.0
docker compose pull
docker compose up -d
```
@@ -236,14 +266,18 @@ docker compose start homegate ui ssh-export
## Что проверено
Локально проходят 55 тестов, включая первый запуск, сохранение пользовательских изменений
Локально проходят 63 теста, включая первый запуск, сохранение пользовательских изменений
и CA, отказ от повреждённого конфига и проверку адреса/версии публикуемого образа.
Оба Compose-файла проверяются установленным Docker Compose. Синтаксис shell, JavaScript
и YAML workflow проверен. Docker daemon при подготовке выключен, поэтому сборка образа
и исполнение самого workflow локально не проверены. Контейнерный smoke-test остаётся
ручной проверкой и исключён из Gitea Actions.
Оба Compose-файла проверяются установленным Docker Compose, включая совместимость
`read_only` с источниками configs/secrets. Синтаксис shell, JavaScript и YAML workflow проверен.
После исправления `read_only` локально проверены сборка образа для ARM64 и контейнерный
smoke-test на Docker Compose 5.3.1: инициализация volumes, вход в панель, изоляция secrets,
SSH-export и сохранение настроек/CA при повторной инициализации. Проверка использует
временные volumes без портов хоста и без доступа к NPM/Pi-hole; их реальные API этим тестом
не проверяются. Контейнерный smoke-test остаётся ручной проверкой и исключён из Gitea Actions.
Официальные контракты: [Gitea Container Registry](https://docs.gitea.com/usage/packages/container/),
[Gitea Actions](https://docs.gitea.com/usage/actions/quickstart/),
[Compose secrets из environment](https://docs.docker.com/reference/compose-file/secrets/),
[Compose configs с content](https://docs.docker.com/reference/compose-file/configs/).
[Compose configs с content](https://docs.docker.com/reference/compose-file/configs/),
[ограничение read_only в реализации Compose](https://github.com/docker/compose/blob/v2.40.0/pkg/compose/secrets.go).

67
SIMPLE.md Normal file
View File

@@ -0,0 +1,67 @@
# Homegate: запуск и настройка через браузер
Используйте образ `gitea.hyperdog.dev/dizyaka/homegate:0.6.0` после успешной публикации
версии в Gitea Actions. Содержимое [compose.simple.yaml](compose.simple.yaml) сохраните
на сервере как `compose.yaml`. Файл не содержит адресов, environment, secrets или паролей.
```sh
docker compose pull
docker compose up -d --remove-orphans
```
Для приватного пакета один раз выполните `docker login gitea.hyperdog.dev`.
Это авторизация скачивания образа; параметры Homegate через неё не передаются.
Откройте `http://IP-СЕРВЕРА:8098`. Панель открывается без логина и показывает форму
первой настройки. Укажите прямо в ней:
- IP NPM, домашние подсети и доменные зоны;
- URL административного API NPM, его логин и пароль;
- URL Pi-hole 6 и его пароль, режим «Pi-hole без пароля» либо ручной режим DNS;
- при необходимости другой URL SSH-конфига и PEM корневого CA для HTTPS API.
Нажмите **Сохранить и начать**, затем добавляйте сервисы и SSH-хосты. Вся последующая
настройка доступна в разделе **Настройки**. Адреса и credentials перечитываются
контроллером без перезапуска. Пустое поле пароля при редактировании сохраняет прежнее значение. Если в Pi-hole пароль
отключён, включите **Pi-hole без пароля**: сохранённый пароль подключения будет удалён,
и Homegate будет работать с API без токена сессии. Адрес Pi-hole укажите без `/admin` и `/api`.
UI, контроллер и SSH-export работают в одном контейнере. До завершения первой настройки
работает только UI; запросы к NPM/Pi-hole ещё не выполняются. Открытые порты: `8098` для
панели и `8099` для `/ssh-config`. До настройки UI принимает подключения с loopback,
RFC1918 и ULA адресов; после настройки действует список разрешённых подсетей.
Пароль NPM и, если включён, пароль Pi-hole вводятся в форме и сохраняются в config volume.
Они не возвращаются в API состояния, скачиваемом YAML или SSH-конфиге.
Локальные HTTPS сертификаты и ключ CA Homegate создаёт сам. Публичный корневой сертификат
скачивается в разделе **Сертификаты**; установите его на клиентские устройства для доверия HTTPS.
Для публичных доменов, например `disk.hyperdog.dev`, можно использовать сертификат NPM
без установки CA на устройства. В карточке сервиса выберите **Let’s Encrypt — DNS challenge**,
укажите DNS-провайдера и API-токен по шаблону. Домашний NPM выпустит сертификат и будет
продлевать его автоматически; VDS не участвует. После выпуска сохраните сервис.
В Compose ничего добавлять не нужно.
Также доступны **Существующий сертификат домашнего NPM** и
**Копия из NPM на VDS — автообновление**. Подключение к VDS
задаётся в разделе **Настройки → Сертификаты с NPM на VDS**.
Подробные шаги и поведение при продлении: [CERTIFICATES.md](CERTIFICATES.md).
## Обновление с прежнего Compose
Сохраните имя проекта `homegate` и volumes `config`, `state`, `control` из прежнего файла.
Новый Compose использует те же данные: сервисы, SSH, история и CA сохраняются.
Замените файл на `compose.simple.yaml` и выполните команды выше. `--remove-orphans`
удаляет прежние отдельные контейнеры `initialize`, `ui`, `ssh-export`, освобождая их порты;
volumes остаются. Адреса и credentials API из прежнего окружения один раз введите в UI.
## Проверки
Unit/HTTP-тесты проверяют первичную настройку без env, LAN-доступ, сохранение credentials,
их отсутствие в публичных ответах, изменение API-подключений и остановку дочерних процессов.
`ci/check_compose.py` проверяет, что простой Compose не требует environment/configs/secrets.
Контейнерную проверку запускайте только локально на отдельном временном Compose-проекте:
`ci/smoke_setup.py` выполняется внутри контейнера с аргументом `write`, а после перезапуска —
с `verify`. Используются API-заглушки на loopback и временные пароли. В Gitea Actions
контейнеры Homegate не запускаются: только тесты, проверка Compose, сборка и публикация образа.

26
THIRD_PARTY_NOTICES.md Normal file
View File

@@ -0,0 +1,26 @@
# Third-party notices
`dns-providers-legacy.json` contains provider names and credential templates from
[Nginx Proxy Manager v2.12.6](https://github.com/NginxProxyManager/nginx-proxy-manager/blob/v2.12.6/global/certbot-dns-plugins.json).
MIT License
Copyright (c) 2017
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -1 +1 @@
0.4.0
0.6.0

3
WEB.md
View File

@@ -54,6 +54,9 @@ sh outputs/homegate/run-local.sh
## Панель для домашней сети через Docker
В версии 0.4.1 есть [простой Compose](SIMPLE.md): панель без логина, первичная настройка
и подключения к NPM/Pi-hole целиком в UI. `UI_ORIGIN`, LAN-IP и credentials в окружении не нужны.
Для готового образа и автоматического создания volumes используйте [один Compose-файл](REGISTRY.md).
Ниже — вариант сборки из исходников.

View File

@@ -7,7 +7,32 @@ import yaml
import homegate as h
def check_read_only_resources(model):
# compose config accepts this combination, but container creation rejects it.
for name, service in model['services'].items():
if not service.get('read_only'):
continue
for kind in ('configs', 'secrets'):
for resource in service.get(kind, []):
source = resource['source']
definition = model[kind][source]
assert 'file' in definition, (
f'{name}: read_only requires a file source for {kind}.{source}; '
'Compose cannot inject content/environment into a read-only container'
)
def main():
simple = json.loads(subprocess.check_output(
['docker', 'compose', '--env-file', os.devnull, '-f', 'compose.simple.yaml',
'config', '--format', 'json']))
assert set(simple['services']) == {'homegate'}
service = simple['services']['homegate']
assert not service.get('environment') and not service.get('env_file')
assert not simple.get('secrets') and not simple.get('configs')
assert service['image'] == 'gitea.hyperdog.dev/dizyaka/homegate:' + Path('VERSION').read_text().strip()
assert {p['published'] for p in service['ports']} == {'8098', '8099'}
assert {v['source'] for v in service['volumes']} == {'config', 'state', 'control'}
env = dict(os.environ, HOMEGATE_IMAGE='registry.example/homegate/homegate:0.4.0',
HOMEGATE_LAN_IP='192.168.0.10', HOMEGATE_PROXY_IP='192.168.0.10',
HOMEGATE_ALLOWED_NETWORKS='[192.168.0.0/24]', HOMEGATE_ZONES='[home, home.arpa]',
@@ -18,6 +43,7 @@ def main():
model = json.loads(subprocess.check_output(
['docker', 'compose', '--env-file', os.devnull, '-f', 'compose.registry.yaml',
'config', '--format', 'json'], env=env))
check_read_only_resources(model)
assert set(model['services']) == {'initialize', 'homegate', 'ssh-export', 'ui'}
for name, service in model['services'].items():
assert 'build' not in service, name
@@ -31,6 +57,7 @@ def main():
assert model['services']['initialize']['network_mode'] == 'none'
assert not model['services']['initialize'].get('secrets')
assert not model['services']['ssh-export'].get('secrets')
assert model['services']['ssh-export']['read_only']
assert [v['source'] for v in model['services']['ui']['secrets']] == ['ui_password']
for name in ('ui', 'ssh-export'):
assert all(v['target'] != '/data' for v in model['services'][name]['volumes'])
@@ -38,8 +65,10 @@ def main():
assert all('environment' in s and 'file' not in s for s in model['secrets'].values())
seed = h.validate_config(yaml.safe_load(model['configs']['initial-config']['content']))
assert seed['services'] == [] and seed['ssh_hosts'] == []
subprocess.run(['docker', 'compose', '--env-file', '.env.example', '-f', 'compose.yaml',
'config', '--quiet'], check=True, env=env)
source_model = json.loads(subprocess.check_output(
['docker', 'compose', '--env-file', '.env.example', '-f', 'compose.yaml',
'config', '--format', 'json'], env=env))
check_read_only_resources(source_model)
# The one-file deployment cannot accidentally fall back to all host interfaces.
del env['HOMEGATE_LAN_IP']
missing = subprocess.run(['docker', 'compose', '--env-file', os.devnull,

111
ci/smoke_setup.py Normal file
View File

@@ -0,0 +1,111 @@
"""Run manually inside a disposable standalone container: python - write|verify < this file."""
import hashlib
import http.cookiejar
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
import json
from pathlib import Path
import sys
import threading
import time
import urllib.error
import urllib.request
origin = 'http://127.0.0.1:8081'
opener = urllib.request.build_opener(urllib.request.ProxyHandler({}),
urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar()))
csrf = ''
def request(path, body=None):
headers = {}
if body is not None:
headers = {'Origin': origin, 'Content-Type': 'application/json', 'X-Homegate-CSRF': csrf}
payload = json.dumps(body).encode() if body is not None else None
with opener.open(urllib.request.Request(origin + path, payload, headers), timeout=3) as response:
data = response.read()
return json.loads(data) if 'application/json' in response.headers.get('Content-Type', '') else data
def wait_for(predicate):
deadline = time.monotonic() + 20
while time.monotonic() < deadline:
value = predicate()
if value:
return value
time.sleep(0.25)
raise AssertionError('Timed out waiting for controller')
def session_ready():
try:
return request('/api/session')
except urllib.error.HTTPError:
raise
except urllib.error.URLError:
return None
session = wait_for(session_ready)
assert session['authenticated']
csrf = session['csrf']
state = request('/api/state')
assert not state['auth_required']
assert b'renderManagedSettings' in request('/settings.js')
if sys.argv[-1] == 'write':
assert state['setup_required']
seen = []
class API(BaseHTTPRequestHandler):
def do_GET(self):
length = int(self.headers.get('Content-Length', '0'))
body = json.loads(self.rfile.read(length)) if length else None
if self.path == '/api/tokens':
seen.append((self.server.server_port, body['identity'], body['secret']))
value = {'token': 'disposable-token'}
elif self.path == '/api/auth':
value = {'session': {'valid': True, 'sid': 'disposable-sid', 'csrf': 'disposable-csrf'}}
elif self.path == '/api/config/dns':
value = {'config': {'dns': {'hosts': [], 'cnameRecords': []}}}
else:
value = []
data = json.dumps(value).encode()
self.send_response(200)
self.send_header('Content-Type', 'application/json')
self.send_header('Content-Length', str(len(data)))
self.end_headers()
self.wfile.write(data)
do_POST = do_GET
do_DELETE = do_GET
def log_message(self, *args):
pass
servers = [ThreadingHTTPServer(('127.0.0.1', port), API) for port in (18181, 18182)]
for server in servers:
threading.Thread(target=server.serve_forever, daemon=True).start()
try:
config = state['config']
config.update(proxy_ip='192.168.42.11', allowed_networks=['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16'],
ssh_hosts=[{'aliases': ['qa-nas'], 'host': '192.168.42.50', 'port': 22, 'user': 'test'}])
links = {'npm_url': 'http://127.0.0.1:18181', 'npm_identity': 'test@example.invalid',
'npm_password': 'disposable-npm-password', 'pihole_url': 'http://127.0.0.1:18181',
'pihole_password': 'disposable-pihole-password'}
state = request('/api/settings', {'config': config, 'connections': links, 'revision': state['revision']})
assert not state['setup_required']
wait_for(lambda: request('/api/state')['controller'].get('ok'))
assert (18181, 'test@example.invalid', 'disposable-npm-password') in seen
ca_before = Path('/data/root-ca.crt').read_bytes()
links.update(npm_url='http://127.0.0.1:18182', npm_password='changed-npm-password')
request('/api/settings', {'config': config, 'connections': links, 'revision': state['revision']})
wait_for(lambda: (18182, 'test@example.invalid', 'changed-npm-password') in seen)
assert Path('/data/root-ca.crt').read_bytes() == ca_before
assert 'changed-npm-password' not in json.dumps(request('/api/state'))
with opener.open('http://127.0.0.1:8080/healthz') as response:
assert response.status == 200
assert b'Host qa-nas' in request('/downloads/ssh-config')
Path('/data/.qa-fingerprint').write_text(hashlib.sha256(ca_before).hexdigest())
print('Standalone: no-env onboarding, real HTTP settings, NPM/Pi-hole mock login, live API reload, CA and SSH verified.')
finally:
for server in servers:
server.shutdown()
else:
assert not state['setup_required']
assert state['connections']['npm_url'] == 'http://127.0.0.1:18182'
assert state['connections']['npm_password_set']
assert state['config']['ssh_hosts'][0]['aliases'] == ['qa-nas']
assert hashlib.sha256(Path('/data/root-ca.crt').read_bytes()).hexdigest() == Path('/data/.qa-fingerprint').read_text()
assert b'Host qa-nas' in request('/downloads/ssh-config')
print('Standalone restart: setup, credentials, SSH inventory and CA retained; no login or environment required.')

View File

@@ -1,6 +1,6 @@
# Download this file only. Supply settings/passwords via the shell or an optional .env.
# Docker Compose >= 2.30.0 (not docker stack deploy). See REGISTRY.md.
# Example image: git.example.home/your-user/homegate:0.4.0
# Example image: git.example.home/your-user/homegate:0.6.0
name: homegate
x-runtime: &runtime
@@ -31,6 +31,8 @@ x-environment: &environment
services:
initialize:
<<: *runtime
# Compose copies configs.content into the container before starting it.
read_only: false
entrypoint: [python, /app/bootstrap.py]
command: []
user: "0:0"
@@ -52,6 +54,8 @@ services:
homegate:
<<: *runtime
# Compose requires a writable root filesystem for secrets.environment.
read_only: false
depends_on:
initialize:
condition: service_completed_successfully
@@ -98,6 +102,8 @@ services:
ui:
<<: *runtime
# Compose requires a writable root filesystem for secrets.environment.
read_only: false
entrypoint: [python, /app/homegate_ui.py]
command: []
depends_on:

20
compose.simple.yaml Normal file
View File

@@ -0,0 +1,20 @@
name: homegate
services:
homegate:
image: gitea.hyperdog.dev/dizyaka/homegate:0.6.0
entrypoint: [python, /app/standalone.py]
restart: unless-stopped
init: true
ports:
- "8098:8081"
- "8099:8080"
volumes:
- config:/config
- state:/data
- control:/control
volumes:
config:
state:
control:

View File

@@ -2,7 +2,7 @@ name: homegate
services:
homegate:
build: .
image: homegate:0.4.0
image: homegate:0.6.0
restart: unless-stopped
init: true
user: "${LOCAL_UID:-1000}:${LOCAL_GID:-1000}"
@@ -50,7 +50,7 @@ services:
ssh-export:
build: .
image: homegate:0.4.0
image: homegate:0.6.0
command: [serve]
restart: unless-stopped
init: true
@@ -87,7 +87,7 @@ services:
ui:
build: .
image: homegate:0.4.0
image: homegate:0.6.0
entrypoint: [python, /app/homegate_ui.py]
command: []
restart: unless-stopped

380
dns-providers-legacy.json Normal file
View File

@@ -0,0 +1,380 @@
{
"source": "https://github.com/NginxProxyManager/nginx-proxy-manager/blob/v2.12.6/global/certbot-dns-plugins.json",
"providers": [
{
"id": "acmedns",
"name": "ACME-DNS",
"credentials": "dns_acmedns_api_url = http://acmedns-server/\ndns_acmedns_registration_file = /data/acme-registration.json"
},
{
"id": "active24",
"name": "Active24",
"credentials": "dns_active24_api_key = <identifier>\ndns_active24_secret = <secret>"
},
{
"id": "aliyun",
"name": "Aliyun",
"credentials": "dns_aliyun_access_key = 12345678\ndns_aliyun_access_key_secret = 1234567890abcdef1234567890abcdef"
},
{
"id": "azure",
"name": "Azure",
"credentials": "# This plugin supported API authentication using either Service Principals or utilizing a Managed Identity assigned to the virtual machine.\n# Regardless which authentication method used, the identity will need the “DNS Zone Contributor” role assigned to it.\n# As multiple Azure DNS Zones in multiple resource groups can exist, the config file needs a mapping of zone to resource group ID. Multiple zones -> ID mappings can be listed by using the key dns_azure_zoneX where X is a unique number. At least 1 zone mapping is required.\n\n# Using a service principal (option 1)\ndns_azure_sp_client_id = 912ce44a-0156-4669-ae22-c16a17d34ca5\ndns_azure_sp_client_secret = E-xqXU83Y-jzTI6xe9fs2YC~mck3ZzUih9\ndns_azure_tenant_id = ed1090f3-ab18-4b12-816c-599af8a88cf7\n\n# Using used assigned MSI (option 2)\n# dns_azure_msi_client_id = 912ce44a-0156-4669-ae22-c16a17d34ca5\n\n# Using system assigned MSI (option 3)\n# dns_azure_msi_system_assigned = true\n\n# Zones (at least one always required)\ndns_azure_zone1 = example.com:/subscriptions/c135abce-d87d-48df-936c-15596c6968a5/resourceGroups/dns1\ndns_azure_zone2 = example.org:/subscriptions/99800903-fb14-4992-9aff-12eaf2744622/resourceGroups/dns2"
},
{
"id": "baidu",
"name": "baidu",
"credentials": "dns_baidu_access_key = 12345678\ndns_baidu_secret_key = 1234567890abcdef1234567890abcdef"
},
{
"id": "beget",
"name": "Beget",
"credentials": "# Beget API credentials used by Certbot\nbeget_plugin_username = username\nbeget_plugin_password = password"
},
{
"id": "bunny",
"name": "bunny.net",
"credentials": "# Bunny API token used by Certbot (see https://dash.bunny.net/account/settings)\ndns_bunny_api_key = xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
},
{
"id": "cdmon",
"name": "cdmon",
"credentials": "dns_cdmon_api_key=your-cdmon-api-token\ndns_cdmon_domain=your_domain_is_optional"
},
{
"id": "cloudflare",
"name": "Cloudflare",
"credentials": "# Cloudflare API token\ndns_cloudflare_api_token=0123456789abcdef0123456789abcdef01234567"
},
{
"id": "cloudns",
"name": "ClouDNS",
"credentials": "# Target user ID (see https://www.cloudns.net/api-settings/)\n\tdns_cloudns_auth_id=1234\n\t# Alternatively, one of the following two options can be set:\n\t# dns_cloudns_sub_auth_id=1234\n\t# dns_cloudns_sub_auth_user=foobar\n\n\t# API password\n\tdns_cloudns_auth_password=password1"
},
{
"id": "cloudxns",
"name": "CloudXNS",
"credentials": "dns_cloudxns_api_key = 1234567890abcdef1234567890abcdef\ndns_cloudxns_secret_key = 1122334455667788"
},
{
"id": "constellix",
"name": "Constellix",
"credentials": "dns_constellix_apikey = 5fb4e76f-ac91-43e5-f982458bc595\ndns_constellix_secretkey = 47d99fd0-32e7-4e07-85b46d08e70b\ndns_constellix_endpoint = https://api.dns.constellix.com/v1"
},
{
"id": "corenetworks",
"name": "Core Networks",
"credentials": "dns_corenetworks_username = asaHB12r\ndns_corenetworks_password = secure_password"
},
{
"id": "cpanel",
"name": "cPanel",
"credentials": "cpanel_url = https://cpanel.example.com:2083\ncpanel_username = your_username\ncpanel_password = your_password\ncpanel_token = your_api_token"
},
{
"id": "ddnss",
"name": "DDNSS",
"credentials": "dns_ddnss_token = YOUR_DDNSS_API_TOKEN"
},
{
"id": "desec",
"name": "deSEC",
"credentials": "dns_desec_token = YOUR_DESEC_API_TOKEN\ndns_desec_endpoint = https://desec.io/api/v1/"
},
{
"id": "duckdns",
"name": "DuckDNS",
"credentials": "dns_duckdns_token=your-duckdns-token"
},
{
"id": "digitalocean",
"name": "DigitalOcean",
"credentials": "dns_digitalocean_token = 0000111122223333444455556666777788889999aaaabbbbccccddddeeeeffff"
},
{
"id": "directadmin",
"name": "DirectAdmin",
"credentials": "directadmin_url = https://my.directadminserver.com:2222\ndirectadmin_username = username\ndirectadmin_password = aSuperStrongPassword"
},
{
"id": "dnsimple",
"name": "DNSimple",
"credentials": "dns_dnsimple_token = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw"
},
{
"id": "dnsmadeeasy",
"name": "DNS Made Easy",
"credentials": "dns_dnsmadeeasy_api_key = 1c1a3c91-4770-4ce7-96f4-54c0eb0e457a\ndns_dnsmadeeasy_secret_key = c9b5625f-9834-4ff8-baba-4ed5f32cae55"
},
{
"id": "dnsmulti",
"name": "DnsMulti",
"credentials": "# See https://go-acme.github.io/lego/dns/#dns-providers for list of providers and their settings\n# Example provider configuration for DreamHost\n# dns_multi_provider = dreamhost\n# DREAMHOST_API_KEY = ABCDEFG1234"
},
{
"id": "dnspod",
"name": "DNSPod",
"credentials": "dns_dnspod_email = \"email@example.com\"\ndns_dnspod_api_token = \"id,key\""
},
{
"id": "domainoffensive",
"name": "DomainOffensive (do.de)",
"credentials": "dns_domainoffensive_api_token = YOUR_DO_DE_AUTH_TOKEN"
},
{
"id": "domeneshop",
"name": "Domeneshop",
"credentials": "dns_domeneshop_client_token=YOUR_DOMENESHOP_CLIENT_TOKEN\ndns_domeneshop_client_secret=YOUR_DOMENESHOP_CLIENT_SECRET"
},
{
"id": "dynu",
"name": "Dynu",
"credentials": "dns_dynu_auth_token = YOUR_DYNU_AUTH_TOKEN"
},
{
"id": "easydns",
"name": "easyDNS",
"credentials": "dns_easydns_usertoken = YOUR_EASYDNS_USERTOKEN\ndns_easydns_userkey = YOUR_EASYDNS_USERKEY\ndns_easydns_endpoint = https://rest.easydns.net"
},
{
"id": "eurodns",
"name": "EuroDNS",
"credentials": "dns_eurodns_applicationId = myuser\ndns_eurodns_apiKey = mysecretpassword\ndns_eurodns_endpoint = https://rest-api.eurodns.com/user-api-gateway/proxy"
},
{
"id": "firstdomains",
"name": "First Domains",
"credentials": "dns_firstdomains_username = myremoteuser\ndns_firstdomains_password = verysecureremoteuserpassword"
},
{
"id": "freedns",
"name": "FreeDNS",
"credentials": "dns_freedns_username = myremoteuser\ndns_freedns_password = verysecureremoteuserpassword"
},
{
"id": "gandi",
"name": "Gandi Live DNS",
"credentials": "# Gandi personal access token\ndns_gandi_token=PERSONAL_ACCESS_TOKEN"
},
{
"id": "gcore",
"name": "Gcore DNS",
"credentials": "dns_gcore_apitoken = 0123456789abcdef0123456789abcdef01234567"
},
{
"id": "godaddy",
"name": "GoDaddy",
"credentials": "dns_godaddy_secret = 0123456789abcdef0123456789abcdef01234567\ndns_godaddy_key = abcdef0123456789abcdef01234567abcdef0123"
},
{
"id": "google",
"name": "Google",
"credentials": "{\n\"type\": \"service_account\",\n...\n}"
},
{
"id": "googledomains",
"name": "GoogleDomainsDNS",
"credentials": "dns_google_domains_access_token = 0123456789abcdef0123456789abcdef01234567\ndns_google_domains_zone = \"example.com\""
},
{
"id": "he",
"name": "Hurricane Electric",
"credentials": "dns_he_user = Me\ndns_he_pass = my HE password"
},
{
"id": "hetzner",
"name": "Hetzner",
"credentials": "dns_hetzner_api_token = 0123456789abcdef0123456789abcdef"
},
{
"id": "hostingnl",
"name": "Hosting.nl",
"credentials": "dns_hostingnl_api_key = 0123456789abcdef0123456789abcdef"
},
{
"id": "hover",
"name": "Hover",
"credentials": "dns_hover_hoverurl = https://www.hover.com\ndns_hover_username = hover-admin-username\ndns_hover_password = hover-admin-password\ndns_hover_totpsecret = 2fa-totp-secret"
},
{
"id": "infomaniak",
"name": "Infomaniak",
"credentials": "dns_infomaniak_token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
{
"id": "inwx",
"name": "INWX",
"credentials": "dns_inwx_url = https://api.domrobot.com/xmlrpc/\ndns_inwx_username = your_username\ndns_inwx_password = your_password\ndns_inwx_shared_secret = your_shared_secret optional"
},
{
"id": "ionos",
"name": "IONOS",
"credentials": "dns_ionos_prefix = myapikeyprefix\ndns_ionos_secret = verysecureapikeysecret\ndns_ionos_endpoint = https://api.hosting.ionos.com"
},
{
"id": "ispconfig",
"name": "ISPConfig",
"credentials": "dns_ispconfig_username = myremoteuser\ndns_ispconfig_password = verysecureremoteuserpassword\ndns_ispconfig_endpoint = https://localhost:8080"
},
{
"id": "isset",
"name": "Isset",
"credentials": "dns_isset_endpoint=\"https://customer.isset.net/api\"\ndns_isset_token=\"<token>\""
},
{
"id": "joker",
"name": "Joker",
"credentials": "dns_joker_username = <Dynamic DNS Authentication Username>\ndns_joker_password = <Dynamic DNS Authentication Password>\ndns_joker_domain = <Dynamic DNS Domain>"
},
{
"id": "leaseweb",
"name": "LeaseWeb",
"credentials": "dns_leaseweb_api_token = 01234556789"
},
{
"id": "linode",
"name": "Linode",
"credentials": "dns_linode_key = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ64\ndns_linode_version = [<blank>|3|4]"
},
{
"id": "loopia",
"name": "Loopia",
"credentials": "dns_loopia_user = user@loopiaapi\ndns_loopia_password = abcdef0123456789abcdef01234567abcdef0123"
},
{
"id": "luadns",
"name": "LuaDNS",
"credentials": "dns_luadns_email = user@example.com\ndns_luadns_token = 0123456789abcdef0123456789abcdef"
},
{
"id": "mijnhost",
"name": "mijn.host",
"credentials": "dns_mijn_host_api_key=0123456789abcdef0123456789abcdef"
},
{
"id": "namecheap",
"name": "Namecheap",
"credentials": "dns_namecheap_username = 123456\ndns_namecheap_api_key = 0123456789abcdef0123456789abcdef01234567"
},
{
"id": "netcup",
"name": "netcup",
"credentials": "dns_netcup_customer_id = 123456\ndns_netcup_api_key = 0123456789abcdef0123456789abcdef01234567\ndns_netcup_api_password = abcdef0123456789abcdef01234567abcdef0123"
},
{
"id": "nicru",
"name": "nic.ru",
"credentials": "dns_nicru_client_id = application-id\ndns_nicru_client_secret = application-token\ndns_nicru_username = 0001110/NIC-D\ndns_nicru_password = password\ndns_nicru_scope = .+:.+/zones/example.com(/.+)?\ndns_nicru_service = DNS_SERVICE_NAME\ndns_nicru_zone = example.com"
},
{
"id": "njalla",
"name": "Njalla",
"credentials": "dns_njalla_token = 0123456789abcdef0123456789abcdef01234567"
},
{
"id": "nsone",
"name": "NS1",
"credentials": "dns_nsone_api_key = MDAwMDAwMDAwMDAwMDAw"
},
{
"id": "oci",
"name": "Oracle Cloud Infrastructure DNS",
"credentials": "[DEFAULT]\nuser = ocid1.user.oc1...\nfingerprint = xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx\ntenancy = ocid1.tenancy.oc1...\nregion = us-ashburn-1\nkey_file = ~/.oci/oci_api_key.pem"
},
{
"id": "ovh",
"name": "OVH",
"credentials": "dns_ovh_endpoint = ovh-eu\ndns_ovh_application_key = MDAwMDAwMDAwMDAw\ndns_ovh_application_secret = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw\ndns_ovh_consumer_key = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw"
},
{
"id": "plesk",
"name": "Plesk",
"credentials": "dns_plesk_username = your-username\ndns_plesk_password = secret\ndns_plesk_api_url = https://plesk-api-host:8443"
},
{
"id": "porkbun",
"name": "Porkbun",
"credentials": "dns_porkbun_key=your-porkbun-api-key\ndns_porkbun_secret=your-porkbun-api-secret"
},
{
"id": "powerdns",
"name": "PowerDNS",
"credentials": "dns_powerdns_api_url = https://api.mypowerdns.example.org\ndns_powerdns_api_key = AbCbASsd!@34"
},
{
"id": "regru",
"name": "reg.ru",
"credentials": "dns_username=username\ndns_password=password"
},
{
"id": "rfc2136",
"name": "RFC 2136",
"credentials": "# Target DNS server\ndns_rfc2136_server = 192.0.2.1\n# Target DNS port\ndns_rfc2136_port = 53\n# TSIG key name\ndns_rfc2136_name = keyname.\n# TSIG key secret\ndns_rfc2136_secret = 4q4wM/2I180UXoMyN4INVhJNi8V9BCV+jMw2mXgZw/CSuxUT8C7NKKFs AmKd7ak51vWKgSl12ib86oQRPkpDjg==\n# TSIG key algorithm\ndns_rfc2136_algorithm = HMAC-SHA512"
},
{
"id": "rockenstein",
"name": "rockenstein AG",
"credentials": "dns_rockenstein_token=<token>"
},
{
"id": "route53",
"name": "Route 53 (Amazon)",
"credentials": "[default]\naws_access_key_id=AKIAIOSFODNN7EXAMPLE\naws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
{
"id": "spaceship",
"name": "Spaceship",
"credentials": "[spaceship]\napi_key=your_api_key\napi_secret=your_api_secret"
},
{
"id": "strato",
"name": "Strato",
"credentials": "dns_strato_username = user\ndns_strato_password = pass\n# uncomment if youre using two factor authentication:\n# dns_strato_totp_devicename = 2fa_device\n# dns_strato_totp_secret = 2fa_secret\n#\n# uncomment if domain name contains special characters\n# insert domain display name as seen on your account page here\n# dns_strato_domain_display_name = my-punicode-url.de\n#\n# if youre not using strato.de or another special endpoint you can customise it below\n# you will probably only need to adjust the host, but you can also change the complete endpoint url\n# dns_strato_custom_api_scheme = https\n# dns_strato_custom_api_host = www.strato.de\n# dns_strato_custom_api_port = 443\n# dns_strato_custom_api_path = \"/apps/CustomerService\""
},
{
"id": "selectelv2",
"name": "Selectel api v2",
"credentials": "dns_selectel_api_v2_account_id = your_account_id\ndns_selectel_api_v2_project_name = your_project\ndns_selectel_api_v2_username = your_username\ndns_selectel_api_v2_password = your_password"
},
{
"id": "timeweb",
"name": "Timeweb Cloud",
"credentials": "dns_timeweb_api_key = XXXXXXXXXXXXXXXXXXX"
},
{
"id": "transip",
"name": "TransIP",
"credentials": "dns_transip_username = my_username\ndns_transip_key_file = /etc/letsencrypt/transip-rsa.key"
},
{
"id": "tencentcloud",
"name": "Tencent Cloud",
"credentials": "dns_tencentcloud_secret_id = TENCENT_CLOUD_SECRET_ID\ndns_tencentcloud_secret_key = TENCENT_CLOUD_SECRET_KEY"
},
{
"id": "vultr",
"name": "Vultr",
"credentials": "dns_vultr_key = YOUR_VULTR_API_KEY"
},
{
"id": "websupport",
"name": "Websupport.sk",
"credentials": "dns_websupport_identifier = <api_key>\ndns_websupport_secret_key = <secret>"
},
{
"id": "wedos",
"name": "Wedos",
"credentials": "dns_wedos_user = <wedos_registration>\ndns_wedos_auth = <wapi_password>"
},
{
"id": "edgedns",
"name": "Akamai Edge DNS",
"credentials": "edgedns_client_secret = as3d1asd5d1a32sdfsdfs2d1asd5=\nedgedns_host = sdflskjdf-dfsdfsdf-sdfsdfsdf.luna.akamaiapis.net\nedgedns_access_token = kjdsi3-34rfsdfsdf-234234fsdfsdf\nedgedns_client_token = dkfjdf-342fsdfsd-23fsdfsdfsdf"
},
{
"id": "zoneedit",
"name": "ZoneEdit",
"credentials": "dns_zoneedit_user = <login-user-id>\ndns_zoneedit_token = <dyn-authentication-token>"
}
]
}

175
dns_challenge.py Normal file
View File

@@ -0,0 +1,175 @@
"""Background DNS-01 issuance in the home NPM. Renewal belongs to NPM's scheduler."""
from pathlib import Path
import re
import secrets
import threading
import time
import homegate as h
ISSUE_TIMEOUT = 900
RESERVED = {"home", "lan", "local", "localhost", "internal", "invalid", "test", "example", "onion", "arpa"}
def providers(npm):
try:
rows = npm.call("GET", "/nginx/certificates/dns-providers")
legacy = False
except h.APIError as exc:
# In old NPM this path matches /:certificate_id and can return 400.
if exc.status not in (400, 404):
raise
rows = h.read_json(Path(__file__).with_name("dns-providers-legacy.json"))["providers"]
legacy = True
h.require(isinstance(rows, list) and 0 < len(rows) <= 256, "NPM вернул некорректный список DNS-провайдеров")
clean = []
for row in rows:
h.require(isinstance(row, dict) and isinstance(row.get("id"), str) and
re.fullmatch(r"[a-z0-9_-]{1,100}", row["id"]), "Некорректный DNS-провайдер NPM")
clean.append({"id": row["id"], "name": str(row.get("name", row["id"]))[:200],
"template": str(row.get("credentials", ""))[:16384]})
return {"providers": sorted(clean, key=lambda p: p["name"].lower()), "email_required": legacy}
def validate_request(value):
h.require(isinstance(value, dict) and not set(value) -
{"domains", "provider", "credentials", "email", "propagation_seconds", "agree"},
"Некорректные параметры DNS challenge")
domains = value.get("domains")
h.require(isinstance(domains, list) and 1 <= len(domains) <= 100, "Укажите от 1 до 100 доменов")
names = []
for name in domains:
h.require(isinstance(name, str), "Домены должны быть строками")
name = name.strip().lower().rstrip(".")
base = name.removeprefix("*.")
h.require(h.DOMAIN.fullmatch(base) and not base.split(".")[-1].isdigit() and
base.split(".")[-1] not in RESERVED,
"Для Let's Encrypt нужен публичный домен; .home, .local и другие локальные зоны не подходят")
h.require(name not in names, "Домен указан повторно")
names.append(name)
provider = value.get("provider")
h.require(isinstance(provider, str) and re.fullmatch(r"[a-z0-9_-]{1,100}", provider), "Выберите DNS-провайдера")
credentials = value.get("credentials")
h.require(isinstance(credentials, str) and 0 < len(credentials.strip()) <= 16384 and "\x00" not in credentials,
"Введите API-доступ DNS-провайдера в формате шаблона")
email = value.get("email", "")
h.require(isinstance(email, str), "Некорректный email")
email = email.strip()
h.require(not email or re.fullmatch(r"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,63}", email), "Некорректный email")
propagation = value.get("propagation_seconds")
if propagation is not None:
h.number(propagation, 0, 600, "propagation_seconds")
h.require(value.get("agree") is True, "Подтвердите согласие с условиями Let's Encrypt")
return {"domains": names, "provider": provider, "credentials": credentials, "email": email,
"propagation_seconds": propagation, "agree": True}
class DNSChallenge:
def __init__(self, control, connect):
self.path = Path(control) / "dns-challenge.json"
self.connect = connect
self.lock = threading.RLock()
self.thread = None
self.job = h.read_json(self.path, {"status": "idle"})
if self.job["status"] == "running":
self.update(status="unknown", message="Homegate был перезапущен. Проверьте результат в домашнем NPM перед повторным выпуском.")
def update(self, **fields):
with self.lock:
self.job.update(fields)
h.save_json(self.path, self.job)
return self.status()
def status(self):
with self.lock:
# Never publish the full request or an NPM response.
return {k: v for k, v in self.job.items() if k in
{"id", "status", "domains", "provider", "message", "certificate", "started_at"}}
def start(self, value):
request = validate_request(value)
with self.lock:
h.require(self.job["status"] != "running", "Выпуск уже выполняется. Дождитесь результата.")
h.require(self.job["status"] != "unknown" or time.time() - self.job.get("issued_at", self.job.get("started_at", 0)) >= ISSUE_TIMEOUT,
"Результат предыдущего выпуска пока неизвестен. Нажмите «Проверить результат»; повторный выпуск доступен через 15 минут.")
self.job = {"id": secrets.token_hex(16), "status": "running", "domains": request["domains"],
"provider": request["provider"], "started_at": time.time(), "message": "Проверяем домашний NPM…"}
self.update()
self.thread = threading.Thread(target=self.run, args=(request,), daemon=True)
self.thread.start()
return self.status()
def check(self):
with self.lock:
if self.job["status"] in ("idle", "success", "running"):
return self.status()
self.update(status="running", message="Проверяем, завершился ли выпуск в домашнем NPM…")
self.thread = threading.Thread(target=self.run, args=(None,), daemon=True)
self.thread.start()
return self.status()
def matching(self, rows):
matches = []
for row in rows:
if (row.get("provider") == "letsencrypt" and row.get("meta", {}).get("dns_challenge") is True
and row.get("meta", {}).get("dns_provider") == self.job["provider"]
and set(row.get("domain_names", [])) == set(self.job["domains"])):
info = h.certificate_info(row)
try:
h.check_certificate(info, self.job["domains"])
except h.Error:
continue
matches.append(info)
# Reuse a valid certificate instead of submitting a duplicate ACME order.
return sorted(matches, key=lambda c: c["id"], reverse=True)
def run(self, request):
npm, submitted = None, False
try:
npm = self.connect()
if request is None:
h.require(not self.job.get("npm_base") or npm.base == self.job["npm_base"],
"Подключение к домашнему NPM изменилось; проверьте сертификаты в прежнем NPM")
self.update(npm_base=npm.base)
rows = npm.call("GET", "/nginx/certificates")
matches = self.matching(rows)
if matches:
self.update(status="success", certificate=matches[0], message="Сертификат готов. Автопродление выполняет домашний NPM.")
return
if request is None:
self.update(status="unknown", message="Готовый сертификат пока не найден. Выпуск может продолжаться в NPM. Повторный запрос автоматически не отправляется.")
return
catalog = providers(npm)
h.require(any(p["id"] == request["provider"] for p in catalog["providers"]),
"Этот DNS-провайдер не поддерживается домашним NPM")
meta = {"dns_challenge": True, "dns_provider": request["provider"],
"dns_provider_credentials": request["credentials"]}
if catalog["email_required"]:
h.require(bool(request["email"]), "Для этой версии NPM укажите email Let's Encrypt")
meta.update(letsencrypt_email=request["email"], letsencrypt_agree=True)
if request["propagation_seconds"] is not None:
meta["propagation_seconds"] = request["propagation_seconds"]
self.update(issued_at=time.time(), message="Домашний NPM выпускает сертификат через DNS challenge. Это может занять несколько минут.")
submitted = True
result = npm.call("POST", "/nginx/certificates", json={"provider": "letsencrypt",
"domain_names": request["domains"], "meta": meta}, timeout=(5, ISSUE_TIMEOUT))
info = h.certificate_info(result)
h.require(info["provider"] == "letsencrypt" and info["dns_challenge"], "NPM вернул неожиданный тип сертификата")
h.check_certificate(info, request["domains"])
self.update(status="success", certificate=info, message="Сертификат выпущен. Автопродление выполняет домашний NPM.")
except h.APIError as exc:
uncertain = submitted and exc.status in (None, 408, 502, 503, 504)
self.update(status="unknown" if uncertain or request is None else "error", message=(
"NPM не подтвердил результат. Нажмите «Проверить результат»; Homegate не повторяет выпуск автоматически."
if uncertain else "Не удалось выполнить запрос к домашнему NPM. Проверьте подключение, DNS-доступ и журнал NPM. " + str(exc)))
except h.Error as exc:
self.update(status="unknown" if submitted or request is None else "error", message=str(exc))
except Exception:
# Exception representations from parsers/third-party code may contain credentials.
self.update(status="unknown" if submitted or request is None else "error",
message="Не удалось обработать ответ NPM. Проверьте результат в его разделе сертификатов.")
finally:
if request is not None:
request.clear()
if npm:
npm.close()

View File

@@ -5,6 +5,7 @@ import argparse
import copy
import fcntl
import hashlib
import io
import ipaddress
import json
import logging
@@ -21,11 +22,12 @@ from datetime import datetime, timedelta, timezone
from urllib.parse import quote, urlsplit
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
import uuid
import zipfile
import requests
import yaml
from cryptography import x509
from cryptography.exceptions import InvalidSignature
from cryptography.exceptions import InvalidSignature, UnsupportedAlgorithm
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import ec
from cryptography.x509.oid import ExtendedKeyUsageOID, NameOID
@@ -45,6 +47,12 @@ class Error(RuntimeError):
pass
class APIError(Error):
def __init__(self, message, status=None):
super().__init__(message)
self.status = status
def require(ok, message):
if not ok:
raise Error(message)
@@ -113,7 +121,8 @@ def validate_config(value):
for r in c["services"]:
require(isinstance(r, dict), "Each service must be a mapping")
require(not set(r) - {"hostname", "display_name", "upstream", "upstream_tls_verify", "upstream_tls_name",
"upstream_ca_file", "websocket", "timeout_seconds", "max_body_mb", "enabled", "ssh"},
"upstream_ca_file", "websocket", "timeout_seconds", "max_body_mb", "enabled", "ssh",
"certificate_mode", "npm_certificate_id", "remote_certificate_id"},
"Unknown service config key")
if "display_name" in r:
name = r["display_name"]
@@ -126,6 +135,16 @@ def validate_config(value):
"hostname must be a lowercase DNS name in domain_zones")
require(host not in seen, f"Duplicate hostname: {host}")
seen.add(host)
mode = r.setdefault("certificate_mode", "homegate")
require(mode in ("homegate", "npm", "remote_npm"), "Invalid certificate_mode")
if mode == "npm" or "npm_certificate_id" in r:
number(r.get("npm_certificate_id"), 1, 2147483647, "npm_certificate_id")
if mode == "remote_npm":
number(r.get("remote_certificate_id"), 1, 2147483647, "remote_certificate_id")
else:
require("remote_certificate_id" not in r, "remote_certificate_id requires remote_npm mode")
require(mode != "homegate" or "npm_certificate_id" not in r,
"npm_certificate_id requires an NPM certificate mode")
u = urlsplit(r["upstream"])
require(u.scheme in ("http", "https") and not u.username and not u.password
and u.path in ("", "/") and not u.query and not u.fragment,
@@ -151,6 +170,14 @@ def validate_config(value):
"service.ssh accepts alias, host, port, user and enabled")
boolean(s.get("enabled", True), "ssh.enabled")
require(isinstance(c.get("ssh_hosts", []), list), "ssh_hosts must be a list")
targets = {}
for r in c["services"]:
if r.get("npm_certificate_id"):
target = r["npm_certificate_id"]
source = (r["certificate_mode"], r.get("remote_certificate_id"))
require(target not in targets or targets[target] == source,
"A local certificate cannot have different renewal sources")
targets[target] = source
# Validate the complete inventory (including duplicate aliases) before any side effects.
ssh_entries(c)
return c
@@ -359,7 +386,9 @@ def export_handler(config_path):
def serve_export(config_path):
load_config(config_path)
# Compose requires an explicit private host IP; never publish on every host interface.
# The standalone deployment enforces LAN access through the configured subnets.
bind_ip = "LAN (configured in the web panel)"
if os.environ.get("HOMEGATE_MANAGED_UI") != "1":
bind_ip = private_address(os.environ.get("SSH_BIND_IP", ""))
require(ipaddress.ip_address(bind_ip).version == 4, "SSH_BIND_IP must be a private IPv4 address")
with ThreadingHTTPServer(("0.0.0.0", 8080), export_handler(config_path)) as server:
@@ -381,19 +410,20 @@ class API:
def call(self, method, path, **kwargs):
try:
response = self.session.request(method, self.base + path, timeout=(5, 30),
response = self.session.request(method, self.base + path, timeout=kwargs.pop("timeout", (5, 30)),
allow_redirects=False, **kwargs)
except requests.RequestException:
raise Error(f"{self.label}: connection or TLS error at {path}") from None
require(200 <= response.status_code < 300,
f"{self.label}: HTTP {response.status_code} at {path}; check credentials, version and permissions")
raise APIError(f"{self.label}: connection or TLS error at {path}") from None
if not 200 <= response.status_code < 300:
raise APIError(f"{self.label}: HTTP {response.status_code} at {path}; check credentials, version and permissions",
response.status_code)
# Do not log response bodies: NPM upload responses contain the private key.
if not response.content:
return None
try:
return response.json()
except ValueError:
raise Error(f"{self.label}: non-JSON response at {path}; check management URL") from None
raise APIError(f"{self.label}: non-JSON response at {path}; check management URL") from None
def close(self):
self.session.close()
@@ -453,10 +483,241 @@ class NPM(API):
return result
class RemoteNPM(API):
"""Read-only production source. No renewal, upload, host or settings endpoints."""
login = NPM.login
def call(self, method, path, **kwargs):
require((method == "POST" and path == "/tokens") or
(method == "GET" and path == "/nginx/certificates"),
"Remote NPM is read-only: request refused")
return super().call(method, path, **kwargs)
def download(self, cert_id):
number(cert_id, 1, 2147483647, "remote_certificate_id")
path = f"/nginx/certificates/{cert_id}/download"
try:
with self.session.get(self.base + path, timeout=(5, 30), allow_redirects=False, stream=True) as response:
require(response.status_code == 200, f"Remote NPM: HTTP {response.status_code} downloading certificate")
content = bytearray()
for chunk in response.iter_content(65536):
content.extend(chunk)
require(len(content) <= 2 * 1024 * 1024, "Remote certificate archive is too large")
return bytes(content)
except requests.RequestException:
raise Error("Remote NPM: certificate download connection or TLS error") from None
def certificate_info(cert):
"""Whitelist public fields: NPM responses can contain private keys and DNS tokens."""
domains = cert.get("domain_names", [])
expires = cert.get("expires_on")
fingerprint = None
pem = cert.get("meta", {}).get("certificate")
if isinstance(pem, str) and "BEGIN CERTIFICATE" in pem:
try:
leaf = x509.load_pem_x509_certificate(pem.encode())
domains = leaf.extensions.get_extension_for_class(x509.SubjectAlternativeName).value.get_values_for_type(x509.DNSName)
expires = leaf.not_valid_after_utc.isoformat()
fingerprint = leaf.fingerprint(hashes.SHA256()).hex()
except (ValueError, x509.ExtensionNotFound, x509.DuplicateExtension):
raise Error("NPM certificate has invalid PEM or missing DNS subject alternative names") from None
return {"id": cert["id"], "name": cert.get("nice_name", ""), "provider": cert.get("provider"),
"domains": domains, "expires": expires, "fingerprint": fingerprint,
"modified": cert.get("modified_on"), "dns_challenge": cert.get("meta", {}).get("dns_challenge") is True,
"dns_provider": cert.get("meta", {}).get("dns_provider")}
def covers_domain(pattern, hostname):
pattern = pattern.lower().rstrip(".")
return pattern == hostname or (pattern.startswith("*.") and
hostname.count(".") == pattern.count(".") and hostname.endswith(pattern[1:]))
def check_certificate(info, hostnames):
try:
expires = datetime.fromisoformat(info["expires"].replace("Z", "+00:00"))
if expires.tzinfo is None:
expires = expires.replace(tzinfo=timezone.utc)
except (ValueError, TypeError, AttributeError):
raise Error("NPM certificate has no valid expiration date") from None
require(expires > now(), "NPM certificate has expired")
for hostname in hostnames:
require(any(covers_domain(d, hostname) for d in info["domains"]),
f"NPM certificate does not cover {hostname}")
return expires
def remote_bundle(content, hostnames):
"""Read bounded PEMs in memory, never extract untrusted ZIP paths to disk."""
try:
with zipfile.ZipFile(io.BytesIO(content)) as archive:
entries = archive.infolist()
require(len(entries) <= 16 and sum(e.file_size for e in entries) <= 2 * 1024 * 1024,
"Invalid remote certificate archive size")
require(all(re.fullmatch(r"[a-zA-Z0-9_.-]+", e.filename) and not e.flag_bits & 1 for e in entries),
"Invalid remote certificate archive entries")
def read_one(pattern):
matches = [e for e in entries if re.fullmatch(pattern, e.filename)]
require(len(matches) == 1, "Remote archive must contain one fullchain and one private key")
return archive.read(matches[0]).decode("ascii")
fullchain = read_one(r"fullchain\d*\.pem")
key_pem = read_one(r"privkey\d*\.pem")
chain = x509.load_pem_x509_certificates(fullchain.encode())
require(len(chain) >= 2, "Remote certificate must include the intermediate chain")
leaf = chain[0]
require(not leaf.extensions.get_extension_for_class(x509.BasicConstraints).value.ca,
"Remote certificate must be a server certificate")
key = serialization.load_pem_private_key(key_pem.encode(), password=None)
public = lambda k: k.public_bytes(serialization.Encoding.DER, serialization.PublicFormat.SubjectPublicKeyInfo)
require(public(key.public_key()) == public(leaf.public_key()), "Remote certificate and key do not match")
require(leaf.not_valid_before_utc <= now(), "Remote certificate is not valid yet")
for child, issuer in zip(chain, chain[1:]):
child.verify_directly_issued_by(issuer)
require(issuer.extensions.get_extension_for_class(x509.BasicConstraints).value.ca,
"Invalid intermediate CA")
require(issuer.not_valid_before_utc <= now() < issuer.not_valid_after_utc,
"Remote intermediate certificate is not valid")
info = certificate_info({"id": 0, "meta": {"certificate": fullchain}})
check_certificate(info, hostnames)
return {"cert": leaf.public_bytes(serialization.Encoding.PEM).decode(), "key": key_pem,
"chain": "".join(c.public_bytes(serialization.Encoding.PEM).decode() for c in chain[1:]),
"info": info}
except (zipfile.BadZipFile, UnicodeError, ValueError, TypeError, InvalidSignature, NotImplementedError,
UnsupportedAlgorithm, x509.ExtensionNotFound, x509.DuplicateExtension):
raise Error("Invalid remote certificate archive, key or certificate chain") from None
class CertificateSync:
"""Copy renewed source certificates into the home NPM; retain last copy offline."""
def __init__(self, npm, remote, settings, state, registry, routes):
self.npm, self.remote, self.settings = npm, remote, settings or {}
self.state, self.registry, self.routes = state, registry, routes
self.sources = None
self.source_error = None
self.results = {}
self.conflicts = set()
targets = {}
for route in routes:
target_id = route.get("npm_certificate_id")
if not target_id and route.get("certificate_mode") == "remote_npm":
name = f'homegate:{registry["instance"]}:remote:{route["remote_certificate_id"]}'
target_id = next((c["id"] for c in npm.certs if c.get("nice_name") == name), None)
if target_id:
source = (route["certificate_mode"], route.get("remote_certificate_id"))
if target_id in targets and targets[target_id] != source:
self.conflicts.add(target_id)
targets[target_id] = source
def get_sources(self):
if self.source_error:
raise Error(self.source_error)
if self.sources is None:
try:
require(self.remote is not None, "Configure the VDS NPM connection in Settings")
self.remote.login(self.settings["remote_npm_identity"], self.settings["remote_npm_password"])
self.sources = self.remote.call("GET", "/nginx/certificates")
except (Error, KeyError):
self.source_error = "Remote NPM unavailable; check its connection and certificate read permissions"
raise Error(self.source_error) from None
return self.sources
def select(self, route):
target_id = route.get("npm_certificate_id")
source_id = route.get("remote_certificate_id")
name = f'homegate:{self.registry["instance"]}:remote:{source_id}'
matches = [c for c in self.npm.certs if c["id"] == target_id] if target_id else [
c for c in self.npm.certs if c.get("nice_name") == name]
require(len(matches) <= 1, "Duplicate local NPM certificate")
target = matches[0] if matches else None
require(target is not None or not target_id, "Selected local NPM certificate no longer exists")
require(not target or target["id"] not in self.conflicts,
"Local certificate has conflicting renewal sources; use a separate copy")
if route["certificate_mode"] == "npm":
info = certificate_info(target)
check_certificate(info, [route["hostname"]])
signature = {"id": target["id"], "sha256": info["fingerprint"],
"expires": info["expires"], "modified": info["modified"]}
return target["id"], info, signature, None
require(target is None or target["provider"] == "other",
"VDS synchronization requires a custom certificate in the home NPM")
cache_key = str(target["id"]) if target else name
if cache_key in self.results:
check_certificate(self.results[cache_key][1], [route["hostname"]])
return self.results[cache_key]
error = None
# Validate every local proxy sharing this certificate before replacing it.
hostnames = {r["hostname"] for r in self.routes if r.get("npm_certificate_id") == target_id and
(target_id or r.get("remote_certificate_id") == source_id)}
hostnames.update(d for host in self.npm.hosts if target and host.get("certificate_id") == target["id"]
for d in host["domain_names"])
records = self.registry.setdefault("certificate_copies", {})
record = records.get(str(target["id"]), {}) if target else {}
try:
sources = [c for c in self.get_sources() if c["id"] == source_id]
require(len(sources) == 1 and sources[0]["provider"] == "letsencrypt",
"Select an existing Let's Encrypt certificate from VDS NPM")
source = certificate_info(sources[0])
check_certificate(source, hostnames)
revision = {"url": self.remote.base, "id": source_id,
"expires": source["expires"], "modified": source["modified"]}
local = certificate_info(target) if target else None
if (record.get("source") != revision or not local or
local["fingerprint"] != record.get("fingerprint") or
time.time() - record.get("checked_at", 0) >= 86400):
bundle = remote_bundle(self.remote.download(source_id), hostnames)
info = bundle["info"]
if local and local["expires"]:
# A source rolled back to an older certificate must not shorten local validity.
try:
old_expiry = check_certificate(local, hostnames)
except Error:
old_expiry = now()
require(check_certificate(info, hostnames) >= old_expiry,
"VDS certificate is older than the local copy")
if not target:
target = self.npm.call("POST", "/nginx/certificates", json={"provider": "other", "nice_name": name})
self.npm.certs.append(target)
digest = hashlib.sha256((bundle["cert"] + bundle["chain"]).encode()).hexdigest()
if not local or local["fingerprint"] != info["fingerprint"] or record.get("sha256") != digest:
self.npm.call("POST", f'/nginx/certificates/{target["id"]}/upload', files={
"certificate": ("certificate.pem", bundle["cert"], "application/x-pem-file"),
"certificate_key": ("key.pem", bundle["key"], "application/x-pem-file"),
"intermediate_certificate": ("chain.pem", bundle["chain"], "application/x-pem-file"),
})
target.update(expires_on=info["expires"], domain_names=info["domains"],
meta={"certificate": bundle["cert"]})
record = {"source": revision, "fingerprint": info["fingerprint"], "sha256": digest,
"checked_at": time.time(), "synced_at": time.time()}
records[str(target["id"])] = record
save_json(self.state / "registry.json", self.registry)
except (Error, ValueError, KeyError, OSError) as exc:
error = str(exc)
LOG.warning("VDS certificate copy: %s", error)
require(target is not None, error or "Local certificate copy is not available yet")
info = certificate_info(target)
check_certificate(info, [route["hostname"]])
info["synced_at"] = record.get("synced_at")
info["sync_error"] = error
# The route records this fingerprint only after nginx accepted a reload.
signature = {"id": target["id"], "sha256": record.get("sha256") or info["fingerprint"]}
result = (target["id"], info, signature, error)
self.results[str(target["id"])] = self.results[cache_key] = result
return result
class PiHole(API):
def login(self, password):
self.session.headers.pop("X-FTL-SID", None)
self.session.headers.pop("X-FTL-CSRF", None)
self.session.cookies.clear()
session = self.call("POST", "/auth", json={"password": password})["session"]
require(session.get("valid") and session.get("sid"), "Pi-hole authentication failed")
# Pi-hole with authentication disabled returns valid=true, sid=null,
# validity=-1 and no CSRF token. It needs neither auth headers nor logout.
no_password = "sid" in session and session["sid"] is None and session.get("validity") == -1
require(session.get("valid") is True and (session.get("sid") or no_password),
"Pi-hole authentication failed")
if session.get("sid"):
self.session.headers["X-FTL-SID"] = session["sid"]
self.session.headers["X-FTL-CSRF"] = session["csrf"]
@@ -515,8 +776,9 @@ def payload(config, route, cert_id, marker):
"locations": [], "enabled": route["enabled"]}
def reconcile(config, state, ca, registry, npm, dns):
def reconcile(config, state, ca, registry, npm, dns, remote=None, settings=None):
npm.inventory()
certificates = CertificateSync(npm, remote, settings, state, registry, config["services"])
dns_error = False
if dns:
try:
@@ -537,18 +799,27 @@ def reconcile(config, state, ca, registry, npm, dns):
existing = npm.find_host(host, marker)
if dns and route["enabled"]:
dns.check(host, config["proxy_ip"])
bundle = ca.leaf(host)
previous = registry["routes"].get(host, {})
cert_error = None
if route.get("certificate_mode", "homegate") == "homegate":
bundle = ca.leaf(host)
cert_id, changed, signature = npm.certificate(name, bundle, previous.get("uploaded"))
cert_info = None
else:
cert_id, cert_info, signature, cert_error = certificates.select(route)
changed = signature != previous.get("uploaded")
result = npm.host(existing, payload(config, route, cert_id, marker), force_reload=changed)
# Save only AFTER nginx accepts the host/reload. Failed upload/reload is retried.
registry["routes"][host] = {"host_id": result["id"], "uploaded": signature}
registry["routes"][host] = {"host_id": result["id"], "uploaded": signature,
"certificate": cert_info, "certificate_mode": route.get("certificate_mode", "homegate")}
save_json(state / "registry.json", registry)
# Publish DNS only once proxy and TLS are configured.
if dns and route["enabled"]:
dns.ensure(host, config["proxy_ip"])
if changed or not existing:
LOG.info("Configured https://%s -> %s", host, route["upstream"])
if cert_error:
failures.append(host)
except (Error, ValueError, KeyError, OSError) as exc:
failures.append(host)
LOG.error("%s: %s", host, exc)
@@ -565,26 +836,39 @@ def secret(name):
def cycle(config, state, ca, registry):
verify = os.environ.get("API_CA_BUNDLE") or True
npm = NPM(os.environ.get("NPM_URL", ""), "NPM", verify)
settings_file = os.environ.get("HOMEGATE_CONNECTIONS")
settings = read_json(Path(settings_file)) if settings_file else None
if settings is not None and settings.get("api_ca_pem"):
ca_path = Path(settings_file).with_name("management-ca.pem")
atomic(ca_path, settings["api_ca_pem"].encode(), 0o600)
verify = str(ca_path)
npm = NPM(settings["npm_url"] if settings is not None else os.environ.get("NPM_URL", ""), "NPM", verify)
dns = None
remote = None
dns_error = False
try:
npm.login(os.environ.get("NPM_IDENTITY", ""), secret("NPM"))
npm.login(settings["npm_identity"] if settings is not None else os.environ.get("NPM_IDENTITY", ""),
settings["npm_password"] if settings is not None else secret("NPM"))
if config["dns_mode"] == "pihole6":
dns = PiHole(os.environ.get("PIHOLE_URL", ""), "PIHOLE", verify)
dns = PiHole(settings["pihole_url"] if settings is not None else os.environ.get("PIHOLE_URL", ""), "PIHOLE", verify)
try:
dns.login(secret("PIHOLE"))
dns.login(settings["pihole_password"] if settings is not None else secret("PIHOLE"))
except (Error, OSError) as exc:
LOG.error("Pi-hole login unavailable; continuing proxy maintenance: %s", exc)
dns.close()
dns = None
dns_error = True
reconcile(config, state, ca, registry, npm, dns)
if settings and settings.get("remote_npm_url") and any(
r.get("certificate_mode") == "remote_npm" for r in config["services"]):
remote = RemoteNPM(settings["remote_npm_url"], "Remote NPM")
reconcile(config, state, ca, registry, npm, dns, remote, settings)
require(not dns_error, "Pi-hole login failed; proxy/certificate maintenance completed")
finally:
npm.close()
if dns:
dns.close()
if remote:
remote.close()
def publish_panel_status(control, revision, config, state, ca, ok, error):
@@ -592,11 +876,19 @@ def publish_panel_status(control, revision, config, state, ca, ok, error):
control.mkdir(parents=True, exist_ok=True, mode=0o700)
previous = read_json(control / "status.json", {})
certs = []
registry = read_json(state / "registry.json", {"routes": {}})
for route in config["services"]:
mode = route.get("certificate_mode", "homegate")
if mode != "homegate":
saved = registry["routes"].get(route["hostname"], {})
info = saved.get("certificate") if saved.get("certificate_mode") == mode else None
if info and (not route.get("npm_certificate_id") or info["id"] == route["npm_certificate_id"]):
certs.append({"hostname": route["hostname"], "mode": mode, **info})
continue
path = state / "issued" / (route["hostname"] + ".json")
if path.exists():
cert = x509.load_pem_x509_certificate(read_json(path)["cert"].encode())
certs.append({"hostname": route["hostname"], "expires": cert.not_valid_after_utc.isoformat()})
certs.append({"hostname": route["hostname"], "mode": mode, "expires": cert.not_valid_after_utc.isoformat()})
save_json(control / "status.json", {
"ok": ok, "time": time.time(), "max_age": max(180, config["interval_seconds"] * 3),
"error": error, "applied_revision": revision if ok else previous.get("applied_revision"),

View File

@@ -18,6 +18,7 @@ from urllib.parse import urlsplit
import yaml
import homegate as h
from dns_challenge import DNSChallenge, providers as dns_providers
LOG = logging.getLogger("homegate.ui")
BASE = Path(__file__).resolve().parent
@@ -31,26 +32,33 @@ class UIError(Exception):
class Panel:
def __init__(self, config, control, origin, local=False, password_file=None, ssh_url=""):
def __init__(self, config, control, origin, local=False, password_file=None, ssh_url="", auth_required=True, connections_file=None):
self.config = Path(config)
self.control = Path(control)
self.connections_file = Path(connections_file) if connections_file else None
self.origin = origin.rstrip("/")
self.authority = urlsplit(self.origin).netloc
parsed_origin = urlsplit(self.origin)
if (parsed_origin.scheme not in ("http", "https") or not self.authority
if not (self.connections_file and not self.origin) and (parsed_origin.scheme not in ("http", "https") or not self.authority
or parsed_origin.path or parsed_origin.query or parsed_origin.fragment or parsed_origin.username):
raise UIError("UI_ORIGIN must be the exact http(s)://host:port of the panel")
self.local = local
self.auth_required = auth_required and not local
self.password_file = password_file
self.ssh_url = ssh_url
self.sessions = {}
self.attempts = defaultdict(list)
self.mutex = threading.RLock()
if not local and (not password_file or len(Path(password_file).read_text().strip()) < 12):
if self.auth_required and (not password_file or len(Path(password_file).read_text().strip()) < 12):
raise UIError("UI password must contain at least 12 characters; run setup.sh")
if self.config.exists() or not self.connections_file:
h.load_config(self.config)
self.dns_challenge = DNSChallenge(self.control, self.connect_npm)
def config_data(self):
if self.connections_file and not self.config.exists():
return {"proxy_ip": "", "allowed_networks": [], "domain_zones": ["home", "home.arpa"],
"dns_mode": "pihole6", "interval_seconds": 60, "services": [], "ssh_hosts": []}, ""
raw = self.config.read_bytes()
value = yaml.safe_load(raw)
h.validate_config(value)
@@ -64,6 +72,8 @@ class Panel:
return True
if self.local:
return False
if self.connections_file and not self.config.exists():
return any(address.version == net.version and address in net for net in h.PRIVATE)
c = h.load_config(self.config)
return any(address.version == net.version and address in net for net in
(ipaddress.ip_network(n) for n in c["allowed_networks"]))
@@ -107,8 +117,102 @@ class Panel:
snapshot = h.read_json(self.control / "status.json", {})
fresh = bool(snapshot) and time.time() - snapshot.get("time", 0) < snapshot.get("max_age", 180)
history = h.read_json(self.control / "ui-history.json", [])
connections = h.read_json(self.connections_file, {}) if self.connections_file else None
public_connections = None if connections is None else {
**{key: connections.get(key, "") for key in ("npm_url", "npm_identity", "pihole_url", "ssh_public_url", "api_ca_pem", "remote_npm_url", "remote_npm_identity")},
**{key + "_set": bool(connections.get(key)) for key in ("npm_password", "pihole_password", "remote_npm_password")},
}
return {"config": value, "revision": revision, "mode": "local" if self.local else "lan",
"ssh_url": self.ssh_url, "controller": {**snapshot, "fresh": fresh}, "history": history[:8]}
"setup_required": self.connections_file is not None and (not self.config.exists() or not self.connections_file.exists()),
"connections": public_connections,
"auth_required": self.auth_required,
"ssh_url": connections.get("ssh_public_url", "") if connections is not None else self.ssh_url,
"controller": {**snapshot, "fresh": fresh}, "history": history[:8]}
def save_settings(self, config, connections, revision):
if self.connections_file is None:
raise UIError("Connections are managed by the existing deployment", 409)
h.validate_config(config)
h.require(isinstance(connections, dict), "Connections must be an object")
with self.mutex:
if self.config_data()[1] != revision:
raise UIError("Настройки уже изменились. Обновите страницу.", 409)
values = h.read_json(self.connections_file, {})
allowed = {"npm_url", "npm_identity", "npm_password", "pihole_url", "pihole_password", "ssh_public_url", "api_ca_pem", "clear_pihole_password",
"remote_npm_url", "remote_npm_identity", "remote_npm_password"}
h.require(not set(connections) - allowed, "Unknown connection field")
clear_pihole_password = connections.get("clear_pihole_password", False)
h.require(isinstance(clear_pihole_password, bool), "clear_pihole_password must be boolean")
for key, value in connections.items():
if key == "clear_pihole_password":
continue
h.require(isinstance(value, str), f"{key} must be text")
if key.endswith("_password") and not value and values.get(key):
continue
values[key] = value if key.endswith("_password") else value.strip()
h.require(bool(values.get("npm_identity")), "Укажите логин Nginx Proxy Manager")
h.require(bool(values.get("npm_password")), "Укажите пароль Nginx Proxy Manager")
for key in ("npm_url", "pihole_url"):
if key == "pihole_url" and config["dns_mode"] == "manual" and not values.get(key):
continue
client = h.API(values.get(key, ""), key.removesuffix("_url").upper())
client.close()
if values.get("remote_npm_url"):
h.require(urlsplit(values["remote_npm_url"]).scheme == "https",
"Для NPM на VDS укажите HTTPS URL панели")
h.require(values.get("remote_npm_identity") and values.get("remote_npm_password"),
"Укажите логин и пароль NPM на VDS")
client = h.RemoteNPM(values["remote_npm_url"], "Remote NPM")
client.close()
h.require(client.base != values["npm_url"].rstrip("/") + "/api",
"Домашний NPM и NPM на VDS должны быть разными серверами")
values.setdefault("pihole_password", "")
if clear_pihole_password:
values["pihole_password"] = ""
if values.get("ssh_public_url"):
url = urlsplit(values["ssh_public_url"])
h.require(url.scheme in ("http", "https") and url.hostname and not url.username and not url.fragment,
"Укажите полный http(s) URL SSH-конфига")
if values.get("api_ca_pem"):
h.require(bool(h.x509.load_pem_x509_certificates(values["api_ca_pem"].encode())), "Некорректный PEM сертификата API")
h.save_json(self.connections_file, values)
result = self.save(config, revision)
self.request_sync()
return result
def connect_npm(self, remote=False):
h.require(self.connections_file is not None, "Сначала настройте подключения через UI")
values = h.read_json(self.connections_file, {})
prefix = "remote_npm" if remote else "npm"
h.require(values.get(prefix + "_url"), "Сначала сохраните подключение к NPM в Настройках")
verify = True
if not remote and values.get("api_ca_pem"):
ca_path = self.connections_file.with_name("management-ca.pem")
h.atomic(ca_path, values["api_ca_pem"].encode())
verify = str(ca_path)
client = (h.RemoteNPM if remote else h.NPM)(values[prefix + "_url"], "Remote NPM" if remote else "NPM", verify)
try:
client.login(values[prefix + "_identity"], values[prefix + "_password"])
return client
except Exception:
client.close()
raise
def certificates(self, remote=False):
client = self.connect_npm(remote)
try:
certs = client.call("GET", "/nginx/certificates")
return {"certificates": [h.certificate_info(c) for c in certs
if not remote or c.get("provider") == "letsencrypt"]}
finally:
client.close()
def dns_providers(self):
client = self.connect_npm()
try:
return dns_providers(client)
finally:
client.close()
def save(self, value, revision):
h.validate_config(value)
@@ -117,10 +221,12 @@ class Panel:
lock_path = self.config.parent / ".ui-config.lock"
with lock_path.open("a") as lock:
fcntl.flock(lock, fcntl.LOCK_EX)
original = self.config.read_bytes()
if hashlib.sha256(original).hexdigest() != revision:
original = self.config.read_bytes() if self.config.exists() else None
current_revision = hashlib.sha256(original).hexdigest() if original is not None else ""
if current_revision != revision:
raise UIError("Настройки уже изменились. Обновите страницу и повторите сохранение.", 409)
backup = self.config.parent / "backups" / f"services-{time.time_ns()}.yaml"
if original is not None:
h.atomic(backup, original)
# Preserve readability for the export container running under the same UID.
h.atomic(self.config, data, 0o644)
@@ -167,24 +273,44 @@ def handler_for(panel):
self.wfile.write(body)
def dispatch(self):
if self.headers.get("Host", "") != panel.authority:
host = self.headers.get("Host", "")
if panel.authority and host != panel.authority:
raise UIError("Unexpected Host", 403)
if not panel.authority:
parsed = urlsplit("http://" + host)
if not parsed.hostname or parsed.username or parsed.path or parsed.query or parsed.fragment:
raise UIError("Unexpected Host", 403)
try:
address = ipaddress.ip_address(parsed.hostname)
allowed_host = address.is_loopback or any(address.version == net.version and address in net for net in h.PRIVATE)
except ValueError:
zones = panel.config_data()[0].get("domain_zones", h.DEFAULT_ZONES)
allowed_host = parsed.hostname == "localhost" or any(parsed.hostname == zone or parsed.hostname.endswith("." + zone) for zone in zones)
if not allowed_host:
raise UIError("Open the panel using the server LAN IP or a configured local domain", 403)
if not panel.allowed(self.client_address[0]):
raise UIError("Доступ разрешён только из домашней сети", 403)
path = urlsplit(self.path).path
if self.command == "GET" and path in ("/", "/app.js", "/style.css", "/favicon.svg"):
name = {"/": "index.html", "/app.js": "app.js", "/style.css": "style.css", "/favicon.svg": "favicon.svg"}[path]
if self.command == "GET" and path == "/healthz":
return self.respond(200, {"ok": True})
if self.command == "GET" and path in ("/", "/app.js", "/settings.js", "/certificates.js", "/dns-challenge.js", "/style.css", "/favicon.svg"):
name = {"/": "index.html", "/app.js": "app.js", "/settings.js": "settings.js", "/certificates.js": "certificates.js", "/dns-challenge.js": "dns-challenge.js", "/style.css": "style.css", "/favicon.svg": "favicon.svg"}[path]
content_type = {"index.html": "text/html; charset=utf-8", "app.js": "text/javascript; charset=utf-8",
"style.css": "text/css; charset=utf-8", "favicon.svg": "image/svg+xml"}[name]
"settings.js": "text/javascript; charset=utf-8", "certificates.js": "text/javascript; charset=utf-8", "dns-challenge.js": "text/javascript; charset=utf-8", "style.css": "text/css; charset=utf-8", "favicon.svg": "image/svg+xml"}[name]
return self.respond(200, (BASE / "ui" / "dist" / name).read_bytes(), content_type)
token, session = panel.session(self.headers.get("Cookie"))
if self.command == "GET" and path == "/api/session":
if panel.local and session is None:
if not panel.auth_required and session is None:
token, session = panel.new_session()
return self.respond(200, {"authenticated": bool(session), "local": panel.local,
"csrf": session["csrf"] if session else None}, cookie=token if session else None)
if self.command == "POST":
if self.headers.get("Origin") != panel.origin:
origin = self.headers.get("Origin", "")
parsed = urlsplit(origin)
valid_origin = origin == panel.origin if panel.origin else (
parsed.scheme in ("http", "https") and parsed.netloc == host
and not parsed.path and not parsed.query and not parsed.fragment and not parsed.username)
if not valid_origin:
raise UIError("Invalid request origin", 403)
if self.headers.get("Content-Type", "").split(";")[0] != "application/json":
raise UIError("JSON required", 415)
@@ -194,7 +320,7 @@ def handler_for(panel):
body = json.loads(self.rfile.read(size))
if not isinstance(body, dict):
raise UIError("JSON object required")
if path == "/api/login" and not panel.local:
if path == "/api/login" and panel.auth_required:
token, session = panel.login(body.get("password"), self.client_address[0])
return self.respond(200, {"csrf": session["csrf"]}, cookie=token)
if session is None:
@@ -202,6 +328,12 @@ def handler_for(panel):
if self.command == "GET":
if path == "/api/state":
return self.respond(200, panel.status())
if path in ("/api/npm-certificates", "/api/remote-certificates"):
return self.respond(200, panel.certificates(remote=path == "/api/remote-certificates"))
if path == "/api/dns-providers":
return self.respond(200, panel.dns_providers())
if path == "/api/dns-challenge":
return self.respond(200, panel.dns_challenge.status())
if path == "/api/ssh-config":
text = h.render_ssh(h.ssh_entries(h.load_config(panel.config)))
return self.respond(200, text.encode(), "text/plain; charset=utf-8")
@@ -222,8 +354,14 @@ def handler_for(panel):
raise UIError("Invalid session token", 403)
if path == "/api/config":
return self.respond(200, panel.save(body["config"], body["revision"]))
if path == "/api/settings":
return self.respond(200, panel.save_settings(body["config"], body["connections"], body["revision"]))
if path == "/api/sync":
return self.respond(202, panel.request_sync())
if path == "/api/dns-challenge":
return self.respond(202, panel.dns_challenge.start(body))
if path == "/api/dns-challenge/check":
return self.respond(202, panel.dns_challenge.check())
if path == "/api/logout":
panel.sessions.pop(token, None)
return self.respond(200, {"ok": True}, cookie="")
@@ -257,17 +395,21 @@ def main():
args = p.parse_args()
if args.local and args.host != "127.0.0.1":
raise UIError("Local no-login mode must bind to loopback")
if not args.local:
managed = os.environ.get("HOMEGATE_MANAGED_UI") == "1"
if not args.local and not managed:
bind_ip = os.environ.get("UI_BIND_IP", "")
h.private_address(bind_ip)
h.require(ipaddress.ip_address(bind_ip).version == 4, "UI_BIND_IP must be a private IPv4 address")
origin = os.environ.get("UI_ORIGIN", f"http://{args.host}:{args.port}")
origin = os.environ.get("UI_ORIGIN", "" if managed else f"http://{args.host}:{args.port}")
auth_mode = os.environ.get("UI_AUTH_MODE", "password")
h.require(auth_mode in ("password", "none"), "UI_AUTH_MODE must be password or none")
panel = Panel(os.environ.get("HOMEGATE_CONFIG", "/config/services.yaml"),
os.environ.get("HOMEGATE_CONTROL", "/control"), origin, args.local,
os.environ.get("UI_PASSWORD_FILE", "/run/secrets/ui_password"),
os.environ.get("SSH_PUBLIC_URL", ""))
os.environ.get("SSH_PUBLIC_URL", ""), auth_required=auth_mode != "none",
connections_file=os.environ.get("HOMEGATE_CONNECTIONS") if managed else None)
with ThreadingHTTPServer((args.host, args.port), handler_for(panel)) as server:
print(f"Homegate Local: {origin}", flush=True)
print(f"Homegate UI: {origin or f'http://{args.host}:{args.port}'}", flush=True)
server.serve_forever()

111
standalone.py Normal file
View File

@@ -0,0 +1,111 @@
"""Run the controller, passwordless LAN panel and SSH export in one container."""
import argparse
import os
from pathlib import Path
import signal
import subprocess
import sys
import threading
import time
import urllib.request
import yaml
import homegate as h
BASE = Path(__file__).resolve().parent
def runtime_environment(source):
env = dict(source)
defaults = {
"HOMEGATE_CONFIG": "/config/services.yaml", "HOMEGATE_STATE": "/data",
"HOMEGATE_CONTROL": "/control", "HOMEGATE_CONNECTIONS": "/config/connections.json",
"HOMEGATE_MANAGED_UI": "1",
"UI_AUTH_MODE": "none", "UI_LISTEN_HOST": "0.0.0.0", "UI_LISTEN_PORT": "8081",
"PYTHONDONTWRITEBYTECODE": "1", "PYTHONUNBUFFERED": "1",
}
for key, value in defaults.items():
env.setdefault(key, value)
return env
def prepare(env):
for directory in (Path(env["HOMEGATE_CONFIG"]).parent, Path(env["HOMEGATE_STATE"]), Path(env["HOMEGATE_CONTROL"])):
directory.mkdir(parents=True, exist_ok=True)
def configured(env):
return all(Path(env[key]).is_file() for key in ("HOMEGATE_CONFIG", "HOMEGATE_CONNECTIONS"))
def supervise(commands, env, deferred=()):
stopped = threading.Event()
previous = {sig: signal.signal(sig, lambda *_: stopped.set())
for sig in (signal.SIGTERM, signal.SIGINT)}
children = []
try:
for command in commands:
if stopped.is_set():
return 0
children.append(subprocess.Popen(command, env=env))
while not stopped.wait(0.25):
if deferred and configured(env):
for command in deferred:
children.append(subprocess.Popen(command, env=env))
deferred = ()
for child in children:
if child.poll() is not None:
print(f"Homegate process exited with status {child.returncode}; restarting the container", flush=True)
return 1
return 0
finally:
for child in children:
if child.poll() is None:
child.terminate()
deadline = time.monotonic() + 8
for child in children:
try:
child.wait(timeout=max(0, deadline - time.monotonic()))
except subprocess.TimeoutExpired:
child.kill()
child.wait()
for sig, handler in previous.items():
signal.signal(sig, handler)
def health(env):
opener = urllib.request.build_opener(urllib.request.ProxyHandler({}))
requests = ["http://127.0.0.1:8081/healthz"]
if configured(env):
requests.append("http://127.0.0.1:8080/healthz")
for request in requests:
with opener.open(request, timeout=3) as response:
response.read()
return 0
def main():
os.umask(0o077)
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("command", nargs="?", default="all",
choices=("all", "once", "validate", "fingerprint", "rotate-ca", "ssh-config"))
parser.add_argument("--health", action="store_true")
args = parser.parse_args()
env = runtime_environment(os.environ)
if args.health:
return health(env)
prepare(env)
controller = [sys.executable, str(BASE / "homegate.py")]
if args.command != "all":
h.require(configured(env), "Complete the first-run setup in the web panel")
return subprocess.call(controller + [args.command], env=env)
return supervise([[sys.executable, str(BASE / "homegate_ui.py")]], env,
deferred=[controller + ["run"], controller + ["serve"]])
if __name__ == "__main__":
try:
sys.exit(main())
except (h.Error, OSError, ValueError, TypeError, KeyError, yaml.YAMLError) as exc:
print(f"Homegate: {exc}", file=sys.stderr)
sys.exit(1)

311
tests/test_certificates.py Normal file
View File

@@ -0,0 +1,311 @@
"""Existing NPM certificates, read-only VDS copying and renewal failure behavior."""
import copy
import io
import json
from datetime import timedelta
from pathlib import Path
import tempfile
import unittest
from unittest.mock import patch
from urllib.parse import urlsplit
import zipfile
import requests
import homegate as h
from test_homegate import Transport
import test_setup
def archive(bundle, root, **extra):
output = io.BytesIO()
with zipfile.ZipFile(output, 'w') as z:
z.writestr('fullchain2.pem', bundle['cert'] + root)
z.writestr('privkey2.pem', bundle['key'])
for name, value in extra.items():
z.writestr(name, value)
return output.getvalue()
class CertificateTests(unittest.TestCase):
def setUp(self):
temp = tempfile.TemporaryDirectory()
self.addCleanup(temp.cleanup)
self.state = Path(temp.name)
self.ca = h.Authority(self.state / 'local')
self.source_ca = h.Authority(self.state / 'source', ['example.com'])
self.bundle = self.source_ca.leaf('disk.example.com')
self.root = self.source_ca.cert.public_bytes(h.serialization.Encoding.PEM).decode()
self.source = {'id': 42, 'provider': 'letsencrypt', 'nice_name': 'Nextcloud',
'domain_names': ['disk.example.com'], 'expires_on': self.expires(),
'meta': {'dns_provider_credentials': 'PRIVATE_DNS_TOKEN', 'certificate_key': 'PRIVATE_KEY'}}
self.content = archive(self.bundle, self.root)
self.remote_requests = []
self.offline = False
self.transport = Transport()
def send(session, request, **kwargs):
if urlsplit(request.url).hostname != 'vds.example.com':
return self.transport.send(session, request, **kwargs)
self.remote_requests.append((request.method, urlsplit(request.url).path))
if self.offline:
raise requests.ConnectionError('SECRET_NOT_TO_LOG')
response = requests.Response()
response.status_code = 200
response._content_consumed = True
if request.method == 'POST' and request.url.endswith('/tokens'):
response._content = b'{"token":"REMOTE_TOKEN"}'
elif request.method == 'GET' and request.url.endswith('/nginx/certificates'):
response._content = json.dumps([self.source]).encode()
elif request.method == 'GET' and request.url.endswith('/42/download'):
response._content = self.content
else:
raise AssertionError('Unexpected production request: ' + request.method + ' ' + request.url)
return response
self.mock = patch.object(requests.Session, 'send', send)
self.mock.start()
self.addCleanup(self.mock.stop)
self.npm = h.NPM('http://home-npm:81', 'NPM')
self.npm.login('local', 'test-local')
self.remote = h.RemoteNPM('https://vds.example.com', 'Remote NPM')
self.addCleanup(self.npm.close)
self.addCleanup(self.remote.close)
self.settings = {'remote_npm_identity': 'source', 'remote_npm_password': 'test-source'}
self.registry = {'instance': 'test', 'routes': {}}
self.config = h.validate_config({'proxy_ip': '192.168.0.10', 'allowed_networks': ['192.168.0.0/24'],
'domain_zones': ['home', 'example.com'], 'dns_mode': 'manual', 'services': [
{'hostname': 'disk.example.com', 'upstream': 'http://192.168.0.20:80',
'certificate_mode': 'remote_npm', 'remote_certificate_id': 42}]})
self.transport.writes.clear()
def expires(self):
return h.x509.load_pem_x509_certificate(self.bundle['cert'].encode()).not_valid_after_utc.isoformat()
def sync(self):
with patch.object(self.ca, 'leaf', side_effect=AssertionError('Must not issue a local CA certificate')):
h.reconcile(self.config, self.state, self.ca, self.registry, self.npm, None, self.remote, self.settings)
def renew(self):
(self.state / 'source/issued/disk.example.com.json').unlink()
with patch.object(h, 'now', return_value=h.now() + timedelta(days=1)):
self.bundle = self.source_ca.leaf('disk.example.com')
# Use a valid-from time in the past while extending expiry for the test clock.
self.content = archive(self.bundle, self.root)
self.source['expires_on'] = self.expires()
def test_initial_copy_and_existing_selection_do_not_use_local_ca(self):
self.sync()
self.assertEqual(len(self.transport.certs), 1)
self.assertEqual(self.transport.hosts[0]['certificate_id'], 1)
self.assertEqual(self.transport.certs[0]['provider'], 'other')
self.assertIn('intermediate_certificate', self.transport.uploads[1])
self.transport.writes.clear()
self.sync()
self.assertEqual(self.transport.writes, [])
self.assertEqual(sum(path.endswith('/download') for _, path in self.remote_requests), 1)
self.config['services'][0].update(certificate_mode='npm', npm_certificate_id=1)
del self.config['services'][0]['remote_certificate_id']
self.remote_requests.clear()
self.sync()
self.assertEqual(self.remote_requests, [])
self.assertFalse(any(path.endswith('/upload') for _, path in self.transport.writes))
def test_renewal_updates_same_local_certificate_and_reloads_proxy(self):
self.sync()
old = self.transport.uploads[1]['certificate']
self.renew()
self.transport.writes.clear()
with patch.object(h, 'now', return_value=h.now() + timedelta(days=2)):
self.sync()
self.assertNotEqual(old, self.transport.uploads[1]['certificate'])
self.assertEqual(len(self.transport.certs), 1)
self.assertEqual(self.transport.writes, [('POST', '/nginx/certificates/1/upload'), ('PUT', '/nginx/proxy-hosts/1')])
def test_read_only_production_client_rejects_every_mutation_except_login(self):
for method, path in [('POST', '/nginx/certificates/42/renew'), ('POST', '/nginx/certificates/42/upload'),
('PUT', '/nginx/proxy-hosts/1'), ('DELETE', '/nginx/certificates/42'),
('POST', '/nginx/certificates'), ('GET', '/nginx/proxy-hosts')]:
with self.assertRaisesRegex(h.Error, 'read-only'):
self.remote.call(method, path)
self.assertEqual(self.remote_requests, [])
self.sync()
self.assertEqual(self.remote_requests, [('POST', '/api/tokens'), ('GET', '/api/nginx/certificates'),
('GET', '/api/nginx/certificates/42/download')])
def test_outage_keeps_certificate_and_still_maintains_local_proxy(self):
self.sync()
old = copy.deepcopy(self.transport.uploads)
self.offline = True
self.config['services'][0]['forward_port'] = 8080
self.transport.writes.clear()
with self.assertRaisesRegex(h.Error, 'Routes failed'):
self.sync()
self.assertEqual(old, self.transport.uploads)
self.assertEqual(self.transport.hosts[0]['forward_port'], 8080)
self.assertEqual(self.transport.writes, [('PUT', '/nginx/proxy-hosts/1')])
info = self.registry['routes']['disk.example.com']['certificate']
self.assertIn('unavailable', info['sync_error'])
def test_bad_download_preserves_existing_copy_and_does_not_upload(self):
self.sync()
old = copy.deepcopy(self.transport.uploads)
self.source['modified_on'] = 'changed'
for bad in [b'not a zip', archive(self.bundle, self.root, **{'../key.pem': 'bad'}),
archive(dict(self.bundle, key=h.pem_key(h.ec.generate_private_key(h.ec.SECP256R1()))), self.root)]:
self.content = bad
self.transport.writes.clear()
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(old, self.transport.uploads)
self.assertEqual(self.transport.writes, [])
def test_failed_reload_retried_after_restart_without_redownloading(self):
self.transport.fail_nginx = True
with self.assertRaises(h.Error):
self.sync()
self.assertNotIn('disk.example.com', self.registry['routes'])
self.registry = h.read_json(self.state / 'registry.json')
self.transport.fail_nginx = False
self.transport.writes.clear()
self.sync()
self.assertEqual(self.transport.writes, [('PUT', '/nginx/proxy-hosts/1')])
self.assertEqual(sum(p.endswith('/download') for _, p in self.remote_requests), 1)
def test_missing_local_cert_does_not_silently_create_replacement(self):
self.config['services'][0].update(certificate_mode='npm', npm_certificate_id=99)
del self.config['services'][0]['remote_certificate_id']
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(self.transport.writes, [])
self.assertEqual(self.remote_requests, [])
def test_existing_public_certificate_creates_local_dns_without_uploading(self):
self.transport.certs = [dict(self.source, id=1)]
self.transport.uploads[1] = {'existing': True}
self.config['services'][0].update(certificate_mode='npm', npm_certificate_id=1)
del self.config['services'][0]['remote_certificate_id']
dns = h.PiHole('http://pihole', 'PIHOLE')
self.addCleanup(dns.close)
dns.login('test')
self.transport.writes.clear()
with patch.object(self.ca, 'leaf', side_effect=AssertionError('No local CA issuance')):
h.reconcile(self.config, self.state, self.ca, self.registry, self.npm, dns)
self.assertIn('192.168.0.10 disk.example.com', self.transport.records)
self.assertEqual(self.transport.hosts[0]['certificate_id'], 1)
self.assertFalse(any('/nginx/certificates' in p for _, p in self.transport.writes))
def test_source_unavailable_on_first_copy_makes_no_local_changes(self):
self.offline = True
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(self.transport.writes, [])
self.assertEqual(self.transport.hosts, [])
def test_wrong_domain_is_rejected_before_download_or_local_upload(self):
self.source['domain_names'] = ['unrelated.example.com']
with self.assertRaises(h.Error):
self.sync()
self.assertFalse(any(p.endswith('/download') for _, p in self.remote_requests))
self.assertEqual(self.transport.writes, [])
def test_malformed_renewal_does_not_block_an_unrelated_service(self):
self.sync()
self.offline = True
route = copy.deepcopy(self.config['services'][0])
route.update(hostname='other.example.com', certificate_mode='npm', npm_certificate_id=2)
del route['remote_certificate_id']
self.config['services'].append(route)
self.transport.certs.append(dict(self.source, id=2, domain_names=['other.example.com']))
self.transport.uploads[2] = {'existing': True}
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(self.transport.hosts[1]['domain_names'], ['other.example.com'])
def test_offline_shared_copy_cannot_publish_an_uncovered_domain(self):
self.sync()
self.offline = True
self.config['services'].append(dict(self.config['services'][0], hostname='uncovered.example.com'))
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(len(self.transport.hosts), 1)
def test_explicit_and_automatic_targets_cannot_assign_different_sources(self):
self.sync()
self.config['services'].append(dict(self.config['services'][0], hostname='other.example.com',
npm_certificate_id=1, remote_certificate_id=43))
self.transport.writes.clear()
self.remote_requests.clear()
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(self.transport.writes, [])
self.assertEqual(self.remote_requests, [])
def test_sync_never_overwrites_local_letsencrypt_certificate(self):
self.transport.certs = [dict(self.source, id=1)]
self.config['services'][0]['npm_certificate_id'] = 1
with self.assertRaises(h.Error):
self.sync()
self.assertEqual(self.transport.writes, [])
def test_public_metadata_and_status_never_expose_keys_or_dns_tokens(self):
self.assertNotIn('PRIVATE_', json.dumps(h.certificate_info(self.source)))
self.sync()
h.publish_panel_status(self.state / 'control', 'revision', self.config, self.state, self.ca, True, None)
status = h.read_json(self.state / 'control/status.json')
self.assertEqual(status['certificates'][0]['mode'], 'remote_npm')
self.assertNotIn('PRIVATE KEY', json.dumps(status))
self.assertNotIn(self.bundle['key'], (self.state / 'registry.json').read_text())
def test_wildcard_only_covers_one_label_and_expired_certificates_fail(self):
info = {'domains': ['*.example.com'], 'expires': self.expires()}
h.check_certificate(info, ['disk.example.com'])
for hostname in ['example.com', 'a.disk.example.com', 'other.example.net']:
with self.assertRaises(h.Error):
h.check_certificate(info, [hostname])
with patch.object(h, 'now', return_value=h.now() + timedelta(days=91)), self.assertRaises(h.Error):
h.check_certificate(info, ['disk.example.com'])
class CertificateUITests(unittest.TestCase):
setUp = test_setup.SetupTests.setUp
request = test_setup.SetupTests.request
connect = test_setup.SetupTests.connect
install = test_setup.SetupTests.install
def test_remote_settings_and_certificate_list_are_redacted(self):
self.settings['connections'].update(remote_npm_url='https://vds.example.com',
remote_npm_identity='reader@example.com', remote_npm_password='vds-secret')
state = self.install()
self.assertTrue(state['connections']['remote_npm_password_set'])
self.assertNotIn('vds-secret', json.dumps(state))
self.assertEqual(h.read_json(self.connections)['remote_npm_password'], 'vds-secret')
self.settings['revision'] = state['revision']
self.settings['connections']['remote_npm_password'] = ''
self.assertEqual(self.request('/api/settings', self.settings)[0], 200)
self.assertEqual(h.read_json(self.connections)['remote_npm_password'], 'vds-secret')
with patch.object(h.RemoteNPM, 'login') as login, patch.object(h.RemoteNPM, 'call', return_value=[
{'id': 42, 'provider': 'letsencrypt', 'domain_names': ['disk.example.com'],
'meta': {'certificate_key': 'private-key', 'dns_provider_credentials': 'dns-token'}}]) as call:
code, body, _ = self.request('/api/remote-certificates')
self.assertEqual(code, 200)
self.assertNotIn('private-key', json.dumps(body))
self.assertNotIn('dns-token', json.dumps(body))
login.assert_called_once_with('reader@example.com', 'vds-secret')
call.assert_called_once_with('GET', '/nginx/certificates')
self.cookie = ''
self.assertEqual(self.request('/api/remote-certificates')[0], 401)
def test_public_domain_existing_certificate_can_be_saved_in_ui(self):
state = self.install()
config = state['config']
config['domain_zones'].append('example.com')
config['services'] = [{'hostname': 'disk.example.com', 'upstream': 'http://192.168.0.20',
'certificate_mode': 'npm', 'npm_certificate_id': 7}]
code, saved, _ = self.request('/api/config', {'revision': state['revision'], 'config': config})
self.assertEqual(code, 200)
self.assertEqual(saved['config']['services'][0]['npm_certificate_id'], 7)
def test_conflicting_sources_rejected_before_saving(self):
state = self.install()
config = state['config']
config['services'] = [{'hostname': name + '.home', 'upstream': 'http://192.168.0.20',
'certificate_mode': 'remote_npm', 'npm_certificate_id': 7, 'remote_certificate_id': source}
for name, source in [('a', 1), ('b', 2)]]
self.assertEqual(self.request('/api/config', {'revision': state['revision'], 'config': config})[0], 400)

204
tests/test_dns_challenge.py Normal file
View File

@@ -0,0 +1,204 @@
"""DNS-01 issuance is local, asynchronous, secret-free in state, and retry-safe."""
import copy
from datetime import timedelta
import json
import threading
import unittest
from unittest.mock import Mock, patch
import homegate as h
import homegate_ui as ui
import dns_challenge as dc
import test_setup
class DNSChallengeTests(unittest.TestCase):
setUpPanel = test_setup.SetupTests.setUp
request = test_setup.SetupTests.request
connect = test_setup.SetupTests.connect
install = test_setup.SetupTests.install
def setUp(self):
self.setUpPanel()
self.install()
self.rows = []
self.posts = []
self.legacy = False
self.fail_after_create = False
self.block = None
self.entered = threading.Event()
self.client = Mock(base='http://home-npm:81/api')
self.client.call.side_effect = self.call
self.panel.dns_challenge.connect = lambda: self.client
self.input = {'domains':['disk.example.com'], 'provider':'cloudflare',
'credentials':'dns_cloudflare_api_token=DNS_PRIVATE_TOKEN', 'agree':True,
'email':'admin@example.com', 'propagation_seconds':None}
def call(self, method, path, **kwargs):
if method == 'GET' and path == '/nginx/certificates/dns-providers':
if self.legacy:
raise h.APIError('Not found', 404)
return [{'id':'cloudflare','name':'Cloudflare','credentials':'dns_cloudflare_api_token=EXAMPLE'}]
if method == 'GET' and path == '/nginx/certificates':
return copy.deepcopy(self.rows)
if method == 'POST' and path == '/nginx/certificates':
payload = copy.deepcopy(kwargs['json'])
self.posts.append(payload)
self.assertEqual(kwargs['timeout'], (5, dc.ISSUE_TIMEOUT))
self.entered.set()
if self.block:
self.block.wait(3)
row = dict(payload, id=len(self.rows)+1, nice_name=', '.join(payload['domain_names']),
expires_on=(h.now()+timedelta(days=90)).isoformat())
self.rows.append(row)
if self.fail_after_create:
raise h.APIError('NPM: connection or TLS error')
return copy.deepcopy(row)
raise AssertionError((method,path))
def finish(self):
self.panel.dns_challenge.thread.join(4)
self.assertFalse(self.panel.dns_challenge.thread.is_alive())
return self.request('/api/dns-challenge')[1]
def start(self):
code, body, _ = self.request('/api/dns-challenge', copy.deepcopy(self.input))
self.assertEqual(code, 202, body)
return self.finish()
def test_modern_npm_issues_dns_certificate_and_exports_only_public_metadata(self):
self.input['domains'] = ['example.com','*.example.com']
result = self.start()
self.assertEqual(result['status'], 'success')
self.assertEqual(self.posts[0], {'provider':'letsencrypt','domain_names':self.input['domains'],
'meta':{'dns_challenge':True,'dns_provider':'cloudflare',
'dns_provider_credentials':self.input['credentials']}})
self.assertTrue(result['certificate']['dns_challenge'])
for path in self.root.rglob('*'):
if path.is_file():
self.assertNotIn('DNS_PRIVATE_TOKEN', path.read_text())
for path in ['/api/dns-challenge','/api/state','/downloads/services.yaml']:
self.assertNotIn('DNS_PRIVATE_TOKEN', str(self.request(path)[1]))
with patch.object(h.RemoteNPM, 'call', side_effect=AssertionError('No VDS calls')):
self.assertEqual(self.start()['status'], 'success')
self.assertEqual(len(self.posts), 1) # valid certificate is reused
def test_old_npm_receives_email_and_agreement_with_propagation_delay(self):
self.legacy = True
self.input['propagation_seconds'] = 120
self.assertEqual(self.start()['status'], 'success')
meta = self.posts[0]['meta']
self.assertEqual(meta['letsencrypt_email'], 'admin@example.com')
self.assertIs(meta['letsencrypt_agree'], True)
self.assertEqual(meta['propagation_seconds'], 120)
def test_issuance_is_background_and_duplicate_posts_are_blocked(self):
self.block = threading.Event()
self.addCleanup(self.block.set)
code, _, _ = self.request('/api/dns-challenge', self.input)
self.assertEqual(code, 202)
self.assertTrue(self.entered.wait(2))
self.assertEqual(self.request('/api/state')[0], 200)
self.assertEqual(self.request('/api/dns-challenge')[1]['status'], 'running')
self.assertEqual(self.request('/api/dns-challenge', self.input)[0], 400)
self.block.set()
self.assertEqual(self.finish()['status'], 'success')
self.assertEqual(len(self.posts), 1)
def test_timeout_recovers_existing_certificate_without_another_acme_order(self):
self.fail_after_create = True
self.assertEqual(self.start()['status'], 'unknown')
self.assertEqual(self.request('/api/dns-challenge', self.input)[0], 400)
self.assertEqual(self.request('/api/dns-challenge/check', {})[0], 202)
self.assertEqual(self.finish()['status'], 'success')
self.assertEqual(len(self.posts), 1)
def test_restart_does_not_repeat_pending_order(self):
dc.h.save_json(self.panel.dns_challenge.path, {'status':'running','domains':['disk.example.com'],
'provider':'cloudflare','started_at':dc.time.time(),'issued_at':dc.time.time(),'npm_base':self.client.base})
restarted = dc.DNSChallenge(self.control, lambda:self.client)
self.assertEqual(restarted.status()['status'], 'unknown')
with self.assertRaises(h.Error):
restarted.start(self.input)
self.assertEqual(self.posts, [])
def test_clear_api_failure_is_reported_without_retry_or_response_secrets(self):
original = self.client.call.side_effect
self.client.call.side_effect = lambda method,path,**kw: (
(_ for _ in ()).throw(h.APIError('NPM: HTTP 400',400)) if method == 'POST' else original(method,path,**kw))
result = self.start()
self.assertEqual(result['status'], 'error')
self.assertIn('HTTP 400', result['message'])
self.assertEqual(sum(c.args[0]=='POST' for c in self.client.call.call_args_list), 1)
def test_provider_and_email_are_validated_before_submitting(self):
self.input['provider'] = 'unknown_provider'
self.assertEqual(self.start()['status'], 'error')
self.input['provider'] = 'cloudflare'
self.legacy = True
self.input['email'] = ''
self.assertEqual(self.start()['status'], 'error')
self.assertEqual(self.posts, [])
def test_invalid_requests_do_not_start_background_work(self):
for field, value in [('agree',False),('domains',['pve.home']),('domains',['a.local']),
('domains',['192.168.0.1']),('domains',['*.example.com','*.example.com']),
('domains',['a.example.com;rm']),('credentials',''),('email',None),
('propagation_seconds',True),('propagation_seconds',601)]:
with self.subTest(field=field,value=value):
request = dict(self.input, **{field:value})
self.assertEqual(self.request('/api/dns-challenge',request)[0],400)
self.assertIsNone(self.panel.dns_challenge.thread)
def test_dns_endpoints_enforce_session_origin_csrf_and_lan(self):
for headers in [{'X-Homegate-CSRF':''},{'Origin':'https://attacker.example'}]:
self.assertEqual(self.request('/api/dns-challenge',self.input,headers=headers)[0],403)
self.assertEqual(self.request('/api/dns-challenge',self.input,peer='8.8.8.8')[0],403)
self.cookie = ''
for path in ['/api/dns-providers','/api/dns-challenge']:
self.assertEqual(self.request(path)[0],401)
self.assertEqual(self.posts,[])
def test_provider_catalog_uses_only_local_connection_and_safe_fields(self):
with patch.object(self.panel,'connect_npm',return_value=self.client) as connect:
code, body, _ = self.request('/api/dns-providers')
self.assertEqual(code,200)
self.assertFalse(body['email_required'])
self.assertEqual(body['providers'][0]['id'],'cloudflare')
connect.assert_called_once_with()
self.client.call.side_effect = h.APIError('Forbidden',403)
with self.assertRaises(h.APIError):
dc.providers(self.client) # authentication/permission errors must not become legacy fallback
def test_old_api_bad_certificate_id_path_uses_legacy_catalog(self):
self.client.call.side_effect = h.APIError('Invalid certificate id',400)
catalog = dc.providers(self.client)
self.assertTrue(catalog['email_required'])
self.assertTrue(any(p['id']=='cloudflare' for p in catalog['providers']))
def test_result_can_be_selected_without_changing_certificate_or_vds(self):
result = self.start()
state = self.request('/api/state')[1]
config = state['config']
config['domain_zones'].append('example.com')
config['services'] = [{'hostname':'disk.example.com','upstream':'http://192.168.0.20:8080',
'certificate_mode':'npm','npm_certificate_id':result['certificate']['id']}]
self.assertEqual(self.request('/api/config',{'config':config,'revision':state['revision']})[0],200)
self.assertNotIn('DNS_PRIVATE_TOKEN',self.config.read_text())
self.assertEqual(len(self.posts),1)
def test_real_transport_timeout_can_be_extended_only_for_issuance(self):
client = h.NPM('http://home-npm:81','NPM')
self.addCleanup(client.close)
response = Mock(status_code=201, content=b'{}')
response.json.return_value = {}
with patch.object(client.session,'request',return_value=response) as request:
client.call('POST','/nginx/certificates',json={},timeout=(5,900))
self.assertEqual(request.call_args.kwargs['timeout'],(5,900))
client.call('GET','/nginx/certificates')
self.assertEqual(request.call_args.kwargs['timeout'],(5,30))
source = h.RemoteNPM('https://vds.example.com','Remote NPM')
self.addCleanup(source.close)
for method,path in [('GET','/nginx/certificates/dns-providers'),('POST','/nginx/certificates')]:
with self.assertRaisesRegex(h.Error,'read-only'):
source.call(method,path)

View File

@@ -31,8 +31,11 @@ class Transport:
self.fail_nginx = False
self.fail_dns = False
self.uploads = {}
self.pihole_session = {"valid": True, "sid": "TEST_SID", "csrf": "TEST_CSRF"}
self.requests = []
def send(self, session, request, **kwargs):
self.requests.append(request)
path = unquote(urlsplit(request.url).path.removeprefix("/api"))
method = request.method
data = json.loads(request.body) if request.body and "application/json" in request.headers.get("Content-Type", "") else None
@@ -43,7 +46,7 @@ class Transport:
body = {"token": "TEST_TOKEN"}
elif path == "/auth":
if method == "POST":
body = {"session": {"valid": True, "sid": "TEST_SID", "csrf": "TEST_CSRF"}}
body = {"session": self.pihole_session}
else:
status = 204
elif path.startswith("/nginx/"):
@@ -74,22 +77,25 @@ class Transport:
message = BytesParser(policy=default).parsebytes(raw)
fields = {p.get_param("name", header="content-disposition"): p.get_payload(decode=True)
for p in message.iter_parts()}
assert set(fields) == {"certificate", "certificate_key"}
x509.load_pem_x509_certificate(fields["certificate"])
assert set(fields) in ({"certificate", "certificate_key"},
{"certificate", "certificate_key", "intermediate_certificate"})
leaf = x509.load_pem_x509_certificate(fields["certificate"])
self.uploads[cert_id] = fields
self.certs[cert_id - 1]["meta"] = {"certificate": True, "certificate_key": True}
self.certs[cert_id - 1].update(meta={k: v.decode() for k, v in fields.items()},
expires_on=leaf.not_valid_after_utc.isoformat(),
domain_names=leaf.extensions.get_extension_for_class(x509.SubjectAlternativeName).value.get_values_for_type(x509.DNSName))
body = {"certificate_key": "SECRET_NOT_TO_LOG"}
else:
raise AssertionError(path)
elif path == "/config/dns":
assert request.headers["X-FTL-SID"] == "TEST_SID"
assert request.headers.get("X-FTL-SID") == self.pihole_session["sid"]
if self.fail_dns:
status = 503
else:
body = {"config": {"dns": {"hosts": self.records, "cnameRecords": self.cnames}}}
elif path.startswith("/config/dns/hosts/"):
assert method == "PUT"
assert request.headers["X-FTL-SID"] == "TEST_SID"
assert request.headers.get("X-FTL-SID") == self.pihole_session["sid"]
entry = path.removeprefix("/config/dns/hosts/")
assert entry not in self.records
assert self.hosts[0]["meta"]["nginx_online"]
@@ -140,6 +146,35 @@ class HomegateTests(unittest.TestCase):
self.sync()
self.assertEqual([], self.transport.writes)
def test_passwordless_pihole_publishes_dns_without_auth_headers_or_logout(self):
self.transport.pihole_session = {"valid": True, "sid": None, "validity": -1,
"message": "no password set"}
self.transport.requests.clear()
self.dns.session.cookies.set("sid", "OLD_SESSION")
self.dns.login("")
self.sync()
self.assertIn("192.168.0.10 pve.home", self.transport.records)
self.assertIn("192.168.0.9 unrelated.home", self.transport.records)
self.transport.writes.clear()
self.sync()
self.dns.close()
self.assertEqual([], self.transport.writes)
for request in self.transport.requests:
if urlsplit(request.url).hostname == "pihole":
self.assertNotIn("X-FTL-SID", request.headers)
self.assertNotIn("X-FTL-CSRF", request.headers)
self.assertNotIn("Cookie", request.headers)
def test_invalid_pihole_session_does_not_enable_passwordless_access(self):
for session in ({"valid": False, "sid": None, "validity": -1},
{"valid": False, "sid": "invalid"}, {"valid": True},
{"valid": True, "sid": None, "validity": 300}):
with self.subTest(session=session), patch.object(self.dns, "call", return_value={"session": session}):
with self.assertRaisesRegex(h.Error, "Pi-hole authentication failed"):
self.dns.login("wrong-password")
self.assertNotIn("X-FTL-SID", self.dns.session.headers)
self.assertEqual([], self.transport.writes)
def test_renewal_uploads_and_reloads_existing_host(self):
self.sync()
old = self.transport.uploads[1]["certificate"]

199
tests/test_setup.py Normal file
View File

@@ -0,0 +1,199 @@
"""First-run UI, stored connections, live controller reload and process supervision."""
import copy
import json
import os
from pathlib import Path
import subprocess
import sys
import tempfile
import unittest
from unittest.mock import patch
import homegate as h
import homegate_ui as ui
import standalone
from test_ssh_and_zones import MemorySocket
class SetupTests(unittest.TestCase):
def setUp(self):
temp = tempfile.TemporaryDirectory()
self.addCleanup(temp.cleanup)
self.root = Path(temp.name)
self.config = self.root / 'config/services.yaml'
self.config.parent.mkdir()
self.connections = self.config.with_name('connections.json')
self.control = self.root / 'control'
self.panel = ui.Panel(self.config, self.control, '', auth_required=False, connections_file=self.connections)
self.cookie = ''
self.csrf = ''
self.settings = {'config': {'proxy_ip': '192.168.0.11', 'allowed_networks': ['192.168.0.0/24'],
'domain_zones': ['home', 'home.arpa'], 'dns_mode': 'pihole6', 'interval_seconds': 60,
'services': [], 'ssh_hosts': []}, 'connections': {'npm_url': 'http://192.168.0.11:81',
'npm_identity': 'admin@example.com', 'npm_password': 'test-npm-secret',
'pihole_url': 'http://192.168.0.2', 'pihole_password': 'test-pihole-secret'}, 'revision': ''}
def request(self, path='/api/state', body=None, peer='192.168.0.20', headers=None):
method = 'GET' if body is None else 'POST'
payload = b'' if body is None else json.dumps(body).encode()
heads = {'Host': '192.168.0.10:8098', 'Cookie': self.cookie}
if body is not None:
heads.update({'Origin': 'http://192.168.0.10:8098', 'Content-Type': 'application/json',
'Content-Length': str(len(payload)), 'X-Homegate-CSRF': self.csrf})
heads.update(headers or {})
raw = f'{method} {path} HTTP/1.1\r\n' + ''.join(f'{k}: {v}\r\n' for k, v in heads.items()) + '\r\n'
sock = MemorySocket(raw.encode() + payload)
ui.handler_for(self.panel)(sock, (peer, 5000), None)
head, data = sock.output.split(b'\r\n\r\n', 1)
response_headers = dict(line.decode().split(': ', 1) for line in head.split(b'\r\n')[1:])
if 'application/json' in response_headers.get('Content-Type', ''):
data = json.loads(data)
return int(head.split()[1]), data, response_headers
def connect(self):
code, body, headers = self.request('/api/session')
self.assertEqual(code, 200)
self.assertTrue(body['authenticated'])
self.cookie = headers['Set-Cookie'].split(';')[0]
self.csrf = body['csrf']
def install(self):
self.connect()
code, state, _ = self.request('/api/settings', self.settings)
self.assertEqual(code, 200, state)
self.assertFalse(state['setup_required'])
return state
def test_blank_volume_opens_setup_without_password_or_env(self):
self.connect()
code, state, _ = self.request()
self.assertEqual(code, 200)
self.assertTrue(state['setup_required'])
self.assertFalse(state['auth_required'])
self.assertEqual(state['config']['services'], [])
self.assertEqual(self.request('/healthz')[0], 200)
self.assertEqual(self.request('/settings.js')[0], 200)
self.assertFalse(self.config.exists())
def test_setup_persists_and_keeps_secrets_out_of_state_and_exports(self):
state = self.install()
stored = h.read_json(self.connections)
self.assertEqual(stored['npm_password'], 'test-npm-secret')
self.assertEqual(self.connections.stat().st_mode & 0o777, 0o600)
self.assertTrue(state['connections']['npm_password_set'])
self.assertNotIn('test-npm-secret', json.dumps(state))
self.assertNotIn(b'test-npm-secret', self.request('/downloads/services.yaml')[1])
self.assertTrue((self.control / 'sync-request.json').exists())
restarted = ui.Panel(self.config, self.control, '', auth_required=False, connections_file=self.connections)
self.assertFalse(restarted.status()['setup_required'])
self.assertEqual(restarted.status()['connections']['npm_url'], stored['npm_url'])
def test_save_again_preserves_blank_passwords_and_changes_api_url(self):
state = self.install()
settings = copy.deepcopy(self.settings)
settings['revision'] = state['revision']
settings['connections']['npm_url'] = 'http://192.168.0.12:81'
settings['connections']['npm_password'] = ''
code, _, _ = self.request('/api/settings', settings)
self.assertEqual(code, 200)
stored = h.read_json(self.connections)
self.assertEqual(stored['npm_password'], 'test-npm-secret')
self.assertEqual(stored['npm_url'], 'http://192.168.0.12:81')
def test_invalid_settings_and_stale_revision_do_not_change_credentials(self):
state = self.install()
before = self.connections.read_bytes()
for field, value in [('npm_url', 'http://192.168.0.12/api'), ('api_ca_pem', 'not a certificate')]:
settings = copy.deepcopy(self.settings)
settings['revision'] = state['revision']
settings['connections'][field] = value
self.assertEqual(self.request('/api/settings', settings)[0], 400)
self.assertEqual(self.connections.read_bytes(), before)
self.assertEqual(self.request('/api/settings', self.settings)[0], 409)
self.assertEqual(self.connections.read_bytes(), before)
def test_passwordless_pihole_can_be_enabled_and_password_restored(self):
state = self.install()
settings = copy.deepcopy(self.settings)
settings['revision'] = state['revision']
settings['connections']['pihole_password'] = ''
code, state, _ = self.request('/api/settings', settings)
self.assertEqual(code, 200)
self.assertTrue(state['connections']['pihole_password_set'])
settings['revision'] = state['revision']
settings['connections']['clear_pihole_password'] = True
code, state, _ = self.request('/api/settings', settings)
self.assertEqual(code, 200)
self.assertFalse(state['connections']['pihole_password_set'])
stored = h.read_json(self.connections)
self.assertEqual(stored['pihole_password'], '')
self.assertEqual(stored['npm_password'], 'test-npm-secret')
self.assertNotIn('clear_pihole_password', stored)
with patch.dict(os.environ, {'HOMEGATE_CONNECTIONS': str(self.connections)}, clear=True), patch.object(h, 'NPM'), patch.object(h, 'PiHole') as dns, patch.object(h, 'reconcile'):
h.cycle(settings['config'], self.root, None, {})
dns.return_value.login.assert_called_once_with('')
settings['revision'] = state['revision']
settings['connections'].update(clear_pihole_password=False, pihole_password='new-password')
code, state, _ = self.request('/api/settings', settings)
self.assertEqual(code, 200)
self.assertTrue(state['connections']['pihole_password_set'])
self.assertEqual(h.read_json(self.connections)['pihole_password'], 'new-password')
def test_first_setup_accepts_passwordless_pihole(self):
self.settings['connections'].update(pihole_password='', clear_pihole_password=True)
state = self.install()
self.assertFalse(state['connections']['pihole_password_set'])
self.assertEqual(h.read_json(self.connections)['pihole_password'], '')
def test_invalid_password_clear_flag_does_not_change_credentials(self):
state = self.install()
self.settings['revision'] = state['revision']
self.settings['connections']['clear_pihole_password'] = 'true'
before = self.connections.read_bytes()
self.assertEqual(self.request('/api/settings', self.settings)[0], 400)
self.assertEqual(self.connections.read_bytes(), before)
def test_acl_host_and_same_origin_work_without_fixed_origin(self):
self.connect()
self.assertEqual(self.request(peer='8.8.8.8')[0], 403)
for headers in ({'Host': 'attacker.example'}, {'Origin': 'http://attacker.example'}, {'X-Homegate-CSRF': ''}):
self.assertEqual(self.request('/api/settings', self.settings, headers=headers)[0], 403)
self.install()
self.assertEqual(self.request(peer='192.168.1.20')[0], 403)
self.assertEqual(self.request(headers={'Host': 'homegate.home'})[0], 200)
def test_controller_reloads_connections_on_each_cycle(self):
self.install()
with patch.dict(os.environ, {'HOMEGATE_CONNECTIONS': str(self.connections)}, clear=True), patch.object(h, 'NPM') as npm, patch.object(h, 'PiHole') as dns, patch.object(h, 'reconcile'):
h.cycle(self.settings['config'], self.root, None, {})
npm.assert_called_with('http://192.168.0.11:81', 'NPM', True)
npm.return_value.login.assert_called_with('admin@example.com', 'test-npm-secret')
dns.return_value.login.assert_called_with('test-pihole-secret')
settings = h.read_json(self.connections)
settings.update(npm_url='http://192.168.0.12:81', npm_password='changed')
h.save_json(self.connections, settings)
h.cycle(self.settings['config'], self.root, None, {})
npm.assert_called_with('http://192.168.0.12:81', 'NPM', True)
npm.return_value.login.assert_called_with('admin@example.com', 'changed')
class StandaloneTests(unittest.TestCase):
def test_no_user_environment_required(self):
env = standalone.runtime_environment({})
self.assertEqual(env['UI_AUTH_MODE'], 'none')
self.assertEqual(env['HOMEGATE_MANAGED_UI'], '1')
self.assertNotIn('HOMEGATE_LAN_IP', env)
self.assertNotIn('NPM_PASSWORD', env)
def test_child_failure_stops_remaining_processes(self):
processes = []
popen = subprocess.Popen
def start(*args, **kwargs):
process = popen(*args, **kwargs)
processes.append(process)
return process
with patch.object(standalone.subprocess, 'Popen', side_effect=start):
result = standalone.supervise([[sys.executable, '-c', 'raise SystemExit(3)'],
[sys.executable, '-c', 'import time; time.sleep(60)']], {})
self.assertEqual(result, 1)
self.assertTrue(all(process.poll() is not None for process in processes))

29
ui/dist/app.js vendored
View File

@@ -31,13 +31,14 @@ const services = () => data.config.services || [];
const sshEntries = () => [...services().filter(r=>r.enabled!==false&&r.ssh&&r.ssh.enabled!==false).map(r=>({aliases:[...(r.ssh.alias?[r.ssh.alias]:[]),r.hostname].filter((x,i,a)=>a.indexOf(x)===i),host:r.ssh.host||new URL(r.upstream).hostname,port:r.ssh.port||22,user:r.ssh.user})),...(data.config.ssh_hosts||[]).filter(r=>r.enabled!==false)];
const controller = () => data.controller || {};
const isApplied = () => controller().fresh && controller().ok && controller().applied_revision===data.revision;
const sshUrl = () => data.ssh_url || `http://${data.config.proxy_ip}:8099/ssh-config`;
const sshUrl = () => data.ssh_url || `http://${location.hostname}:8099/ssh-config`;
async function api(path, body) {
async function api(path, body, retry=true) {
const options = {credentials:'same-origin',headers:{}};
if(body!==undefined){options.method='POST';options.headers={'Content-Type':'application/json','X-Homegate-CSRF':csrf};options.body=JSON.stringify(body);}
const r=await fetch(path,options);
const value=(r.headers.get('content-type')||'').includes('application/json')?await r.json():await r.text();
if(r.status===401 && retry && path!=='/api/session' && data?.auth_required===false){const session=await api('/api/session');csrf=session.csrf;return api(path,body,false);}
if(!r.ok) {if(r.status===401&&path!=='/api/login')showLogin();throw new Error(value.error||`Ошибка ${r.status}`);}
return value;
}
@@ -50,7 +51,7 @@ function nav(){
$('#navigation').innerHTML=pages.map(([id,label,i])=>`<a class="nav-item ${tab===id?'active':''}" href="#${id}" ${tab===id?'aria-current="page"':''}>${icon(i,18)}<span>${label}</span>${id==='services'?`<span class="nav-count">${services().length}</span>`:''}</a>`).join('');
$('#crumb').textContent=pages.find(p=>p[0]===tab)[1];
}
function statusStrip(){const c=controller();if(!c.fresh)return `<div class="status-strip">${icon('info',15)}<span><strong>Контроллер пока не подключён.</strong> Настройки сохраняются здесь. Для применения запустите Homegate в Docker.</span><button class="btn link" data-action="guide">Подключить ${icon('arrow',12)}</button></div>`;
function statusStrip(){const c=controller();if(!c.fresh&&data.connections)return `<div class="status-strip">${icon('clock',15)}<span>Контроллер запускается. Состояние подключений появится здесь автоматически.</span></div>`;if(!c.fresh)return `<div class="status-strip">${icon('info',15)}<span><strong>Контроллер пока не подключён.</strong> Настройки сохраняются здесь. Для применения запустите Homegate в Docker.</span><button class="btn link" data-action="guide">Подключить ${icon('arrow',12)}</button></div>`;
if(!c.ok)return `<div class="status-strip bad">${icon('info',15)}<span><strong>Не удалось применить настройки.</strong> ${esc(c.error||'Проверьте подключение к Pi-hole и NPM.')}</span><button class="btn link" data-action="sync">Повторить</button></div>`;
if(!isApplied())return `<div class="status-strip">${icon('clock',15)}<span><strong>Есть новые настройки.</strong> Контроллер применит их в следующем цикле.</span><button class="btn link" data-action="sync">Применить сейчас</button></div>`;
return `<div class="status-strip good">${icon('check',15)}<span>Конфигурация применена <strong>в ${time(c.time)}</strong>. Доступность самих VM проверяется отдельно.</span><button class="btn link" data-action="sync">Обновить ${icon('refresh',12)}</button></div>`;
@@ -65,31 +66,31 @@ function renderServices(){const c=controller();const first=services().find(r=>r.
<section class="stats" aria-label="Сводка"><div class="stat"><div class="stat-top">Сервисы ${icon('grid')}</div><div class="stat-value">${services().length}<span class="mini-pill">${services().filter(r=>r.enabled!==false).length} включено</span></div><div class="stat-note">в вашей конфигурации</div></div><div class="stat"><div class="stat-top">Доменные зоны ${icon('globe')}</div><div class="stat-value">${zones().length}</div><div class="stat-note">${esc(zones().slice(0,3).map(x=>'.'+x).join(' · '))}</div></div><div class="stat"><div class="stat-top">SSH-подключения ${icon('terminal')}</div><div class="stat-value">${ssh.length}</div><div class="stat-note">один конфиг для всех машин</div></div><div class="stat"><div class="stat-top">Локальный HTTPS ${icon('shield')}</div><div class="stat-value text-value">${c.root?'CA настроен':'Ожидает CA'}</div><div class="stat-note">${c.root?'доверие на ваших устройствах':'создаётся при запуске контроллера'}</div></div></section>
<div class="section-heading"><h2>Каталог сервисов <span class="count-label">${services().length}</span></h2><span class="section-kicker">Прокси <span class="mono">${esc(data.config.proxy_ip)}</span></span></div>
<section class="panel"><div class="toolbar"><label class="search-box">${icon('search',16)}<input id="service-search" placeholder="Найти сервис, домен или IP…" value="${esc(search)}" aria-label="Поиск сервисов"></label><div class="filters" aria-label="Фильтр сервисов">${[['all','Все сервисы'],['enabled','Включены'],['disabled','Выключены']].map(([v,l])=>`<button class="filter ${filter===v?'active':''}" data-action="filter" data-filter="${v}">${l}</button>`).join('')}</div></div><div class="table-scroll"><table><thead><tr><th>Сервис</th><th>Локальный адрес</th><th>Куда направлять</th><th>Состояние</th><th></th></tr></thead><tbody id="service-rows">${serviceRows()}</tbody></table></div><button class="add-row" data-action="add-service">${icon('plus',14)} Подключить ещё один сервис</button><div class="table-end"><span>Изменения сохраняются в services.yaml</span><span>Обновление каждые ${data.config.interval_seconds||60} сек.</span></div></section>
<div class="below-grid"><section class="panel panel-pad"><div class="panel-heading">Как проходит соединение <span class="badge muted">Локальная сеть</span></div><p class="panel-description">${first?`Маршрут для ${esc(first.hostname)}`:'Добавьте сервис, чтобы настроить первый маршрут'}</p><div class="flow"><div class="flow-node"><span class="node-symbol">${icon('monitor',19)}</span><strong>Браузер</strong><small>ваше устройство</small></div><span class="flow-line"></span><div class="flow-node"><span class="node-symbol">${icon('globe',19)}</span><strong>Pi-hole</strong><small>имя → IP</small></div><span class="flow-line"></span><div class="flow-node"><span class="node-symbol">${icon('route',19)}</span><strong>NPM</strong><small>HTTPS · 443</small></div><span class="flow-line"></span><div class="flow-node"><span class="node-symbol">${icon('server',19)}</span><strong>${first?esc(serviceName(first)):'Ваша VM'}</strong><small>${first?esc(new URL(first.upstream).hostname):'IP:порт'}</small></div></div><div class="flow-foot">${icon('shield',12)} Корневой сертификат устанавливается на каждое устройство</div></section><section class="panel panel-pad ssh-card"><div class="panel-heading">Серверы на расстоянии команды ${icon('terminal',20)}</div><p class="panel-description">Подключите общий SSH-конфиг на компьютере.<br>IP и порты больше не нужно держать в памяти.</p><div class="command-small"><span><span class="dollar">$</span>ssh ${esc(ssh[0]?.aliases[0]||'имя-сервера')}</span><button class="icon-button" data-action="copy-ssh-command" aria-label="Скопировать SSH-команду">${icon('copy',13)}</button></div><button class="btn" data-action="go-ssh">Настроить SSH-доступ ${icon('arrow',13)}</button></section></div>`;}
function renderDomains(){const root=controller().root;return heading('Доменные зоны','Свои имена для разных частей вашей домашней сети.',`<button class="btn primary" data-action="add-zone">${icon('plus',15)} Добавить зону</button>`)+`<div class="zones-grid">${zones().map((z,i)=>{const count=services().filter(r=>r.hostname===z||r.hostname.endsWith('.'+z)).length;const covered=root&&root.zones.some(p=>z===p||z.endsWith('.'+p));return `<article class="panel zone-card"><div class="zone-top"><span class="zone-symbol">${icon('globe',21)}</span><button class="icon-button danger" data-action="remove-zone" data-index="${i}" aria-label="Удалить зону ${esc(z)}">${icon('trash',14)}</button></div><div class="zone-name">.${esc(z)}</div><p class="zone-caption">${count} ${count===1?'сервис':'сервисов'} в этой зоне</p><div class="zone-foot">${root?(covered?badge('Разрешена CA','success'):badge('Нужна смена CA')):badge('CA ещё не создан','muted')}<span class="mono">DNS / TLS</span></div></article>`;}).join('')}</div><div class="info-box">${icon('info',19)}<p><strong>Домены работают внутри вашей сети.</strong><br>Pi-hole направляет имена на NPM. Для домашних сетей подходит <span class="mono">home.arpa</span>; можно использовать и собственные зоны.</p></div>${root?`<div class="info-box warning">${icon('shield',19)}<p><strong>Новая зона может потребовать нового корневого сертификата.</strong><br>Если зона вне ограничений текущего CA, выполните миграцию и установите новый корень на устройства. <button class="btn link" data-action="ca-guide">Инструкция ${icon('arrow',12)}</button></p></div>`:''}`;}
<div class="below-grid"><section class="panel panel-pad"><div class="panel-heading">Как проходит соединение <span class="badge muted">Локальная сеть</span></div><p class="panel-description">${first?`Маршрут для ${esc(first.hostname)}`:'Добавьте сервис, чтобы настроить первый маршрут'}</p><div class="flow"><div class="flow-node"><span class="node-symbol">${icon('monitor',19)}</span><strong>Браузер</strong><small>ваше устройство</small></div><span class="flow-line"></span><div class="flow-node"><span class="node-symbol">${icon('globe',19)}</span><strong>Pi-hole</strong><small>имя → IP</small></div><span class="flow-line"></span><div class="flow-node"><span class="node-symbol">${icon('route',19)}</span><strong>NPM</strong><small>HTTPS · 443</small></div><span class="flow-line"></span><div class="flow-node"><span class="node-symbol">${icon('server',19)}</span><strong>${first?esc(serviceName(first)):'Ваша VM'}</strong><small>${first?esc(new URL(first.upstream).hostname):'IP:порт'}</small></div></div><div class="flow-foot">${icon('shield',12)} Источник HTTPS-сертификата выбирается в настройках сервиса</div></section><section class="panel panel-pad ssh-card"><div class="panel-heading">Серверы на расстоянии команды ${icon('terminal',20)}</div><p class="panel-description">Подключите общий SSH-конфиг на компьютере.<br>IP и порты больше не нужно держать в памяти.</p><div class="command-small"><span><span class="dollar">$</span>ssh ${esc(ssh[0]?.aliases[0]||'имя-сервера')}</span><button class="icon-button" data-action="copy-ssh-command" aria-label="Скопировать SSH-команду">${icon('copy',13)}</button></div><button class="btn" data-action="go-ssh">Настроить SSH-доступ ${icon('arrow',13)}</button></section></div>`;}
function renderDomains(){const root=controller().root;return heading('Доменные зоны','Свои имена для разных частей вашей домашней сети.',`<button class="btn primary" data-action="add-zone">${icon('plus',15)} Добавить зону</button>`)+`<div class="zones-grid">${zones().map((z,i)=>{const count=services().filter(r=>r.hostname===z||r.hostname.endsWith('.'+z)).length;const covered=root&&root.zones.some(p=>z===p||z.endsWith('.'+p));return `<article class="panel zone-card"><div class="zone-top"><span class="zone-symbol">${icon('globe',21)}</span><button class="icon-button danger" data-action="remove-zone" data-index="${i}" aria-label="Удалить зону ${esc(z)}">${icon('trash',14)}</button></div><div class="zone-name">.${esc(z)}</div><p class="zone-caption">${count} ${count===1?'сервис':'сервисов'} в этой зоне</p><div class="zone-foot">${root?(covered?badge('Разрешена CA','success'):badge('Вне локального CA')):badge('CA ещё не создан','muted')}<span class="mono">DNS / TLS</span></div></article>`;}).join('')}</div><div class="info-box">${icon('info',19)}<p><strong>Домены работают внутри вашей сети.</strong><br>Pi-hole направляет имена на NPM. Для домашних сетей подходит <span class="mono">home.arpa</span>; можно использовать и собственные зоны.</p></div>${root?`<div class="info-box warning">${icon('shield',19)}<p><strong>Новая зона может потребовать нового корневого сертификата.</strong><br>Смена CA нужна только в режиме Homegate для зоны вне ограничений текущего корня. Для публичного сертификата NPM, DNS challenge или копии с VDS менять CA не требуется. <button class="btn link" data-action="ca-guide">Инструкция ${icon('arrow',12)}</button></p></div>`:''}`;}
function renderSSH(){const entries=sshEntries();return heading('SSH-доступ','Один дополнительный конфиг для всех ваших компьютеров.',`<a class="btn" href="/downloads/sync_ssh.py">${icon('download',14)} Скрипт для ПК</a><a class="btn primary" href="/downloads/ssh-config">${icon('download',14)} Скачать конфиг</a>`)+`<div class="two-col"><section class="code-panel"><div class="code-top"><span>~/.ssh/config.d/homegate.conf</span><button class="icon-button" data-action="copy-ssh-config" aria-label="Скопировать SSH-конфиг">${icon('copy',15)}</button></div><pre id="ssh-preview">Загружаем конфиг…</pre></section><section class="panel panel-pad"><div class="panel-heading">Подключите за пару минут</div><div class="step"><span class="step-number">1</span><div><strong>Скачайте скрипт на компьютер</strong><p>Python 3.9+ и OpenSSH. Приватные ключи остаются у вас.</p><a class="btn small" href="/downloads/sync_ssh.py">${icon('download',12)} sync_ssh.py</a></div></div><div class="step"><span class="step-number">2</span><div><strong>Подключите дополнительный файл</strong><p>Основной SSH-конфиг сохраняется. Для Windows используйте <span class="mono">py -3</span>.</p><div class="command-line"><code>python3 sync_ssh.py ${esc(sshUrl())} --install</code><button class="icon-button" data-action="copy-install" aria-label="Скопировать команду установки">${icon('copy',13)}</button></div></div></div><div class="step"><span class="step-number">3</span><div><strong>Подключайтесь по имени</strong><p>При следующих обновлениях запустите скрипт без <span class="mono">--install</span>.</p><div class="command-line"><code>ssh ${esc(entries[0]?.aliases[0]||'имя-сервера')}</code><button class="icon-button" data-action="copy-ssh-command" aria-label="Скопировать SSH-команду">${icon('copy',13)}</button></div></div></div></section></div><div class="info-box">${icon('lock',18)}<p><strong>Открытая выгрузка только для вашей LAN.</strong><br><span class="mono">${esc(sshUrl())}</span><br>${data.mode==='local'?'Этот адрес заработает после запуска ssh-export в Docker. Сейчас конфиг можно скачать кнопкой выше.':'Доступ ограничен разрешёнными подсетями. Пароль панели для этой выгрузки не нужен.'}</p></div><div class="section-heading"><h2>Серверы без веб-интерфейса <span class="count-label">${(data.config.ssh_hosts||[]).length}</span></h2><button class="btn small" data-action="add-ssh">${icon('plus',13)} Добавить SSH-хост</button></div><section class="panel"><div class="table-scroll"><table><thead><tr><th>Псевдонимы</th><th>Адрес</th><th>Пользователь</th><th></th></tr></thead><tbody>${(data.config.ssh_hosts||[]).map((r,i)=>`<tr><td><strong>${esc(r.aliases.join(', '))}</strong> ${r.enabled===false?badge('Выключен','muted'):''}</td><td class="mono">${esc(r.host)}:${r.port||22}</td><td>${esc(r.user||'Из личного конфига')}</td><td><div class="row-actions"><button class="icon-button" data-action="edit-ssh" data-index="${i}" aria-label="Изменить SSH-хост">${icon('edit',14)}</button><button class="icon-button danger" data-action="remove-ssh" data-index="${i}" aria-label="Удалить SSH-хост">${icon('trash',14)}</button></div></td></tr>`).join('')||`<tr><td colspan="4"><div class="empty">${icon('server',25)}<p>Здесь можно добавить NAS, backup-сервер или любую машину с SSH.<br>SSH веб-сервисов настраивается в карточке сервиса.</p></div></td></tr>`}</tbody></table></div></section>`;}
function renderCertificates(){const root=controller().root;const certs=controller().certificates||[];return heading('Сертификаты','Доверенный HTTPS для локальных адресов.',`<button class="btn" data-action="ca-guide">${icon('refresh',14)} Смена CA</button>${root?`<a class="btn primary" href="/downloads/root-ca.crt">${icon('download',14)} Скачать корневой CA</a>`:''}`)+`<div class="two-col"><section class="panel certificate-card"><div class="certificate-art">${icon('shield',29)}</div><h2>Homegate Local Root CA</h2><p class="panel-description">Ваш центр сертификации внутри домашней сети.</p><div class="key-details"><div class="detail-line"><span>Состояние</span>${root?badge('Создан','success'):badge('Ожидает запуска','muted')}</div><div class="detail-line"><span>Действует до</span><strong>${date(root?.expires)}</strong></div><div class="detail-line"><span>Зоны в сертификате</span><strong>${esc(root?.zones.join(', ')||'Определятся при первом запуске')}</strong></div><div class="detail-line"><span>Срок сертификата сервиса</span><strong>90 дней</strong></div><div class="detail-line"><span>Продление</span><strong>Когда осталось менее 30 дней</strong></div></div>${root?`<span class="note">Отпечаток SHA-256</span><div class="fingerprint">${esc(root.fingerprint)}</div>`:`<div class="info-box">${icon('info',17)}<p>Корень создаётся контроллером. Сейчас панель не видит его данные.</p></div>`}</section><div class="stack"><section class="panel panel-pad"><div class="panel-heading">Установите доверие на устройства</div><p class="panel-description">Сертификат на сервере не добавляет доверие на компьютере или телефоне.</p><div class="step"><span class="step-number">1</span><div><strong>Скачайте только root-ca.crt</strong><p>Сверьте отпечаток с сервером. Приватный ключ CA никогда не публикуется в панели.</p></div></div><div class="step"><span class="step-number">2</span><div><strong>Импортируйте как доверенный корневой CA</strong><p>Windows — доверенные корневые центры.<br>macOS — Связка ключей → System → Always Trust.<br>iOS — включите Full Trust после установки.</p></div></div><div class="step"><span class="step-number">3</span><div><strong>Откройте сервис по доменному имени</strong><p>Например, https://${esc(services()[0]?.hostname||'service.home')}. Проверка сертификата по IP — другой запрос.</p></div></div></section><div class="info-box warning">${icon('shield',17)}<p>Проверка TLS между NPM и самой VM настраивается отдельно для каждого сервиса.</p></div></div></div><div class="section-heading"><h2>Сертификаты сервисов</h2><span class="section-kicker">Данные контроллера</span></div><section class="panel"><table><thead><tr><th>Домен</th><th>Действует до</th></tr></thead><tbody>${certs.map(c=>`<tr><td class="domain-link">${icon('lock',12)} ${esc(c.hostname)}</td><td>${date(c.expires)}</td></tr>`).join('')||'<tr><td colspan="2"><div class="empty"><p>После первого применения здесь появятся выданные сертификаты.</p></div></td></tr>'}</tbody></table></section>`;}
function renderSettings(){const c=data.config;return heading('Настройки сети','Адрес прокси, разрешённые подсети и частота обновления.')+`<div class="settings-grid"><form id="settings-form" class="panel"><section class="form-section"><h2>Ваша локальная сеть</h2><p>Доменные имена сервисов будут указывать на адрес NPM.</p><div class="form-grid"><label class="field">IP Nginx Proxy Manager<input name="proxy_ip" value="${esc(c.proxy_ip)}" required><small>Например, 192.168.0.10</small></label><label class="field">Обновление, секунд<input name="interval_seconds" type="number" min="30" max="3600" value="${c.interval_seconds||60}" required></label><label class="field full">Разрешённые подсети<textarea name="allowed_networks" rows="3" required>${esc(c.allowed_networks.join('\n'))}</textarea><small>По одной подсети в строке. Например, 192.168.0.0/24. Влияет на веб-сервисы и доступ к панели/SSH-выгрузке.</small></label></div></section><section class="form-section"><h2>Локальный DNS</h2><p>Выберите, кто создаёт записи для сервисов.</p><label class="field">Управление записями<select name="dns_mode"><option value="pihole6" ${c.dns_mode!=='manual'?'selected':''}>Автоматически — Pi-hole 6</option><option value="manual" ${c.dns_mode==='manual'?'selected':''}>Вручную — Pi-hole 5 или другой DNS</option></select></label><div id="settings-error" class="form-error" hidden></div></section><div class="form-footer"><button class="btn primary" type="submit">${icon('check',14)} Сохранить настройки</button></div></form><div class="stack"><section class="panel panel-pad"><div class="panel-heading">Подключения</div><p class="panel-description">Пароли остаются в Docker secrets на сервере.</p><div class="integration"><span class="integration-icon">${icon('globe',19)}</span><div><strong>Pi-hole</strong><small>${c.dns_mode==='manual'?'Ручное управление DNS':'DNS-записи через API'}</small></div>${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}</div><div class="integration"><span class="integration-icon">${icon('route',19)}</span><div><strong>Nginx Proxy Manager</strong><small>Прокси и HTTPS</small></div>${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}</div><p class="note">Адреса API и учётные данные задаются в .env и secrets/ при установке.</p><button class="btn small" data-action="guide" type="button">Как подключить ${icon('arrow',12)}</button></section><section class="panel panel-pad"><div class="panel-heading">Последние изменения</div>${data.history.length?data.history.map(item=>`<div class="history-item">${icon('check',13)}<p>${esc(item.text)}</p><time>${time(item.time)}</time></div>`).join(''):'<p class="panel-description">Здесь появятся сохранения из панели.</p>'}</section><a class="btn" href="/downloads/services.yaml">${icon('download',14)} Скачать текущий YAML</a></div></div>`;}
function renderCertificates(){const root=controller().root;const certs=controller().certificates||[];return heading('Сертификаты','Локальный CA, сертификаты NPM и обновляемые копии с VDS.',`<button class="btn primary" data-action="issue-certificate">${icon('shield',14)} Выпустить Let’s Encrypt</button><button class="btn" data-action="ca-guide">${icon('refresh',14)} Смена CA</button>${root?`<a class="btn primary" href="/downloads/root-ca.crt">${icon('download',14)} Скачать корневой CA</a>`:''}`)+`<div class="two-col"><section class="panel certificate-card"><div class="certificate-art">${icon('shield',29)}</div><h2>Homegate Local Root CA</h2><p class="panel-description">Ваш центр сертификации внутри домашней сети.</p><div class="key-details"><div class="detail-line"><span>Состояние</span>${root?badge('Создан','success'):badge('Ожидает запуска','muted')}</div><div class="detail-line"><span>Действует до</span><strong>${date(root?.expires)}</strong></div><div class="detail-line"><span>Зоны в сертификате</span><strong>${esc(root?.zones.join(', ')||'Определятся при первом запуске')}</strong></div><div class="detail-line"><span>Срок сертификата сервиса</span><strong>90 дней</strong></div><div class="detail-line"><span>Продление</span><strong>Когда осталось менее 30 дней</strong></div></div>${root?`<span class="note">Отпечаток SHA-256</span><div class="fingerprint">${esc(root.fingerprint)}</div>`:`<div class="info-box">${icon('info',17)}<p>Корень создаётся контроллером. Сейчас панель не видит его данные.</p></div>`}</section><div class="stack"><section class="panel panel-pad"><div class="panel-heading">Установите доверие на устройства</div><p class="panel-description">Для режима Homegate установите корневой CA. Публичный сертификат из NPM или его копия с VDS не требуют установки CA на устройства.</p><div class="step"><span class="step-number">1</span><div><strong>Скачайте только root-ca.crt</strong><p>Сверьте отпечаток с сервером. Приватный ключ CA никогда не публикуется в панели.</p></div></div><div class="step"><span class="step-number">2</span><div><strong>Импортируйте как доверенный корневой CA</strong><p>Windows — доверенные корневые центры.<br>macOS — Связка ключей → System → Always Trust.<br>iOS — включите Full Trust после установки.</p></div></div><div class="step"><span class="step-number">3</span><div><strong>Откройте сервис по доменному имени</strong><p>Например, https://${esc(services()[0]?.hostname||'service.home')}. Проверка сертификата по IP — другой запрос.</p></div></div></section><div class="info-box warning">${icon('shield',17)}<p>Проверка TLS между NPM и самой VM настраивается отдельно для каждого сервиса.</p></div></div></div><div class="section-heading"><h2>Сертификаты сервисов</h2><span class="section-kicker">Данные контроллера</span></div><section class="panel"><table><thead><tr><th>Домен</th><th>Действует до</th><th>Продление</th></tr></thead><tbody>${certs.map(c=>`<tr><td class="domain-link">${icon('lock',12)} ${esc(c.hostname)}</td><td>${date(c.expires)}</td><td>${certificateRenewal(c)}</td></tr>`).join('')||'<tr><td colspan="3"><div class="empty"><p>После первого применения здесь появятся сертификаты.</p></div></td></tr>'}</tbody></table></section>`;}
function renderSettings(){if(data.connections)return renderManagedSettings();const c=data.config;return heading('Настройки сети','Адрес прокси, разрешённые подсети и частота обновления.')+`<div class="settings-grid"><form id="settings-form" class="panel"><section class="form-section"><h2>Ваша локальная сеть</h2><p>Доменные имена сервисов будут указывать на адрес NPM.</p><div class="form-grid"><label class="field">IP Nginx Proxy Manager<input name="proxy_ip" value="${esc(c.proxy_ip)}" required><small>Например, 192.168.0.10</small></label><label class="field">Обновление, секунд<input name="interval_seconds" type="number" min="30" max="3600" value="${c.interval_seconds||60}" required></label><label class="field full">Разрешённые подсети<textarea name="allowed_networks" rows="3" required>${esc(c.allowed_networks.join('\n'))}</textarea><small>По одной подсети в строке. Например, 192.168.0.0/24. Влияет на веб-сервисы и доступ к панели/SSH-выгрузке.</small></label></div></section><section class="form-section"><h2>Локальный DNS</h2><p>Выберите, кто создаёт записи для сервисов.</p><label class="field">Управление записями<select name="dns_mode"><option value="pihole6" ${c.dns_mode!=='manual'?'selected':''}>Автоматически — Pi-hole 6</option><option value="manual" ${c.dns_mode==='manual'?'selected':''}>Вручную — Pi-hole 5 или другой DNS</option></select></label><div id="settings-error" class="form-error" hidden></div></section><div class="form-footer"><button class="btn primary" type="submit">${icon('check',14)} Сохранить настройки</button></div></form><div class="stack"><section class="panel panel-pad"><div class="panel-heading">Подключения</div><p class="panel-description">Пароли остаются в Docker secrets на сервере.</p><div class="integration"><span class="integration-icon">${icon('globe',19)}</span><div><strong>Pi-hole</strong><small>${c.dns_mode==='manual'?'Ручное управление DNS':'DNS-записи через API'}</small></div>${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}</div><div class="integration"><span class="integration-icon">${icon('route',19)}</span><div><strong>Nginx Proxy Manager</strong><small>Прокси и HTTPS</small></div>${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}</div><p class="note">Адреса API и учётные данные задаются в .env и secrets/ при установке.</p><button class="btn small" data-action="guide" type="button">Как подключить ${icon('arrow',12)}</button></section><section class="panel panel-pad"><div class="panel-heading">Последние изменения</div>${data.history.length?data.history.map(item=>`<div class="history-item">${icon('check',13)}<p>${esc(item.text)}</p><time>${time(item.time)}</time></div>`).join(''):'<p class="panel-description">Здесь появятся сохранения из панели.</p>'}</section><a class="btn" href="/downloads/services.yaml">${icon('download',14)} Скачать текущий YAML</a></div></div>`;}
function render(){if(!data)return;tab=pages.some(p=>p[0]===location.hash.slice(1))?location.hash.slice(1):'services';nav();$('#content').innerHTML=({services:renderServices,domains:renderDomains,ssh:renderSSH,certificates:renderCertificates,settings:renderSettings})[tab]();$('#yaml-download').innerHTML=icon('download',16);$('#logout').hidden=data.mode==='local';$('#service-search')?.addEventListener('input',e=>{search=e.target.value;$('#service-rows').innerHTML=serviceRows();});if(tab==='ssh')api('/api/ssh-config').then(text=>{if($('#ssh-preview'))$('#ssh-preview').textContent=text;}).catch(e=>toast(e.message,true));if(tab==='settings'){const form=$('#settings-form');form.addEventListener('input',()=>settingsDirty=true);form.addEventListener('submit',saveSettings);}}
function render(){if(!data)return;tab=pages.some(p=>p[0]===location.hash.slice(1))?location.hash.slice(1):'services';if(data.setup_required)tab='settings';nav();$('#content').innerHTML=({services:renderServices,domains:renderDomains,ssh:renderSSH,certificates:renderCertificates,settings:renderSettings})[tab]();$('#yaml-download').innerHTML=icon('download',16);$('#logout').hidden=data.auth_required===false;$('#yaml-download').hidden=data.setup_required;$('#service-search')?.addEventListener('input',e=>{search=e.target.value;$('#service-rows').innerHTML=serviceRows();});if(tab==='ssh')api('/api/ssh-config').then(text=>{if($('#ssh-preview'))$('#ssh-preview').textContent=text;}).catch(e=>toast(e.message,true));if(tab==='settings'){const form=$('#settings-form');form.addEventListener('input',()=>settingsDirty=true);form.addEventListener('submit',data.connections?saveManagedSettings:saveSettings);if(data.connections)bindManagedSettings(form);}}
async function refresh(){data=await api('/api/state');render();}
async function saveConfig(config){if(busy)throw new Error('Подождите завершения сохранения');busy=true;try{data=await api('/api/config',{config,revision:data.revision});settingsDirty=false;render();toast(controller().fresh?'Настройки сохранены. Контроллер применит их в следующем цикле.':'Настройки сохранены локально. Для применения подключите контроллер.');}finally{busy=false;}}
function showModal(title,subtitle,body,footer){$('#modal-content').innerHTML=`<div class="modal-header"><div><h2 id="modal-title">${title}</h2><p>${subtitle}</p></div><button class="icon-button" data-action="close-modal" aria-label="Закрыть">${icon('close',18)}</button></div>${body}${footer||''}`;$('#modal').showModal();}
const modalFooter=(label='Сохранить')=>`<div class="form-footer"><button type="button" class="btn" data-action="close-modal">Отмена</button><button type="submit" form="modal-form" class="btn primary">${icon('check',14)} ${label}</button></div>`;
function serviceModal(index=-1){const r=index<0?{}:services()[index];showModal(index<0?'Новый сервис':'Настройки сервиса','Домен, адрес VM и параметры подключения.',`<form id="modal-form"><div class="modal-body"><div class="form-grid"><label class="field full">Название<input name="display_name" value="${esc(r.display_name||'')}" maxlength="100" placeholder="Например, Proxmox" autocomplete="off"><small>Название в каталоге. Если не указано, определяется по домену.</small></label><label class="field full">Локальный домен<input name="hostname" value="${esc(r.hostname||'')}" placeholder="service.${esc(zones()[0])}" required autocomplete="off"><small>Доступные зоны: ${esc(zones().join(', '))}</small></label><label class="field full">Адрес сервиса на VM<input name="upstream" type="url" value="${esc(r.upstream||'')}" placeholder="https://192.168.0.137:8006" required><small>HTTP или HTTPS, приватный IP и порт. Без пути.</small></label><label class="check-line"><input name="websocket" type="checkbox" ${r.websocket!==false?'checked':''}> WebSocket / веб-консоль</label><label class="check-line"><input name="upstream_tls_verify" type="checkbox" ${r.upstream_tls_verify!==false?'checked':''}> Проверять TLS самой VM</label></div><h3 class="modal-subtitle">SSH-доступ к этой машине</h3><label class="check-line"><input name="ssh_enabled" type="checkbox" ${r.ssh&&r.ssh.enabled!==false?'checked':''}> Добавить в общий SSH-конфиг</label><div class="form-grid ssh-fields"><label class="field">Псевдоним<input name="ssh_alias" value="${esc(r.ssh?.alias||'')}" placeholder="pve"></label><label class="field">Пользователь<input name="ssh_user" value="${esc(r.ssh?.user||'')}" placeholder="root"></label><label class="field">SSH-порт<input name="ssh_port" type="number" min="1" max="65535" value="${r.ssh?.port||22}"></label><label class="field">Другой IP для SSH<input name="ssh_host" value="${esc(r.ssh?.host||'')}" placeholder="IP из адреса сервиса"></label></div><details class="advanced"><summary>Дополнительные параметры</summary><div class="form-grid"><label class="field">Тайм-аут, секунд<input name="timeout_seconds" type="number" min="1" max="86400" value="${r.timeout_seconds||3600}"></label><label class="field">Загрузка файла, МБ<input name="max_body_mb" type="number" min="1" max="102400" value="${r.max_body_mb||1024}"></label><label class="field full">Имя в TLS-сертификате VM<input name="upstream_tls_name" value="${esc(r.upstream_tls_name||'')}" placeholder="pve.internal.example"></label><label class="field full">CA самой VM внутри NPM<input name="upstream_ca_file" value="${esc(r.upstream_ca_file||'')}" placeholder="/data/custom-trust/pve-root-ca.pem"></label></div></details><div class="form-error" id="modal-error" hidden></div></div></form>`,modalFooter(index<0?'Добавить сервис':'Сохранить'));
const form=$('#modal-form');const check=$('[name=ssh_enabled]',form);const fields=$('.ssh-fields',form);fields.hidden=!check.checked;check.addEventListener('change',()=>fields.hidden=!check.checked);
form.addEventListener('submit',async e=>{e.preventDefault();const f=new FormData(form);const item={...clone(r),hostname:f.get('hostname').trim().toLowerCase(),upstream:f.get('upstream').trim(),websocket:f.has('websocket'),upstream_tls_verify:f.has('upstream_tls_verify'),timeout_seconds:Number(f.get('timeout_seconds')),max_body_mb:Number(f.get('max_body_mb'))};if(f.get('display_name').trim())item.display_name=f.get('display_name').trim();else delete item.display_name;for(const k of ['upstream_tls_name','upstream_ca_file']){if(f.get(k).trim())item[k]=f.get(k).trim();else delete item[k];}if(f.has('ssh_enabled')){item.ssh={port:Number(f.get('ssh_port'))};for(const [a,b] of [['alias','ssh_alias'],['user','ssh_user'],['host','ssh_host']])if(f.get(b).trim())item.ssh[a]=f.get(b).trim();}else delete item.ssh;const c=clone(data.config);if(index<0)c.services.push(item);else c.services[index]=item;await modalSave(c);});
function serviceModal(index=-1){const r=index<0?{}:services()[index];showModal(index<0?'Новый сервис':'Настройки сервиса','Домен, адрес VM и параметры подключения.',`<form id="modal-form"><div class="modal-body"><div class="form-grid"><label class="field full">Название<input name="display_name" value="${esc(r.display_name||'')}" maxlength="100" placeholder="Например, Proxmox" autocomplete="off"><small>Название в каталоге. Если не указано, определяется по домену.</small></label><label class="field full">Локальный домен<input name="hostname" value="${esc(r.hostname||'')}" placeholder="service.${esc(zones()[0])}" required autocomplete="off"><small>Доступные зоны: ${esc(zones().join(', '))}</small></label><label class="field full">Адрес сервиса на VM<input name="upstream" type="url" value="${esc(r.upstream||'')}" placeholder="https://192.168.0.137:8006" required><small>HTTP или HTTPS, приватный IP и порт. Без пути.</small></label><label class="check-line"><input name="websocket" type="checkbox" ${r.websocket!==false?'checked':''}> WebSocket / веб-консоль</label><label class="check-line"><input name="upstream_tls_verify" type="checkbox" ${r.upstream_tls_verify!==false?'checked':''}> Проверять TLS самой VM</label></div>${certificateFields(r)}<h3 class="modal-subtitle">SSH-доступ к этой машине</h3><label class="check-line"><input name="ssh_enabled" type="checkbox" ${r.ssh&&r.ssh.enabled!==false?'checked':''}> Добавить в общий SSH-конфиг</label><div class="form-grid ssh-fields"><label class="field">Псевдоним<input name="ssh_alias" value="${esc(r.ssh?.alias||'')}" placeholder="pve"></label><label class="field">Пользователь<input name="ssh_user" value="${esc(r.ssh?.user||'')}" placeholder="root"></label><label class="field">SSH-порт<input name="ssh_port" type="number" min="1" max="65535" value="${r.ssh?.port||22}"></label><label class="field">Другой IP для SSH<input name="ssh_host" value="${esc(r.ssh?.host||'')}" placeholder="IP из адреса сервиса"></label></div><details class="advanced"><summary>Дополнительные параметры</summary><div class="form-grid"><label class="field">Тайм-аут, секунд<input name="timeout_seconds" type="number" min="1" max="86400" value="${r.timeout_seconds||3600}"></label><label class="field">Загрузка файла, МБ<input name="max_body_mb" type="number" min="1" max="102400" value="${r.max_body_mb||1024}"></label><label class="field full">Имя в TLS-сертификате VM<input name="upstream_tls_name" value="${esc(r.upstream_tls_name||'')}" placeholder="pve.internal.example"></label><label class="field full">CA самой VM внутри NPM<input name="upstream_ca_file" value="${esc(r.upstream_ca_file||'')}" placeholder="/data/custom-trust/pve-root-ca.pem"></label></div></details><div class="form-error" id="modal-error" hidden></div></div></form>`,modalFooter(index<0?'Добавить сервис':'Сохранить'));
const form=$('#modal-form');bindCertificateFields(form,r);const check=$('[name=ssh_enabled]',form);const fields=$('.ssh-fields',form);fields.hidden=!check.checked;check.addEventListener('change',()=>fields.hidden=!check.checked);
form.addEventListener('submit',async e=>{e.preventDefault();const f=new FormData(form);const item={...clone(r),hostname:f.get('hostname').trim().toLowerCase(),upstream:f.get('upstream').trim(),websocket:f.has('websocket'),upstream_tls_verify:f.has('upstream_tls_verify'),timeout_seconds:Number(f.get('timeout_seconds')),max_body_mb:Number(f.get('max_body_mb'))};if(f.get('display_name').trim())item.display_name=f.get('display_name').trim();else delete item.display_name;for(const k of ['upstream_tls_name','upstream_ca_file']){if(f.get(k).trim())item[k]=f.get(k).trim();else delete item[k];}if(f.has('ssh_enabled')){item.ssh={port:Number(f.get('ssh_port'))};for(const [a,b] of [['alias','ssh_alias'],['user','ssh_user'],['host','ssh_host']])if(f.get(b).trim())item.ssh[a]=f.get(b).trim();}else delete item.ssh;readCertificateFields(f,item);const c=clone(data.config);if(index<0)c.services.push(item);else c.services[index]=item;await modalSave(c);});
}
async function modalSave(config){try{await saveConfig(config);$('#modal').close();}catch(e){const error=$('#modal-error');if(error){error.hidden=false;error.textContent=friendlyError(e);}else toast(friendlyError(e),true);}}
function zoneModal(){showModal('Новая доменная зона','Все сервисы этой зоны будут доступны через локальный DNS.',`<form id="modal-form"><div class="modal-body"><label class="field">Доменная зона<input name="zone" placeholder="lab.internal" required autocomplete="off"><small>Без *. Поддомены сервисов добавляются отдельно.</small></label>${controller().root?'<div class="info-box warning"><p>Для зоны вне ограничений текущего корня потребуется смена CA и установка нового сертификата на устройства.</p></div>':''}<div class="form-error" id="modal-error" hidden></div></div></form>`,modalFooter('Добавить зону'));$('#modal-form').addEventListener('submit',async e=>{e.preventDefault();const z=new FormData(e.target).get('zone').trim().toLowerCase().replace(/^\.+|\.+$/g,'');const c=clone(data.config);c.domain_zones=[...zones(),z];await modalSave(c);});}
function zoneModal(){showModal('Новая доменная зона','Все сервисы этой зоны будут доступны через локальный DNS.',`<form id="modal-form"><div class="modal-body"><label class="field">Доменная зона<input name="zone" placeholder="lab.internal" required autocomplete="off"><small>Без *. Поддомены сервисов добавляются отдельно.</small></label>${controller().root?'<div class="info-box warning"><p>Смена CA нужна только для сертификатов Homegate вне зон текущего корня. С существующим сертификатом NPM или копией с VDS менять CA не требуется.</p></div>':''}<div class="form-error" id="modal-error" hidden></div></div></form>`,modalFooter('Добавить зону'));$('#modal-form').addEventListener('submit',async e=>{e.preventDefault();const z=new FormData(e.target).get('zone').trim().toLowerCase().replace(/^\.+|\.+$/g,'');const c=clone(data.config);c.domain_zones=[...zones(),z];await modalSave(c);});}
function sshModal(index=-1){const r=index<0?{}:data.config.ssh_hosts[index];showModal(index<0?'Новый SSH-хост':'Настройки SSH-хоста','Прямое подключение к машине без создания веб-прокси.',`<form id="modal-form"><div class="modal-body"><div class="form-grid"><label class="field full">Псевдонимы через запятую<input name="aliases" value="${esc(r.aliases?.join(', ')||'')}" placeholder="backup, backup.lab.internal" required></label><label class="field">IP сервера<input name="host" value="${esc(r.host||'')}" placeholder="192.168.0.150" required></label><label class="field">Порт<input name="port" type="number" min="1" max="65535" value="${r.port||22}" required></label><label class="field full">Пользователь<input name="user" value="${esc(r.user||'')}" placeholder="Из личного SSH-конфига"></label><label class="check-line"><input name="enabled" type="checkbox" ${r.enabled!==false?'checked':''}> Включить в выгрузку</label></div><div class="form-error" id="modal-error" hidden></div></div></form>`,modalFooter());$('#modal-form').addEventListener('submit',async e=>{e.preventDefault();const f=new FormData(e.target);const item={aliases:f.get('aliases').split(',').map(x=>x.trim().toLowerCase()).filter(Boolean),host:f.get('host').trim(),port:Number(f.get('port')),enabled:f.has('enabled')};if(f.get('user').trim())item.user=f.get('user').trim();const c=clone(data.config);c.ssh_hosts||=[];if(index<0)c.ssh_hosts.push(item);else c.ssh_hosts[index]=item;await modalSave(c);});}
function confirmModal(title,text,action){showModal(title,'',`<div class="modal-body"><p class="note">${text}</p><div class="form-error" id="modal-error" hidden></div></div>`,`<div class="form-footer"><button class="btn" data-action="close-modal">Отмена</button><button class="btn danger" id="confirm-action">Подтвердить</button></div>`);$('#confirm-action').addEventListener('click',action);}
function guide(ca=false){const command=ca?'docker compose stop homegate\ndocker compose run --rm homegate rotate-ca\n# Установите новый state/root-ca.crt на устройства\ndocker compose up -d homegate':'sh setup.sh\n# Укажите адреса и пароли в .env / secrets\ndocker compose up -d --build';showModal(ca?'Смена корневого сертификата':'Подключите Homegate к вашей сети',ca?'Выполните на Docker-хосте после добавления новых зон.':'Панель готовит конфигурацию. Контроллер применяет её к Pi-hole и NPM.',`<div class="modal-body"><div class="code-panel"><div class="code-top"><span>На вашем сервере</span><button class="icon-button" id="copy-guide" aria-label="Скопировать команды">${icon('copy',15)}</button></div><pre>${esc(command)}</pre></div><p class="note">${ca?'Старый CA будет сохранён в state/ca-history. Новый корень нужно установить на все устройства до перезапуска контроллера. Эта операция не выполняется нажатием кнопки в панели.':'В .env задайте NPM_URL, NPM_IDENTITY, PIHOLE_URL и LAN-адреса панели/SSH. Пароли хранятся отдельно. В настройках панели проверьте IP NPM и разрешённые подсети.'}</p>${!ca?'<div class="info-box"><p>Для HTTPS без предупреждений установите root-ca.crt на клиентские устройства. Панель никогда не подменяет отсутствующие данные статусом «работает».</p></div>':''}</div>`,`<div class="form-footer"><button class="btn primary" data-action="close-modal">Понятно</button></div>`);$('#copy-guide').addEventListener('click',()=>copy(command));}
function guide(ca=false){if(!ca&&data.connections){location.hash='settings';return;}const command=ca?'docker compose stop homegate\ndocker compose run --rm homegate rotate-ca\n# Установите новый state/root-ca.crt на устройства\ndocker compose up -d homegate':'sh setup.sh\n# Укажите адреса и пароли в .env / secrets\ndocker compose up -d --build';showModal(ca?'Смена корневого сертификата':'Подключите Homegate к вашей сети',ca?'Выполните на Docker-хосте после добавления новых зон.':'Панель готовит конфигурацию. Контроллер применяет её к Pi-hole и NPM.',`<div class="modal-body"><div class="code-panel"><div class="code-top"><span>На вашем сервере</span><button class="icon-button" id="copy-guide" aria-label="Скопировать команды">${icon('copy',15)}</button></div><pre>${esc(command)}</pre></div><p class="note">${ca?'Старый CA будет сохранён в state/ca-history. Новый корень нужно установить на все устройства до перезапуска контроллера. Эта операция не выполняется нажатием кнопки в панели.':'В .env задайте NPM_URL, NPM_IDENTITY, PIHOLE_URL и LAN-адреса панели/SSH. Пароли хранятся отдельно. В настройках панели проверьте IP NPM и разрешённые подсети.'}</p>${!ca?'<div class="info-box"><p>Для HTTPS без предупреждений установите root-ca.crt на клиентские устройства. Панель никогда не подменяет отсутствующие данные статусом «работает».</p></div>':''}</div>`,`<div class="form-footer"><button class="btn primary" data-action="close-modal">Понятно</button></div>`);$('#copy-guide').addEventListener('click',()=>copy(command));}
async function saveSettings(e){e.preventDefault();const f=new FormData(e.target);const c=clone(data.config);c.proxy_ip=f.get('proxy_ip').trim();c.allowed_networks=f.get('allowed_networks').split(/\n|,/).map(x=>x.trim()).filter(Boolean);c.dns_mode=f.get('dns_mode');c.interval_seconds=Number(f.get('interval_seconds'));try{await saveConfig(c);}catch(err){$('#settings-error').hidden=false;$('#settings-error').textContent=friendlyError(err);}}
document.addEventListener('click',async e=>{const button=e.target.closest('[data-action]');if(!button)return;const i=Number(button.dataset.index);const a=button.dataset.action;try{
if(a==='add-service')serviceModal();else if(a==='edit-service')serviceModal(i);else if(a==='add-zone')zoneModal();else if(a==='add-ssh')sshModal();else if(a==='edit-ssh')sshModal(i);else if(a==='close-modal')$('#modal').close();else if(a==='guide')guide();else if(a==='ca-guide')guide(true);else if(a==='go-ssh')location.hash='ssh';
if(a==='add-service')serviceModal();else if(a==='edit-service')serviceModal(i);else if(a==='add-zone')zoneModal();else if(a==='add-ssh')sshModal();else if(a==='edit-ssh')sshModal(i);else if(a==='close-modal')$('#modal').close();else if(a==='guide')guide();else if(a==='ca-guide')guide(true);else if(a==='issue-certificate')dnsChallengeModal();else if(a==='go-ssh')location.hash='ssh';
else if(a==='filter'){filter=button.dataset.filter;render();}
else if(a==='sync'){button.disabled=true;const r=await api('/api/sync',{});toast(r.fresh?'Применение запрошено. Дождитесь обновления состояния.':'Запрос сохранён. Контроллер пока не отвечает.');button.disabled=false;}
else if(a==='toggle-service'){const c=clone(data.config);c.services[i].enabled=c.services[i].enabled===false;await saveConfig(c);}

95
ui/dist/certificates.js vendored Normal file
View File

@@ -0,0 +1,95 @@
function certificateFields(route) {
const mode = route.certificate_mode || 'homegate';
return `<h3 class="modal-subtitle">HTTPS-сертификат</h3><div class="form-grid">
<label class="field full">Источник<select name="certificate_mode">
<option value="homegate" ${mode === 'homegate' ? 'selected' : ''}>Homegate — локальный CA</option>
<option value="npm" ${mode === 'npm' ? 'selected' : ''}>Существующий сертификат домашнего NPM</option>
<option value="dns_challenge">Let’s Encrypt — DNS challenge</option>
<option value="remote_npm" ${mode === 'remote_npm' ? 'selected' : ''}>Копия из NPM на VDS — автообновление</option>
</select></label>
<div class="field full" id="npm-certificate-fields" ${mode === 'homegate' ? 'hidden' : ''}>
<label class="field">Сертификат домашнего NPM<select name="npm_certificate_id"></select></label>
<label class="field" id="remote-certificate-field" ${mode !== 'remote_npm' ? 'hidden' : ''}>Сертификат на VDS<select name="remote_certificate_id"></select></label>
<button type="button" class="btn" id="reload-certificates">${icon('refresh',14)} Обновить список</button>
<small id="certificate-list-status" role="status"></small>
</div><p class="note field full" id="certificate-help"></p>
</div>${dnsChallengeFields(route.hostname || '')}`;
}
function bindCertificateFields(form, route) {
let local = [], remote = [], generation = 0;
const mode = form.elements.certificate_mode, target = form.elements.npm_certificate_id;
const source = form.elements.remote_certificate_id, status = form.querySelector('#certificate-list-status');
let selectedTarget = String(route.npm_certificate_id || ''), selectedSource = String(route.remote_certificate_id || '');
const dns = bindDNSChallenge(form, cert => {
if(mode.value !== 'dns_challenge') return;
const hostname = form.elements.hostname.value.trim().toLowerCase();
if(hostname && !cert.domains.some(d => d === hostname || (d.startsWith('*.') && hostname.endsWith(d.slice(1)) && hostname.split('.').length === d.split('.').length))) {
form.querySelector('#dns-challenge-status').textContent = `Сертификат #${cert.id} готов, но не покрывает ${hostname}. Укажите соответствующий домен сервиса или выпустите сертификат для него.`;
return;
}
local = [...local.filter(c => c.id !== cert.id), cert];
selectedTarget = String(cert.id); mode.value = 'npm';
update();
status.textContent = 'Сертификат готов. Сохраните сервис — Homegate создаст DNS и прокси. Автопродление уже включено в NPM.';
});
const option = (value, label) => `<option value="${esc(value)}">${esc(label)}</option>`;
const label = c => `#${c.id} · ${c.name || c.domains.join(', ')} · ${c.domains.join(', ')} · до ${date(c.expires)}${c.provider === 'letsencrypt' ? ' · Let’s Encrypt' : ''}`;
function populate(select, certs, selected, placeholder) {
select.innerHTML = option('', placeholder) + certs.map(c => option(String(c.id), label(c))).join('');
if(selected && !certs.some(c => String(c.id) === selected)) select.insertAdjacentHTML('beforeend', option(selected, `#${selected} — сохранённый выбор, нет в списке`));
select.value = selected;
}
function update() {
const copying = mode.value === 'remote_npm', issuing = mode.value === 'dns_challenge';
const enabled = ['npm','remote_npm'].includes(mode.value);
if(issuing) dns.load(); else dns.hide();
document.querySelector('button[type="submit"][form="modal-form"]').disabled = issuing;
form.querySelector('#npm-certificate-fields').hidden = !enabled;
form.querySelector('#remote-certificate-field').hidden = !copying;
target.disabled = !enabled; target.required = mode.value === 'npm';
source.disabled = !copying; source.required = copying;
populate(target, local.filter(c => !copying || c.provider === 'other'), selectedTarget,
copying ? 'Создать новую копию в домашнем NPM' : 'Выберите сертификат');
populate(source, remote, selectedSource, 'Выберите сертификат Let’s Encrypt');
form.querySelector('#certificate-help').textContent = {
homegate: 'Homegate выпускает и продлевает сертификат. На устройствах нужен доверенный корневой CA.',
npm: 'Homegate привяжет этот сертификат к прокси и создаст локальный DNS. Сертификат не заменяется. Let’s Encrypt автоматически продлевает домашний NPM; Custom нужно обновлять у его издателя.',
dns_challenge: 'Сначала выпустите сертификат кнопкой ниже, затем сохраните сервис. Подключение к VDS для этого режима не требуется.',
remote_npm: 'NPM на VDS продлевает сертификат самостоятельно. Homegate проверяет его каждый цикл и копирует обновление домой. На VDS выполняется только чтение. Если интернет недоступен, используется последняя копия до окончания её срока. При выборе существующего Custom обновляется именно он.'
}[mode.value];
}
async function load() {
if(!['npm','remote_npm'].includes(mode.value)) return;
const request = ++generation, copying = mode.value === 'remote_npm';
status.textContent = 'Загрузка сертификатов…';
const results = await Promise.allSettled([api('/api/npm-certificates'), ...(copying ? [api('/api/remote-certificates')] : [])]);
if(request !== generation || !form.isConnected) return;
const errors = [];
if(results[0].status === 'fulfilled') local = results[0].value.certificates; else errors.push(results[0].reason.message);
if(copying) {
if(results[1].status === 'fulfilled') remote = results[1].value.certificates; else errors.push(results[1].reason.message);
}
update();
status.textContent = errors.length ? errors.join(' · ') : (copying ? 'Списки обновлены. Настройки VDS не изменены.' : 'Список обновлён.');
}
target.addEventListener('change', () => selectedTarget = target.value);
source.addEventListener('change', () => selectedSource = source.value);
mode.addEventListener('change', () => { generation++; selectedTarget = ''; update(); load(); });
form.querySelector('#reload-certificates').addEventListener('click', load);
update(); load();
}
function readCertificateFields(fields, item) {
item.certificate_mode = fields.get('certificate_mode');
delete item.npm_certificate_id;
delete item.remote_certificate_id;
if(item.certificate_mode !== 'homegate' && fields.get('npm_certificate_id')) item.npm_certificate_id = Number(fields.get('npm_certificate_id'));
if(item.certificate_mode === 'remote_npm') item.remote_certificate_id = Number(fields.get('remote_certificate_id'));
}
function certificateRenewal(cert) {
if(cert.mode === 'remote_npm') return cert.sync_error ? `Ошибка копирования: ${esc(cert.sync_error)}` : `Копия с VDS${cert.synced_at ? ' · проверена ' + esc(new Date(cert.synced_at * 1000).toLocaleString('ru-RU')) : ''}`;
if(cert.mode === 'npm') return cert.provider === 'letsencrypt' ? `Автоматически в домашнем NPM${cert.dns_challenge ? ' · DNS challenge' : ''}` : 'Custom — у издателя сертификата';
return 'Автоматически в Homegate';
}

103
ui/dist/dns-challenge.js vendored Normal file
View File

@@ -0,0 +1,103 @@
function dnsChallengeFields(domains = '') {
return `<fieldset id="dns-challenge-fields" class="dns-challenge-fields" hidden disabled>
<div class="info-box"><p>Домашний NPM выпустит публичный сертификат через временную TXT-запись у DNS-провайдера и будет продлевать его автоматически. Нужен ваш публичный домен. Порты дома открывать в интернет не требуется; NPM на VDS не участвует.</p></div>
<div class="form-grid">
<label class="field full">Домены сертификата<textarea name="dns_domains" rows="2" required placeholder="disk.hyperdog.dev\n*.hyperdog.dev">${esc(domains)}</textarea><small>По одному в строке. Wildcard *.hyperdog.dev покрывает один уровень поддоменов.</small></label>
<label class="field full">DNS-провайдер<select name="dns_provider" required><option value="">Загрузка провайдеров…</option></select></label>
<label class="field full" id="dns-email-field" hidden>Email для Let's Encrypt<input name="dns_email" type="email" disabled placeholder="admin@example.com"></label>
<div class="field full"><details open><summary>Шаблон API-доступа</summary><pre id="dns-credential-template" class="dns-credential-template">Выберите провайдера.</pre></details></div>
<label class="field full">API-доступ DNS-провайдера<textarea name="dns_credentials" rows="4" required autocomplete="off" spellcheck="false" placeholder="Вставьте настройки по шаблону, заменив пример своим токеном"></textarea><small>Токен передаётся только домашнему NPM для выпуска и продления. В настройках Homegate, YAML и логах он не сохраняется. Для Cloudflare нужен API Token с Zone:DNS:Edit для вашей зоны.</small></label>
<label class="field full">Ожидание DNS, секунд<input name="dns_propagation" type="number" min="0" max="600" placeholder="По умолчанию у провайдера"><small>Оставьте пустым, чтобы NPM использовал значение DNS-плагина.</small></label>
<label class="check-line"><input name="dns_agree" type="checkbox" required>Принимаю <a href="https://letsencrypt.org/repository/" target="_blank" rel="noopener noreferrer">условия Let's Encrypt</a></label>
</div>
<p class="note" id="dns-account-note">Для регистрации используется email учётной записи домашнего NPM.</p>
<div class="dns-challenge-actions"><button type="button" class="btn primary" id="start-dns-challenge">${icon('shield',14)} Выпустить сертификат</button><button type="button" class="btn" id="check-dns-challenge" hidden>${icon('refresh',14)} Проверить результат</button></div>
<p class="note" id="dns-challenge-status" role="status" aria-live="polite"></p>
</fieldset>`;
}
function bindDNSChallenge(form, onCertificate) {
const fields = form.querySelector('#dns-challenge-fields');
const button = form.querySelector('#start-dns-challenge'), check = form.querySelector('#check-dns-challenge');
const status = form.querySelector('#dns-challenge-status'), provider = form.elements.dns_provider;
let catalog = null, loading = false, timer = null, watching = false, waiting = false, delivered = null;
const domainNames = () => form.elements.dns_domains.value.split(/[\n,]/).map(s => s.trim().toLowerCase()).filter(Boolean);
function show(job) {
if(!form.isConnected) return;
waiting = job.status === 'running';
button.disabled = waiting || !catalog;
check.hidden = !['unknown','error'].includes(job.status);
status.textContent = job.status === 'idle' ? '' : `${job.domains?.join(', ') || ''}: ${job.message || ''}`;
if(job.status === 'success' && watching && job.id !== delivered) {
delivered = job.id;
onCertificate(job.certificate);
}
if(waiting) { clearTimeout(timer); timer = setTimeout(poll, 1500); }
}
async function poll() {
if(!form.isConnected) return;
try { show(await api('/api/dns-challenge')); }
catch(error) { status.textContent = error.message; check.hidden = false; }
}
function template() {
form.querySelector('#dns-credential-template').textContent = catalog?.providers.find(p => p.id === provider.value)?.template || 'Выберите провайдера.';
}
async function load() {
fields.disabled = false;
fields.hidden = false;
if(!form.elements.dns_domains.value && form.elements.hostname) form.elements.dns_domains.value = form.elements.hostname.value.trim();
if(catalog || loading) return;
loading = true; button.disabled = true;
try {
catalog = await api('/api/dns-providers');
if(!form.isConnected) return;
provider.innerHTML = '<option value="">Выберите провайдера</option>' + catalog.providers.map(p => `<option value="${esc(p.id)}">${esc(p.name)}</option>`).join('');
form.querySelector('#dns-email-field').hidden = !catalog.email_required;
form.elements.dns_email.disabled = !catalog.email_required;
form.elements.dns_email.required = catalog.email_required;
form.querySelector('#dns-account-note').hidden = catalog.email_required;
button.disabled = waiting;
const job = await api('/api/dns-challenge');
const names = domainNames();
watching = job.status === 'running' && (names.length === 0 || names.every(d => job.domains?.includes(d)));
show(job);
} catch(error) { status.textContent = error.message; check.hidden = false; }
finally { loading = false; }
}
provider.addEventListener('change', () => { form.elements.dns_credentials.value = ''; template(); });
button.addEventListener('click', async () => {
if(![...fields.querySelectorAll('input,textarea,select')].every(input => input.reportValidity())) return;
const propagation = form.elements.dns_propagation.value;
const request = {domains:domainNames(), provider:provider.value, credentials:form.elements.dns_credentials.value,
email:form.elements.dns_email.value, propagation_seconds:propagation === '' ? null : Number(propagation), agree:form.elements.dns_agree.checked};
button.disabled = true;
try {
watching = true; delivered = null;
const job = await api('/api/dns-challenge', request);
form.elements.dns_credentials.value = ''; form.elements.dns_agree.checked = false;
show(job);
} catch(error) { status.textContent = error.message; button.disabled = false; check.hidden = false; }
});
check.addEventListener('click', async () => {
check.disabled = true;
try {
if(!catalog) { await load(); return; }
watching = true;
show(await api('/api/dns-challenge/check', {}));
} catch(error) { status.textContent = error.message; }
finally { check.disabled = false; }
});
return {load, hide:() => {fields.hidden = true; fields.disabled = true;}};
}
function dnsChallengeModal() {
showModal('Let’s Encrypt через DNS challenge', 'Выпуск и автопродление в домашнем NPM.',
`<form id="modal-form"><div class="modal-body">${dnsChallengeFields()}<div class="form-error" id="modal-error" hidden></div></div></form>`,
'<div class="form-footer"><button type="button" class="btn" data-action="close-modal">Закрыть</button></div>');
const form = $('#modal-form');
form.addEventListener('submit', e => e.preventDefault());
const dns = bindDNSChallenge(form, cert => {
form.querySelector('#dns-challenge-status').textContent = `Готово: сертификат #${cert.id} для ${cert.domains.join(', ')}. Теперь выберите его в настройках сервиса. Продление выполняется автоматически в домашнем NPM.`;
});
dns.load();
}

5
ui/dist/index.html vendored
View File

@@ -8,6 +8,9 @@
<meta name="description" content="Управление локальными сервисами, доменными зонами, HTTPS и SSH-доступом.">
<link rel="icon" href="/favicon.svg" type="image/svg+xml">
<link rel="stylesheet" href="/style.css">
<script src="/settings.js" defer></script>
<script src="/dns-challenge.js" defer></script>
<script src="/certificates.js" defer></script>
<script src="/app.js" defer></script>
</head>
<body>
@@ -18,7 +21,7 @@
<div class="nav-label">УПРАВЛЕНИЕ</div>
<nav id="navigation" aria-label="Разделы"></nav>
<div class="sidebar-guide"><span class="guide-orbit">↗</span><strong>Всё остаётся дома</strong><p>Ваши сервисы и настройки — внутри локальной сети.</p><button class="text-link" id="guide-button">Как это работает <span>→</span></button></div>
<div class="sidebar-bottom"><span class="online-dot"></span><div><strong>Локальная панель</strong><span>Homegate <span class="version">0.4</span></span></div><button id="logout" class="icon-button" aria-label="Выйти" hidden>↪</button></div>
<div class="sidebar-bottom"><span class="online-dot"></span><div><strong>Локальная панель</strong><span>Homegate <span class="version">0.6</span></span></div><button id="logout" class="icon-button" aria-label="Выйти" hidden>↪</button></div>
</aside>
<div class="sidebar-shade" id="sidebar-shade"></div>
<div class="workspace-main">

85
ui/dist/settings.js vendored Normal file
View File

@@ -0,0 +1,85 @@
function renderManagedSettings() {
const c = data.config, links = data.connections, first = data.setup_required;
const passwordField = (name, title, disabled = false) => `<label class="field full">${title}<input name="${name}" type="password" autocomplete="new-password" placeholder="${links[name + '_set'] ? 'Сохранён. Оставьте пустым, чтобы не менять' : 'Пароль существующего сервиса'}" ${name === 'npm_password' && !links.npm_password_set ? 'required' : ''} ${disabled ? 'disabled' : ''}></label>`;
return heading(first ? 'Подключим вашу домашнюю сеть' : 'Настройки и подключения',
first ? 'Заполните адреса здесь — Homegate сохранит настройки и начнёт работать.' : 'Все параметры сохраняются здесь и применяются автоматически.') + `
<div class="settings-grid"><form id="settings-form" class="panel">
<section class="form-section"><h2>Ваша сеть</h2><p>Сервисы будут открываться через Nginx Proxy Manager.</p>
<div class="form-grid">
<label class="field">IP Nginx Proxy Manager<input name="proxy_ip" value="${esc(c.proxy_ip)}" placeholder="192.168.0.11" required><small>Адрес, на который должны указывать домены сервисов.</small></label>
<label class="field">Обновление, секунд<input name="interval_seconds" type="number" min="30" max="3600" value="${c.interval_seconds || 60}" required></label>
<label class="field full">Домашние подсети<textarea name="allowed_networks" rows="2" placeholder="192.168.0.0/24" required>${esc(c.allowed_networks.join('\n'))}</textarea><small>Укажите вашу LAN. Можно несколько подсетей, по одной в строке.</small></label>
<label class="field full">Доменные зоны<textarea name="domain_zones" rows="2" required>${esc((c.domain_zones || ['home','home.arpa']).join('\n'))}</textarea><small>Например: home, home.arpa, lab.internal.</small></label>
</div>
</section>
<section class="form-section"><h2>Nginx Proxy Manager</h2><p>Homegate создаёт прокси и загружает сертификаты через API.</p>
<div class="form-grid">
<label class="field full">Адрес панели NPM<input name="npm_url" type="url" value="${esc(links.npm_url)}" placeholder="http://192.168.0.11:81" required><small>Без /api в конце.</small></label>
<label class="field full">Логин NPM<input name="npm_identity" value="${esc(links.npm_identity)}" placeholder="admin@example.com" autocomplete="username" required></label>
${passwordField('npm_password', 'Пароль NPM')}
</div>
</section>
<section class="form-section"><h2>Сертификаты с NPM на VDS</h2><p>Необязательное подключение. Продлением занимается NPM на VDS. Homegate читает сертификаты и обновляет их копии дома; настройки и прокси на VDS не меняются.</p>
<div class="form-grid">
<label class="field full">HTTPS адрес панели NPM на VDS<input name="remote_npm_url" type="url" value="${esc(links.remote_npm_url || '')}" placeholder="https://npm.example.com"><small>Адрес API-панели, без /api. Оставьте пустым, если копирование не нужно.</small></label>
<label class="field full">Логин NPM на VDS<input name="remote_npm_identity" value="${esc(links.remote_npm_identity || '')}" autocomplete="username"></label>
${passwordField('remote_npm_password', 'Пароль NPM на VDS')}
</div>
</section>
<section class="form-section"><h2>DNS</h2><div class="form-grid">
<label class="field full">Создание DNS-записей<select name="dns_mode"><option value="pihole6" ${c.dns_mode !== 'manual' ? 'selected' : ''}>Автоматически — Pi-hole 6</option><option value="manual" ${c.dns_mode === 'manual' ? 'selected' : ''}>Вручную — другой DNS</option></select></label>
<div id="pihole-fields" class="field full" ${c.dns_mode === 'manual' ? 'hidden' : ''}>
<label class="field">Адрес Pi-hole<input name="pihole_url" type="url" value="${esc(links.pihole_url)}" placeholder="http://192.168.0.2" ${c.dns_mode !== 'manual' ? 'required' : ''}><small>Без /admin и /api в конце.</small></label>
<label class="check-line"><input name="pihole_no_password" type="checkbox" ${!links.pihole_password_set ? 'checked' : ''}>Pi-hole без пароля</label>
<small>Включите, если пароль в Pi-hole отключён. Сохранённый пароль подключения будет удалён.</small>
<div id="pihole-password-field" ${!links.pihole_password_set ? 'hidden' : ''}>${passwordField('pihole_password', 'Пароль Pi-hole', !links.pihole_password_set)}</div>
</div>
</div></section>
<section class="form-section"><details><summary>Дополнительные настройки</summary><div class="form-grid">
<label class="field full">URL SSH-конфига<input name="ssh_public_url" type="url" value="${esc(links.ssh_public_url)}" placeholder="${esc(sshUrl())}"><small>Оставьте пустым для адреса этого сервера на порту 8099.</small></label>
<label class="field full">Корневой сертификат API, PEM<textarea name="api_ca_pem" rows="4" placeholder="-----BEGIN CERTIFICATE-----">${esc(links.api_ca_pem)}</textarea><small>Нужен только если HTTPS API NPM или Pi-hole использует собственный CA.</small></label>
</div></details><div id="settings-error" class="form-error" hidden></div></section>
<div class="form-footer"><button class="btn primary" type="submit">${icon('check',14)} ${first ? 'Сохранить и начать' : 'Сохранить и применить'}</button></div>
</form><div class="stack"><section class="panel panel-pad"><div class="panel-heading">${first ? 'Всё настраивается здесь' : 'Подключения'}</div>
<p class="panel-description">Адреса, домены и доступ к вашим сервисам сохраняются на сервере. После перезапуска ничего вводить заново не нужно.</p>
<div class="integration"><span class="integration-icon">${icon('route',19)}</span><div><strong>Nginx Proxy Manager</strong><small>Прокси и HTTPS для ваших VM</small></div></div>
<div class="integration"><span class="integration-icon">${icon('globe',19)}</span><div><strong>Pi-hole</strong><small>Локальные DNS-записи</small></div></div>
<p class="note">Пароли в форме — от уже работающих сервисов. Если в Pi-hole пароль отключён, включите «Pi-hole без пароля». Панель Homegate открывается без логина.</p>
</section>${!first ? statusStrip() : ''}</div></div>`;
}
function bindManagedSettings(form) {
form.elements.pihole_no_password.addEventListener('change', () => {
const noPassword = form.elements.pihole_no_password.checked;
document.querySelector('#pihole-password-field').hidden = noPassword;
form.elements.pihole_password.disabled = noPassword;
});
form.elements.dns_mode.addEventListener('change', () => {
const manual = form.elements.dns_mode.value === 'manual';
document.querySelector('#pihole-fields').hidden = manual;
form.elements.pihole_url.required = !manual;
});
}
async function saveManagedSettings(event) {
event.preventDefault();
const form = event.target, fields = new FormData(form), config = clone(data.config);
const list = name => fields.get(name).split(/\n|,/).map(value => value.trim()).filter(Boolean);
Object.assign(config, {proxy_ip: fields.get('proxy_ip').trim(), allowed_networks: list('allowed_networks'),
domain_zones: list('domain_zones'), dns_mode: fields.get('dns_mode'), interval_seconds: Number(fields.get('interval_seconds'))});
const connections = Object.fromEntries(['npm_url','npm_identity','npm_password','pihole_url','pihole_password','ssh_public_url','api_ca_pem','remote_npm_url','remote_npm_identity','remote_npm_password'].map(key => [key, fields.get(key) || '']));
connections.clear_pihole_password = fields.has('pihole_no_password');
const first = data.setup_required, button = form.querySelector('[type=submit]');
button.disabled = true;
try {
data = await api('/api/settings', {config, connections, revision: data.revision});
settingsDirty = false;
if(first) location.hash = 'services';
render();
toast(first ? 'Готово. Добавьте первый сервис.' : 'Настройки сохранены. Подключения обновляются.');
} catch(error) {
document.querySelector('#settings-error').hidden = false;
document.querySelector('#settings-error').textContent = friendlyError(error);
button.disabled = false;
}
}

2
ui/dist/style.css vendored

File diff suppressed because one or more lines are too long