Djangoの認証システムを使用するLink to this heading#

認証バックエンドの選択Link to this heading#

ユーザーがログインする際、そのユーザーの ID と認証時に用いた認証バックエンドはセッション中保持されます。その仕組みによって、ユーザーの詳細情報を取得するリクエストが発生した場合に同じ 認証バックエンド を利用できます。セッション中に保持される認証バックエンドは下記の手順を経て選択されます:

1. 省略可能な backend 引数が与えられている場合は利用します。

2. 存在すれば属性 user.backend の値を利用する。authenticate() は返すユーザーオブジェクトに属性値 user.backend を付与するので、authenticate() と login() とで連携を図ることができる。

3. ただ一つだけ設定が存在すれば AUTHENTICATION_BACKENDS の backend を利用する。

4. いずれにも該当しなかった場合、例外が送出される。

1 もしくは 2 においては、引数 backend あるいは属性値 user.backend は(AUTHENTICATION_BACKENDS で定義されているのと同様に)ドット付きのインポート先を示すパスの文字列でなければなりません。

原理的な方法Link to this heading#

The raw way to limit access to pages is to check request.user.is_authenticated and either redirect to a login page:

from django.conf import settings
from django.shortcuts import redirect

def my_view(request):
    if not request.user.is_authenticated:
        return redirect('%s?next=%s' % (settings.LOGIN_URL, request.path))
    # ...

もしくはエラーメッセージを出力します。

from django.shortcuts import render

def my_view(request):
    if not request.user.is_authenticated:
        return render(request, 'myapp/login_error.html')
    # ...

login_required デコレータLink to this heading#

login_required(redirect_field_name='next', login_url=None)Link to this definition#

ショートカットとして、便利な login_required() デコレータを利用できます:

Code

from django.contrib.auth.decorators import login_required

@login_required
def my_view(request):
    ...

login_required() は下記の処理を行います:

• もしユーザがログインしていなければ、settings.LOGIN_URL にリダイレクトし、クエリ文字列に現在の絶対パスを渡します。リダイレクト先の例: /accounts/login/?next=/polls/3/

• もしユーザがログインしていれば、通常通りビューを処理します。ビューのコードの中ではユーザがログインしているかを意識しなくて良いのです。

デフォルトでは、認証に成功したユーザがリダイレクトされる先のパスは "next" という名称のクエリパラメータに格納されています。もし異なるパラメータ名を利用したい場合、login_required() が redirect_field_name という省略可能な引数を受け取ります:

Code

from django.contrib.auth.decorators import login_required

@login_required(redirect_field_name='my_redirect_field')
def my_view(request):
    ...

redirect_field_name に値を持たせた場合、ログインテンプレートもカスタマイズする必要があるでしょう。これは、リダイレクト先のパスを格納しているテンプレートコンテキスト変数が、キーとして (デフォルトの) "next" でなく redirect_field_name の値を使用してしまうためです。

login_required() はまた省略可能な引数として login_url を受け取る事ができます。以下の例のように利用します:

Code

from django.contrib.auth.decorators import login_required

@login_required(login_url='/accounts/login/')
def my_view(request):
    ...

`login_url` のパラメータを定義しない場合、settings.LOGIN_URL が設定されかつログイン用ビューが適切に配置されている必要が有ります。例えば、デフォルトの設定を利用して下記の内容を URLconf に追加してください:

Code

from django.contrib.auth import views as auth_views

path('accounts/login/', auth_views.LoginView.as_view()),

settings.LOGIN_URL はまたビュー関数名と 命名された URL パターン を受け付けます。この仕組みによって設定を更新することなく URLconf 内のログイン用ビューを再配置する事ができます。

LoginRequired mixinLink to this heading#

クラスベースのビュー を使う際、 LoginRequiredMixin を使うことで login_required と同じ動作をさせることができます。 この mixin は、継承リストの一番左に記述される必要があります。

class LoginRequiredMixinLink to this definition#

ビューがこの mixin を使う場合、認証されていないユーザによるすべてのリクエストは、ログインページにリダイレクトされるか、HTTP 403 Forbidden エラー表示となります。これは、raise_exception パラメータにて設定します。

AccessMixin のパラメータをセットすると、認証されていないユーザの管理をカスタムできます:

Code

from django.contrib.auth.mixins import LoginRequiredMixin

class MyView(LoginRequiredMixin, View):
    login_url = '/login/'
    redirect_field_name = 'redirect_to'

テストをパスしたログイン済みユーザのアクセスを制限するLink to this heading#

To limit access based on certain permissions or some other test, you'd do essentially the same thing as described in the previous section.

You can run your test on request.user in the view directly. For example, this view checks to make sure the user has an email in the desired domain and if not, redirects to the login page:

from django.shortcuts import redirect

def my_view(request):
    if not request.user.email.endswith('@example.com'):
        return redirect('/login/?next=%s' % request.path)
    # ...

user_passes_test(test_func, login_url=None, redirect_field_name='next')Link to this definition#

As a shortcut, you can use the convenient user_passes_test decorator which performs a redirect when the callable returns False:

Code

from django.contrib.auth.decorators import user_passes_test

def email_check(user):
    return user.email.endswith('@example.com')

@user_passes_test(email_check)
def my_view(request):
    ...

user_passes_test() takes a required argument: a callable that takes a User object and returns True if the user is allowed to view the page. Note that user_passes_test() does not automatically check that the User is not anonymous.

user_passes_test() takes two optional arguments:

login_url

Lets you specify the URL that users who don't pass the test will be redirected to. It may be a login page and defaults to settings.LOGIN_URL if you don't specify one.

redirect_field_name

Same as for login_required(). Setting it to None removes it from the URL, which you may want to do if you are redirecting users that don't pass the test to a non-login page where there's no "next page".

例:

Code

@user_passes_test(email_check, login_url='/login/')
def my_view(request):
    ...

class UserPassesTestMixinLink to this definition#

When using class-based views, you can use the UserPassesTestMixin to do this.

test_func()Link to this definition#

You have to override the test_func() method of the class to provide the test that is performed. Furthermore, you can set any of the parameters of AccessMixin to customize the handling of unauthorized users:

Code

from django.contrib.auth.mixins import UserPassesTestMixin

class MyView(UserPassesTestMixin, View):

    def test_func(self):
        return self.request.user.email.endswith('@example.com')

get_test_func()Link to this definition#

You can also override the get_test_func() method to have the mixin use a differently named function for its checks (instead of test_func()).

permission_required デコレータLink to this heading#

permission_required(perm, login_url=None, raise_exception=False)Link to this definition#

It's a relatively common task to check whether a user has a particular permission. For that reason, Django provides a shortcut for that case: the permission_required() decorator.:

Code

from django.contrib.auth.decorators import permission_required

@permission_required('polls.add_choice')
def my_view(request):
    ...

Just like the has_perm() method, permission names take the form "<app label>.<permission codename>" (i.e. polls.add_choice for a permission on a model in the polls application).

The decorator may also take an iterable of permissions, in which case the user must have all of the permissions in order to access the view.

Note that permission_required() also takes an optional login_url parameter:

Code

from django.contrib.auth.decorators import permission_required

@permission_required('polls.add_choice', login_url='/loginpage/')
def my_view(request):
    ...

As in the login_required() decorator, login_url defaults to settings.LOGIN_URL.

If the raise_exception parameter is given, the decorator will raise PermissionDenied, prompting the 403 (HTTP Forbidden) view instead of redirecting to the login page.

If you want to use raise_exception but also give your users a chance to login first, you can add the login_required() decorator:

Code

from django.contrib.auth.decorators import login_required, permission_required

@login_required
@permission_required('polls.add_choice', raise_exception=True)
def my_view(request):
    ...

This also avoids a redirect loop when LoginView's redirect_authenticated_user=True and the logged-in user doesn't have all of the required permissions.

The PermissionRequiredMixin mixinLink to this heading#

To apply permission checks to class-based views, you can use the PermissionRequiredMixin:

class PermissionRequiredMixinLink to this definition#

This mixin, just like the permission_required decorator, checks whether the user accessing a view has all given permissions. You should specify the permission (or an iterable of permissions) using the permission_required parameter:

Code

from django.contrib.auth.mixins import PermissionRequiredMixin

class MyView(PermissionRequiredMixin, View):
    permission_required = 'polls.add_choice'
    # Or multiple of permissions:
    permission_required = ('polls.view_choice', 'polls.change_choice')

You can set any of the parameters of AccessMixin to customize the handling of unauthorized users.

You may also override these methods:

get_permission_required()Link to this definition#

Returns an iterable of permission names used by the mixin. Defaults to the permission_required attribute, converted to a tuple if necessary.

has_permission()Link to this definition#

Returns a boolean denoting whether the current user has permission to execute the decorated view. By default, this returns the result of calling has_perms() with the list of permissions returned by get_permission_required().

Session invalidation on password changeLink to this heading#

If your AUTH_USER_MODEL inherits from AbstractBaseUser or implements its own get_session_auth_hash() method, authenticated sessions will include the hash returned by this function. In the AbstractBaseUser case, this is an HMAC of the password field. Django verifies that the hash in the session for each request matches the one that's computed during the request. This allows a user to log out all of their sessions by changing their password.

The default password change views included with Django, PasswordChangeView and the user_change_password view in the django.contrib.auth admin, update the session with the new password hash so that a user changing their own password won't log themselves out. If you have a custom password change view and wish to have similar behavior, use the update_session_auth_hash() function.

update_session_auth_hash(request, user)Link to this definition#

This function takes the current request and the updated user object from which the new session hash will be derived and updates the session hash appropriately. It also rotates the session key so that a stolen session cookie will be invalidated.

使い方の例:

Code

from django.contrib.auth import update_session_auth_hash

def password_change(request):
    if request.method == 'POST':
        form = PasswordChangeForm(user=request.user, data=request.POST)
        if form.is_valid():
            form.save()
            update_session_auth_hash(request, form.user)
    else:
        ...

ビューを使用するLink to this heading#

プロジェクト内でこれらのビューを実装するには、いくつかの方法があります。最も簡単なのは、django.contrib.auth.urls で提供される URLconf をあなた独自の URLconf に含めることです。たとえば:

urlpatterns = [
    path('accounts/', include('django.contrib.auth.urls')),
]

これは以下の URL パターンを含みます:

accounts/login/ [name='login']
accounts/logout/ [name='logout']
accounts/password_change/ [name='password_change']
accounts/password_change/done/ [name='password_change_done']
accounts/password_reset/ [name='password_reset']
accounts/password_reset/done/ [name='password_reset_done']
accounts/reset/<uidb64>/<token>/ [name='password_reset_confirm']
accounts/reset/done/ [name='password_reset_complete']

これらのビューは、より簡単に参照できる URL 名を提供します. 名前付き URL パターンの詳細については、URL ドキュメント をご覧ください。

URL をより詳細にコントロールしたい場合は、URLconf 内の特定のビューを指定することもできます:

from django.contrib.auth import views as auth_views

urlpatterns = [
    path('change-password/', auth_views.PasswordChangeView.as_view()),
]

これらのビューでは、挙動を操作するためのオプショナル引数を使えます。たとえば、ビューが参照するテンプレートの名前を変更したいときは、template_name 引数を指定します。引数指定の方法の 1 つは、URLconf 内でキーワード引数を渡すことです。指定した引数はビューに渡されます。たとえば:

urlpatterns = [
    path(
        'change-password/',
        auth_views.PasswordChangeView.as_view(template_name='change-password.html'),
    ),
]

すべてのビューは クラスベース なので、サブクラス化することで容易にカスタムできます。

すべての認証ビューLink to this heading#

以下は、django.contrib.auth が提供するすべてのビューのリストです。実装の詳細については、ビューを使う を参照してください。

class LoginViewLink to this definition#

URL name: login

名前付き URL パターンの使い方は、URL ドキュメント をご覧ください。

属性:

• template_name: The name of a template to display for the view used to log the user in. Defaults to registration/login.html.

• redirect_field_name: The name of a GET field containing the URL to redirect to after login. Defaults to next.

• authentication_form: A callable (typically a form class) to use for authentication. Defaults to AuthenticationForm.

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

• redirect_authenticated_user: A boolean that controls whether or not authenticated users accessing the login page will be redirected as if they had just successfully logged in. Defaults to False.

• success_url_allowed_hosts: A set of hosts, in addition to request.get_host(), that are safe for redirecting after login. Defaults to an empty set.

Here's what LoginView does:

• If called via GET, it displays a login form that POSTs to the same URL. More on this in a bit.

• If called via POST with user submitted credentials, it tries to log the user in. If login is successful, the view redirects to the URL specified in next. If next isn't provided, it redirects to settings.LOGIN_REDIRECT_URL (which defaults to /accounts/profile/). If login isn't successful, it redisplays the login form.

It's your responsibility to provide the html for the login template , called registration/login.html by default. This template gets passed four template context variables:

• form: A Form object representing the AuthenticationForm.

• next: The URL to redirect to after successful login. This may contain a query string, too.

• site: The current Site, according to the SITE_ID setting. If you don't have the site framework installed, this will be set to an instance of RequestSite, which derives the site name and domain from the current HttpRequest.

• site_name: An alias for site.name. If you don't have the site framework installed, this will be set to the value of request.META['SERVER_NAME']. For more on sites, see The "sites" framework.

If you'd prefer not to call the template registration/login.html, you can pass the template_name parameter via the extra arguments to the as_view method in your URLconf. For example, this URLconf line would use myapp/login.html instead:

Code

path('accounts/login/', auth_views.LoginView.as_view(template_name='myapp/login.html')),

You can also specify the name of the GET field which contains the URL to redirect to after login using redirect_field_name. By default, the field is called next.

Here's a sample registration/login.html template you can use as a starting point. It assumes you have a base.html template that defines a content block:

Django template

{% extends "base.html" %}

{% block content %}

{% if form.errors %}
<p>Your username and password didn't match. Please try again.</p>
{% endif %}

{% if next %}
    {% if user.is_authenticated %}
    <p>Your account doesn't have access to this page. To proceed,
    please login with an account that has access.</p>
    {% else %}
    <p>Please login to see this page.</p>
    {% endif %}
{% endif %}

<form method="post" action="{% url 'login' %}">
{% csrf_token %}
<table>
<tr>
    <td>{{ form.username.label_tag }}</td>
    <td>{{ form.username }}</td>
</tr>
<tr>
    <td>{{ form.password.label_tag }}</td>
    <td>{{ form.password }}</td>
</tr>
</table>

<input type="submit" value="login">
<input type="hidden" name="next" value="{{ next }}">
</form>

{# Assumes you setup the password_reset view in your URLconf #}
<p><a href="{% url 'password_reset' %}">Lost password?</a></p>

{% endblock %}

If you have customized authentication (see Customizing Authentication) you can use a custom authentication form by setting the authentication_form attribute. This form must accept a request keyword argument in its __init__() method and provide a get_user() method which returns the authenticated user object (this method is only ever called after successful form validation).

class LogoutViewLink to this definition#

Logs a user out.

URL name: logout

属性:

• next_page: The URL to redirect to after logout. Defaults to settings.LOGOUT_REDIRECT_URL.

• template_name: The full name of a template to display after logging the user out. Defaults to registration/logged_out.html.

• redirect_field_name: The name of a GET field containing the URL to redirect to after log out. Defaults to next. Overrides the next_page URL if the given GET parameter is passed.

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

• success_url_allowed_hosts: A set of hosts, in addition to request.get_host(), that are safe for redirecting after logout. Defaults to an empty set.

Template context:

• title: The string "Logged out", localized.

• site: The current Site, according to the SITE_ID setting. If you don't have the site framework installed, this will be set to an instance of RequestSite, which derives the site name and domain from the current HttpRequest.

• site_name: An alias for site.name. If you don't have the site framework installed, this will be set to the value of request.META['SERVER_NAME']. For more on sites, see The "sites" framework.

logout_then_login(request, login_url=None)Link to this definition#

Logs a user out, then redirects to the login page.

URL name: No default URL provided

Optional arguments:

• login_url: The URL of the login page to redirect to. Defaults to settings.LOGIN_URL if not supplied.

class PasswordChangeViewLink to this definition#

URL name: password_change

Allows a user to change their password.

属性:

• template_name: The full name of a template to use for displaying the password change form. Defaults to registration/password_change_form.html if not supplied.

• success_url: The URL to redirect to after a successful password change. Defaults to 'password_change_done'.

• form_class: A custom "change password" form which must accept a user keyword argument. The form is responsible for actually changing the user's password. Defaults to PasswordChangeForm.

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

Template context:

• form: The password change form (see form_class above).

class PasswordChangeDoneViewLink to this definition#

URL name: password_change_done

The page shown after a user has changed their password.

属性:

• template_name: The full name of a template to use. Defaults to registration/password_change_done.html if not supplied.

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

class PasswordResetViewLink to this definition#

URL 名: password_reset

パスワードをリセットするために使われる 1 回限り有効なリンクを生成し、ユーザがパスワードをリセットできるようにします。そのリンクはユーザーが登録した E メールアドレスに送信されます。

入力された E メールアドレスがシステムに存在しない場合、ビューはメール送信をせず、またエラーメッセージも表示しません。これは、潜在的な攻撃者への情報漏洩を防ぐためです。エラーメッセージを表示したい場合は、PasswordResetForm をサブクラス化して、form_class 属性を使用してください。

無効なパスワード (詳しくは set_unusable_password() ) でフラグが立てられたユーザは、パスワードリセットのリクエストができないようになっており、LDAP のような外部の認証ソースを使っているときに悪用されるのを防ぎます。アカウントの存在が漏洩しないように、ユーザーはエラーメッセージを受け取ることもメールが送信されることもありません。

属性:

• template_name: パスワードリセットのフォームを表示するためのテンプレート名です。指定しない場合のデフォルトは registration/password_reset_form.html です。

• form_class: パスワードをリセットするためのユーザの E メールアドレス入力用のフォームです。デフォルトは PasswordResetForm です。

• email_template_name: リセットパスワードのリンクとともに生成される E メールを生成するためのテンプレート名です。指定しない場合のデフォルトは registration/password_reset_email.html です。

• subject_template_name: リセットパスワードのリンクとともに生成される E メールの表題に対して使われるテンプレートの名前です。指定しない場合のデフォルトは registration/password_reset_subject.txt です。

• token_generator: 1 回限りのリンクをチェックするためのクラスのインスタンスです。デフォルトは default_token_generator で、これは django.contrib.auth.tokens.PasswordResetTokenGenerator のインスタンスです。

• success_url: The URL to redirect to after a successful password reset request. Defaults to 'password_reset_done'.

• from_email: 検証済みの E メールアドレスです。デフォルトでは、Django は DEFAULT_FROM_EMAIL を使います。

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

• html_email_template_name: The full name of a template to use for generating a text/html multipart email with the password reset link. By default, HTML email is not sent.

• extra_email_context: A dictionary of context data that will be available in the email template. It can be used to override default template context values listed below e.g. domain.

Template context:

• form: ユーザのパスワードをリセットするためのフォームです (上述の form_class をご覧ください)。

E メールテンプレートのコンテキスト:

• email: user.email の別名 (エイリアス) です。

• user: 現在の User で、email フォームフィールドから取得されます。アクティブなユーザ (User.is_active が True) だけがパスワードをリセットすることができます。

• site_name: An alias for site.name. If you don't have the site framework installed, this will be set to the value of request.META['SERVER_NAME']. For more on sites, see The "sites" framework.

• domain: site.domain の別名 (エイリアス) です。サイトのフレームワークをインストールしていない場合、request.get_host() の値がセットされます。

• protocol: http か https です。

• uid: Base 64 でエンコードされたユーザのプライマリキーです。

• token: リセットリンクを検証するためのトークンです。

以下はサンプルの registration/password_reset_email.html (E メール本文のテンプレート)です:

Django template

Someone asked for password reset for email {{ email }}. Follow the link below:
{{ protocol}}://{{ domain }}{% url 'password_reset_confirm' uidb64=uid token=token %}

表題のテンプレートにも同じテンプレートコンテキストが使われます。表題は 1 行のプレーンテキスト文字列の必要があります。

class PasswordResetDoneViewLink to this definition#

URL 名: password_reset_done

パスワードリセット用のリンクがユーザにメール送信された後に表示されるページです。このビューは、デフォルトで PasswordResetView に明示的な success_url URL セットが指定されていないときに呼び出されます。

属性:

• template_name: テンプレートの名前です。指定しない場合のデフォルトは registration/password_reset_done.html です。

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

class PasswordResetConfirmViewLink to this definition#

URL 名: password_reset_confirm

新しいパスワードを入力するためのフォームを提供します。

Keyword arguments from the URL:

• uidb64: The user's id encoded in base 64.

• token: Token to check that the password is valid.

属性:

• template_name: パスワード確認のビューを表示するためのテンプレートの名前です。デフォルト値は registration/password_reset_confirm.html です。

• token_generator: パスワードをチェックするためのクラスのインスタンスです。デフォルトは default_token_generator で、これは django.contrib.auth.tokens.PasswordResetTokenGenerator のインスタンスです。

• post_reset_login: A boolean indicating if the user should be automatically authenticated after a successful password reset. Defaults to False.

• post_reset_login_backend: A dotted path to the authentication backend to use when authenticating a user if post_reset_login is True. Required only if you have multiple AUTHENTICATION_BACKENDS configured. Defaults to None.

• form_class: Form that will be used to set the password. Defaults to SetPasswordForm.

• success_url: URL to redirect after the password reset done. Defaults to 'password_reset_complete'.

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

• reset_url_token: Token parameter displayed as a component of password reset URLs. Defaults to 'set-password'.

Template context:

• form: The form (see form_class above) for setting the new user's password.

• validlink: 真偽値で、リンク (uidb64 と token の組み合わせ) が有効か、まだ使われていない場合に True となります。

class PasswordResetCompleteViewLink to this definition#

URL 名: password_reset_complete

パスワードの変更が成功したことをユーザに知らせるためのビューを提供します。

属性:

• template_name: ビューを表示するためのテンプレートの名前です。デフォルトは registration/password_reset_complete.html です。

• extra_context: A dictionary of context data that will be added to the default context data passed to the template.

ユーザLink to this heading#

テンプレート RequestContext をレンダリングするとき、現在ログイン中のユーザ (User インスタンスか AnonymousUser のどちらか) はテンプレート変数 {{ user }} 内に格納されます:

{% if user.is_authenticated %}
    <p>Welcome, {{ user.username }}. Thanks for logging in.</p>
{% else %}
    <p>Welcome, new user. Please log in.</p>
{% endif %}

RequestContext が使用されていない場合、このテンプレートコンテキスト変数は無効となります。

パーミッションLink to this heading#

現在ログイン中のユーザのパーミッションは、テンプレート変数 {{ perms }} 内に保持されています。 これは django.contrib.auth.context_processors.PermWrapper のインスタンスで、パーミッションをテンプレートで使いやすくするための代替表現です。

Evaluating a single-attribute lookup of {{ perms }} as a boolean is a proxy to User.has_module_perms(). For example, to check if the logged-in user has any permissions in the foo app:

{% if perms.foo %}

Evaluating a two-level-attribute lookup as a boolean is a proxy to User.has_perm(). For example, to check if the logged-in user has the permission foo.add_vote:

{% if perms.foo.add_vote %}

Here's a more complete example of checking permissions in a template:

{% if perms.foo %}
    <p>You have permission to do something in the foo app.</p>
    {% if perms.foo.add_vote %}
        <p>You can vote!</p>
    {% endif %}
    {% if perms.foo.add_driving %}
        <p>You can drive!</p>
    {% endif %}
{% else %}
    <p>You don't have permission to do anything in the foo app.</p>
{% endif %}

{% if in %} ステートメントを使ってパーミッションをルックアップすることも可能です。例えば:

{% if 'foo' in perms %}
    {% if 'foo.add_vote' in perms %}
        <p>In lookup works, too.</p>
    {% endif %}
{% endif %}