Django の認証方法のカスタマイズ

Django がデフォルトで提供する認証機能は、ほとんどの一般的なケースでは十分なものですが、デフォルトではニーズにマッチしない場合もあると思います。自分のプロジェクトで認証のカスタマイズを行うためには、Django が提供する認証システムをどの場所で拡張・置換できるかという知識が必要です。このドキュメントでは、認証システムをカスタマイズする方法の詳細について説明します。

認証バックエンド を利用すると、ユーザーモデルに保存されたユーザー名とパスワードを用いて異なるサービス間での認証を行う必要が生じた場合に Django 標準よりも高い拡張性を持たせることができます。

モデルには、Django の認可システムで検証可能な カスタムパーミッション を組み込むことができます。

デフォルトの User モデルを 拡張 したり、完全にカスタマイズしたモデルと 置換 したりできます。

他の認証ソースを利用する

別の認証ソース、つまり、ユーザー名とパスワード、または他の認証方法を持つ別のソースにフックする必要がある場合があるかも知れません。

たとえば、あなたの会社ですでに全ての従業員のユーザ名とパスワードを記録しているLDAP認証があるとしましょう。もしユーザがLDAP認証とDjangoアプリケーションで異なるアカウントだとしたらネットワーク管理者とユーザで口論になるでしょう。

そこでこのような状況に対応するためにDjangoの認証システムは他の認証システムのリソースと接続できます。あなたはDjangoのデフォルトのデータベーススキーマをオーバーライドするか、他のシステムを連携するためにデフォルトシステムを使うことができます。

Django に含まれている認証バックエンドに関する情報は 認証バックエンドリファレンス を参照してください。

認証バックエンドを指定する

Djangoは内部で、「認証バックエンド」と呼ばれるリストを保持しており、認証のためにそれをチェックします。誰かが django.contrib.auth.authenticate() を呼び出したとき（ユーザーをログインさせる方法 に記載されているように）、Djangoはすべての認証バックエンドを通じて認証を試みます。最初の認証方法が失敗した場合、Djangoは次のものを試し、すべてのバックエンドが試行されるまで続けます。

認証バックエンドとして利用するリストは AUTHENTICATION_BACKENDS に定義されています。この設定値は認証方法を定義している Python クラスを指定する Python パスのリスト型変数でなければなりません。これらのクラスはあなたの環境で有効な Python パスのどこにでも配置可能です。

初期状態では、AUTHENTICATION_BACKENDS は以下の値として定義されています。:

["django.contrib.auth.backends.ModelBackend"]

これは Django のユーザーデータベースを確認してビルトインの権限を照会する基本的な認証バックエンドです。このバックエンドにはログイン試行を制限することでブルートフォース攻撃を防御する仕組みは提供していません。独自に試行制限を実装した認証バックエンドを利用するか、多くのウェブサーバーで提供されている各種防御機構が利用可能です。

AUTHENTICATION_BACKENDS への順番は処理に影響し、同じユーザー名とパスワードによって複数のバックエンドで有効な認証と判定されれば、Django は最初に有効と判定した時点で処理を終了します。

ある認証バックエンドにおいて PermissionDenied 例外が発生した場合、認証処理は直ちに終了し、Django は続く認証バックエンドに対する認証判定を行いません。

注釈

一度ユーザーが認証されると、Django はユーザーの認証に使われたバックエンドの種類をユーザーのセッションに保存し、現在認証されているユーザーへのアクセスが必要なときはいつでも、そのセッションの間は同じバックエンドを再利用します。これは事実上、認証元がセッションごとにキャッシュされることを意味するため、AUTHENTICATION_BACKENDS を変更したとき、ユーザーに別の方法を使用した再認証を強制する必要がある場合、セッションデータを消去する必要があります。そのための簡単な方法は、Session.objects.all().delete() の実行です。

認証バックエンドの実装

認証 (authentication) バックエンドは、2つの必須メソッド: get_user(user_id) と authenticate(request, **credentials) を実装したクラスであり、パーミッションに関連した省略可能な 認可 (authorization) メソッド もあります。

get_user メソッドは user_id 引数を取ります。これはユーザーネーム、データベースID、またはその他何でもかまいませんが、ユーザーオブジェクトの主キーである必要があります。そして、ユーザーオブジェクトまたは None を返します。

authenticate メソッドは request 引数と credentials キーワード引数を取ります。殆どの場合、これは次のようになります。

from django.contrib.auth.backends import BaseBackend


class MyBackend(BaseBackend):
    def authenticate(self, request, username=None, password=None):
        # Check the username/password and return a user.
        ...

一方、次のように認証トークンでも表せます。

from django.contrib.auth.backends import BaseBackend


class MyBackend(BaseBackend):
    def authenticate(self, request, token=None):
        # Check the token and return a user.
        ...

いずれの場合にせよ、 authenticate() は与えられた認証情報を確認し、それが有効であれば、認証情報とマッチしたユーザーオブジェクトを返すべきです。それが有効でなければ None を返すべきです。

request は HttpRequest で、 authenticate() が提供されていない場合は None となる可能性があります (バックエンドでこれを通過するため)。

The Django admin is tightly coupled to the Django User object. For example, for a user to access the admin, User.is_staff and User.is_active must be True (see AdminSite.has_permission() for details).

The best way to deal with this is to create a Django User object for each user that exists for your backend (e.g., in your LDAP directory, your external SQL database, etc.). You can either write a script to do this in advance, or your authenticate method can do it the first time a user logs in.

Here's an example backend that authenticates against a username and password variable defined in your settings.py file and creates a Django User object the first time a user authenticates. In this example, the created Django User object is a superuser who will have full access to the admin:

from django.conf import settings
from django.contrib.auth.backends import BaseBackend
from django.contrib.auth.hashers import check_password
from django.contrib.auth.models import User


class SettingsBackend(BaseBackend):
    """
    Authenticate against the settings ADMIN_LOGIN and ADMIN_PASSWORD.

    Use the login name and a hash of the password. For example:

    ADMIN_LOGIN = 'admin'
    ADMIN_PASSWORD = 'pbkdf2_sha256$30000$Vo0VlMnkR4Bk$qEvtdyZRWTcOsCnI/oQ7fVOu1XAURIZYoOZ3iq8Dr4M='
    """

    def authenticate(self, request, username=None, password=None):
        login_valid = settings.ADMIN_LOGIN == username
        pwd_valid = check_password(password, settings.ADMIN_PASSWORD)
        if login_valid and pwd_valid:
            try:
                user = User.objects.get(username=username)
            except User.DoesNotExist:
                # Create a new user. There's no need to set a password
                # because only the password from settings.py is checked.
                user = User(username=username)  # is_active defaults to True.
                user.is_staff = True
                user.is_superuser = True
                user.save()
            return user
        return None

    def get_user(self, user_id):
        try:
            return User.objects.get(pk=user_id)
        except User.DoesNotExist:
            return None

カスタムバックエンドによる認可の扱い

カスタム認証バックエンドはそれら独自のパーミッションを提供できます。

ユーザーモデルとそのマネージャは、ルックアップ関数を実装している認証バックエンドが何であっても、ルックアップ関数 (get_user_permissions()、get_group_permissions()、get_all_permissions()、has_perm()、has_module_perms()、with_perm()) に権限を移譲します。

これによりユーザーに与えられたパーミッションは全てのバックエンドが返すすべてのパーミッションの上位セットになります。つまり、Django はユーザーに、任意のバックエンドが付与するパーミッションを与えます。

もし例外 PermissionDenied を has_perm() か has_module_perms() の中でバックエンドが出した場合、認可は直ちに失敗し、 Django はそこから続くバックエンドを確認しません。

バックエンドは、魔法のような admin のパーミッションを次のように実装できます。

from django.contrib.auth.backends import BaseBackend


class MagicAdminBackend(BaseBackend):
    def has_perm(self, user_obj, perm, obj=None):
        return user_obj.username == settings.ADMIN_LOGIN

上記の例では、アクセスしたユーザーに全てのパーミッションを付与します。注意すべき点として、関数 django.contrib.auth.models.User から関連して得られた同じ引数は、バックエンド認証関数は、匿名のユーザーを表すものも含んでいるかもしれない、全てのユーザーオブジェクトを引数として取る点があります。

認可の実装の完全なものは django/contrib/auth/backends.py の ModelBackend クラスにあり、これはデフォルトのバックエンドであり、ほとんどの場合 auth_permission テーブルを照会します。

匿名ユーザーに対する認可

匿名ユーザーは認証されていないユーザー、すなわち、有効な認証の詳細を何も提供しないユーザーです。しかし、それは必ずしも匿名ユーザーが何かを行うことを認可されないことを意味するわけではありません。最も基本的な基準として、ほとんどのウェブサイトは匿名ユーザーにサイトの大部分を閲覧する権限を与え、その多くは匿名ユーザーにコメント投稿などを許可しています。

Django の認証フレームワークには、匿名ユーザーのアクセス許可を格納する場所はありません。しかし、認証バックエンドに渡されたユーザーオブジェクトは django.contrib.auth.models.AnonymousUser オブジェクトとなることがあります。これにより、バックエンドは匿名ユーザー向けのカスタムの認可動作を指定できます。この仕組みで特に便利なのは、再利用可能なアプリの作者が、たとえば匿名アクセスの制御の設定をする必要がなくなり、認可に関するすべての質問を認証バックエンドに移譲できるようになるような場合です。

アクティブでないユーザーに対する認可

is_active フィールドが False となっているユーザーを、アクティブでないユーザーと呼びます。認証バックエンド ModelBackend と RemoteUserBackend はこれらのユーザーの認証行為を禁止します。カスタムユーザーモデルが is_active を持っていない場合、すべてのユーザーの認証行為が許可されます。

もし、アクティブでないユーザーの認証行為を許可したい場合は、AllowAllUsersModelBackend や AllowAllUsersRemoteUserBackend を使用できます。

パーミッションシステムが匿名ユーザーをサポートしている場合、匿名ユーザーがパーミッションを持つ操作であっても、アクティブでないユーザーにはそれができないということが起こりえます。

バックエンドで独自のパーミッションメソッド持つときは、ユーザーの is_active 属性のテストを忘れずに行ってください。

オブジェクトのパーミッションの取扱い

Django のパーミッションフレームワークはオブジェクトパーミッション基盤を持っていますが、コアには実装されていません。これにより、オブジェクトパーミッションのチェックは常に False または空のリスト（実行されたチェックに応じていずれか）が返されます。認証バックエンドは、オブジェクトに関連した認可メソッドごとに obj および user_obj のキーワードパラメータを受け取り、必要に応じてオブジェクトレベルのパーミッションを返します。

カスタムパーミッション

モデルオブジェクトに対してカスタムパーミッションを作成したい場合は モデルの Meta 属性 permissions を使用してください。

この例の Task モデルは、2つのカスタムパーミッションを作成します。すなわち、このアプリケーションにおいて、ユーザーが Task インスタンスに関係して、できることとできないことを規定します。

class Task(models.Model):
    ...

    class Meta:
        permissions = [
            ("change_task_status", "Can change the status of tasks"),
            ("close_task", "Can remove a task by setting its status as closed"),
        ]

これは manage.py migrate を実行したときに、追加のパーミッションを作成するだけです (パーミッションを作成する関数は post_migrate シグナルに接続されています)。あなたがコード内でやることは、ユーザがアプリケーションの提供する機能(タスクのステータスを変更したり、タスクを閉じたり)にアクセスしようとしたときに、これらのパーミッションの値をチェックすることです。上記の例の続きで、次のコードはユーザーがタスクを閉じることができるかどうかをチェックします:

user.has_perm("app.close_task")

既存の User モデルを拡張する

独自のモデルを使用することなく、デフォルトのモデル User を拡張する方法が2つあります。振る舞いのみを変更し、データベースに格納されている内容を変更する必要がない場合は User に基づいて プロキシモデル を作成できます。これにより、デフォルトの並び順、カスタムマネージャ、カスタムモデルメソッドなど、プロキシモデルによって提供される機能を利用可能です。

User に関連した情報を格納したい場合は、 OneToOneField を追加する情報のフィールドを持ったモデルに使用します。この一対一モデルはサイトユーザーに関する、認証には関連しない情報を格納することがあるため、しばしばプロファイルモデルと呼ばれます。たとえば、次のような Employee モデルを作ります:

from django.contrib.auth.models import User


class Employee(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    department = models.CharField(max_length=100)

User モデルと Employee モデルの両方を持つ既存の Employee Fred Smith を想定すると、 Django の標準的なリレーション先モデルの規約を使って、関連情報にアクセスできます:

>>> u = User.objects.get(username="fsmith")
>>> freds_department = u.employee.department

admin のユーザーページにプロファイルモデルのフィールドを追加する場合は、InlineModelAdmin (この例では、StackedInline を使用しています) をあなたの admin.py に定義し、それを User クラスで追加した UserAdmin クラスに追加します。

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
from django.contrib.auth.models import User

from my_user_profile_app.models import Employee


# Define an inline admin descriptor for Employee model
# which acts a bit like a singleton
class EmployeeInline(admin.StackedInline):
    model = Employee
    can_delete = False
    verbose_name_plural = "employee"


# Define a new User admin
class UserAdmin(BaseUserAdmin):
    inlines = [EmployeeInline]


# Re-register UserAdmin
admin.site.unregister(User)
admin.site.register(User, UserAdmin)

これらのプロファイルモデルは、特別な方法で処理される Django モデルではありません。ユーザーモデルと一対一のリンクを持っているだけです。したがって、ユーザーが作成されたときに自動的に作成されることはありませんが、django.db.models.signals.post_save を使って、適切にリレーション先モデルを作成または更新できます。

関連づけされたモデルを使用した場合、関連するデータを検索するための追加のクエリ実行や結合が行われます。あなたの必要性に応じて、関連づけされたフィールドをカスタムユーザーモデルにインクルードすることは適した選択肢となるでしょう。しかしながら、デフォルトのユーザーモデルとプロジェクトのアプリケーションに組み込み済みの連携は追加のデータベース負荷を正当化するでしょう。

カスタムの User モデルを置き換える

Django にビルトインされている User モデルは、必ずしもプロジェクトが必要とする認証のモデルと合致するわけではありません。たとえば、サイトによってはユーザー名の代わりにメールアドレスを識別トークンとして使用する方が適した場合があります。

Django では、カスタムモデルを参照するように AUTH_USER_MODEL の値を設定することにより、デフォルトのユーザーモデルをオーバーライドできます:

AUTH_USER_MODEL = "myapp.MyUser"

このドットで区切られたペアは、Django app の label (INSTALLED_APPS に含まれている必要があります) と、ユーザーモデルとして使用したい Django モデルの名前です。

プロジェクトの開始時にカスタムのユーザーモデルを使用する

If you're starting a new project, you can set up a custom user model that behaves identically to the default user model by subclassing AbstractUser:

from django.contrib.auth.models import AbstractUser


class User(AbstractUser):
    pass

AUTH_USER_MODEL に指定することを忘れないでください。任意のマイグレーションの作成、また、最初に実行する manage.py migrate の前に行ってください。

そして、モデルをアプリの admin.py に登録してください:

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from .models import User

admin.site.register(User, UserAdmin)

プロジェクト途中からのカスタムユーザーモデルへの変更

Changing AUTH_USER_MODEL after you've created database tables is possible, but can be complex, since it affects foreign keys and many-to-many relationships, for example.

この変更は自動的には行うことができません。手動でのスキーマ修正、古いユーザーテーブルからのデータ移動、一部のマイグレーションの手動による再適用をする必要があります。ステップの概要は #25313 を参照してください。

スワップ可能なモデルという Django の動的依存性により、 AUTH_USER_MODEL によって参照されるモデルはアプリの初回のマイグレーションで作成されなければなりません（通常は 0001_initial と呼ばれます）。そうしない場合、依存関係の問題が発生します。

マイグレーション中に CircularDependencyError に遭遇するかもしれません。依存関係の動的な性質のため、Django は依存関係のループを自動的に断ち切ることができないためです。もしこのエラーを見た場合、ユーザーモデルが依存しているモデルを2回目のマイグレーションに移動することで、依存関係のループがなくなるようにしてください。(お互いに ForeignKey を持つ2つの通常のモデルを作ることで、makemigrations が循環依存関係を通常と同じように解決させることもできます。)

再利用可能なアプリと AUTH_USER_MODEL

再利用可能アプリはカスタムのユーザーモデルを実装するべきではありません。多数のアプリを使用するプロジェクトの場合、それぞれカスタムのユーザーモデルを実装した再利用可能アプリが2つあると、同時に使うことができなくなってしまいます。もしユーザー情報をアプリ度とに保存したい場合は、以下のように settings.AUTH_USER_MODEL に対して ForeignKey または OneToOneField を使用してください。

User モデルを参照する

User を直接参照する場合 (たとえば外部キーで参照する場合)、AUTH_USER_MODEL 設定が異なるユーザモデルに変更されたプロジェクトでは正しく動作しません。

get_user_model()[ソース]

User を直接参照する代わりに、django.contrib.auth.get_user_model() を使ってユーザモデルを参照すべきです。このメソッドは現在アクティブなユーザモデルを返します -- 指定されている場合はカスタムのユーザモデル、指定されていない場合は User です。

ユーザモデルに対して外部キーや多対多の関係を定義するときは、AUTH_USER_MODEL 設定を使ってカスタムのモデルを指定してください。例えば:

from django.conf import settings
from django.db import models


class Article(models.Model):
    author = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )

ユーザモデルによって送信されたシグナルと接続するときは、AUTH_USER_MODEL 設定を使ってカスタムのユーザモデルを指定してください。例えば:

from django.conf import settings
from django.db.models.signals import post_save


def post_save_receiver(sender, instance, created, **kwargs):
    pass


post_save.connect(post_save_receiver, sender=settings.AUTH_USER_MODEL)

一般的に言って、最も簡単な方法は、インポート時に実行されるコードの中で AUTH_USER_MODEL 設定を用いてユーザーモデルを参照することです。しかし、Django がモデルをインポートするときに get_user_model() を呼ぶという方法もあります。こうすると、models.ForeignKey(get_user_model(), ...) という表記が可能です。

たとえば、@override_settings(AUTH_USER_MODEL=...) などを使用して、アプリが複数のユーザーモデルでテストされていて、get_user_model() の結果をモジュールレベルの変数にキャッシュしている場合、setting_changed シグナルを listen してキャッシュをクリアする必要があるかもしれません。そのためには、次のように書きます。

from django.apps import apps
from django.contrib.auth import get_user_model
from django.core.signals import setting_changed
from django.dispatch import receiver


@receiver(setting_changed)
def user_model_swapped(*, setting, **kwargs):
    if setting == "AUTH_USER_MODEL":
        apps.clear_cache()
        from myapp import some_module

        some_module.UserModel = get_user_model()

カスタムのユーザーモデルを指定する

プロジェクトの開始時にカスタムのユーザーモデルを使おうとしている場合、自分のプロジェクトにとってこの選択は本当に正しいのだろうか、と立ち止まってよく考えてください。

ユーザーに関連するすべての情報を1つのモデルに記録すれば、関連モデルを取得するために、追加のより複雑なデータベースクエリを書く必要がなくなります。しかし一方で、アプリ固有のユーザー情報は、カスタムのユーザーモデルに関連するモデルに記録した方がより適切かもしれません。そうすることにより、各アプリは、他のアプリと競合したりデータを破壊されたりする可能性を考えずに、自分のアプリに必要なユーザーデータのみを指定できます。また、ユーザーモデルを、認証に焦点を絞った、可能な限りシンプルなものに保ち続けられるようになります。それはまた、Django がカスタムのユーザーモデルに期待する最小限の要求を満たすことにもなります。

デフォルトの認証バックエンドを使用している場合、モデルは必ず、認証のために使用できるユニークなフィールドを1つ持たなければなりません。このフィールドとしては、ユーザー名やメールアドレスなど、ユニークな属性ならば使用できます。ユニークでないユーザー名などのフィールドが使用できるのは、そのようなフィールドを扱えるカスタムの認証バックエンドだけです。

準拠したカスタムユーザーモデルを構築する最も簡単な方法は、AbstractBaseUser を継承することです。AbstractBaseUser はユーザーモデルのコアとなる実装を提供しており、その中には、ハッシュ化パスワードやトークン化されたパスワードリセットなどの機能が含まれます。このクラスの継承後、以下のように、キー実装の詳細を自分で記述する必要があります。

class models.CustomUser

USERNAME_FIELD

ユニークな ID として使用される、ユーザーモデルのフィールド名を説明する文字列。これは通常、ある種のユーザー名になりますが、メールアドレスや他のユニークな ID にすることもできます。非ユニークなユーザー名をサポートできるカスタムの認証バックエンドを使っていない限り、このフィールドは 必ず ユニークである (たとえば、unique=True を定義内で設定する) 必要があります。

以下の例では、フィールドを一意に指定するために、identifier フィールドが使われています。

class MyUser(AbstractBaseUser):
    identifier = models.CharField(max_length=40, unique=True)
    ...
    USERNAME_FIELD = "identifier"

EMAIL_FIELD

ユーザーモデルにあるメールのフィールド名を文字列で記述します。この値は get_email_field_name() で返されます。

REQUIRED_FIELDS

createsuperuser 管理コマンド経由でユーザーを作成するときにプロンプトが表示されるフィールド名のリスト。ユーザーはこれらの各フィールドごとに値を入力するようにプロンプトが表示されます。blank が False または未定義のフィールドを含む必要があり、ユーザーが対話的に作成されるときにプロンプトを表示したい追加のフィールドを含むことができます。REQUIRED_FIELDS は、たとえば admin 上のユーザーの作成などの Django の他の部分では何も効果がありません。

たとえば、これは誕生日と身長の2つの必須フィールドを定義しているユーザーモデルの部分的な定義です。

class MyUser(AbstractBaseUser):
    ...
    date_of_birth = models.DateField()
    height = models.FloatField()
    ...
    REQUIRED_FIELDS = ["date_of_birth", "height"]

注釈

REQUIRED_FIELDS はユーザーモデルのすべての必須フィールドを含む必要がありますが、USERNAME_FIELD や password を含んでは いけません 。これらのフィールドは常に入力を求められるためです。

is_active

ユーザーが "active" かどうかを示すブール属性。この属性は、デフォルトが True の AbstractBaseUser 上の属性として与えられます。実装時にどのような選択をするかは、選択した認証バックエンドの詳細によって変わります。詳細については、ビルトインのユーザーモデル上の is_active のドキュメントを読んでください。

get_full_name()

オプション。フルネームなどのユーザーに対するより長い正式の ID です。実装した場合、django.contrib.admin のオブジェクト履歴内でユーザー名とともに表示されます。

get_short_name()

オプション。ファーストネームなどのユーザーに対するより短い正式ではない ID です。実装した場合、django.contrib.admin のヘッダー内のユーザーへの挨拶内でユーザー名の代わりに使われます。

AbstractBaseUser のインポート

AbstractBaseUser と BaseUserManager は django.contrib.auth.base_user からインポートでき、 INSTALLED_APPS の中に django.contrib.auth をインクルードすることなくインポートできます。

次の属性とメソッドは AbstractBaseUser: の任意のサブクラスで利用可能です。

class models.AbstractBaseUser

get_username()

USERNAME_FIELD で指定されたフィールドの値を返します。

clean()

normalize_username() を呼び出し、username を正規化します。このメソッドをオーバーライドした場合、正規化を保持するために super() を呼び出すようにしてください。

classmethod get_email_field_name()

EMAIL_FIELD 属性で指定されたメールフィールドの名前を返します。EMAIL_FIELD の指定が無いとき、デフォルトは 'email' です。

classmethod normalize_username(username)

視覚的に同一であるが異なる Unicode の符号位置を持つ文字について、それらが同一とみなされるように、username に NFKC Unicode正規化を適用します。

is_authenticated

(AnonymousUser.is_authenticated が常に False なのとは対照的に) 常に True の読み取り専用属性です。ユーザが認証済みかどうかを知らせる方法です。これはパーミッションという意味ではなく、ユーザーがアクティブかどうか、また有効なセッションがあるかどうかをチェックするわけでもありません。 通常、request.user のこの属性をチェックして AuthenticationMiddleware (現在ログイン中のユーザを表します) によって格納されているかどうかを調べます。User のインスタンスの場合、この属性は True となります。

is_anonymous

常に False の読み取り専用属性です。User オブジェクトと AnonymousUser オブジェクトを区別する方法です。一般的に、is_authenticated を使う方が好ましいと言えます。

set_password(raw_password)

指定された生の文字列に、ユーザのパスワードをセットし、パスワードのハッシュ処理を行います。AbstractBaseUser は保存しません。

raw_password が None のとき、set_unusable_password() が使われるのと同じように、パスワードは使用に適さないパスワードになります。

check_password(raw_password)

acheck_password(raw_password)

非同期バージョン: acheck_password()

与えられた生の文字列が、ユーザに対して正しいパスワードであれば True を返します。 (比較する際にはパスワードハッシュを処理します。)

Changed in Django 5.0:

acheck_password() メソッドが追加されました。

set_unusable_password()

ユーザにパスワードが設定されていないものとしてマークします。これは、空の文字列のパスワードを設定することとは違います。このユーザに対する check_password() は True を返しません。AbstractBaseUser オブジェクトを保存しません。

アプリケーションの認証が LDAP ディレクトリなどの既存の外部ソースに対して行われている場合は、これが必要になることがあります。

has_usable_password()

ユーザに対して set_unusable_password() が呼ばれている場合、False を返します。

get_session_auth_hash()

パスワードフィールドの HAMC を返します。パスワード変更時にセッションを無効化する ために利用されます。

get_session_auth_fallback_hash()

SECRET_KEY_FALLBACKS を使用しているパスワードフィールドの HMAC を yield します。get_user() で使用されます。

AbstractUser は AbstractBaseUser をサブクラス化します。

class models.AbstractUser

clean()

BaseUserManager.normalize_email() を呼び出し、メールを正規化します。このメソッドをオーバーライドした場合、正規化を保持するために必ず super() を呼び出すようにしてください。

カスタムユーザーモデルのためのマネージャーを書く

また、ユーザモデルに対してカスタムマネージャを定義する必要があります。ユーザモデルが username, email, is_staff, is_active, is_superuser, last_login, date_joined フィールドを Django のデフォルトユーザと同じように定義している場合、 Django の UserManager をインストールできます。しかし、ユーザモデルが異なるフィールドを定義している場合は、 BaseUserManager を継承して、さらに 2 つのメソッドを提供するカスタムマネージャを定義する必要があります:

class models.CustomUserManager

create_user(username_field, password=None, **other_fields)

create_user() のプロトタイプは、ユーザ名フィールドとすべての必須フィールドを引数として受け取る必要があります。たとえば、ユーザーモデルがユーザー名フィールドとして email を使用し、必須フィールドとして date_of_birth を持つ場合、 create_user は次のように定義します:

def create_user(self, email, date_of_birth, password=None):
    # create user here
    ...

create_superuser(username_field, password=None, **other_fields)

create_superuser() のプロトタイプは、ユーザ名フィールドとすべての必須フィールドを引数として受け取る必要があります。たとえば、ユーザーモデルがユーザー名フィールドとして email を使用し、必須フィールドとして date_of_birth を持つ場合、 create_superuser は次のように定義します:

def create_superuser(self, email, date_of_birth, password=None):
    # create superuser here
    ...

ForeignKey の USERNAME_FIELD または REQUIRED_FIELDS の場合、これらのメソッドは既存のインスタンスの to_field (デフォルトでは primary_key) の値を受け取ります。

BaseUserManager は以下のユーティリティメソッドを提供します:

class models.BaseUserManager

classmethod normalize_email(email)

メールアドレスのドメイン部分を小文字にすることで、メールアドレスを正規化します。

get_by_natural_key(username)

USERNAME_FIELD で指定されたフィールドの内容を使用してユーザーインスタンスを取得します。

Django 標準の User を拡張する

Django の User モデルに完全に満足しているものの、追加のプロフィール情報をいくつか追加したい場合、django.contrib.auth.models.AbstractUser をサブクラス化して、カスタムのプロフィールフィールドを追加することも可能ですが、カスタムのユーザーモデルを指定する で説明されているように、独立したモデルを作ることをおすすめします。AbstractUser は、デフォルトの User の完全な実装を 抽象モデル として提供します。

カスタムのユーザーとビルトインの認証フォーム

Django のビルトインの フォーム と ビュー は、協調して動作するユーザーモデルに対して、いくつかの前提を置いています。

以下のフォームは AbstractBaseUser のあらゆるサブクラスに互換性があります。

• AuthenticationForm: USERNAME_FIELD で指定したユーザー名フィールドを使用する。

• SetPasswordForm

• PasswordChangeForm

• AdminPasswordChangeForm

以下のフォームは、ユーザーモデルについて以下のようないくつか前提を置いています。これらの前提を満たしている場合、同じユーザーモデルとみなして使用できます。

• PasswordResetForm: ユーザモデルには、ユーザのメールアドレスを格納するフィールドがあり、 get_email_field_name() (デフォルトでは email) によって返される名前がユーザを識別するために使用され、 is_active という真偽値フィールドがアクティブでないユーザのパスワードリセットを防ぐために使用されると仮定します。

最後に、以下のフォームは、User と固く結びついているため、カスタムのユーザーモデルとともに使用するには、書き換えや拡張が必要になります。

• UserCreationForm

• UserChangeForm

カスタムユーザモデルが AbstractUser のサブクラスであれば、次ようにフォームを拡張できます:

from django.contrib.auth.forms import UserCreationForm
from myapp.models import CustomUser


class CustomUserCreationForm(UserCreationForm):
    class Meta(UserCreationForm.Meta):
        model = CustomUser
        fields = UserCreationForm.Meta.fields + ("custom_field",)

カスタムのユーザーと django.contrib.admin

カスタムのユーザーモデルを admin で動作させたい場合、ユーザーモデルにいくつかの追加の属性とメソッドを定義しなければなりません。これらのメソッドを定義することで、admin はユーザーへアクセスを制御して admin のコンテンツに合わせることができます。

class models.CustomUser

is_staff

ユーザーが admin サイトへのアクセス権を持っている時、True を返します。

is_active

ユーザーアカウントが現在アクティブな時、True を返します。

has_perm(perm, obj=None):

ユーザーが名前付きの権限を持っている時、True を返します。obj が提供された場合、特定のオブジェクトのインスタンスに対して権限をチェックする必要があります。

has_module_perms(app_label):

ユーザーが与えられたアプリ内のモデルへのアクセス権を持っている場合、True を返します。

また、カスタムユーザークラスを admin に登録する必要もあります。もしカスタムユーザーモデルが django.contrib.auth.models.AbstractUser を継承したものである場合、Django の既存の django.contrib.auth.admin.UserAdmin クラスがそのまま利用できます。しかし、ユーザーモデルが AbstractBaseUser を継承したものである場合には、カスタムの ModelAdmin クラスを定義する必要があります。デフォルトの django.contrib.auth.admin.UserAdmin をサブクラス化することも可能ですが、その場合には django.contrib.auth.models.AbstractUser 上のフィールドを参照する定義のうち、カスタムユーザークラス上にはない定義をすべてオーバーライドする必要があるでしょう。

注釈

django.contrib.auth.admin.UserAdmin のサブクラスである ModelAdmin を使用する場合、fieldsets (ユーザーの変更時に使われるフィールド) および add_fieldsets (ユーザーの作成時に使われるフィールド) に自分のカスタムフィールドを追加する必要があります。たとえば、次のように書くことができます。

from django.contrib.auth.admin import UserAdmin


class CustomUserAdmin(UserAdmin):
    ...
    fieldsets = UserAdmin.fieldsets + ((None, {"fields": ["custom_field"]}),)
    add_fieldsets = UserAdmin.add_fieldsets + ((None, {"fields": ["custom_field"]}),)

詳細は、完全な例 のページを参照してください。

カスタムのユーザーとパーミッション

Django のパーミッションフレームワークをカスタムのユーザーモデルに簡単に取り入れられるように用意されているのが、Django の PermissionsMixin です。これはユーザーモデルの階層に取り入れることができる抽象モデルで、Django のパーミッションモデルをサポートするのに必要なすべてのメソッドとデーターベースのフィールドを使えるようにしてくれます。

PermissionsMixin は、以下のメソッドと属性を提供します。

class models.PermissionsMixin

is_superuser

真偽値です。明示的に与えられない場合でも、ユーザーがが全てのパーミッションを持っているかどうかを示します。

get_user_permissions(obj=None)

ユーザーが直接持っているパーミッション文字列のセットを返します。

もし obj が渡された場合、この特定のオブジェクトのユーザパーミッションのみを返します。

get_group_permissions(obj=None)

ユーザがグループを通して持つパーミッションの文字列のセットを返します。

obj が渡されたとき、指定されたオブジェクトに対するグループパーミッションのみを返します。

get_all_permissions(obj=None)

ユーザがグループおよびユーザパーミッションを通して持つパーミッションの文字列のセットを返します。

obj が渡された場合、指定されたオブジェクトに対するパーミッションのみを返します。

has_perm(perm, obj=None)

ユーザーが指定したパーミッションを持っている場合、True を返します。ここで、perm は "<app label>.<permission codename>" という形式で指定します (パーミッション を参照)。もし、User.is_active と is_superuser が両方とも True だった場合、このメソッドは常に True を返します。

obj が渡された場合、このメソッドはモデルに対するパーミッションのチェックを行わず、指定されたオブジェクトに対して行います。

has_perms(perm_list, obj=None)

ユーザーが指定したパーミッションを持っている場合、True を返します。ここで、perm は "<app label>.<permission codename>" という形式で指定します。もし、User.is_active と is_superuser が両方とも True だった場合、このメソッドは常に True を返します。

obj が渡された場合、このメソッドは指定されたオブジェクトに対してパーミッションのチェックを行い、モデルに対しては行いません。

has_module_perms(package_name)

ユーザが指定されたパッケージ（Django アプリのラベル）に何らかのパーミッションを持っている場合、 True を返します。 User.is_active と is_superuser が両方 True なら、このメソッドは常に True を返します。

PermissionsMixin と ModelBackend

PermissionsMixin をインクルードしていない場合、 ModelBackend のパーミッションメソッドを呼び出してはいけません。 ModelBackend は、ユーザモデルで特定のフィールドが利用可能であることを想定しています。ユーザモデルがこれらのフィールドを提供していない場合、パーミッションをチェックするとデータベースエラーになります。

カスタムのユーザーと proxy モデル

カスタムユーザモデルの制限の一つは、カスタムユーザモデルをインストールすると、 User を拡張するプロキシモデルが壊れてしまうことです。プロキシモデルは具象基底クラスを継承している必要があります。カスタムユーザモデルを定義すると、 Django が基底クラスを確実に識別する方法を奪ってしまいます。

プロジェクトでプロキシモデルを使用している場合、プロキシを変更してプロジェクトで使用しているユーザーモデルを拡張するか、プロキシの動作を User サブクラスにマージする必要があります。

完全な具体例

以下は admin に準拠したカスタムユーザーアプリの例です。このユーザモデルはユーザ名としてメールアドレスを使用し、生年月日を必須とします。ユーザーアカウントに admin フラグを立てるだけで、権限のチェックは行いません。このモデルはユーザー作成フォームを除く、すべての組み込みの認証フォームとビューと互換性があります。このサンプルはほとんどのコンポーネントがどう連携して動作するかの例であり、実運用のためのプロジェクトに直接コピーされることを想定したものではありません。

このコードはすべてカスタム認証アプリの models.py ファイルに格納されます:

from django.db import models
from django.contrib.auth.models import BaseUserManager, AbstractBaseUser


class MyUserManager(BaseUserManager):
    def create_user(self, email, date_of_birth, password=None):
        """
        Creates and saves a User with the given email, date of
        birth and password.
        """
        if not email:
            raise ValueError("Users must have an email address")

        user = self.model(
            email=self.normalize_email(email),
            date_of_birth=date_of_birth,
        )

        user.set_password(password)
        user.save(using=self._db)
        return user

    def create_superuser(self, email, date_of_birth, password=None):
        """
        Creates and saves a superuser with the given email, date of
        birth and password.
        """
        user = self.create_user(
            email,
            password=password,
            date_of_birth=date_of_birth,
        )
        user.is_admin = True
        user.save(using=self._db)
        return user


class MyUser(AbstractBaseUser):
    email = models.EmailField(
        verbose_name="email address",
        max_length=255,
        unique=True,
    )
    date_of_birth = models.DateField()
    is_active = models.BooleanField(default=True)
    is_admin = models.BooleanField(default=False)

    objects = MyUserManager()

    USERNAME_FIELD = "email"
    REQUIRED_FIELDS = ["date_of_birth"]

    def __str__(self):
        return self.email

    def has_perm(self, perm, obj=None):
        "Does the user have a specific permission?"
        # Simplest possible answer: Yes, always
        return True

    def has_module_perms(self, app_label):
        "Does the user have permissions to view the app `app_label`?"
        # Simplest possible answer: Yes, always
        return True

    @property
    def is_staff(self):
        "Is the user a member of staff?"
        # Simplest possible answer: All admins are staff
        return self.is_admin

そして、このカスタムユーザモデルを Django の admin に登録するには、アプリの admin.py ファイルに以下のコードが必要になります:

from django import forms
from django.contrib import admin
from django.contrib.auth.models import Group
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
from django.contrib.auth.forms import ReadOnlyPasswordHashField
from django.core.exceptions import ValidationError

from customauth.models import MyUser


class UserCreationForm(forms.ModelForm):
    """A form for creating new users. Includes all the required
    fields, plus a repeated password."""

    password1 = forms.CharField(label="Password", widget=forms.PasswordInput)
    password2 = forms.CharField(
        label="Password confirmation", widget=forms.PasswordInput
    )

    class Meta:
        model = MyUser
        fields = ["email", "date_of_birth"]

    def clean_password2(self):
        # Check that the two password entries match
        password1 = self.cleaned_data.get("password1")
        password2 = self.cleaned_data.get("password2")
        if password1 and password2 and password1 != password2:
            raise ValidationError("Passwords don't match")
        return password2

    def save(self, commit=True):
        # Save the provided password in hashed format
        user = super().save(commit=False)
        user.set_password(self.cleaned_data["password1"])
        if commit:
            user.save()
        return user


class UserChangeForm(forms.ModelForm):
    """A form for updating users. Includes all the fields on
    the user, but replaces the password field with admin's
    disabled password hash display field.
    """

    password = ReadOnlyPasswordHashField()

    class Meta:
        model = MyUser
        fields = ["email", "password", "date_of_birth", "is_active", "is_admin"]


class UserAdmin(BaseUserAdmin):
    # The forms to add and change user instances
    form = UserChangeForm
    add_form = UserCreationForm

    # The fields to be used in displaying the User model.
    # These override the definitions on the base UserAdmin
    # that reference specific fields on auth.User.
    list_display = ["email", "date_of_birth", "is_admin"]
    list_filter = ["is_admin"]
    fieldsets = [
        (None, {"fields": ["email", "password"]}),
        ("Personal info", {"fields": ["date_of_birth"]}),
        ("Permissions", {"fields": ["is_admin"]}),
    ]
    # add_fieldsets is not a standard ModelAdmin attribute. UserAdmin
    # overrides get_fieldsets to use this attribute when creating a user.
    add_fieldsets = [
        (
            None,
            {
                "classes": ["wide"],
                "fields": ["email", "date_of_birth", "password1", "password2"],
            },
        ),
    ]
    search_fields = ["email"]
    ordering = ["email"]
    filter_horizontal = []


# Now register the new UserAdmin...
admin.site.register(MyUser, UserAdmin)
# ... and, since we're not using Django's built-in permissions,
# unregister the Group model from admin.
admin.site.unregister(Group)

最後に、 settings.py: の AUTH_USER_MODEL 設定を使用して、カスタムモデルをプロジェクトのデフォルトのユーザーモデルとして指定します:

AUTH_USER_MODEL = "customauth.MyUser"