fix: fk resolver permissions leak (#1411)

* fix: fk resolver permissions leak

* fix: only one query for 1o1 relation

* tests: added queries count check

* fix: docstring

* fix: typo

* docs: added warning to authorization

* feat: added bypass_get_queryset decorator

.gitignore

@@ -11,6 +11,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+.env/
 venv/
 .venv/
 build/

docs/authorization.rst

@@ -144,6 +144,21 @@ If you are using ``DjangoObjectType`` you can define a custom `get_queryset`.
                 return queryset.filter(published=True)
             return queryset
 
+.. warning::
+
+    Defining a custom ``get_queryset`` gives the guaranteed it will be called
+    when resolving the ``DjangoObjectType``, even through related objects.
+    Note that because of this, benefits from using ``select_related``
+    in objects that define a relation to this ``DjangoObjectType`` will be canceled out.
+    In the case of ``prefetch_related``, the benefits of the optimization will be lost only
+    if the custom ``get_queryset`` modifies the queryset. For more information about this, refers
+    to Django documentation about ``prefetch_related``: https://docs.djangoproject.com/en/4.2/ref/models/querysets/#prefetch-related.
+
+
+    If you want to explicitly disable the execution of the custom ``get_queryset`` when resolving,
+    you can decorate the resolver with `@graphene_django.bypass_get_queryset`. Note that this
+    can lead to authorization leaks if you are performing authorization checks in the custom
+    ``get_queryset``.
 
 Filtering ID-based Node Access
 ------------------------------
@@ -197,8 +212,8 @@ For Django 2.2 and above:
 .. code:: python
 
     urlpatterns = [
-      # some other urls
+        # some other urls
-      path('graphql/', PrivateGraphQLView.as_view(graphiql=True, schema=schema)),
+        path('graphql/', PrivateGraphQLView.as_view(graphiql=True, schema=schema)),
     ]
 
 .. _LoginRequiredMixin: https://docs.djangoproject.com/en/dev/topics/auth/default/#the-loginrequired-mixin

docs/introspection.rst

@@ -57,9 +57,9 @@ specify the parameters in your settings.py:
 .. code:: python
 
     GRAPHENE = {
-    	'SCHEMA': 'tutorial.quickstart.schema',
+        'SCHEMA': 'tutorial.quickstart.schema',
-    	'SCHEMA_OUTPUT': 'data/schema.json',  # defaults to schema.json,
+        'SCHEMA_OUTPUT': 'data/schema.json',  # defaults to schema.json,
-    	'SCHEMA_INDENT': 2,  # Defaults to None (displays all data on a single line)
+        'SCHEMA_INDENT': 2,  # Defaults to None (displays all data on a single line)
     }
 
 

graphene_django/__init__.py

@@ -1,5 +1,6 @@
 from .fields import DjangoConnectionField, DjangoListField
 from .types import DjangoObjectType
+from .utils import bypass_get_queryset
 
 __version__ = "3.1.3"
 
@@ -8,4 +9,5 @@ __all__ = [
     "DjangoObjectType",
     "DjangoListField",
     "DjangoConnectionField",
+    "bypass_get_queryset",
 ]

graphene_django/converter.py

@@ -1,5 +1,6 @@
+import inspect
 from collections import OrderedDict
-from functools import singledispatch, wraps
+from functools import partial, singledispatch, wraps
 
 from django.db import models
 from django.utils.encoding import force_str
@@ -25,6 +26,7 @@ from graphene import (
 )
 from graphene.types.json import JSONString
 from graphene.types.scalars import BigInt
+from graphene.types.resolver import get_default_resolver
 from graphene.utils.str_converters import to_camel_case
 from graphql import GraphQLError
 
@@ -258,6 +260,9 @@ def convert_time_to_string(field, registry=None):
 
 @convert_django_field.register(models.OneToOneRel)
 def convert_onetoone_field_to_djangomodel(field, registry=None):
+    from graphene.utils.str_converters import to_snake_case
+    from .types import DjangoObjectType
+
     model = field.related_model
 
     def dynamic_type():
@@ -265,7 +270,52 @@ def convert_onetoone_field_to_djangomodel(field, registry=None):
         if not _type:
             return
 
-        return Field(_type, required=not field.null)
+        class CustomField(Field):
+            def wrap_resolve(self, parent_resolver):
+                """
+                Implements a custom resolver which goes through the `get_node` method to ensure that
+                it goes through the `get_queryset` method of the DjangoObjectType.
+                """
+                resolver = super().wrap_resolve(parent_resolver)
+
+                # If `get_queryset` was not overridden in the DjangoObjectType
+                # or if we explicitly bypass the `get_queryset` method,
+                # we can just return the default resolver.
+                if (
+                    _type.get_queryset.__func__
+                    is DjangoObjectType.get_queryset.__func__
+                    or getattr(resolver, "_bypass_get_queryset", False)
+                ):
+                    return resolver
+
+                def custom_resolver(root, info, **args):
+                    # Note: this function is used to resolve 1:1 relation fields
+
+                    is_resolver_awaitable = inspect.iscoroutinefunction(resolver)
+
+                    if is_resolver_awaitable:
+                        fk_obj = resolver(root, info, **args)
+                        # In case the resolver is a custom awaitable resolver that overwrites
+                        # the default Django resolver
+                        return fk_obj
+
+                    field_name = to_snake_case(info.field_name)
+                    reversed_field_name = root.__class__._meta.get_field(
+                        field_name
+                    ).remote_field.name
+                    return _type.get_queryset(
+                        _type._meta.model.objects.filter(
+                            **{reversed_field_name: root.pk}
+                        ),
+                        info,
+                    ).get()
+
+                return custom_resolver
+
+        return CustomField(
+            _type,
+            required=not field.null,
+        )
 
     return Dynamic(dynamic_type)
 
@@ -313,6 +363,9 @@ def convert_field_to_list_or_connection(field, registry=None):
 @convert_django_field.register(models.OneToOneField)
 @convert_django_field.register(models.ForeignKey)
 def convert_field_to_djangomodel(field, registry=None):
+    from graphene.utils.str_converters import to_snake_case
+    from .types import DjangoObjectType
+
     model = field.related_model
 
     def dynamic_type():
@@ -320,7 +373,79 @@ def convert_field_to_djangomodel(field, registry=None):
         if not _type:
             return
 
-        return Field(
+        class CustomField(Field):
+            def wrap_resolve(self, parent_resolver):
+                """
+                Implements a custom resolver which goes through the `get_node` method to ensure that
+                it goes through the `get_queryset` method of the DjangoObjectType.
+                """
+                resolver = super().wrap_resolve(parent_resolver)
+
+                # If `get_queryset` was not overridden in the DjangoObjectType
+                # or if we explicitly bypass the `get_queryset` method,
+                # we can just return the default resolver.
+                if (
+                    _type.get_queryset.__func__
+                    is DjangoObjectType.get_queryset.__func__
+                    or getattr(resolver, "_bypass_get_queryset", False)
+                ):
+                    return resolver
+
+                def custom_resolver(root, info, **args):
+                    # Note: this function is used to resolve FK or 1:1 fields
+                    #   it does not differentiate between custom-resolved fields
+                    #   and default resolved fields.
+
+                    # because this is a django foreign key or one-to-one field, the primary-key for
+                    # this node can be accessed from the root node.
+                    # ex: article.reporter_id
+
+                    # get the name of the id field from the root's model
+                    field_name = to_snake_case(info.field_name)
+                    db_field_key = root.__class__._meta.get_field(field_name).attname
+                    if hasattr(root, db_field_key):
+                        # get the object's primary-key from root
+                        object_pk = getattr(root, db_field_key)
+                    else:
+                        return None
+
+                    is_resolver_awaitable = inspect.iscoroutinefunction(resolver)
+
+                    if is_resolver_awaitable:
+                        fk_obj = resolver(root, info, **args)
+                        # In case the resolver is a custom awaitable resolver that overwrites
+                        # the default Django resolver
+                        return fk_obj
+
+                    instance_from_get_node = _type.get_node(info, object_pk)
+
+                    if instance_from_get_node is None:
+                        # no instance to return
+                        return
+                    elif (
+                        isinstance(resolver, partial)
+                        and resolver.func is get_default_resolver()
+                    ):
+                        return instance_from_get_node
+                    elif resolver is not get_default_resolver():
+                        # Default resolver is overridden
+                        # For optimization, add the instance to the resolver
+                        setattr(root, field_name, instance_from_get_node)
+                        # Explanation:
+                        #   previously, _type.get_node` is called which results in at least one hit to the database.
+                        #   But, if we did not pass the instance to the root, calling the resolver will result in
+                        #   another call to get the instance which results in at least two database queries in total
+                        #   to resolve this node only.
+                        #   That's why the value of the object is set in the root so when the object is accessed
+                        #   in the resolver (root.field_name) it does not access the database unless queried explicitly.
+                        fk_obj = resolver(root, info, **args)
+                        return fk_obj
+                    else:
+                        return instance_from_get_node
+
+                return custom_resolver
+
+        return CustomField(
             _type,
             description=get_django_field_description(field),
             required=not field.null,

graphene_django/tests/test_get_queryset.py

@@ -8,7 +8,7 @@ from graphql_relay import to_global_id
 from ..fields import DjangoConnectionField
 from ..types import DjangoObjectType
 
-from .models import Article, Reporter
+from .models import Article, Reporter, FilmDetails, Film
 
 
 class TestShouldCallGetQuerySetOnForeignKey:
@@ -127,6 +127,69 @@ class TestShouldCallGetQuerySetOnForeignKey:
         assert not result.errors
         assert result.data == {"reporter": {"firstName": "Jane"}}
 
+    def test_get_queryset_called_on_foreignkey(self):
+        # If a user tries to access a reporter through an article they should get our authorization error
+        query = """
+            query getArticle($id: ID!) {
+                article(id: $id) {
+                    headline
+                    reporter {
+                        firstName
+                    }
+                }
+            }
+        """
+
+        result = self.schema.execute(query, variables={"id": self.articles[0].id})
+        assert len(result.errors) == 1
+        assert result.errors[0].message == "Not authorized to access reporters."
+
+        # An admin user should be able to get reporters through an article
+        query = """
+            query getArticle($id: ID!) {
+                article(id: $id) {
+                    headline
+                    reporter {
+                        firstName
+                    }
+                }
+            }
+        """
+
+        result = self.schema.execute(
+            query,
+            variables={"id": self.articles[0].id},
+            context_value={"admin": True},
+        )
+        assert not result.errors
+        assert result.data["article"] == {
+            "headline": "A fantastic article",
+            "reporter": {"firstName": "Jane"},
+        }
+
+        # An admin user should not be able to access draft article through a reporter
+        query = """
+            query getReporter($id: ID!) {
+                reporter(id: $id) {
+                    firstName
+                    articles {
+                        headline
+                    }
+                }
+            }
+        """
+
+        result = self.schema.execute(
+            query,
+            variables={"id": self.reporter.id},
+            context_value={"admin": True},
+        )
+        assert not result.errors
+        assert result.data["reporter"] == {
+            "firstName": "Jane",
+            "articles": [{"headline": "A fantastic article"}],
+        }
+
 
 class TestShouldCallGetQuerySetOnForeignKeyNode:
     """
@@ -233,3 +296,272 @@ class TestShouldCallGetQuerySetOnForeignKeyNode:
         )
         assert not result.errors
         assert result.data == {"reporter": {"firstName": "Jane"}}
+
+    def test_get_queryset_called_on_foreignkey(self):
+        # If a user tries to access a reporter through an article they should get our authorization error
+        query = """
+            query getArticle($id: ID!) {
+                article(id: $id) {
+                    headline
+                    reporter {
+                        firstName
+                    }
+                }
+            }
+        """
+
+        result = self.schema.execute(
+            query, variables={"id": to_global_id("ArticleType", self.articles[0].id)}
+        )
+        assert len(result.errors) == 1
+        assert result.errors[0].message == "Not authorized to access reporters."
+
+        # An admin user should be able to get reporters through an article
+        query = """
+            query getArticle($id: ID!) {
+                article(id: $id) {
+                    headline
+                    reporter {
+                        firstName
+                    }
+                }
+            }
+        """
+
+        result = self.schema.execute(
+            query,
+            variables={"id": to_global_id("ArticleType", self.articles[0].id)},
+            context_value={"admin": True},
+        )
+        assert not result.errors
+        assert result.data["article"] == {
+            "headline": "A fantastic article",
+            "reporter": {"firstName": "Jane"},
+        }
+
+        # An admin user should not be able to access draft article through a reporter
+        query = """
+            query getReporter($id: ID!) {
+                reporter(id: $id) {
+                    firstName
+                    articles {
+                        edges {
+                            node {
+                                headline
+                            }
+                        }
+                    }
+                }
+            }
+        """
+
+        result = self.schema.execute(
+            query,
+            variables={"id": to_global_id("ReporterType", self.reporter.id)},
+            context_value={"admin": True},
+        )
+        assert not result.errors
+        assert result.data["reporter"] == {
+            "firstName": "Jane",
+            "articles": {"edges": [{"node": {"headline": "A fantastic article"}}]},
+        }
+
+
+class TestShouldCallGetQuerySetOnOneToOne:
+    @pytest.fixture(autouse=True)
+    def setup_schema(self):
+        class FilmDetailsType(DjangoObjectType):
+            class Meta:
+                model = FilmDetails
+
+            @classmethod
+            def get_queryset(cls, queryset, info):
+                if info.context and info.context.get("permission_get_film_details"):
+                    return queryset
+                raise Exception("Not authorized to access film details.")
+
+        class FilmType(DjangoObjectType):
+            class Meta:
+                model = Film
+
+            @classmethod
+            def get_queryset(cls, queryset, info):
+                if info.context and info.context.get("permission_get_film"):
+                    return queryset
+                raise Exception("Not authorized to access film.")
+
+        class Query(graphene.ObjectType):
+            film_details = graphene.Field(
+                FilmDetailsType, id=graphene.ID(required=True)
+            )
+            film = graphene.Field(FilmType, id=graphene.ID(required=True))
+
+            def resolve_film_details(self, info, id):
+                return (
+                    FilmDetailsType.get_queryset(FilmDetails.objects, info)
+                    .filter(id=id)
+                    .last()
+                )
+
+            def resolve_film(self, info, id):
+                return FilmType.get_queryset(Film.objects, info).filter(id=id).last()
+
+        self.schema = graphene.Schema(query=Query)
+
+        self.films = [
+            Film.objects.create(
+                genre="do",
+            ),
+            Film.objects.create(
+                genre="ac",
+            ),
+        ]
+
+        self.film_details = [
+            FilmDetails.objects.create(
+                film=self.films[0],
+            ),
+            FilmDetails.objects.create(
+                film=self.films[1],
+            ),
+        ]
+
+    def test_get_queryset_called_on_field(self):
+        # A user tries to access a film
+        query = """
+            query getFilm($id: ID!) {
+                film(id: $id) {
+                    genre
+                }
+            }
+        """
+
+        # With `permission_get_film`
+        result = self.schema.execute(
+            query,
+            variables={"id": self.films[0].id},
+            context_value={"permission_get_film": True},
+        )
+        assert not result.errors
+        assert result.data["film"] == {
+            "genre": "DO",
+        }
+
+        # Without `permission_get_film`
+        result = self.schema.execute(
+            query,
+            variables={"id": self.films[1].id},
+            context_value={"permission_get_film": False},
+        )
+        assert len(result.errors) == 1
+        assert result.errors[0].message == "Not authorized to access film."
+
+        # A user tries to access a film details
+        query = """
+            query getFilmDetails($id: ID!) {
+                filmDetails(id: $id) {
+                    location
+                }
+            }
+        """
+
+        # With `permission_get_film`
+        result = self.schema.execute(
+            query,
+            variables={"id": self.film_details[0].id},
+            context_value={"permission_get_film_details": True},
+        )
+        assert not result.errors
+        assert result.data == {"filmDetails": {"location": ""}}
+
+        # Without `permission_get_film`
+        result = self.schema.execute(
+            query,
+            variables={"id": self.film_details[0].id},
+            context_value={"permission_get_film_details": False},
+        )
+        assert len(result.errors) == 1
+        assert result.errors[0].message == "Not authorized to access film details."
+
+    def test_get_queryset_called_on_foreignkey(self, django_assert_num_queries):
+        # A user tries to access a film details through a film
+        query = """
+            query getFilm($id: ID!) {
+                film(id: $id) {
+                    genre
+                    details {
+                        location
+                    }
+                }
+            }
+        """
+
+        # With `permission_get_film_details`
+        with django_assert_num_queries(2):
+            result = self.schema.execute(
+                query,
+                variables={"id": self.films[0].id},
+                context_value={
+                    "permission_get_film": True,
+                    "permission_get_film_details": True,
+                },
+            )
+        assert not result.errors
+        assert result.data["film"] == {
+            "genre": "DO",
+            "details": {"location": ""},
+        }
+
+        # Without `permission_get_film_details`
+        with django_assert_num_queries(1):
+            result = self.schema.execute(
+                query,
+                variables={"id": self.films[0].id},
+                context_value={
+                    "permission_get_film": True,
+                    "permission_get_film_details": False,
+                },
+            )
+        assert len(result.errors) == 1
+        assert result.errors[0].message == "Not authorized to access film details."
+
+        # A user tries to access a film through a film details
+        query = """
+            query getFilmDetails($id: ID!) {
+                filmDetails(id: $id) {
+                    location
+                    film {
+                        genre
+                    }
+                }
+            }
+        """
+
+        # With `permission_get_film`
+        with django_assert_num_queries(2):
+            result = self.schema.execute(
+                query,
+                variables={"id": self.film_details[0].id},
+                context_value={
+                    "permission_get_film": True,
+                    "permission_get_film_details": True,
+                },
+            )
+        assert not result.errors
+        assert result.data["filmDetails"] == {
+            "location": "",
+            "film": {"genre": "DO"},
+        }
+
+        # Without `permission_get_film`
+        with django_assert_num_queries(1):
+            result = self.schema.execute(
+                query,
+                variables={"id": self.film_details[1].id},
+                context_value={
+                    "permission_get_film": False,
+                    "permission_get_film_details": True,
+                },
+            )
+        assert len(result.errors) == 1
+        assert result.errors[0].message == "Not authorized to access film."

graphene_django/utils/__init__.py

@@ -6,6 +6,7 @@ from .utils import (
     get_reverse_fields,
     is_valid_django_model,
     maybe_queryset,
+    bypass_get_queryset,
 )
 
 __all__ = [
@@ -16,4 +17,5 @@ __all__ = [
     "camelize",
     "is_valid_django_model",
     "GraphQLTestCase",
+    "bypass_get_queryset",
 ]

graphene_django/utils/utils.py

@@ -105,3 +105,12 @@ def set_rollback():
     atomic_requests = connection.settings_dict.get("ATOMIC_REQUESTS", False)
     if atomic_requests and connection.in_atomic_block:
         transaction.set_rollback(True)
+
+
+def bypass_get_queryset(resolver):
+    """
+    Adds a bypass_get_queryset attribute to the resolver, which is used to
+    bypass any custom get_queryset method of the DjangoObjectType.
+    """
+    resolver._bypass_get_queryset = True
+    return resolver