Djangoの認証システムを使用するLink to this heading
このドキュメントでは、デフォルト設定でのDjangoの認証システムの使用方法を説明します。この設定は、タスクの適切な範囲を管理することで、最も一般的なプロジェクトのニーズにかなうよう徐々に発展してきました。そして、パスワードや権限の入念な実装を持っています。デフォルトの認証システムからの変更が必要なプロジェクトのために、Djangoは認証システムの広範囲の 拡張とカスタマイズ をサポートします。
Djangoの認証は、認証機能と権限機能の両方を共に提供しています。そして、一般的に、これらの機能を合わせて認証システムと呼びます。
User オブジェクトLink to this heading
User オブジェクトは、認証システムの中核です。一般的に、このオブジェクトはあなたのサイトに関係する人々を表し、アクセスを制限すること、ユーザ情報を登録すること、コンテンツを作成者と関連付けることを可能にする際などに利用されます。
Djangoの認証フレームワークにはUserクラスという、ただひとつのクラスのみが存在します。すなわち、 'superusers' または admin 'staff' ユーザは、Userオブジェクトと異なるクラスではなく、特別な属性セットを持ったUserオブジェクトなのです。
デフォルトのユーザの主要な属性は次のとおりです。
仕様については full API documentation を参照してください。 次のドキュメントは、よりタスク指向の形式となっています。
ユーザを作成するLink to this heading
ユーザを作成するための最も直接的な方法は、組み込まれている create_user() というヘルパー関数を利用することです。
>>> from django.contrib.auth.models import User
>>> user = User.objects.create_user('john', 'lennon@thebeatles.com', 'johnpassword')
# At this point, user is a User object that has already been saved
# to the database. You can continue to change its attributes
# if you want to change other fields.
>>> user.last_name = 'Lennon'
>>> user.save()
すでにDjango adminをインストールしている場合は、 インタラクティブにユーザを作成する こともできます。
スーパーユーザを作成するLink to this heading
Create superusers using the createsuperuser command:
$ python manage.py createsuperuser --username=joe --email=joe@example.com
パスワードを入力するように促されます。入力後、ただちにユーザが作成されます。 --username または --email オプションを使用しなければ、これらの値を入力するように促されます。
パスワードを変更するLink to this heading
Djangoはユーザモデルに未加工の(はっきりとしたテキストの)パスワードは保存せず、ハッシュ値でのみ保存します( 詳細は、 パスワードは管理方法に関するドキュメント を参照してください)。これにより、パスワード属性を使用されません。これが、ユーザを作成する際にヘルパー関数を使用する理由です。
ユーザのパスワードを変更するには、いくつかのオプションがあります。
manage.py changepassword *username* offers a method
of changing a user's password from the command line. It prompts you to
change the password of a given user which you must enter twice. If
they both match, the new password will be changed immediately. If you
do not supply a user, the command will attempt to change the password
whose username matches the current system user.
set_password() を使用することで、プログラムでパスワードを変更することもできます:
>>> from django.contrib.auth.models import User
>>> u = User.objects.get(username='john')
>>> u.set_password('new password')
>>> u.save()
Django admin がインストールされていれば、 認証システムのadminページ にて、ユーザのパスワードを変更することも可能です。
また、Djangoはユーザ自身のパスワードを変更するための ビュー と フォーム を提供します。
ユーザーのパスワード変更を行う事とそのユーザーのセッションは全てログアウトされます。詳細は Session invalidation on password change を参照してください。
ユーザを認証するLink to this heading
- authenticate(\**credentials)Link to this definition
認証情報のセットを検証するには
authenticate()を利用してください。このメソッドは認証情報をキーワード引数として受け取ります。検証する対象はデフォルトではusernameとpasswordであり、その組み合わせを個々の 認証バックエンド に対して問い合わせ、認証バックエンドで認証情報が有効とされればUserオブジェクトを返します。もしいずれの認証バックエンドでも認証情報が有効と判定されなければPermissionDeniedが送出され、Noneが返されます。以下は実装例です:from django.contrib.auth import authenticate user = authenticate(username='john', password='secret') if user is not None: # A backend authenticated the credentials else: # No backend authenticated the credentials
Web のリクエストにおける認証Link to this heading
Django は リクエストオブジェクト に対して認証システムを接続させるのに セッション とミドルウェアを利用します。
それらは現在のユーザーを示す request.user 属性を付与します。もしユーザーが現在ログインしていない場合、この属性には AnonymousUser のインスタンスが、ログインしている場合は User のインスタンスがセットされます。
この二者は is_authenticated を用いて次のように識別する事ができます:
if request.user.is_authenticated:
# Do something for authenticated users.
...
else:
# Do something for anonymous users.
...
ユーザーをログインさせるにはLink to this heading
現在のセッションにおいて認証を有効としたいユーザーがいる場合 - login() 関数によってそれを行う事ができます。
- login(request, user, backend=None)Link to this definition
あるユーザーをログインさせる場合は、
login()を利用してください。この関数はHttpRequestオブジェクトとUserオブジェクトを受け取ります。login()は Django のセッションフレームワークを利用して、ユーザーのセッション中での ID を保持します。匿名ユーザーとしてのセッション中にセットされたデータが、ログイン後も継続して利用できる事に注意してください。
以下の例では
authenticate()およびlogin()をどのように用いるかを示します:from django.contrib.auth import authenticate, login def my_view(request): username = request.POST['username'] password = request.POST['password'] user = authenticate(username=username, password=password) if user is not None: login(request, user) # Redirect to a success page. ... else: # Return an 'invalid login' error message. ...
認証バックエンドの選択Link to this heading
ユーザーがログインする際、そのユーザーの ID と認証時に用いた認証バックエンドはセッション中保持されます。その仕組みによって、ユーザーの詳細情報を取得するリクエストが発生した場合に同じ 認証バックエンド を利用できます。セッション中に保持される認証バックエンドは下記の手順を経て選択されます:
省略可能な
backend引数が与えられている場合は利用します。存在すれば属性
user.backendの値を利用する。authenticate()は返すユーザーオブジェクトに属性値user.backendを付与するので、authenticate()とlogin()とで連携を図ることができる。ただ一つだけ設定が存在すれば
AUTHENTICATION_BACKENDSのbackendを利用する。いずれにも該当しなかった場合、例外が送出される。
1 もしくは 2 においては、引数 backend あるいは属性値 user.backend は(AUTHENTICATION_BACKENDS で定義されているのと同様に)ドット付きのインポート先を示すパスの文字列でなければなりません。
ユーザーをログアウトさせるにはLink to this heading
- logout(request)Link to this definition
django.contrib.auth.login()を利用してログインしたユーザーをログアウトさせるためには、django.contrib.auth.logout()をビューの中で利用してください。この関数はHttpRequestオブジェクトを受け取り、値を返しません。実装例は下記のようになります:from django.contrib.auth import logout def logout_view(request): logout(request) # Redirect to a success page.logout()は対象となるユーザーが最初からログインしていなかった場合でも例外を送出しない事に注意してください。logout()を呼びだすと、現在処理しているリクエストに対応したセッション情報は完全に破棄されます。その時点までに存在している全てのデータが削除されます。これは別の人物が同じ Web ブラウザを利用してログインし、前のユーザーのセッションにアクセスして使用してしまう事態を防ぐためです。ログアウトした直後から利用できる何らかの情報をセッションに保存したい場合は、django.contrib.auth.logout()を呼び出した後に処理してください。
ログインしているユーザーにアクセスを制限するLink to this heading
原理的な方法Link to this heading
ページに対するアクセスを制限する原理的な方法は request.user.is_authenticated の確認と共にログインページへのリダイレクトを利用する事です:
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()デコレータを利用できます: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という省略可能な引数を受け取ります: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を受け取る事ができます。以下の例のように利用します:from django.contrib.auth.decorators import login_required @login_required(login_url='/accounts/login/') def my_view(request): ...`login_url`のパラメータを定義しない場合、settings.LOGIN_URLが設定されかつログイン用ビューが適切に配置されている必要が有ります。例えば、デフォルトの設定を利用して下記の内容を URLconf に追加してください:from django.contrib.auth import views as auth_views url(r'^accounts/login/$', auth_views.login),settings.LOGIN_URLはまたビュー関数名と 命名された URL パターン を受け付けます。この仕組みによって設定を更新することなく URLconf 内のログイン用ビューを再配置する事ができます。
The LoginRequired mixinLink to this heading
When using class-based views, you can
achieve the same behavior as with login_required by using the
LoginRequiredMixin. This mixin should be at the leftmost position in the
inheritance list.
- class LoginRequiredMixinLink to this definition
-
If a view is using this mixin, all requests by non-authenticated users will be redirected to the login page or shown an HTTP 403 Forbidden error, depending on the
raise_exceptionparameter.You can set any of the parameters of
AccessMixinto customize the handling of unauthorized users:from django.contrib.auth.mixins import LoginRequiredMixin class MyView(LoginRequiredMixin, View): login_url = '/login/' redirect_field_name = 'redirect_to'
Limiting access to logged-in users that pass a testLink 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.
The simple way is to 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_testdecorator which performs a redirect when the callable returnsFalse: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 aUserobject and returnsTrueif the user is allowed to view the page. Note thatuser_passes_test()does not automatically check that theUseris not anonymous.user_passes_test()takes two optional arguments:login_urlLets 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_URLif you don't specify one.redirect_field_nameSame as for
login_required(). Setting it toNoneremoves 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".
For example:
@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
UserPassesTestMixinto 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 ofAccessMixinto customize the handling of unauthorized users: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 oftest_func()).
The permission_required decoratorLink 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.:from django.contrib.auth.decorators import permission_required @permission_required('polls.can_vote') def my_view(request): ...Just like the
has_perm()method, permission names take the form"<app label>.<permission codename>"(i.e.polls.can_votefor a permission on a model in thepollsapplication).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 optionallogin_urlparameter:from django.contrib.auth.decorators import permission_required @permission_required('polls.can_vote', login_url='/loginpage/') def my_view(request): ...As in the
login_required()decorator,login_urldefaults tosettings.LOGIN_URL.If the
raise_exceptionparameter is given, the decorator will raisePermissionDenied, prompting the 403 (HTTP Forbidden) view instead of redirecting to the login page.If you want to use
raise_exceptionbut also give your users a chance to login first, you can add thelogin_required()decorator:from django.contrib.auth.decorators import login_required, permission_required @login_required @permission_required('polls.can_vote', raise_exception=True) def my_view(request): ...
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_requireddecorator, checks whether the user accessing a view has all given permissions. You should specify the permission (or an iterable of permissions) using thepermission_requiredparameter:from django.contrib.auth.mixins import PermissionRequiredMixin class MyView(PermissionRequiredMixin, View): permission_required = 'polls.can_vote' # Or multiple of permissions: permission_required = ('polls.can_open', 'polls.can_edit')You can set any of the parameters of
AccessMixinto 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_requiredattribute, 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 byget_permission_required().
Authentication ViewsLink to this heading
Django provides several views that you can use for handling login, logout, and password management. These make use of the stock auth forms but you can pass in your own forms as well.
Django provides no default template for the authentication views. You should create your own templates for the views you want to use. The template context is documented in each view, see All authentication views.
Using the viewsLink to this heading
There are different methods to implement these views in your project. The
easiest way is to include the provided URLconf in django.contrib.auth.urls
in your own URLconf, for example:
urlpatterns = [
url('^', include('django.contrib.auth.urls')),
]
This will include the following URL patterns:
^login/$ [name='login']
^logout/$ [name='logout']
^password_change/$ [name='password_change']
^password_change/done/$ [name='password_change_done']
^password_reset/$ [name='password_reset']
^password_reset/done/$ [name='password_reset_done']
^reset/(?P<uidb64>[0-9A-Za-z_\-]+)/(?P<token>[0-9A-Za-z]{1,13}-[0-9A-Za-z]{1,20})/$ [name='password_reset_confirm']
^reset/done/$ [name='password_reset_complete']
The views provide a URL name for easier reference. See the URL documentation for details on using named URL patterns.
If you want more control over your URLs, you can reference a specific view in your URLconf:
from django.contrib.auth import views as auth_views
urlpatterns = [
url('^change-password/$', auth_views.password_change),
]
The views have optional arguments you can use to alter the behavior of the
view. For example, if you want to change the template name a view uses, you can
provide the template_name argument. A way to do this is to provide keyword
arguments in the URLconf, these will be passed on to the view. For example:
urlpatterns = [
url(
'^change-password/$',
auth_views.password_change,
{'template_name': 'change-password.html'}
),
]
All views return a TemplateResponse
instance, which allows you to easily customize the response data before
rendering. A way to do this is to wrap a view in your own view:
from django.contrib.auth import views
def change_password(request):
template_response = views.password_change(request)
# Do something with `template_response`
return template_response
For more details, see the TemplateResponse documentation.
All authentication viewsLink to this heading
This is a list with all the views django.contrib.auth provides. For
implementation details see Using the views.
- login(request, template_name=`registration/login.html`, redirect_field_name='next', authentication_form=AuthenticationForm, current_app=None, extra_context=None, redirect_authenticated_user=False)Link to this definition
URL name:
loginSee the URL documentation for details on using named URL patterns.
Optional arguments:
template_name: The name of a template to display for the view used to log the user in. Defaults toregistration/login.html.redirect_field_name: The name of aGETfield containing the URL to redirect to after login. Defaults tonext.authentication_form: A callable (typically just a form class) to use for authentication. Defaults toAuthenticationForm.current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.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 toFalse.
Here's what
django.contrib.auth.views.logindoes:If called via
GET, it displays a login form that POSTs to the same URL. More on this in a bit.If called via
POSTwith user submitted credentials, it tries to log the user in. If login is successful, the view redirects to the URL specified innext. Ifnextisn't provided, it redirects tosettings.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.htmlby default. This template gets passed four template context variables:form: AFormobject representing theAuthenticationForm.next: The URL to redirect to after successful login. This may contain a query string, too.site: The currentSite, according to theSITE_IDsetting. If you don't have the site framework installed, this will be set to an instance ofRequestSite, which derives the site name and domain from the currentHttpRequest.site_name: An alias forsite.name. If you don't have the site framework installed, this will be set to the value ofrequest.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 thetemplate_nameparameter via the extra arguments to the view in your URLconf. For example, this URLconf line would usemyapp/login.htmlinstead:url(r'^accounts/login/$', auth_views.login, {'template_name': 'myapp/login.html'}),You can also specify the name of the
GETfield which contains the URL to redirect to after login by passingredirect_field_nameto the view. By default, the field is callednext.Here's a sample
registration/login.htmltemplate you can use as a starting point. It assumes you have abase.htmltemplate that defines acontentblock:{% 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 pass a custom authentication form to the login view via the
authentication_formparameter. This form must accept arequestkeyword argument in its__init__method, and provide aget_user()method which returns the authenticated user object (this method is only ever called after successful form validation).
- logout(request, next_page=None, template_name='registration/logged_out.html', redirect_field_name='next', current_app=None, extra_context=None)Link to this definition
Logs a user out.
URL name:
logoutOptional arguments:
next_page: The URL to redirect to after logout. Defaults tosettings.LOGOUT_REDIRECT_URLif not supplied.template_name: The full name of a template to display after logging the user out. Defaults toregistration/logged_out.htmlif no argument is supplied.redirect_field_name: The name of aGETfield containing the URL to redirect to after log out. Defaults tonext. Overrides thenext_pageURL if the givenGETparameter is passed.current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.
Template context:
title: The string "Logged out", localized.site: The currentSite, according to theSITE_IDsetting. If you don't have the site framework installed, this will be set to an instance ofRequestSite, which derives the site name and domain from the currentHttpRequest.site_name: An alias forsite.name. If you don't have the site framework installed, this will be set to the value ofrequest.META['SERVER_NAME']. For more on sites, see The "sites" framework.
- logout_then_login(request, login_url=None, current_app=None, extra_context=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 tosettings.LOGIN_URLif not supplied.current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.
- password_change(request, template_name='registration/password_change_form.html', post_change_redirect=None, password_change_form=PasswordChangeForm, current_app=None, extra_context=None)Link to this definition
Allows a user to change their password.
URL name:
password_changeOptional arguments:
template_name: The full name of a template to use for displaying the password change form. Defaults toregistration/password_change_form.htmlif not supplied.post_change_redirect: The URL to redirect to after a successful password change.password_change_form: A custom "change password" form which must accept auserkeyword argument. The form is responsible for actually changing the user's password. Defaults toPasswordChangeForm.current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.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 (seepassword_change_formabove).
- password_change_done(request, template_name='registration/password_change_done.html', current_app=None, extra_context=None)Link to this definition
The page shown after a user has changed their password.
URL name:
password_change_doneOptional arguments:
template_name: The full name of a template to use. Defaults toregistration/password_change_done.htmlif not supplied.current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.
- password_reset(request, template_name='registration/password_reset_form.html', email_template_name='registration/password_reset_email.html', subject_template_name='registration/password_reset_subject.txt', password_reset_form=PasswordResetForm, token_generator=default_token_generator, post_reset_redirect=None, from_email=None, current_app=None, extra_context=None, html_email_template_name=None, extra_email_context=None)Link to this definition
パスワードをリセットするために使われる 1 回限り有効なリンクを生成し、ユーザがパスワードをリセットできるようにします。そのリンクはユーザーが登録した E メールアドレスに送信されます。
システムに E メールアドレスが登録されていない場合、E メールは送信されませんが、ユーザはエラーメッセージを受け取りません。これは、情報が悪意を持った攻撃者に流出するのを防ぐためです。エラーメッセージを提供するように変更したいときは、
PasswordResetFormをサブクラス化して、password_reset_form引数を使用してください。無効なパスワード (詳しくは
set_unusable_password()) でフラグが立てられたユーザは、パスワードリセットのリクエストができないようになっており、LDAP のような外部の認証ソースを使っているときに悪用されるのを防ぎます。アカウントの存在が漏洩しないように、ユーザーはエラーメッセージを受け取ることもメールが送信されることもありません。URL 名:
password_resetOptional arguments:
template_name: パスワードリセットのフォームを表示するためのテンプレート名です。指定しない場合のデフォルトはregistration/password_reset_form.htmlです。email_template_name: リセットパスワードのリンクとともに生成される E メールを生成するためのテンプレート名です。指定しない場合のデフォルトはregistration/password_reset_email.htmlです。subject_template_name: リセットパスワードのリンクとともに生成される E メールの表題に対して使われるテンプレートの名前です。指定しない場合のデフォルトはregistration/password_reset_subject.txtです。password_reset_form: ユーザーがパスワードをリセットするために E メールを受け取るために使われるフォームです。デフォルトはPasswordResetFormです。token_generator: 1 回限りのリンクをチェックするためのクラスのインスタンスです。デフォルトはdefault_token_generatorで、これはdjango.contrib.auth.tokens.PasswordResetTokenGeneratorのインスタンスです。post_reset_redirect: パスワードリセットのリクエストが成功した後のリダイレクト先の URL です。from_email: 検証済みの E メールアドレスです。デフォルトでは、Django はDEFAULT_FROM_EMAILを使います。current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.html_email_template_name: パスワードリセットのリンクとともに送信されるtext/htmlのマルチパートの E メールを生成するためのテンプレートの名前です。デフォルトでは、HTML メールは送信されません。extra_email_context: E メールテンプレート内で使われるコンテキストデータのディクショナリです。
Template context:
form: ユーザーのパスワードをリセットするためのフォームです (詳細は上述のpassword_reset_form)。
E メールテンプレートのコンテキスト:
email:user.emailの別名 (エイリアス) です。user: 現在のUserで、emailフォームフィールドから取得されます。アクティブなユーザ (User.is_active が True) だけがパスワードをリセットすることができます。site_name: An alias forsite.name. If you don't have the site framework installed, this will be set to the value ofrequest.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 メール本文のテンプレート)です:Someone asked for password reset for email {{ email }}. Follow the link below: {{ protocol}}://{{ domain }}{% url 'password_reset_confirm' uidb64=uid token=token %}表題のテンプレートにも同じテンプレートコンテキストが使われます。表題は 1 行のプレーンテキスト文字列の必要があります。
- password_reset_done(request, template_name='registration/password_reset_done.html', current_app=None, extra_context=None)Link to this definition
パスワードリセットのためのリンクが E メール送信された後にユーザに表示されるページです。デフォルトでは、
password_reset()ビューに明示的にpost_reset_redirectURL セットがない場合に呼ばれます。URL 名:
password_reset_doneOptional arguments:
template_name: テンプレートの名前です。指定しない場合のデフォルトはregistration/password_reset_done.htmlです。current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.
- password_reset_confirm(request, uidb64=None, token=None, template_name='registration/password_reset_confirm.html', token_generator=default_token_generator, set_password_form=SetPasswordForm, post_reset_redirect=None, current_app=None, extra_context=None)Link to this definition
新しいパスワードを入力するためのフォームを提供します。
URL 名:
password_reset_confirmOptional arguments:
uidb64: Base 64 でエンコードされたユーザの ID です。デフォルトはNoneです。token: パスワードが有効かを確認するためのトークンです。デフォルトはNoneです。template_name: パスワード確認のビューをを表示するためのテンプレートの名前です。デフォルト値はregistration/password_reset_confirm.htmlです。token_generator: パスワードをチェックするためのクラスのインスタンスです。デフォルトはdefault_token_generator``で、これは ``django.contrib.auth.tokens.PasswordResetTokenGeneratorのインスタンスです。set_password_form: パスワードをセットするために使われるフォームです。デフォルトはSetPasswordFormです。post_reset_redirect: パスワードリセットが完了したときのリダイレクト先の URLです。デフォルトはNoneです。current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.
Template context:
form: 新しいユーザーのパスワードをセットするためのフォーム (詳しくは上述のset_password_form) です。validlink: 真偽値で、リンク (uidb64とtokenの組み合わせ) が有効か、まだ使われていない場合に True となります。
- password_reset_complete(request, template_name='registration/password_reset_complete.html', current_app=None, extra_context=None)Link to this definition
パスワードの変更が成功したことをユーザに知らせるためのビューを提供します。
URL 名:
password_reset_completeOptional arguments:
template_name: ビューを表示するためのテンプレートの名前です。デフォルトはregistration/password_reset_complete.htmlです。current_app: A hint indicating which application contains the current view. See the namespaced URL resolution strategy for more information.extra_context: A dictionary of context data that will be added to the default context data passed to the template.
ヘルパー関数Link to this heading
- redirect_to_login(next, login_url=None, redirect_field_name='next')Link to this definition
ログインページにリダイレクトし、ログイン成功後にもう 1 つの URL に戻ります。
必須の引数:
next: ログイン成功後のリダイレクト先の URL です。
Optional arguments:
login_url: The URL of the login page to redirect to. Defaults tosettings.LOGIN_URLif not supplied.redirect_field_name: ログアウト後のリダイレクト先の URL を含むGETフィールドの名前です。指定されたGETパラメータが与えられ場合、nextをオーバーライドします。
ビルトインのフォームLink to this heading
ビルトインのビューを使いたくないけれども、ビューの機能を再利用したいと考えている場合、認証システムが提供しているビルトインのフォームを使うことができます。ビルトインのフォームは django.contrib.auth.forms にあります。
- class AdminPasswordChangeFormLink to this definition
ユーザのパスワードを変更するために admin インターフェイス内で使われるフォームです。
第 1 引数として
userを取ります。
- class AuthenticationFormLink to this definition
ユーザーログインのためのフォームです。
第 1 引数として
requestを取り、サブクラスで使えるようにフォームのインスタンス上に保持されます。- confirm_login_allowed(user)Link to this definition
デフォルトでは、
AuthenticationFormはis_activeフラグがFalseにセットされたユーザを拒否します。どのユーザがログインできるかを決定する独自のポリシーによって、この挙動をオーバーライドできます。AuthenticationFormをサブクラス化した独自のフォームを使って、confirm_login_allowed()メソッドを上書きしてください。指定されたユーザがログインできない場合、このメソッドはValidationErrorを投げます。例えば、"active" ステータスにかかわらず全てのユーザにログインを許可するには:
from django.contrib.auth.forms import AuthenticationForm class AuthenticationFormWithInactiveUsersOkay(AuthenticationForm): def confirm_login_allowed(self, user): pass(この例では、非アクティブのユーザを許可する認証バックエンドの使用も必要となります。たとえば
AllowAllUsersModelBackendなどです。)または、何人かのアクティブユーザのみにログインを許可するには、以下のようにします:
class PickyAuthenticationForm(AuthenticationForm): def confirm_login_allowed(self, user): if not user.is_active: raise forms.ValidationError( _("This account is inactive."), code='inactive', ) if user.username.startswith('b'): raise forms.ValidationError( _("Sorry, accounts starting with 'b' aren't welcome here."), code='no_b_users', )
- class PasswordChangeFormLink to this definition
ユーザがパスワードを変更できるようにするフォームです。
- class PasswordResetFormLink to this definition
ユーザのパスワードリセットするための 1 回限りのリンクを生成して E メール送信するためのフォームです。
- send_mail(subject_template_name, email_template_name, context, from_email, to_email, html_email_template_name=None)Link to this definition
引数を使って
EmailMultiAlternativesを送信します。オーバーライドして、どのように E メールが送信されるかカスタマイズできます。- パラメータ:
subject_template_name -- 表題用のテンプレートです。
email_template_name -- E メール本文用のテンプレートです。
context --
subject_template、email_template、html_email_template(Noneではない場合のみ) に渡されるコンテキストです。from_email -- 送信者の E メールです。
to_email -- リクエストしてきたユーザの E メールです。
html_email_template_name -- HTML 本文用のテンプレートです; デフォルトは
Noneで、この場合プレーンテキストの E メールが送信されます。
デフォルトでは、
save()はcontextに 変数を格納します。この変数はpassword_reset()が E メールのコンテキストに渡す変数と同じです。
- class SetPasswordFormLink to this definition
古いパスワードを入力しないでパスワードを変更できるようにするフォームです。
- class UserChangeFormLink to this definition
ユーザの情報とパーミッションを変更するために admin インターフェイスで使われるフォームです。
- class UserCreationFormLink to this definition
新しいユーザを作成するための
ModelFormです。3 つのフィールドがあります:
username(ユーザモデルより)、password1、password2``です。``password1とpassword2が一致するか確認し、validate_password()を使ってパスワードを検証します。そして、set_password()を使ってユーザのパスワードをセットします。
テンプレート内の認証データLink to this heading
RequestContext を使うと、現在ログインしているユーザとパーミッションを template context 内で使えるようにできます。
ユーザ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 のインスタンスで、パーミッションをテンプレートで使いやすくするための代替表現です。
{{ perms }} オブジェクトでは、単一属性のルックアップは User.has_module_perms の代替表現です。以下の例では、ログイン中のユーザが foo アプリケーションにおいて何かしらのパーミッションを有する場合、True を返します:
{{ perms.foo }}
2 段階の属性のルックアップは User.has_perm の代替表現です。以下の例は、ログイン中のユーザがユーザがパーミッション foo.can_vote を有する場合に True を表示します:
{{ perms.foo.can_vote }}
したがって、テンプレート内の {% if %} ステートメントでパーミッションをチェックするには、以下のようにします:
{% if perms.foo %}
<p>You have permission to do something in the foo app.</p>
{% if perms.foo.can_vote %}
<p>You can vote!</p>
{% endif %}
{% if perms.foo.can_drive %}
<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.can_vote' in perms %}
<p>In lookup works, too.</p>
{% endif %}
{% endif %}
admin 内でユーザを管理するLink to this heading
django.contrib.admin と django.contrib.auth の両方をインストールしていれば、admin でユーザ、グループおよびパーミッションを見たり管理することが簡単にできます。ユーザは通常の Django モデルと同じく作成や削除ができます。グループも作成することができ、パーミッションはユーザやグループにアサインすることができます。admin でのユーザー編集のログも保管および表示されます。
ユーザを作成するLink to this heading
admin のメインインデックスページの "Auth" セクションに "Users" へのリンクがあります。"Add user" ページは通常の admin ページとは異なり、他のユーザーのフィールドを編集する際に、ユーザ名とパスワードを選択する必要があります。
また、Django の admin サイトを使用してユーザアカウントを作成できるようにするには、ユーザを追加 および 変更する権限をユーザに与える必要があります (つまり "Add user" と "Change user" パーミッション)。あるアカウントにユーザの追加権限のみが与えられ変更権限がない場合、そのアカウントはユーザを追加できません。なぜなら、追加権限によってスーパーユーザを作成することができ、そのスーパーユーザを使って他のユーザーを変更することができてしまうからです。 そのため、Django はちょっとしたセキュリティ対策として、追加と変更の 両方 の権限を必要とするのです。
ユーザに与えるパーミッション管理の権限については、よく考える必要があります。たとえば非スーパーユーザにユーザ編集の権限を与えてしまうと、結果的に彼らにスーパーユーザと同じ能力を与えることになります。というのも、彼らはユーザ編集の権限によってユーザのパーミッションを昇格させることができるため、彼ら自身のパーミッションも昇格させられるのです!
パスワードを変更するLink to this heading
User passwords are not displayed in the admin (nor stored in the database), but the password storage details are displayed. Included in the display of this information is a link to a password change form that allows admins to change user passwords.