Skip to main content

Strawberry-graphql port of the graphene-django-jwt package

Project description

Strawberry Django JWT

PyPI - Downloads

GitHub commit activity GitHub last commit

Codecov Codacy grade

JSON Web Token authentication for Strawberry Django GraphQL


Disclaimer

This project is a forked version of Django GraphQL JWT that substitutes Graphene GraphQL backend for Strawberry


Installation

  1. Install last stable version from Pypi:

    pip install strawberry-django-jwt
    
  2. Add AuthenticationMiddleware middleware to your MIDDLEWARE settings:

    MIDDLEWARE = [
        ...,
        'django.contrib.auth.middleware.AuthenticationMiddleware',
        ...,
    ]
    
  3. Add following django apps to INSTALLED_APPS:

    INSTALLED_APPS = [
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        ...,
    ]
    

    If using refresh tokens, also add strawberry_django_jwt.refresh_token

    INSTALLED_APPS = [
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        ...,
        'strawberry_django_jwt.refresh_token',
        ...,
    ]
    
  4. Add JSONWebTokenMiddleware or AsyncJSONWebTokenMiddleware middleware to your STRAWBERRY schema definition:

    from strawberry_django_jwt.middleware import JSONWebTokenMiddleware, AsyncJSONWebTokenMiddleware
    from strawberry import Schema
    
    # !! IMPORTANT !!
    # Pick only one, async middleware is needed when using AsyncGraphQLSchema
    schema = Schema(..., extensions=[
       JSONWebTokenMiddleware,
       AsyncJSONWebTokenMiddleware,
    ])
    
  5. Add JSONWebTokenBackend backend to your AUTHENTICATION_BACKENDS:

    AUTHENTICATION_BACKENDS = [
        'strawberry_django_jwt.backends.JSONWebTokenBackend',
        'django.contrib.auth.backends.ModelBackend',
    ]
    
  6. Add strawberry-django-jwt mutations to the root schema:

    import strawberry
    import strawberry_django_jwt.mutations as jwt_mutations
    
    @strawberry.type
    class Mutation:
        token_auth = jwt_mutations.ObtainJSONWebToken.obtain
        verify_token = jwt_mutations.Verify.verify
        refresh_token = jwt_mutations.Refresh.refresh
        delete_token_cookie = jwt_mutations.DeleteJSONWebTokenCookie.delete_cookie
    

    schema = strawberry.Schema(mutation=Mutation, query=...)

  7. [OPTIONAL] Set up the custom Strawberry views

    These views set the status code of failed authentication attempts to 401 instead of the default 200.

    from django.urls import re_path
    from strawberry_django_jwt.decorators import jwt_cookie
    from strawberry_django_jwt.views import StatusHandlingGraphQLView as GQLView
    from ... import schema
    
    urlpatterns += \
    [
        re_path(r'^graphql/?$', jwt_cookie(GQLView.as_view(schema=schema))),
    ]
    

    or, for async views:

    from django.urls import re_path
    from strawberry_django_jwt.decorators import jwt_cookie
    from strawberry_django_jwt.views import AsyncStatusHandlingGraphQLView as AGQLView
    from ... import schema
    
    urlpatterns += \
    [
        re_path(r'^graphql/?$', jwt_cookie(AGQLView.as_view(schema=schema))),
    ]
    

Known Issues

  • JWT_ALLOW_ANY_CLASSES

    • Only supports return-type based filtering at the moment, because strawberry does not use class-based field definitions (so all superclasses are dropped)

    • It might be possible to create a workaround by using either a class decorator or by creating a custom graphql scheme that somehow preserves class hierarchy of types

Example Application

To start the example application, install poetry dev dependencies (poetry install will suffice) and run poetry run uvicorn tests.example_app.asgi:application

Quickstart Documentation

===============Work in Progress===============

Relay support has been temporarily removed due to lack of experience with Relay

Most of the features are conceptually the same as those provided by Django GraphQL JWT

Authenticating Fields

Fields can be set to auth-only using the login_required decorator in combination with strawberry.field or via login_field

import strawberry
from strawberry.types import Info
from strawberry_django_jwt.decorators import login_required
from strawberry_django_jwt.decorators import login_field


@strawberry.type
class Query:
    @login_field
    def hello(self, info: Info) -> str:
        return "World"

    @strawberry.field
    @login_required
    def foo(self, info: Info) -> str:
        return "Bar"

    @strawberry.field
    @login_required
    def foo2(self) -> str:
        return "Bar2"

The info argument is optional. If not provided, the login_required decorator decorates the resolver function with a custom function with info.

All required function arguments that are not present in the definition (atm. only info) will be added by the login_required decorator to the self dictionary as kwargs.

Model Mutations

You can add the login_required decorator to them as well

import strawberry
from strawberry_django_jwt.decorators import login_required
from strawberry.django import mutations


@strawberry.type
class Mutation:
    foo_create: FooType = login_required(mutations.create(FooInput))
    foo_delete: FooType = login_required(mutations.update(FooPartialInput))
    foo_update: FooType = login_required(mutations.delete())

Async Views

Should be fully supported :)

import strawberry
from strawberry_django_jwt.decorators import login_field


@strawberry.type
class Query:
    @login_field
    async def foo(self) -> str:
        return "bar"

Other

The introspection query authentication can be controlled by setting JWT_AUTHENTICATE_INTROSPECTION

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file strawberry-django-jwt-0.2.1.dev1645534192.tar.gz.

File metadata

File hashes

Hashes for strawberry-django-jwt-0.2.1.dev1645534192.tar.gz
Algorithm Hash digest
SHA256 36766ab72aaa6a831375795f7de1c0c1dd1b183ac6204dabcb3124b5966c05d7
MD5 d42ca53bb1a8142ca310b5c6d7e4203a
BLAKE2b-256 fc3b40a4aaa3412265a03342f50dd410725d9689b95e6d6530a8f5f00739e30c

See more details on using hashes here.

File details

Details for the file strawberry_django_jwt-0.2.1.dev1645534192-py3-none-any.whl.

File metadata

File hashes

Hashes for strawberry_django_jwt-0.2.1.dev1645534192-py3-none-any.whl
Algorithm Hash digest
SHA256 b7a51eed745e935dc0c1399f3b611620ec1f6cff49493718200a27de056a61b0
MD5 d7fe1469e4ff669d29ced1a997bbde1b
BLAKE2b-256 c3c899ff03f13f50761e82907f386060ab7a095271c2bfbd8415ce66009e5c2a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page