Support passwordless Pi-hole authentication and UI settings

This commit is contained in:
2026-10-14 18:12:10 +03:00
parent a83d897b70
commit 3731460aa4
13 changed files with 130 additions and 33 deletions

View File

@@ -4,7 +4,7 @@ COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY homegate.py sync_ssh.py homegate_ui.py bootstrap.py standalone.py VERSION .
COPY ui/dist ./ui/dist
ARG VERSION=0.4.1
ARG VERSION=0.4.2
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

View File

@@ -1,4 +1,4 @@
# Homegate 0.4.1
# Homegate 0.4.2
Дополнение к **существующим Pi-hole и Nginx Proxy Manager** для домашней сети:
@@ -11,7 +11,7 @@ https://pve.home → NPM:443 → https://192.168.0.137:8006
Веб-панель Homegate управляет сервисами, доменными зонами, SSH и настройками сети.
SSH-конфиг публикуется без авторизации для устройств домашней подсети.
**Простой запуск 0.4.1: [Compose без env и secrets, вся настройка в UI](SIMPLE.md).**
**Простой запуск 0.4.2: [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).

View File

@@ -75,7 +75,7 @@ Homegate 0.4 поддерживает два способа установки:
По умолчанию registry берётся из адреса Gitea, image — из `owner/repository` в нижнем регистре:
```text
git.example.home/your-user/homegate:0.4.1
git.example.home/your-user/homegate:0.4.2
```
Если registry доступен по другому имени/порту, задайте Actions **variable** `REGISTRY`,
@@ -89,16 +89,16 @@ git.example.home/your-user/homegate:0.4.1
## 2. Выпустите образ
Файл `VERSION` сейчас содержит `0.4.1`. После загрузки проверенного кода в Gitea:
Файл `VERSION` сейчас содержит `0.4.2`. После загрузки проверенного кода в Gitea:
```sh
git tag v0.4.1
git push origin v0.4.1
git tag v0.4.2
git push origin v0.4.2
```
При следующем выпуске измените `VERSION`, закоммитьте его вместе с изменениями и создайте
соответствующий тег. Тег должен совпасть с файлом `VERSION`: например `v0.4.1` и `0.4.1`.
Предварительные версии вида `v0.4.1-rc.1` также поддерживаются. Полный номер задаётся
соответствующий тег. Тег должен совпасть с файлом `VERSION`: например `v0.4.2` и `0.4.2`.
Предварительные версии вида `v0.4.2-rc.1` также поддерживаются. Полный номер задаётся
в `VERSION`; примеры в Compose, Dockerfile и документации при выпуске также обновите.
Workflow `.gitea/workflows/release.yaml` выполняет:
@@ -110,7 +110,7 @@ Workflow `.gitea/workflows/release.yaml` выполняет:
3. Только для push тега `v*`, после успешных проверок — проверку `VERSION`, сборку
`linux/amd64` + `linux/arm64` и публикацию в Gitea Container Registry.
Образ получает два тега: `0.4.1` и `sha-<полный SHA коммита>`. Тег `latest` не создаётся.
Образ получает два тега: `0.4.2` и `sha-<полный SHA коммита>`. Тег `latest` не создаётся.
`org.opencontainers.image.source` связывает метаданные образа с URL исходников.
Права на просмотр/скачивание пакета проверьте в Gitea Packages отдельно от доступа к коду.
Workflow не запускает контейнеры Homegate и не развёртывает приложение.
@@ -136,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.1
export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.4.2
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]'
@@ -214,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.4.2
docker compose pull
docker compose up -d
```

View File

@@ -1,6 +1,6 @@
# Homegate: запуск и настройка через браузер
Используйте образ `gitea.hyperdog.dev/dizyaka/homegate:0.4.1` после успешной публикации
Используйте образ `gitea.hyperdog.dev/dizyaka/homegate:0.4.2` после успешной публикации
версии в Gitea Actions. Содержимое [compose.simple.yaml](compose.simple.yaml) сохраните
на сервере как `compose.yaml`. Файл не содержит адресов, environment, secrets или паролей.
@@ -17,19 +17,21 @@ docker compose up -d --remove-orphans
- IP NPM, домашние подсети и доменные зоны;
- URL административного API NPM, его логин и пароль;
- URL Pi-hole 6 и его пароль либо ручной режим DNS;
- 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 нужны их API, вводятся в форме и сохраняются в config volume.
Пароль NPM и, если включён, пароль Pi-hole вводятся в форме и сохраняются в config volume.
Они не возвращаются в API состояния, скачиваемом YAML или SSH-конфиге.
Локальные HTTPS сертификаты и ключ CA Homegate создаёт сам. Публичный корневой сертификат
скачивается в разделе **Сертификаты**; установите его на клиентские устройства для доверия HTTPS.

View File

@@ -1 +1 @@
0.4.1
0.4.2

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.1
# Example image: git.example.home/your-user/homegate:0.4.2
name: homegate
x-runtime: &runtime

View File

@@ -2,7 +2,7 @@ name: homegate
services:
homegate:
image: gitea.hyperdog.dev/dizyaka/homegate:0.4.1
image: gitea.hyperdog.dev/dizyaka/homegate:0.4.2
entrypoint: [python, /app/standalone.py]
restart: unless-stopped
init: true

View File

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

View File

@@ -457,8 +457,16 @@ class NPM(API):
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"]

View File

@@ -136,9 +136,13 @@ class Panel:
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"}
allowed = {"npm_url", "npm_identity", "npm_password", "pihole_url", "pihole_password", "ssh_public_url", "api_ca_pem", "clear_pihole_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
@@ -151,6 +155,8 @@ class Panel:
client = h.API(values.get(key, ""), key.removesuffix("_url").upper())
client.close()
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,

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/"):
@@ -82,14 +85,14 @@ class Transport:
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 +143,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"]

View File

@@ -112,6 +112,47 @@ class SetupTests(unittest.TestCase):
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)

16
ui/dist/settings.js vendored
View File

@@ -1,6 +1,6 @@
function renderManagedSettings() {
const c = data.config, links = data.connections, first = data.setup_required;
const passwordField = (name, title) => `<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' : ''}></label>`;
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">
@@ -23,7 +23,9 @@ function renderManagedSettings() {
<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>
${passwordField('pihole_password', 'Пароль Pi-hole')}
<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">
@@ -35,11 +37,16 @@ function renderManagedSettings() {
<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">Пароли в форме — от уже работающих NPM и Pi-hole. Панель Homegate открывается без логина.</p>
<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;
@@ -53,7 +60,8 @@ async function saveManagedSettings(event) {
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'].map(key => [key, fields.get(key)]));
const connections = Object.fromEntries(['npm_url','npm_identity','npm_password','pihole_url','pihole_password','ssh_public_url','api_ca_pem'].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 {