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

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

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)