Adds the ability to define how to store a user (#1328)

* Update oauth2_validators.py * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add docs & tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 1vank1n

AUTHORS

@@ -60,6 +60,7 @@ Hasan Ramezani
 Hiroki Kiyohara
 Hossein Shakiba
 Islam Kamel
+Ivan Lukyanets
 Jadiel Teófilo
 Jens Timmerman
 Jerome Leclanche

CHANGELOG.md

@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 *#1337 Gracefully handle expired or deleted refresh tokens, in `validate_user`.
 *#1350 Support Python 3.12 and Django 5.0
 *#1249 Add code_challenge_methods_supported property to auto discovery information, per [RFC 8414 section 2](https://www.rfc-editor.org/rfc/rfc8414.html#page-7)
+*#1328 Adds the ability to define how to store a user profile
 
 
 ### Fixed

docs/oidc.rst

@@ -404,6 +404,17 @@ In the docs below, it assumes that you have mounted the
 the URLs accordingly.
 
 
+Define where to store the profile
+=================================
+
+.. py:function:: OAuth2Validator.get_or_create_user_from_content(content)
+
+An optional layer to define where to store the profile in ``UserModel`` or a separate model. For example ``UserOAuth``, where ``user = models.OneToOneField(UserModel)``.
+
+The function is called after checking that the username is present in the content.
+
+:return: An instance of the ``UserModel`` representing the user fetched or created.
+
 ConnectDiscoveryInfoView
 ~~~~~~~~~~~~~~~~~~~~~~~~
 

oauth2_provider/oauth2_validators.py

@@ -333,6 +333,17 @@ def validate_client_id(self, client_id, request, *args, **kwargs):
 defget_default_redirect_uri(self, client_id, request, *args, **kwargs):
 returnrequest.client.default_redirect_uri
 
+defget_or_create_user_from_content(self, content):
+"""
+ An optional layer to define where to store the profile in `UserModel` or a separate model. For example `UserOAuth`, where `user = models.OneToOneField(UserModel)` .
+
+ The function is called after checking that username is in the content.
+
+ Returns an UserModel instance;
+ """
+user, _=UserModel.objects.get_or_create(**{UserModel.USERNAME_FIELD: content["username"]})
+returnuser
+
 def_get_token_from_authentication_server(
 self, token, introspection_url, introspection_token, introspection_credentials
  ):
@@ -383,9 +394,7 @@ def _get_token_from_authentication_server(
 
 if"active"incontentandcontent["active"] isTrue:
 if"username"incontent:
-user, _created=UserModel.objects.get_or_create(
-**{UserModel.USERNAME_FIELD: content["username"]}
- )
+user=self.get_or_create_user_from_content(content)
 else:
 user=None
 

tests/test_oauth2_validators.py

@@ -335,6 +335,14 @@ def test_save_bearer_token__with_new_token__calls_methods_to_create_access_and_r
 assertcreate_access_token_mock.call_count==1
 assertcreate_refresh_token_mock.call_count==1
 
+deftest_get_or_create_user_from_content(self):
+content={"username": "test_user"}
+UserModel.objects.filter(username=content["username"]).delete()
+user=self.validator.get_or_create_user_from_content(content)
+
+self.assertIsNotNone(user)
+self.assertEqual(content["username"], user.username)
+
 
 classTestOAuth2ValidatorProvidesErrorData(TransactionTestCase):
 """These test cases check that the recommended error codes are returned