この構成の場合、Djangoのデフォルトの認証機能でも実現はできるが、SPAのコンセプトが台無しになるため、JWTを使う。

JWT とは？

JSON Web Token の略である。

JWTとは、認証情報や権限を含んだ文字列(トークン)のこと。JSON形式で送受信される。

参照: https://ja.wikipedia.org/wiki/JSON_Web_Token

クライアント側が、ログイン用のユーザー名とパスワードを入力

サーバーがその検証をする。検証の結果、問題なければトークンを生成、これがJWTである。

レスポンスとして返却し、クライアント側は、ブラウザのlocalStorageにトークンを保存する。

以降、クライアント側は、localStorageに保存したトークンを使って、認証済みであることを証明する。

必要なライブラリ

Django側

pip install django djangorestframework 
pip install django-cors-headers
pip install djangorestframework-simplejwt

これまで通り、djangorestframework と django-cors-headersをインストールしている

djangorestframework-simplejwtはDjango側でJWT認証をするためのライブラリである。

settings.pyで設定をする。

React側

npm install axios
npm install jwt-decode

これまで通り、axiosを使っている。

jwt-decode は アクセストークンをデコードして、ユーザー情報やトークンの有効期限などの情報を手に入れることができる。

Djangoのソースコード

settings.py

"""
Django settings for config project.

Generated by 'django-admin startproject' using Django 4.1.5.

For more information on this file, see
https://docs.djangoproject.com/en/4.1/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.1/ref/settings/
"""

from pathlib import Path

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'django-insecure-8%$blv$7^^$pm(s#r(!tr94k9ch7p@wissbgbz!jep%@xlsced'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []


# Application definition

INSTALLED_APPS = [

    "bbs.apps.BbsConfig",
    'corsheaders',
    'rest_framework',
    'rest_framework_simplejwt',

    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]



REST_FRAMEWORK = {

    # 全てのエンドポイントで認証を必須とする。
    # (ビュークラスで、`permission_classes  = [IsAuthenticated]` が無い場合でも、↓の設定が有効なので、認証必須となる)
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],

    # 認証の際には、JWTを使用する。
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ]

}


from datetime import timedelta

# https://django-rest-framework-simplejwt.readthedocs.io/en/latest/settings.html
SIMPLE_JWT = {
    # アクセストークンの有効期限
    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=50),

    # リフレッシュトークンの有効期限(このリフレッシュトークンを使ってアクセストークンを生成できる)
    'REFRESH_TOKEN_LIFETIME': timedelta(days=1),

    # リフレッシュトークンが使われる時、新しいリフレッシュトークンを生成するか？ → いいえ
    'ROTATE_REFRESH_TOKENS': False,
}


# 同一オリジンポリシー対策
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',

    'corsheaders.middleware.CorsMiddleware',
]

# Reactサーバーからのリクエストを許可する。
CORS_ORIGIN_WHITELIST = [
     'http://localhost:3000'
]



ROOT_URLCONF = 'config.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'config.wsgi.application'


# Database
# https://docs.djangoproject.com/en/4.1/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}


# Password validation
# https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]


# Internationalization
# https://docs.djangoproject.com/en/4.1/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/4.1/howto/static-files/

STATIC_URL = 'static/'

# Default primary key field type
# https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

下記設定を追加している。

REST_FRAMEWORK = {

    # 全てのエンドポイントで認証を必須とする。
    # (ビュークラスで、`permission_classes  = [IsAuthenticated]` が無い場合でも、↓の設定が有効なので、認証必須となる)
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],

    # 認証の際には、JWTを使用する。
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ]

}

from datetime import timedelta

# https://django-rest-framework-simplejwt.readthedocs.io/en/latest/settings.html
SIMPLE_JWT = {
    # アクセストークンの有効期限
    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=50),

    # リフレッシュトークンの有効期限(このリフレッシュトークンを使ってアクセストークンを生成できる)
    'REFRESH_TOKEN_LIFETIME': timedelta(days=1),

    # リフレッシュトークンが使われる時、新しいリフレッシュトークンを生成するか？ → いいえ
    'ROTATE_REFRESH_TOKENS': False,
}

views.py

from django.shortcuts import render
from rest_framework import viewsets
from .serializers import TopicSerializer
from .models import Topic


from rest_framework.permissions import IsAuthenticated

class TopicView(viewsets.ModelViewSet):

    permission_classes  = [IsAuthenticated]

    serializer_class    = TopicSerializer
    queryset            = Topic.objects.all()

このpermission_classesの指定で、未ログイン状態だと実行しない。

ただ、今回はsettings.pyで

    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],

があるため、このpermission_classesが無くても、未ログインでは実行しないようになっている。

今回は、ビュー単位でも未ログイン時には実行しない設定ができることを説明するため、あえて追加した。

Reactのソースコード

結論

Reactライブラリ jwt-decode は無くても良い？

Reactのライブラリであるjwt-decodeを使うことで、トークンからユーザー情報等が手に入る。

手に入る情報は

{
  "token_type": "access",
  "exp": 1719885656,
  "iat": 1719882656,
  "jti": "bc790eb46a9241b7806d7f19d71b2b56",
  "user_id": 1
}

上から順に

• “token_type”: トークンのタイプ
• “exp”: トークンの有効期限(UNIXタイムスタンプ)
• “iat”: トークンの発行日時(UNIXタイムスタンプ)
• “jti”: トークンのID(リプレイ攻撃対策用)
• “user_id”: ユーザーID

となっている。

例えば、トークンの有効期限を使って、まもなくログアウトされる旨を報告できる。

しかし、ユーザー情報は、専用のビューをDjango側に用意することで手に入れることができるだろう。

そのため、有効期限や発行日時などの情報を使わない限りは、あえてjwt-decodeを使う理由がないと思われる。

ソースコード

https://github.com/seiya0723/react-django-startup-bbs-jwt