Self hosted FLOSS fitness/workout, nutrition and weight tracker
Add auth proxy headers for email and name
Roland Geiderf9b1b8813bcd
diff --git a/extras/docker/production/settings.py b/extras/docker/production/settings.pyindex c9a501597..b3bc64862 100644--- a/extras/docker/production/settings.py+++ b/extras/docker/production/settings.py@@ -108,6 +108,8 @@ WGER_SETTINGS["USE_CELERY"] = env.bool("USE_CELERY", False)AUTH_PROXY_HEADER = env.str("AUTH_PROXY_HEADER", '')AUTH_PROXY_TRUSTED_IPS = env.list("AUTH_PROXY_TRUSTED_IPS", default=[])AUTH_PROXY_CREATE_UNKNOWN_USER = env.bool("AUTH_PROXY_CREATE_UNKNOWN_USER", False)+AUTH_PROXY_USER_EMAIL_HEADER = env.str("AUTH_PROXY_USER_EMAIL_HEADER", '')+AUTH_PROXY_USER_NAME_HEADER = env.str("AUTH_PROXY_USER_NAME_HEADER", '')# Cacheif os.environ.get("DJANGO_CACHE_BACKEND"):diff --git a/wger/core/backends.py b/wger/core/backends.pyindex 76260f146..b2d1cdee2 100644--- a/wger/core/backends.py+++ b/wger/core/backends.py@@ -20,7 +20,6 @@ from django.conf import settingsfrom django.contrib.auth import get_user_modelfrom django.contrib.auth.backends import BaseBackend-logger = logging.getLogger(__name__)User = get_user_model()@@ -31,7 +30,13 @@ class AuthProxyUserBackend(BaseBackend):Relies on the middleware to ensure the header comes from a trusted source."""- def authenticate(self, request, username=None):+ def authenticate(+ self,+ request,+ username: str | None = None,+ email: str | None = None,+ name: str | None = None,+ ):"""Authenticate the user based on the username provided.The middleware ensures this is only called when the source is trusted.@@ -40,7 +45,7 @@ class AuthProxyUserBackend(BaseBackend):# This backend requires a username passed explicitlyreturn None- create_unknown_user = getattr(settings, 'AUTH_PROXY_CREATE_UNKNOWN_USER', True)+ create_unknown_user = getattr(settings, 'AUTH_PROXY_CREATE_UNKNOWN_USER', False)user = Nonetry:@@ -49,7 +54,7 @@ class AuthProxyUserBackend(BaseBackend):except User.DoesNotExist:if create_unknown_user:try:- user = User.objects.create_user(username=username)+ user = User.objects.create_user(username=username, email=email, first_name=name)logger.info(f"AuthProxy: Created new user '{username}'")except Exception as e:logger.error(f"AuthProxy: Failed to create user '{username}': {e}")diff --git a/wger/core/middleware.py b/wger/core/middleware.pyindex 84e3f107d..fe529e759 100644--- a/wger/core/middleware.py+++ b/wger/core/middleware.py@@ -48,6 +48,8 @@ class AuthProxyHeaderMiddleware(MiddlewareMixin):def process_request(self, request):header_key = getattr(settings, 'AUTH_PROXY_HEADER', None)+ user_email_key = getattr(settings, 'AUTH_PROXY_USER_EMAIL_HEADER', None)+ user_name_key = getattr(settings, 'AUTH_PROXY_USER_NAME_HEADER', None)trusted_ips = set(getattr(settings, 'AUTH_PROXY_TRUSTED_IPS', []))# Skip processing if not configured@@ -80,6 +82,8 @@ class AuthProxyHeaderMiddleware(MiddlewareMixin):return Noneusername = request.META.get(header_key)+ email = request.META.get(user_email_key, '') if user_email_key else None+ name = request.META.get(user_name_key, '') if user_name_key else Noneif not username:# Trusted IP, but no header. Could mean proxy auth failed upstream.# Log, but otherwise do nothing.@@ -106,7 +110,7 @@ class AuthProxyHeaderMiddleware(MiddlewareMixin):logout(request)# Authenticate using our custom backend- user = authenticate(request, username=username)+ user = authenticate(request, username=username, email=email, name=name)if user:# Authentication successful, log the user in.diff --git a/wger/core/tests/test_auth_proxy_middleware.py b/wger/core/tests/test_auth_proxy_middleware.pyindex b54719d08..b1fc8f772 100644--- a/wger/core/tests/test_auth_proxy_middleware.py+++ b/wger/core/tests/test_auth_proxy_middleware.py@@ -28,6 +28,8 @@ TRUSTED_IP = '192.0.2.1'UNTRUSTED_IP = '198.51.100.5'PROXY_HEADER_KEY = 'HTTP_X_REMOTE_USER'+PROXY_EMAIL_HEADER_KEY = 'HTTP_X_REMOTE_USER_EMAIL'+PROXY_NAME_HEADER_KEY = 'HTTP_X_REMOTE_USER_NAME'USERNAME = 'admin'NEW_USER_VALUE = 'auth_proxy_user'@@ -48,10 +50,22 @@ class AuthProxyMiddlewareTests(TestCase):self.login_url = reverse('core:user:login')# Helper to make requests with specific IP and header- def make_request(self, ip_addr, header_value=None):+ def make_request(+ self,+ ip_addr: str,+ proxy_header_value: str | None = None,+ email_header_value: str | None = None,+ name_header_value: str | None = None,+ ):headers = {}- if header_value:- headers[PROXY_HEADER_KEY] = header_value+ if proxy_header_value:+ headers[PROXY_HEADER_KEY] = proxy_header_value++ if email_header_value:+ headers[PROXY_EMAIL_HEADER_KEY] = email_header_value++ if name_header_value:+ headers[PROXY_NAME_HEADER_KEY] = name_header_valuereturn self.client.get(self.protected_url, REMOTE_ADDR=ip_addr, follow=True, **headers)@@ -71,16 +85,25 @@ class AuthProxyMiddlewareTests(TestCase):AUTH_PROXY_TRUSTED_IPS=[TRUSTED_IP],AUTH_PROXY_HEADER=PROXY_HEADER_KEY,AUTH_PROXY_CREATE_UNKNOWN_USER=True,+ AUTH_PROXY_USER_EMAIL_HEADER=PROXY_EMAIL_HEADER_KEY,+ AUTH_PROXY_USER_NAME_HEADER=PROXY_NAME_HEADER_KEY,)def test_success_trusted_ip_new_user_created(self):self.assertFalse(User.objects.filter(username=NEW_USER_VALUE).exists())- response = self.make_request(TRUSTED_IP, NEW_USER_VALUE)+ response = self.make_request(+ TRUSTED_IP,+ proxy_header_value=NEW_USER_VALUE,+ email_header_value='[email protected]',+ name_header_value='Admin User',+ )self.assertEqual(response.status_code, 200)- # Verify user was created- newly_created_user = User.objects.filter(username=NEW_USER_VALUE).first()- self.assertIsNotNone(newly_created_user)- self.assertEqual(int(self.client.session['_auth_user_id']), newly_created_user.pk)+ # Verify the user was created with the correct values+ new_user = User.objects.filter(username=NEW_USER_VALUE).first()+ self.assertIsNotNone(new_user)+ self.assertEqual(new_user.email, '[email protected]')+ self.assertEqual(new_user.first_name, 'Admin User')+ self.assertEqual(int(self.client.session['_auth_user_id']), new_user.pk)@override_settings(AUTH_PROXY_HEADER=PROXY_HEADER_KEY,@@ -102,7 +125,7 @@ class AuthProxyMiddlewareTests(TestCase):)def test_failure_trusted_ip_header_missing(self):"""Should redirect to login"""- response = self.make_request(TRUSTED_IP, header_value=None)+ response = self.make_request(TRUSTED_IP, proxy_header_value=None)self.assertEqual(response.status_code, 200)self.assertTrue(response.request['PATH_INFO'].startswith(self.login_url))diff --git a/wger/settings_global.py b/wger/settings_global.pyindex 266dba548..a7d2522e9 100644--- a/wger/settings_global.py+++ b/wger/settings_global.py@@ -562,6 +562,8 @@ WGER_SETTINGS = {# https://wger.readthedocs.io/en/latest/administration/auth_proxy.html#AUTH_PROXY_HEADER = ''+AUTH_PROXY_USER_EMAIL_HEADER = ''+AUTH_PROXY_USER_NAME_HEADER = ''AUTH_PROXY_TRUSTED_IPS = []AUTH_PROXY_CREATE_UNKNOWN_USER = False