mirror of
https://github.com/eitchtee/WYGIWYH.git
synced 2026-11-19 23:28:54 +01:00
Merge pull request #615 from eitchtee/fix/oidc-unverified-email-autoconnect
feat(auth): make OIDC email trust configurable
This commit is contained in:
5 files changed
+126
-60
No files matched your search
@@ -38,6 +38,9 @@ TASK_WORKERS=1 # This only work if you're using the single container option. Inc
|
||||
#OIDC_CLIENT_SECRET=""
|
||||
#OIDC_SERVER_URL=""
|
||||
#OIDC_ALLOW_SIGNUP=true
|
||||
# Trust all provider emails, including false or missing email_verified claims.
|
||||
# Set to false to require provider-verified emails before linking existing accounts.
|
||||
#OIDC_TRUST_EMAIL=true
|
||||
|
||||
# Personal access tokens. How often (seconds) a token's last_used_at is rewritten.
|
||||
#API_TOKEN_LAST_USED_UPDATE_INTERVAL=600
|
||||
|
||||
@@ -158,9 +158,11 @@ WYGIWYH supports login via OpenID Connect (OIDC) through `django-allauth`. This
|
||||
> Currently only OpenID Connect is supported as a provider, open an issue if you need something else.
|
||||
|
||||
> [!Caution]
|
||||
> WYGIWYH automatically connects OIDC accounts to existing local accounts with matching email addresses.
|
||||
> By default, WYGIWYH automatically connects OIDC accounts to existing local accounts with matching email addresses.
|
||||
> This means if a user already exists with email `user@example.com` and someone logs in via OIDC with the same email, the OIDC account will be automatically linked to the existing account without requiring user confirmation.
|
||||
> This is only recommended for trusted OIDC providers that verify email addresses and where you control who can create accounts.
|
||||
> Set `OIDC_TRUST_EMAIL=false` to only link accounts when your provider marks the email as verified (`email_verified` claim).
|
||||
> The default `OIDC_TRUST_EMAIL=true` preserves existing behavior: emails are trusted even when `email_verified` is explicitly false or missing. If the issuer allows users to claim another person's email, this can allow account takeover, including administrator accounts. Email matching is case-insensitive in both modes.
|
||||
|
||||
### Configuration
|
||||
|
||||
@@ -173,6 +175,7 @@ To configure OIDC, you need to set the following environment variables:
|
||||
| `OIDC_CLIENT_SECRET` | The Client Secret provided by your OIDC provider. |
|
||||
| `OIDC_SERVER_URL` | The base URL of your OIDC provider's discovery document or authorization server (e.g., `https://your-provider.com/auth/realms/your-realm`). `django-allauth` will use this to discover the necessary endpoints (authorization, token, userinfo, etc.). |
|
||||
| `OIDC_ALLOW_SIGNUP` | Allow the automatic creation of inexistent accounts on a successfull authentication. Defaults to `true`. |
|
||||
| `OIDC_TRUST_EMAIL` | Treat every email sent by your provider as verified, linking it to a matching existing local account even without the `email_verified` claim. Set to `false` to only link verified emails. Defaults to `true`. |
|
||||
|
||||
**Callback URL (Redirect URI):**
|
||||
|
||||
|
||||
@@ -372,6 +372,11 @@ if (
|
||||
"secret": os.getenv("OIDC_CLIENT_SECRET"),
|
||||
"settings": {
|
||||
"server_url": os.getenv("OIDC_SERVER_URL"),
|
||||
# When true, every email from the provider is treated as
|
||||
# verified and auto-linked to a matching local account. When
|
||||
# false, only emails with email_verified=true are linked.
|
||||
"verified_email": os.getenv("OIDC_TRUST_EMAIL", "true").lower()
|
||||
== "true",
|
||||
},
|
||||
}
|
||||
)
|
||||
|
||||
+15
-58
@@ -1,75 +1,32 @@
|
||||
import logging
|
||||
|
||||
from allauth.socialaccount.adapter import DefaultSocialAccountAdapter
|
||||
from django.contrib.auth import get_user_model
|
||||
|
||||
User = get_user_model()
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class AutoConnectSocialAccountAdapter(DefaultSocialAccountAdapter):
|
||||
"""
|
||||
Custom adapter to automatically connect social accounts to existing users
|
||||
with the same email address.
|
||||
"""Link verified (or provider-trusted) emails case-insensitively.
|
||||
|
||||
SECURITY WARNING:
|
||||
This adapter automatically connects OIDC accounts to existing local accounts
|
||||
based on email matching.
|
||||
|
||||
If your OIDC provider allows unverified emails, this could lead to
|
||||
ACCOUNT TAKEOVER attacks where an attacker creates an OIDC account
|
||||
with someone else's email and gains access to their account.
|
||||
OIDC_TRUST_EMAIL=true makes allauth treat every provider email as verified.
|
||||
Only use that mode with an issuer that guarantees email ownership.
|
||||
"""
|
||||
|
||||
def pre_social_login(self, request, sociallogin):
|
||||
"""
|
||||
Invoked just after a user successfully authenticates via a
|
||||
social provider, but before the login is actually processed.
|
||||
|
||||
If a user with the same email already exists, connect the social
|
||||
account to that existing user instead of creating a new account.
|
||||
"""
|
||||
# If the social account is already connected to a user, do nothing
|
||||
if sociallogin.is_existing:
|
||||
return
|
||||
|
||||
# Check if we have an email from the social provider
|
||||
if not sociallogin.email_addresses:
|
||||
logger.warning(
|
||||
"OIDC login attempted without email address. "
|
||||
f"Provider: {sociallogin.account.provider}"
|
||||
)
|
||||
return
|
||||
for address in sociallogin.email_addresses:
|
||||
if not address.verified:
|
||||
continue
|
||||
try:
|
||||
user = get_user_model().objects.get(email__iexact=address.email)
|
||||
except get_user_model().DoesNotExist:
|
||||
continue
|
||||
except get_user_model().MultipleObjectsReturned:
|
||||
logger.error("Multiple local users match OIDC email; blocking auto-connect.")
|
||||
return
|
||||
|
||||
# Get the email from the social login
|
||||
email = sociallogin.email_addresses[0].email.lower()
|
||||
|
||||
# Try to find an existing user with this email
|
||||
try:
|
||||
user = User.objects.get(email__iexact=email)
|
||||
|
||||
# Log this connection for security audit trail
|
||||
logger.info(
|
||||
f"Auto-connecting OIDC account to existing user. "
|
||||
f"Email: {email}, Provider: {sociallogin.account.provider}, "
|
||||
f"User ID: {user.id}"
|
||||
)
|
||||
|
||||
# Connect the social account to the existing user
|
||||
sociallogin.connect(request, user)
|
||||
|
||||
except User.DoesNotExist:
|
||||
# No user with this email exists, proceed with normal signup flow
|
||||
logger.debug(
|
||||
f"No existing user found for email {email}. "
|
||||
"Proceeding with new account creation."
|
||||
)
|
||||
pass
|
||||
except User.MultipleObjectsReturned:
|
||||
# Multiple users with the same email (shouldn't happen with unique constraint)
|
||||
logger.error(
|
||||
f"Multiple users found with email {email}. "
|
||||
"This should not happen with unique constraint. "
|
||||
"Blocking auto-connect."
|
||||
)
|
||||
# Let the default behavior handle this
|
||||
pass
|
||||
return
|
||||
+99
-1
@@ -1,5 +1,5 @@
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.test import TestCase
|
||||
from django.test import TestCase, override_settings
|
||||
from django.urls import reverse
|
||||
from django.utils import timezone
|
||||
|
||||
@@ -71,3 +71,101 @@ class UserAPITokenViewsTests(TestCase):
|
||||
|
||||
self.assertEqual(response.status_code, 404)
|
||||
self.assertTrue(APIToken.objects.filter(id=token.id).exists())
|
||||
|
||||
|
||||
def _oidc_providers(trust_email=False):
|
||||
return {
|
||||
"openid_connect": {
|
||||
"APPS": [
|
||||
{
|
||||
"provider_id": "test-oidc",
|
||||
"name": "Test OIDC",
|
||||
"client_id": "client",
|
||||
"secret": "secret",
|
||||
"settings": {
|
||||
"server_url": "https://idp.example.com",
|
||||
"verified_email": trust_email,
|
||||
},
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
class OIDCEmailAutoConnectTests(TestCase):
|
||||
"""GHSA-prgm-wrjv-fvrh: OIDC logins must only link to existing local
|
||||
accounts by email when the email is verified (or explicitly trusted)."""
|
||||
|
||||
def setUp(self):
|
||||
self.victim = get_user_model().objects.create_superuser(
|
||||
email="Victim@example.com", password="victim-password"
|
||||
)
|
||||
|
||||
def _login(self, claims):
|
||||
from allauth.core import context
|
||||
from allauth.socialaccount.adapter import get_adapter
|
||||
from allauth.socialaccount.helpers import complete_social_login
|
||||
from allauth.socialaccount.models import SocialLogin
|
||||
from django.contrib.messages.middleware import MessageMiddleware
|
||||
from django.contrib.sessions.middleware import SessionMiddleware
|
||||
from django.contrib.auth.models import AnonymousUser
|
||||
from django.test import RequestFactory
|
||||
|
||||
request = RequestFactory().get("/auth/oidc/test-oidc/login/callback/")
|
||||
SessionMiddleware(lambda r: None).process_request(request)
|
||||
MessageMiddleware(lambda r: None).process_request(request)
|
||||
request.user = AnonymousUser()
|
||||
|
||||
provider = get_adapter().get_provider(request, "test-oidc")
|
||||
sociallogin = provider.sociallogin_from_response(request, claims)
|
||||
sociallogin.state = SocialLogin.state_from_request(request)
|
||||
with context.request_context(request):
|
||||
complete_social_login(request, sociallogin)
|
||||
return request
|
||||
|
||||
def _assert_not_linked(self, request):
|
||||
from allauth.socialaccount.models import SocialAccount
|
||||
|
||||
self.assertFalse(SocialAccount.objects.filter(user=self.victim).exists())
|
||||
self.assertNotEqual(
|
||||
request.session.get("_auth_user_id"), str(self.victim.pk)
|
||||
)
|
||||
|
||||
def _assert_linked(self, request):
|
||||
from allauth.socialaccount.models import SocialAccount
|
||||
|
||||
self.assertTrue(
|
||||
SocialAccount.objects.filter(user=self.victim, uid="oidc-uid").exists()
|
||||
)
|
||||
self.assertEqual(request.session.get("_auth_user_id"), str(self.victim.pk))
|
||||
|
||||
@override_settings(SOCIALACCOUNT_PROVIDERS=_oidc_providers())
|
||||
def test_unverified_email_is_not_linked(self):
|
||||
request = self._login(
|
||||
{"sub": "oidc-uid", "email": "victim@example.com", "email_verified": False}
|
||||
)
|
||||
self._assert_not_linked(request)
|
||||
|
||||
@override_settings(SOCIALACCOUNT_PROVIDERS=_oidc_providers())
|
||||
def test_missing_email_verified_claim_is_not_linked(self):
|
||||
request = self._login({"sub": "oidc-uid", "email": "VICTIM@example.com"})
|
||||
self._assert_not_linked(request)
|
||||
|
||||
@override_settings(SOCIALACCOUNT_PROVIDERS=_oidc_providers())
|
||||
def test_verified_email_is_linked(self):
|
||||
request = self._login(
|
||||
{"sub": "oidc-uid", "email": "victim@example.com", "email_verified": True}
|
||||
)
|
||||
self._assert_linked(request)
|
||||
|
||||
@override_settings(SOCIALACCOUNT_PROVIDERS=_oidc_providers(trust_email=True))
|
||||
def test_trusted_provider_links_without_email_verified_claim(self):
|
||||
request = self._login({"sub": "oidc-uid", "email": "victim@example.com"})
|
||||
self._assert_linked(request)
|
||||
|
||||
@override_settings(SOCIALACCOUNT_PROVIDERS=_oidc_providers(trust_email=True))
|
||||
def test_trusted_provider_links_explicitly_unverified_email(self):
|
||||
request = self._login(
|
||||
{"sub": "oidc-uid", "email": "victim@example.com", "email_verified": False}
|
||||
)
|
||||
self._assert_linked(request)
|
||||
Reference in new issue
Block a user