"""Authentication Backends for the People core app.""" from django.conf import settings from django.core.exceptions import SuspiciousOperation from django.utils.translation import gettext_lazy as _ import requests from mozilla_django_oidc.auth import ( OIDCAuthenticationBackend as MozillaOIDCAuthenticationBackend, ) class OIDCAuthenticationBackend(MozillaOIDCAuthenticationBackend): """Custom OpenID Connect (OIDC) Authentication Backend. This class overrides the default OIDC Authentication Backend to accommodate differences in the User model, and handles signed and/or encrypted UserInfo response. """ def get_userinfo(self, access_token, id_token, payload): """Return user details dictionary. Parameters: - access_token (str): The access token. - id_token (str): The id token (unused). - payload (dict): The token payload (unused). Note: The id_token and payload parameters are unused in this implementation, but were kept to preserve base method signature. Note: It handles signed and/or encrypted UserInfo Response. It is required by Agent Connect, which follows the OIDC standard. It forces us to override the base method, which deal with 'application/json' response. Returns: - dict: User details dictionary obtained from the OpenID Connect user endpoint. """ user_response = requests.get( self.OIDC_OP_USER_ENDPOINT, headers={"Authorization": f"Bearer {access_token}"}, verify=self.get_settings("OIDC_VERIFY_SSL", True), timeout=self.get_settings("OIDC_TIMEOUT", None), proxies=self.get_settings("OIDC_PROXY", None), ) user_response.raise_for_status() userinfo = self.verify_token(user_response.text) return userinfo def get_or_create_user(self, access_token, id_token, payload): """Return a User based on userinfo. Get or create a new user if no user matches the Sub. Parameters: - access_token (str): The access token. - id_token (str): The ID token. - payload (dict): The user payload. Returns: - User: An existing or newly created User instance. Raises: - Exception: Raised when user creation is not allowed and no existing user is found. """ user_info = self.get_userinfo(access_token, id_token, payload) # Compute user name from OIDC name fields as defined in settings names_list = [ user_info[field] for field in settings.USER_OIDC_FIELDS_TO_NAME if user_info.get(field) ] user_info["name"] = " ".join(names_list) or None sub = user_info.get("sub") if sub is None: raise SuspiciousOperation( _("User info contained no recognizable user identification") ) try: user = self.UserModel.objects.get(sub=sub, is_active=True) except self.UserModel.DoesNotExist: if self.get_settings("OIDC_CREATE_USER", True): user = self.create_user(user_info) else: email = user_info.get("email") name = user_info.get("name") if email and email != user.email or name and name != user.name: self.UserModel.objects.filter(sub=sub).update(email=email, name=name) return user def create_user(self, claims): """Return a newly created User instance.""" sub = claims.get("sub") if sub is None: raise SuspiciousOperation( _("Claims contained no recognizable user identification") ) return self.UserModel.objects.create( password="!", # noqa: S106 sub=sub, email=claims.get("email"), name=claims.get("name"), )