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
@@ -0,0 +1,26 @@
# Generated by Django 5.2.19 on 2026-11-21 18:56
import uuid
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('gatekeeper', '0011_authmethod_display_name_gatekeepergroup_display_name'),
]
operations = [
migrations.CreateModel(
name='RevokedGatewaySession',
fields=[
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('session_hash', models.CharField(max_length=64, unique=True)),
('username', models.CharField(blank=True, max_length=254)),
('expires_at', models.DateTimeField()),
('created', models.DateTimeField(auto_now_add=True)),
('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True)),
],
),
]
+14 -1
View File
@@ -154,4 +154,17 @@ class GatekeeperIPAddress(models.Model):
ordering = ['address']
unique_together = [('auth_method', 'address', 'prefix_length')]
verbose_name = 'IP Address'
verbose_name_plural = 'IP Addresses'
verbose_name_plural = 'IP Addresses'
class RevokedGatewaySession(models.Model):
"""Session ended from the WireGuard WebAdmin. Kept until the session would have expired."""
session_hash = models.CharField(max_length=64, unique=True)
username = models.CharField(max_length=254, blank=True)
expires_at = models.DateTimeField()
created = models.DateTimeField(auto_now_add=True)
uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)
def __str__(self):
return f'{self.username or "-"} ({self.session_hash[:12]})'
+126
View File
@@ -0,0 +1,126 @@
"""Sessions of the auth-gateway: published by each gateway, listed and revoked from the WireGuard WebAdmin."""
import ipaddress
import json
import os
import re
from django.utils import timezone
from django.utils.dateparse import parse_datetime
from app_gateway.caddy_config_export import CADDY_EXPORT_DIR
from cluster.models import Worker
from gatekeeper.models import RevokedGatewaySession
PRIMARY_SESSIONS_FILE = os.path.join('state', 'sessions.json')
REVOKED_SESSIONS_FILE = 'revoked_sessions.json'
MAX_REPORTED_SESSIONS = 5000
SESSION_ID_PATTERN = re.compile(r'^[a-f0-9]{64}$')
TEXT_FIELDS = ('username', 'email', 'host', 'client_ip', 'user_agent', 'created_at', 'expires_at', 'last_seen')
LIST_FIELDS = ('groups', 'factors')
def get_export_dir():
return CADDY_EXPORT_DIR
def clean_gateway_sessions(sessions):
"""Keep only the known fields of the sessions published by a gateway."""
cleaned = []
for session in sessions[:MAX_REPORTED_SESSIONS]:
if not isinstance(session, dict) or not SESSION_ID_PATTERN.match(str(session.get('id', ''))):
continue
entry = {'id': session['id'], 'online': session.get('online') is True}
for field in TEXT_FIELDS:
if isinstance(session.get(field), str):
entry[field] = session[field][:254]
for field in LIST_FIELDS:
values = session.get(field)
entry[field] = [str(value)[:64] for value in values[:50]] if isinstance(values, list) else []
cleaned.append(entry)
return cleaned
def load_primary_sessions(export_dir=None):
"""Sessions published by the auth-gateway of this primary server, or None when it published none."""
try:
with open(os.path.join(export_dir or get_export_dir(), PRIMARY_SESSIONS_FILE), 'r', encoding='utf-8') as sessions_file:
sessions = json.load(sessions_file).get('sessions')
except (OSError, ValueError, AttributeError):
return None
return clean_gateway_sessions(sessions) if isinstance(sessions, list) else None
def ip_sort_key(value):
"""Value that sorts IP addresses numerically in the sessions table (IPv4, then IPv6, then anything else)."""
try:
address = ipaddress.ip_address(value)
except ValueError:
return f'9-{value}'
return f'{address.version - 4}-{int(address):039d}'
def _describe(session, server_name, server_key, stale, reported_at, revoked_hashes):
return dict(
session,
server_name=server_name,
server_key=server_key,
stale=stale,
reported_at=reported_at,
revoking=session['id'] in revoked_hashes,
created=parse_datetime(session.get('created_at', '')),
expires=parse_datetime(session.get('expires_at', '')),
last_seen_at=parse_datetime(session.get('last_seen', '')) if session.get('last_seen') else None,
client_ip_order=ip_sort_key(session.get('client_ip', '')),
)
def get_active_sessions(export_dir=None):
"""Sessions of the primary server and of every worker. Worker sessions are the last ones it reported."""
revoked_hashes = set(RevokedGatewaySession.objects.filter(expires_at__gt=timezone.now()).values_list('session_hash', flat=True))
rows = [
_describe(session, None, 'primary', False, None, revoked_hashes)
for session in load_primary_sessions(export_dir) or []
]
for worker in Worker.objects.select_related('workerstatus').order_by('name'):
worker_status = getattr(worker, 'workerstatus', None)
if not worker_status or not worker_status.gateway_sessions:
continue
stale = not worker.enabled or not worker_status.is_online
for session in worker_status.gateway_sessions:
rows.append(_describe(
session, worker.display_name, str(worker.uuid), stale, worker_status.gateway_sessions_updated, revoked_hashes,
))
rows.sort(key=lambda row: (not row['online'], row.get('username') or row.get('email') or '', row['server_key']))
return rows
def build_revoked_sessions_data():
hashes = RevokedGatewaySession.objects.filter(expires_at__gt=timezone.now()).values_list('session_hash', flat=True)
return {'sessions': sorted(hashes)}
def write_revoked_sessions(export_dir=None):
"""Publish the revoked sessions to the auth-gateway of this primary server (workers get them by the cluster)."""
RevokedGatewaySession.objects.filter(expires_at__lte=timezone.now()).delete()
export_dir = export_dir or get_export_dir()
if not os.path.isdir(export_dir):
return
target = os.path.join(export_dir, REVOKED_SESSIONS_FILE)
temp_path = f'{target}.tmp'
with open(temp_path, 'w', encoding='utf-8') as revoked_file:
json.dump(build_revoked_sessions_data(), revoked_file, indent=2)
revoked_file.write('\n')
os.replace(temp_path, target)
def revoke_session(session_hash, export_dir=None):
"""End a session listed by get_active_sessions. Return the revoked session, or None when it is not listed."""
session = next((row for row in get_active_sessions(export_dir) if row['id'] == session_hash), None)
if not session or not session['expires']:
return None
RevokedGatewaySession.objects.update_or_create(
session_hash=session_hash,
defaults={'username': session.get('username') or session.get('email') or '', 'expires_at': session['expires']},
)
write_revoked_sessions(export_dir)
return session
+141 -1
View File
@@ -1 +1,141 @@
# Create your tests here.
import json
import os
import tempfile
from datetime import timedelta
from unittest.mock import patch
from django.contrib.auth.models import User
from django.test import TestCase
from django.utils import timezone
from cluster.models import Worker, WorkerStatus
from cluster.sync import build_gateway_section
from gatekeeper.models import RevokedGatewaySession
from gatekeeper.sessions import (
REVOKED_SESSIONS_FILE,
build_revoked_sessions_data,
clean_gateway_sessions,
get_active_sessions,
)
from user_manager.models import UserAcl
PRIMARY_ID = 'a' * 64
WORKER_ID = 'b' * 64
def gateway_session(session_id, username='alice', online=True, expires_in_hours=6):
session = {
'id': session_id,
'username': username,
'email': f'{username}@example.test',
'groups': ['staff'],
'factors': ['password'],
'host': 'app.example.test',
'client_ip': '203.0.113.5',
'user_agent': 'test',
'created_at': timezone.now().isoformat(),
'expires_at': (timezone.now() + timedelta(hours=expires_in_hours)).isoformat(),
'online': online,
}
if not online:
session['last_seen'] = (timezone.now() - timedelta(minutes=30)).isoformat()
return session
class GatewaySessionsTestMixin:
"""Primary server sessions in a temporary export directory and one worker reporting its sessions."""
def setUp(self):
super().setUp()
temp_dir = tempfile.TemporaryDirectory()
self.addCleanup(temp_dir.cleanup)
self.export_dir = temp_dir.name
patcher = patch('gatekeeper.sessions.CADDY_EXPORT_DIR', self.export_dir)
patcher.start()
self.addCleanup(patcher.stop)
os.makedirs(os.path.join(self.export_dir, 'state'))
with open(os.path.join(self.export_dir, 'state', 'sessions.json'), 'w', encoding='utf-8') as sessions_file:
json.dump({'sessions': [gateway_session(PRIMARY_ID)]}, sessions_file)
self.worker = Worker.objects.create(name='node-a', hostname='node-a.example.test')
WorkerStatus.objects.create(
worker=self.worker, gateway_sessions=[gateway_session(WORKER_ID, username='bob', online=False)],
gateway_sessions_updated=timezone.now(),
)
def read_revoked_file(self):
with open(os.path.join(self.export_dir, REVOKED_SESSIONS_FILE), 'r', encoding='utf-8') as revoked_file:
return json.load(revoked_file)['sessions']
class GatewaySessionDataTests(GatewaySessionsTestMixin, TestCase):
def test_reported_sessions_keep_only_known_fields(self):
cleaned = clean_gateway_sessions([
dict(gateway_session(PRIMARY_ID), session_id='secret', extra='x', groups=['g'] * 80),
{'id': 'not-a-hash', 'username': 'mallory'},
'not a session',
])
self.assertEqual(len(cleaned), 1)
self.assertNotIn('session_id', cleaned[0])
self.assertNotIn('extra', cleaned[0])
self.assertEqual(len(cleaned[0]['groups']), 50)
def test_active_sessions_list_primary_and_workers(self):
sessions = {session['id']: session for session in get_active_sessions()}
self.assertEqual(set(sessions), {PRIMARY_ID, WORKER_ID})
self.assertIsNone(sessions[PRIMARY_ID]['server_name'])
self.assertEqual(sessions[WORKER_ID]['server_name'], self.worker.display_name)
self.assertFalse(sessions[WORKER_ID]['online'])
self.assertIsNotNone(sessions[WORKER_ID]['last_seen_at'])
def test_sessions_of_offline_workers_are_marked(self):
WorkerStatus.objects.filter(worker=self.worker).update(last_seen=timezone.now() - timedelta(minutes=20))
sessions = {session['id']: session for session in get_active_sessions()}
self.assertTrue(sessions[WORKER_ID]['stale'])
self.assertFalse(sessions[PRIMARY_ID]['stale'])
def test_revoked_sessions_only_list_sessions_not_expired(self):
RevokedGatewaySession.objects.create(session_hash=PRIMARY_ID, expires_at=timezone.now() + timedelta(hours=1))
RevokedGatewaySession.objects.create(session_hash=WORKER_ID, expires_at=timezone.now() - timedelta(hours=1))
self.assertEqual(build_revoked_sessions_data(), {'sessions': [PRIMARY_ID]})
def test_gateway_section_carries_revoked_sessions_to_workers(self):
RevokedGatewaySession.objects.create(session_hash=WORKER_ID, expires_at=timezone.now() + timedelta(hours=1))
section = build_gateway_section(self.worker)
self.assertEqual(json.loads(section.files[REVOKED_SESSIONS_FILE])['sessions'], [WORKER_ID])
class RevokeSessionViewTests(GatewaySessionsTestMixin, TestCase):
def setUp(self):
super().setUp()
self.admin = User.objects.create_user(username='admin', password='unused')
UserAcl.objects.create(user=self.admin, user_level=50)
self.client.force_login(self.admin)
def test_revoking_a_worker_session_publishes_it(self):
response = self.client.post('/gatekeeper/session/revoke/', {'session': WORKER_ID})
self.assertRedirects(response, '/gatekeeper/?tab=sessions', fetch_redirect_response=False)
revoked = RevokedGatewaySession.objects.get(session_hash=WORKER_ID)
self.assertEqual(revoked.username, 'bob')
self.assertEqual(self.read_revoked_file(), [WORKER_ID])
self.assertTrue(next(session for session in get_active_sessions() if session['id'] == WORKER_ID)['revoking'])
def test_unknown_session_is_not_revoked(self):
self.client.post('/gatekeeper/session/revoke/', {'session': 'c' * 64})
self.assertFalse(RevokedGatewaySession.objects.exists())
def test_revoke_requires_post(self):
self.assertEqual(self.client.get('/gatekeeper/session/revoke/', {'session': WORKER_ID}).status_code, 405)
self.assertFalse(RevokedGatewaySession.objects.exists())
def test_revoke_requires_level_50(self):
UserAcl.objects.filter(user=self.admin).update(user_level=40)
self.client.post('/gatekeeper/session/revoke/', {'session': WORKER_ID})
self.assertFalse(RevokedGatewaySession.objects.exists())
def test_sessions_tab_lists_sessions(self):
UserAcl.objects.filter(user=self.admin).update(user_level=20)
content = self.client.get('/gatekeeper/?tab=sessions').content.decode()
self.assertIn('alice@example.test', content)
self.assertIn('bob@example.test', content)
+3
View File
@@ -30,4 +30,7 @@ urlpatterns = [
# Gatekeeper IP Addresses
path('ip/manage/', views.view_manage_gatekeeper_ip, name='manage_gatekeeper_ip'),
path('ip/delete/', views.view_delete_gatekeeper_ip, name='delete_gatekeeper_ip'),
# Gateway sessions
path('session/revoke/', views.view_revoke_gatekeeper_session, name='revoke_gatekeeper_session'),
]
+19
View File
@@ -9,6 +9,7 @@ from django.http import HttpResponse
from django.shortcuts import render, get_object_or_404, redirect
from django.urls import reverse
from django.utils.translation import gettext as _
from django.views.decorators.http import require_POST
from app_gateway.caddy_config_export import auto_apply_caddy_config, caddy_export_pending
from app_gateway.setup_defaults import create_default_entries
@@ -16,6 +17,7 @@ from gatekeeper.forms import GatekeeperUserForm, GatekeeperGroupForm, AuthMethod
AuthMethodAllowedEmailForm, GatekeeperIPAddressForm
from gatekeeper.models import GatekeeperUser, GatekeeperGroup, AuthMethod, AuthMethodAllowedDomain, \
AuthMethodAllowedEmail, GatekeeperIPAddress
from gatekeeper.sessions import get_active_sessions, revoke_session
from user_manager.models import UserAcl
@@ -44,10 +46,27 @@ def view_gatekeeper_list(request):
'active_tab': active_tab,
'caddy_enabled': settings.CADDY_ENABLED,
'pending_export': caddy_export_pending(),
'gateway_sessions': get_active_sessions() if active_tab == 'sessions' else [],
}
return render(request, 'gatekeeper/gatekeeper_list.html', context)
@login_required
@require_POST
def view_revoke_gatekeeper_session(request):
if not UserAcl.objects.filter(user=request.user).filter(user_level__gte=50).exists():
return render(request, 'access_denied.html', {'page_title': _('Access Denied')})
session = revoke_session(request.POST.get('session', ''))
if session:
messages.success(request, _('Session ended|The session of %(user)s ends on its server within a minute.') % {
'user': session.get('username') or session.get('email') or '-'
})
else:
messages.warning(request, _('Session not found|The session is no longer active.'))
return redirect(reverse('gatekeeper_list') + '?tab=sessions')
@login_required
def view_manage_gatekeeper_user(request):
if not UserAcl.objects.filter(user=request.user).filter(user_level__gte=50).exists():