Add OIDC_CLIENT_MODEL setting to enable client model swapping

eirsyl · stefanfoulis · stefanfoulis · commit 53f86a8dbd3a · 2018-12-07T14:35:45.000+01:00
Co-authored-by: Eirik Martiniussen Sylliaas &lt;eirik@sylliaas.no&gt;
Co-authored-by: Stefan Foulis &lt;stefan@foulis.ch&gt;
diff --git a/docs/sections/settings.rst b/docs/sections/settings.rst
@@ -21,6 +21,15 @@ If not specified, it will be automatically generated using ``request.scheme`` an
 
 For example ``http://localhost:8000``.
 
+OIDC_CLIENT_MODEL
+=================
+
+OPTIONAL. ``str``. The client model.
+
+If not specified, the default oidc_provider.Client model is used. This is typically used when
+you need to override the Client model to add custom properties on the class. The custom class
+should override the oidc_provider.AbstractClient model.
+
 OIDC_AFTER_USERLOGIN_HOOK
 =========================
 
diff --git a/oidc_provider/lib/endpoints/authorize.py b/oidc_provider/lib/endpoints/authorize.py
@@ -26,13 +26,14 @@
     encode_id_token,
 )
 from oidc_provider.models import (
-    Client,
     UserConsent,
+    get_client_model
 )
 from oidc_provider import settings
 from oidc_provider.lib.utils.common import get_browser_state_or_default
 
 logger = logging.getLogger(__name__)
+Client = get_client_model()
 
 
 class AuthorizeEndpoint(object):
diff --git a/oidc_provider/lib/endpoints/token.py b/oidc_provider/lib/endpoints/token.py
@@ -17,13 +17,14 @@
     encode_id_token,
 )
 from oidc_provider.models import (
-    Client,
     Code,
     Token,
+    get_client_model
 )
 from oidc_provider import settings
 
 logger = logging.getLogger(__name__)
+Client = get_client_model()
 
 
 class TokenEndpoint(object):
diff --git a/oidc_provider/migrations/0001_initial.py b/oidc_provider/migrations/0001_initial.py
@@ -3,13 +3,15 @@
 
 from django.db import models, migrations
 from django.conf import settings
+from oidc_provider import settings as oidc_settings
 
 
 class Migration(migrations.Migration):
 
     dependencies = [
         ('auth', '0001_initial'),
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        migrations.swappable_dependency(oidc_settings.get('OIDC_CLIENT_MODEL')),
     ]
 
     operations = [
@@ -26,6 +28,8 @@ class Migration(migrations.Migration):
                 ('_redirect_uris', models.TextField(default=b'')),
             ],
             options={
+                'abstract': False,
+                'swappable': 'OIDC_CLIENT_MODEL'
             },
             bases=(models.Model,),
         ),
@@ -36,7 +40,7 @@ class Migration(migrations.Migration):
                 ('expires_at', models.DateTimeField()),
                 ('_scope', models.TextField(default=b'')),
                 ('code', models.CharField(unique=True, max_length=255)),
-                ('client', models.ForeignKey(to='oidc_provider.Client', on_delete=models.CASCADE)),
+                ('client', models.ForeignKey(oidc_settings.get('OIDC_CLIENT_MODEL'), on_delete=models.CASCADE)),
             ],
             options={
                 'abstract': False,
@@ -51,7 +55,7 @@ class Migration(migrations.Migration):
                 ('_scope', models.TextField(default=b'')),
                 ('access_token', models.CharField(unique=True, max_length=255)),
                 ('_id_token', models.TextField()),
-                ('client', models.ForeignKey(to='oidc_provider.Client', on_delete=models.CASCADE)),
+                ('client', models.ForeignKey(oidc_settings.get('OIDC_CLIENT_MODEL'), on_delete=models.CASCADE)),
             ],
             options={
                 'abstract': False,
diff --git a/oidc_provider/migrations/0002_userconsent.py b/oidc_provider/migrations/0002_userconsent.py
@@ -4,6 +4,8 @@
 from django.db import models, migrations
 from django.conf import settings
 
+from oidc_provider import settings as oidc_settings
+
 
 class Migration(migrations.Migration):
 
@@ -19,7 +21,7 @@ class Migration(migrations.Migration):
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
                 ('expires_at', models.DateTimeField()),
                 ('_scope', models.TextField(default=b'')),
-                ('client', models.ForeignKey(to='oidc_provider.Client', on_delete=models.CASCADE)),
+                ('client', models.ForeignKey(to=oidc_settings.get('OIDC_CLIENT_MODEL'), on_delete=models.CASCADE)),
                 ('user', models.ForeignKey(to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE)),
             ],
             options={
diff --git a/oidc_provider/migrations/0016_userconsent_and_verbosenames.py b/oidc_provider/migrations/0016_userconsent_and_verbosenames.py
@@ -8,6 +8,8 @@
 import django.db.models.deletion
 from django.utils.timezone import utc
 
+from oidc_provider import settings as oidc_settings
+
 
 class Migration(migrations.Migration):
 
@@ -79,7 +81,7 @@ class Migration(migrations.Migration):
             model_name='code',
             name='client',
             field=models.ForeignKey(
-                on_delete=django.db.models.deletion.CASCADE, to='oidc_provider.Client', verbose_name='Client'),
+                on_delete=django.db.models.deletion.CASCADE, to=oidc_settings.get('OIDC_CLIENT_MODEL'), verbose_name='Client'),
         ),
         migrations.AlterField(
             model_name='code',
@@ -141,7 +143,7 @@ class Migration(migrations.Migration):
             model_name='token',
             name='client',
             field=models.ForeignKey(
-                on_delete=django.db.models.deletion.CASCADE, to='oidc_provider.Client', verbose_name='Client'),
+                on_delete=django.db.models.deletion.CASCADE, to=oidc_settings.get('OIDC_CLIENT_MODEL'), verbose_name='Client'),
         ),
         migrations.AlterField(
             model_name='token',
@@ -168,7 +170,7 @@ class Migration(migrations.Migration):
             model_name='userconsent',
             name='client',
             field=models.ForeignKey(
-                on_delete=django.db.models.deletion.CASCADE, to='oidc_provider.Client', verbose_name='Client'),
+                on_delete=django.db.models.deletion.CASCADE, to=oidc_settings.get('OIDC_CLIENT_MODEL'), verbose_name='Client'),
         ),
         migrations.AlterField(
             model_name='userconsent',
diff --git a/oidc_provider/migrations/0027_auto_20181207_1311.py b/oidc_provider/migrations/0027_auto_20181207_1311.py
@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.4 on 2018-12-07 13:11
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oidc_provider', '0026_client_multiple_response_types'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='client',
+            name='owner',
+            field=models.ForeignKey(blank=True, default=None, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='oidc_provider_client_set', to=settings.AUTH_USER_MODEL, verbose_name='Owner'),
+        ),
+    ]
diff --git a/oidc_provider/models.py b/oidc_provider/models.py
@@ -4,11 +4,14 @@
 from hashlib import md5, sha256
 import json
 
+from django.apps import apps
 from django.db import models
 from django.utils import timezone
 from django.utils.translation import ugettext_lazy as _
 from django.conf import settings
 
+from oidc_provider import settings as oidc_settings
+
 
 CLIENT_TYPE_CHOICES = [
     ('confidential', 'Confidential'),
@@ -54,12 +57,13 @@ def __str__(self):
         return u'{0}'.format(self.description)
 
 
-class Client(models.Model):
+class AbstractClient(models.Model):
 
     name = models.CharField(max_length=100, default='', verbose_name=_(u'Name'))
     owner = models.ForeignKey(
         settings.AUTH_USER_MODEL, verbose_name=_(u'Owner'), blank=True,
-        null=True, default=None, on_delete=models.SET_NULL, related_name='oidc_clients_set')
+        null=True, default=None, on_delete=models.SET_NULL,
+        related_name='%(app_label)s_%(class)s_set')
     client_type = models.CharField(
         max_length=30,
         choices=CLIENT_TYPE_CHOICES,
@@ -115,6 +119,7 @@ class Client(models.Model):
     class Meta:
         verbose_name = _(u'Client')
         verbose_name_plural = _(u'Clients')
+        abstract = True
 
     def __str__(self):
         return u'{0}'.format(self.name)
@@ -158,9 +163,21 @@ def default_redirect_uri(self):
         return self.redirect_uris[0] if self.redirect_uris else ''
 
 
+class Client(AbstractClient):
+    class Meta(AbstractClient.Meta):
+        swappable = 'OIDC_CLIENT_MODEL'
+
+
+def get_client_model():
+    """ Return the Application model that is active in this project. """
+    return apps.get_model(oidc_settings.get('OIDC_CLIENT_MODEL'))
+
+
 class BaseCodeTokenModel(models.Model):
 
-    client = models.ForeignKey(Client, verbose_name=_(u'Client'), on_delete=models.CASCADE)
+    client = models.ForeignKey(
+        oidc_settings.get('OIDC_CLIENT_MODEL'), verbose_name=_(u'Client'),
+        on_delete=models.CASCADE)
     expires_at = models.DateTimeField(verbose_name=_(u'Expiration Date'))
     _scope = models.TextField(default='', verbose_name=_(u'Scopes'))
 
diff --git a/oidc_provider/settings.py b/oidc_provider/settings.py
@@ -25,6 +25,14 @@ def SITE_URL(self):
         """
         return None
 
+    @property
+    def OIDC_CLIENT_MODEL(self):
+        """
+        OPTIONAL.  Use a custom client model, typically used to extend the client model
+        with custom fields. The custom model should override oidc_provider.AbstractClient.
+        """
+        return 'oidc_provider.Client'
+
     @property
     def OIDC_AFTER_USERLOGIN_HOOK(self):
         """
diff --git a/oidc_provider/tests/models.py b/oidc_provider/tests/models.py
@@ -0,0 +1,7 @@
+from django.db import models
+
+from oidc_provider.models import AbstractClient
+
+
+class CustomClient(AbstractClient):
+    custom_field = models.CharField(max_length=255)
diff --git a/oidc_provider/tests/test_models.py b/oidc_provider/tests/test_models.py
@@ -0,0 +1,45 @@
+from unittest import skip
+import django
+from django.test import TestCase, override_settings
+from django.contrib.auth import get_user_model
+
+from oidc_provider.models import get_client_model, Client
+from oidc_provider.tests.models import CustomClient
+
+UserModel = get_user_model()
+
+
+class TestModels(TestCase):
+
+    def test_retrieve_default_client_model(self):
+        client = get_client_model()
+        self.assertEqual(Client, client)
+
+    @override_settings(OIDC_CLIENT_MODEL='tests.CustomClient')
+    def test_retrireve_custom_client_model(self):
+        client = get_client_model()
+        self.assertEqual(CustomClient, client)
+
+
+@override_settings(OIDC_CLIENT_MODEL='tests.CustomClient')
+class TestCustomClientModel(TestCase):
+
+    @skip(django.VERSION <= (1, 7))
+    def test_custom_client_model(self):
+        """
+        If a custom client model is installed, it should be present in
+        the related objects.
+        """
+        related_object_names = [
+            f.name for f in UserModel._meta.get_fields()
+            if (f.one_to_many or f.one_to_one) and f.auto_created and not f.concrete
+        ]
+        self.assertIn("tests_customclient_set", related_object_names)
+
+    @override_settings(OIDC_CLIENT_MODEL='IncorrectModelFormat')
+    def test_custom_application_model_incorrect_format(self):
+        self.assertRaises(ValueError, get_client_model)
+
+    @override_settings(OIDC_CLIENT_MODEL='tests.ClientNotInstalled')
+    def test_custom_application_model_incorrect_format(self):
+        self.assertRaises(LookupError, get_client_model)
diff --git a/oidc_provider/views.py b/oidc_provider/views.py
@@ -49,16 +49,18 @@
 from oidc_provider.lib.utils.oauth2 import protected_resource_view
 from oidc_provider.lib.utils.token import client_id_from_id_token
 from oidc_provider.models import (
-    Client,
     RSAKey,
-    ResponseType)
+    ResponseType,
+    get_client_model,
+)
 from oidc_provider import settings
 from oidc_provider import signals
 
 
 logger = logging.getLogger(__name__)
 
 OIDC_TEMPLATES = settings.get('OIDC_TEMPLATES')
+Client = get_client_model()
 
 
 class AuthorizeView(View):

Original file line number	Diff line number	Diff line change
`@@ -26,13 +26,14 @@`
`26`	`26`	`encode_id_token,`
`27`	`27`	`)`
`28`	`28`	`from oidc_provider.models import (`
`29`		`- Client,`
`30`	`29`	`UserConsent,`
	`30`	`+ get_client_model`
`31`	`31`	`)`
`32`	`32`	`from oidc_provider import settings`
`33`	`33`	`from oidc_provider.lib.utils.common import get_browser_state_or_default`
`34`	`34`
`35`	`35`	`logger = logging.getLogger(__name__)`
	`36`	`+Client = get_client_model()`
`36`	`37`
`37`	`38`
`38`	`39`	`class AuthorizeEndpoint(object):`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,14 @@`
`17`	`17`	`encode_id_token,`
`18`	`18`	`)`
`19`	`19`	`from oidc_provider.models import (`
`20`		`- Client,`
`21`	`20`	`Code,`
`22`	`21`	`Token,`
	`22`	`+ get_client_model`
`23`	`23`	`)`
`24`	`24`	`from oidc_provider import settings`
`25`	`25`
`26`	`26`	`logger = logging.getLogger(__name__)`
	`27`	`+Client = get_client_model()`
`27`	`28`
`28`	`29`
`29`	`30`	`class TokenEndpoint(object):`