Add gateway sessions page and end sessions on credential change

This commit is contained in:
Eduardo Silva
2026-11-21 16:43:06 -03:00
parent 7fd1a4fbc3
commit bf71df194d
24 changed files with 957 additions and 13 deletions
+6
View File
@@ -10,6 +10,7 @@ from django.views.decorators.http import require_GET, require_POST
from cluster.models import ClusterSettings, Worker, WorkerStatus
from cluster.sync import SECTION_NAMES, build_manifest, build_section
from gatekeeper.sessions import clean_gateway_sessions
REPORT_STATUS_FIELDS = ('status', 'message')
@@ -160,6 +161,11 @@ def api_report(request):
worker_status.certificate_status_updated = timezone.now()
update_fields += ['certificate_status', 'certificate_status_updated']
if isinstance(payload.get('gateway_sessions'), list):
worker_status.gateway_sessions = clean_gateway_sessions(payload['gateway_sessions'])
worker_status.gateway_sessions_updated = timezone.now()
update_fields += ['gateway_sessions', 'gateway_sessions_updated']
if isinstance(payload.get('wireguard_status'), dict):
worker_status.wireguard_status = payload['wireguard_status']
worker_status.wireguard_status_updated = timezone.now()
@@ -0,0 +1,23 @@
# Generated by Django 5.2.19 on 2026-11-21 18:56
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('cluster', '0019_alter_clustersettings_cluster_mode'),
]
operations = [
migrations.AddField(
model_name='workerstatus',
name='gateway_sessions',
field=models.JSONField(blank=True, default=list),
),
migrations.AddField(
model_name='workerstatus',
name='gateway_sessions_updated',
field=models.DateTimeField(blank=True, null=True),
),
]
+3
View File
@@ -120,6 +120,9 @@ class WorkerStatus(models.Model):
# {hostname: {"status": ..., "issuer": ..., "not_after": ..., "generation": ...}}
certificate_status = models.JSONField(default=dict, blank=True)
certificate_status_updated = models.DateTimeField(blank=True, null=True)
# Active sessions of the auth-gateway of the worker, as published in its sessions snapshot
gateway_sessions = models.JSONField(default=list, blank=True)
gateway_sessions_updated = models.DateTimeField(blank=True, null=True)
updated = models.DateTimeField(auto_now=True)
created = models.DateTimeField(auto_now_add=True)
+3
View File
@@ -15,6 +15,7 @@ from cluster.models import ClusterSettings, WorkerStatus
from dns.functions import generate_dnsmasq_config
from dns.models import DNSFilterList
from firewall.tools import generate_firewall_script
from gatekeeper.sessions import REVOKED_SESSIONS_FILE, build_revoked_sessions_data
from wireguard.models import WireGuardInstance
from wireguard_tools.functions import CLUSTER_WIREGUARD_CONFIG_DIR, WIREGUARD_CONFIG_DIR
@@ -143,6 +144,8 @@ def build_gateway_section(worker):
section = Section()
for file_name, data in get_gateway_export(worker).items():
section.add_file(file_name, json.dumps(data, indent=2) + '\n')
# Sessions ended from the WireGuard WebAdmin, the same for every server
section.add_file(REVOKED_SESSIONS_FILE, json.dumps(build_revoked_sessions_data(), indent=2) + '\n')
return section
+90
View File
@@ -22,6 +22,7 @@ from firewall.tools import generate_firewall_script
from user_manager.models import UserAcl
from wireguard.models import Peer, PeerAllowedIP, WireGuardInstance
from wireguard_tools.functions import get_config_servers
from wireguard_tools.tests import load_cluster_worker
from wireguard_tools.views import export_wireguard_configuration, generate_peer_config
FAKE_CERTIFICATE = '-----BEGIN CERTIFICATE-----\nfake\n-----END CERTIFICATE-----\n'
@@ -138,6 +139,25 @@ class ClusterApiTests(ClusterTestMixin, TestCase):
self.assertIsNotNone(worker_status.certificate_status_updated)
self.assertIsNotNone(worker_status.wireguard_status_updated)
def test_report_stores_gateway_sessions(self):
sessions = [
{'id': 'a' * 64, 'username': 'alice', 'factors': ['password'], 'online': True, 'session_id': 'secret'},
{'id': 'invalid', 'username': 'mallory'},
]
response = self.client.post(
'/api/cluster/v2/report/', data=json.dumps({'gateway_sessions': sessions}), content_type='application/json',
**self.headers
)
self.assertEqual(response.status_code, 200)
worker_status = WorkerStatus.objects.get(worker=self.worker)
self.assertEqual([session['id'] for session in worker_status.gateway_sessions], ['a' * 64])
self.assertNotIn('session_id', worker_status.gateway_sessions[0])
self.assertIsNotNone(worker_status.gateway_sessions_updated)
# A report without sessions (older worker or no change) keeps the last ones
self.client.post('/api/cluster/v2/report/', data=json.dumps({'services': {}}), content_type='application/json', **self.headers)
self.assertEqual(len(WorkerStatus.objects.get(worker=self.worker).gateway_sessions), 1)
class ClusterSyncTests(ClusterTestMixin, TestCase):
def report_sections(self, manifest, overrides=None):
@@ -435,3 +455,73 @@ class DistributedModeTests(ClusterTestMixin, TestCase):
self.client.get(f'/cluster/worker/manage/?uuid={self.worker_b.uuid}&action=delete&confirmation=delete')
self.assertFalse(Worker.objects.filter(pk=self.worker_b.pk).exists())
class AgentGatewaySessionsTests(TestCase):
"""Sessions of the node auth-gateway are reported when they change, and revocations reach its config."""
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.cluster_worker = load_cluster_worker()
def setUp(self):
temp_dir = tempfile.TemporaryDirectory()
self.addCleanup(temp_dir.cleanup)
self.gateway_dir = temp_dir.name
self.sessions_file = os.path.join(self.gateway_dir, 'state', 'sessions.json')
os.makedirs(os.path.dirname(self.sessions_file))
for name, value in (
('GATEWAY_DIR', self.gateway_dir),
('GATEWAY_SESSIONS_FILE', self.sessions_file),
('gateway_enabled', lambda: True),
('wireguard_status', lambda: {}),
):
patcher = patch.object(self.cluster_worker, name, value)
patcher.start()
self.addCleanup(patcher.stop)
for name in ('services_status', 'certificates_status'):
patcher = patch.object(self.cluster_worker.ClusterNodeAgent, name, staticmethod(lambda: {}))
patcher.start()
self.addCleanup(patcher.stop)
self.agent = self.cluster_worker.ClusterNodeAgent()
self.reports = []
self.status_code = 200
self.agent.request = self.record_report
def record_report(self, method, path, json=None):
self.reports.append(json)
return type('Response', (), {'status_code': self.status_code})()
def publish(self, sessions):
with open(self.sessions_file, 'w', encoding='utf-8') as sessions_file:
sessions_file.write(json.dumps({'sessions': sessions}))
def test_sessions_are_only_reported_when_they_change(self):
self.publish([{'id': 'a' * 64}])
self.agent.send_stats()
self.agent.send_stats()
self.publish([])
self.agent.send_stats()
self.assertEqual([report.get('gateway_sessions') for report in self.reports], [[{'id': 'a' * 64}], None, []])
def test_sessions_are_reported_again_when_the_primary_did_not_accept_them(self):
self.publish([{'id': 'a' * 64}])
self.status_code = 500
self.agent.send_stats()
self.status_code = 200
self.agent.send_stats()
self.agent.send_stats()
self.assertEqual(['gateway_sessions' in report for report in self.reports], [True, True, False])
def test_no_sessions_file_reports_nothing(self):
self.agent.send_stats()
self.assertNotIn('gateway_sessions', self.reports[0])
def test_revoked_sessions_are_written_when_sent(self):
files = {name: '{}' for name in self.cluster_worker.GATEWAY_FILES}
self.agent.apply_gateway({'files': files})
self.assertFalse(os.path.exists(os.path.join(self.gateway_dir, 'revoked_sessions.json')))
self.agent.apply_gateway({'files': dict(files, **{'revoked_sessions.json': '{"sessions": []}'})})
with open(os.path.join(self.gateway_dir, 'revoked_sessions.json'), encoding='utf-8') as revoked_file:
self.assertEqual(revoked_file.read(), '{"sessions": []}')