Mail

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/authentiq/provider.py

@@ -0,0 +1,110 @@
+from allauth.account.models import EmailAddress
+from allauth.socialaccount import app_settings
+from allauth.socialaccount.providers.base import AuthAction, ProviderAccount
+from allauth.socialaccount.providers.oauth2.provider import OAuth2Provider
+
+
+class Scope(object):
+    NAME = "aq:name"
+    EMAIL = "email"
+    PHONE = "phone"
+    ADDRESS = "address"
+    LOCATION = "aq:location"
+    PUSH = "aq:push"
+
+
+IDENTITY_CLAIMS = frozenset(
+    [
+        "sub",
+        "name",
+        "given_name",
+        "family_name",
+        "middle_name",
+        "nickname",
+        "preferred_username",
+        "profile",
+        "picture",
+        "website",
+        "email",
+        "email_verified",
+        "gender",
+        "birthdate",
+        "zoneinfo",
+        "locale",
+        "phone_number",
+        "phone_number_verified",
+        "address",
+        "updated_at",
+        "aq:location",
+    ]
+)
+
+
+class AuthentiqAccount(ProviderAccount):
+    def get_profile_url(self):
+        return self.account.extra_data.get("profile")
+
+    def get_avatar_url(self):
+        return self.account.extra_data.get("picture")
+
+    def to_str(self):
+        dflt = super(AuthentiqAccount, self).to_str()
+        return self.account.extra_data.get("name", dflt)
+
+
+class AuthentiqProvider(OAuth2Provider):
+    id = "authentiq"
+    name = "Authentiq"
+    account_class = AuthentiqAccount
+
+    def get_scope(self, request):
+        scope = set(super(AuthentiqProvider, self).get_scope(request))
+        scope.add("openid")
+
+        if Scope.EMAIL in scope:
+            modifiers = ""
+            if app_settings.EMAIL_REQUIRED:
+                modifiers += "r"
+            if app_settings.EMAIL_VERIFICATION:
+                modifiers += "s"
+            if modifiers:
+                scope.add(Scope.EMAIL + "~" + modifiers)
+                scope.remove(Scope.EMAIL)
+        return list(scope)
+
+    def get_default_scope(self):
+        scope = [Scope.NAME, Scope.PUSH]
+        if app_settings.QUERY_EMAIL:
+            scope.append(Scope.EMAIL)
+        return scope
+
+    def get_auth_params(self, request, action):
+        ret = super(AuthentiqProvider, self).get_auth_params(request, action)
+        if action == AuthAction.REAUTHENTICATE:
+            ret["prompt"] = "select_account"
+        return ret
+
+    def extract_uid(self, data):
+        return str(data["sub"])
+
+    def extract_common_fields(self, data):
+        return dict(
+            username=data.get("preferred_username", data.get("given_name")),
+            email=data.get("email"),
+            name=data.get("name"),
+            first_name=data.get("given_name"),
+            last_name=data.get("family_name"),
+        )
+
+    def extract_extra_data(self, data):
+        return {k: v for k, v in data.items() if k in IDENTITY_CLAIMS}
+
+    def extract_email_addresses(self, data):
+        ret = []
+        email = data.get("email")
+        if email and data.get("email_verified"):
+            ret.append(EmailAddress(email=email, verified=True, primary=True))
+        return ret
+
+
+provider_classes = [AuthentiqProvider]

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/authentiq/tests.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, unicode_literals
+
+import json
+
+from django.test.client import RequestFactory
+from django.test.utils import override_settings
+
+from allauth.socialaccount.tests import OAuth2TestsMixin
+from allauth.tests import MockedResponse, TestCase
+
+from .provider import AuthentiqProvider
+from .views import AuthentiqOAuth2Adapter
+
+
+class AuthentiqTests(OAuth2TestsMixin, TestCase):
+    provider_id = AuthentiqProvider.id
+
+    def get_mocked_response(self):
+        return MockedResponse(
+            200,
+            json.dumps(
+                {
+                    "sub": "ZLARGMFT1M",
+                    "email": "jane@email.invalid",
+                    "email_verified": True,
+                    "given_name": "Jane",
+                    "family_name": "Doe",
+                }
+            ),
+        )
+
+    def test_default_scopes_no_email(self):
+        scopes = self.provider.get_default_scope()
+        self.assertIn("aq:name", scopes)
+        self.assertNotIn("email", scopes)
+
+    @override_settings(
+        SOCIALACCOUNT_QUERY_EMAIL=True,
+    )
+    def test_default_scopes_email(self):
+        scopes = self.provider.get_default_scope()
+        self.assertIn("aq:name", scopes)
+        self.assertIn("email", scopes)
+
+    def test_scopes(self):
+        request = RequestFactory().get(AuthentiqOAuth2Adapter.authorize_url)
+        scopes = self.provider.get_scope(request)
+        self.assertIn("openid", scopes)
+        self.assertIn("aq:name", scopes)
+
+    def test_dynamic_scopes(self):
+        request = RequestFactory().get(
+            AuthentiqOAuth2Adapter.authorize_url, dict(scope="foo")
+        )
+        scopes = self.provider.get_scope(request)
+        self.assertIn("openid", scopes)
+        self.assertIn("aq:name", scopes)
+        self.assertIn("foo", scopes)
+
+    @override_settings(
+        SOCIALACCOUNT_QUERY_EMAIL=True,
+        SOCIALACCOUNT_EMAIL_REQUIRED=True,
+        SOCIALACCOUNT_EMAIL_VERIFICATION=True,
+    )
+    def test_scopes_required_verified_email(self):
+        request = RequestFactory().get(AuthentiqOAuth2Adapter.authorize_url)
+        scopes = self.provider.get_scope(request)
+        self.assertIn("email~rs", scopes)
+        self.assertNotIn("email", scopes)
+
+    @override_settings(
+        SOCIALACCOUNT_QUERY_EMAIL=True,
+        SOCIALACCOUNT_EMAIL_REQUIRED=False,
+        SOCIALACCOUNT_EMAIL_VERIFICATION=True,
+    )
+    def test_scopes_optional_verified_email(self):
+        request = RequestFactory().get(AuthentiqOAuth2Adapter.authorize_url)
+        scopes = self.provider.get_scope(request)
+        self.assertIn("email~s", scopes)
+        self.assertNotIn("email", scopes)
+
+    @override_settings(
+        SOCIALACCOUNT_QUERY_EMAIL=True,
+        SOCIALACCOUNT_EMAIL_REQUIRED=True,
+        SOCIALACCOUNT_EMAIL_VERIFICATION=False,
+    )
+    def test_scopes_required_email(self):
+        request = RequestFactory().get(AuthentiqOAuth2Adapter.authorize_url)
+        scopes = self.provider.get_scope(request)
+        self.assertIn("email~r", scopes)
+        self.assertNotIn("email", scopes)
+
+    @override_settings(
+        SOCIALACCOUNT_QUERY_EMAIL=True,
+        SOCIALACCOUNT_EMAIL_REQUIRED=False,
+        SOCIALACCOUNT_EMAIL_VERIFICATION=False,
+    )
+    def test_scopes_optional_email(self):
+        request = RequestFactory().get(AuthentiqOAuth2Adapter.authorize_url)
+        scopes = self.provider.get_scope(request)
+        self.assertIn("email", scopes)

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/authentiq/urls.py

@@ -0,0 +1,6 @@
+from allauth.socialaccount.providers.oauth2.urls import default_urlpatterns
+
+from .provider import AuthentiqProvider
+
+
+urlpatterns = default_urlpatterns(AuthentiqProvider)

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/authentiq/views.py

@@ -0,0 +1,37 @@
+import requests
+from urllib.parse import urljoin
+
+from allauth.socialaccount import app_settings
+from allauth.socialaccount.providers.oauth2.views import (
+    OAuth2Adapter,
+    OAuth2CallbackView,
+    OAuth2LoginView,
+)
+
+from .provider import AuthentiqProvider
+
+
+class AuthentiqOAuth2Adapter(OAuth2Adapter):
+    provider_id = AuthentiqProvider.id
+
+    settings = app_settings.PROVIDERS.get(provider_id, {})
+
+    provider_url = settings.get("PROVIDER_URL", "https://connect.authentiq.io/")
+    if not provider_url.endswith("/"):
+        provider_url += "/"
+
+    access_token_url = urljoin(provider_url, "token")
+    authorize_url = urljoin(provider_url, "authorize")
+    profile_url = urljoin(provider_url, "userinfo")
+
+    def complete_login(self, request, app, token, **kwargs):
+        auth = {"Authorization": "Bearer " + token.token}
+        resp = requests.get(self.profile_url, headers=auth)
+        resp.raise_for_status()
+        extra_data = resp.json()
+        login = self.get_provider().sociallogin_from_response(request, extra_data)
+        return login
+
+
+oauth2_login = OAuth2LoginView.adapter_view(AuthentiqOAuth2Adapter)
+oauth2_callback = OAuth2CallbackView.adapter_view(AuthentiqOAuth2Adapter)