このドキュメントでは、デフォルト設定でのDjangoの認証システムの使用方法を説明します。この設定は、タスクの適切な範囲を管理することで、最も一般的なプロジェクトのニーズにかなうよう徐々に発展してきました。そして、パスワードや権限の入念な実装を持っています。デフォルトの認証システムからの変更が必要なプロジェクトのために、Djangoは認証システムの広範囲の 拡張とカスタマイズ をサポートします。
\nDjangoの認証は、認証機能と権限機能の両方を共に提供しています。そして、一般的に、これらの機能を合わせて認証システムと呼びます。
\nUser オブジェクトLink to this heading#User オブジェクトは、認証システムの中核です。一般的に、このオブジェクトはあなたのサイトに関係する人々を表し、アクセスを制限すること、ユーザ情報を登録すること、コンテンツを作成者と関連付けることを可能にする際などに利用されます。\nDjangoの認証フレームワークにはUserクラスという、ただひとつのクラスのみが存在します。すなわち、 'superusers' または admin 'staff' ユーザは、Userオブジェクトと異なるクラスではなく、特別な属性セットを持ったUserオブジェクトなのです。
デフォルトのユーザの主要な属性は次のとおりです。
\n仕様については full API documentation を参照してください。 次のドキュメントは、よりタスク指向の形式となっています。
ユーザを作成するための最も直接的な方法は、組み込まれている create_user() というヘルパー関数を利用することです。
>>> from django.contrib.auth.models import User\n>>> user = User.objects.create_user('john', 'lennon@thebeatles.com', 'johnpassword')\n\n# At this point, user is a User object that has already been saved\n# to the database. You can continue to change its attributes\n# if you want to change other fields.\n>>> user.last_name = 'Lennon'\n>>> user.save()\nすでにDjango adminをインストールしている場合は、 インタラクティブにユーザを作成する こともできます。
\nCreate superusers using the createsuperuser command:
$ python manage.py createsuperuser --username=joe --email=joe@example.com\nパスワードを入力するように促されます。入力後、ただちにユーザが作成されます。 --username または --email オプションを使用しなければ、これらの値を入力するように促されます。
Djangoはユーザモデルに未加工の(はっきりとしたテキストの)パスワードは保存せず、ハッシュ値でのみ保存します( 詳細は、 パスワードは管理方法に関するドキュメント を参照してください)。これにより、パスワード属性を使用されません。これが、ユーザを作成する際にヘルパー関数を使用する理由です。
\nユーザのパスワードを変更するには、いくつかのオプションがあります。
\nmanage.py changepassword *username* offers a method\nof changing a user's password from the command line. It prompts you to\nchange the password of a given user which you must enter twice. If\nthey both match, the new password will be changed immediately. If you\ndo not supply a user, the command will attempt to change the password\nwhose username matches the current system user.
set_password() を使用することで、プログラムでパスワードを変更することもできます:
>>> from django.contrib.auth.models import User\n>>> u = User.objects.get(username='john')\n>>> u.set_password('new password')\n>>> u.save()\nDjango admin がインストールされていれば、 認証システムのadminページ にて、ユーザのパスワードを変更することも可能です。
\nまた、Djangoはユーザ自身のパスワードを変更するための ビュー と フォーム を提供します。
\nユーザーのパスワード変更を行う事とそのユーザーのセッションは全てログアウトされます。詳細は Session invalidation on password change を参照してください。
\n認証情報のセットを検証するには authenticate() を利用してください。このメソッドは認証情報をキーワード引数として受け取ります。検証する対象はデフォルトでは username と password であり、その組み合わせを個々の 認証バックエンド に対して問い合わせ、認証バックエンドで認証情報が有効とされれば User オブジェクトを返します。もしいずれの認証バックエンドでも認証情報が有効と判定されなければ PermissionDenied が送出され、None が返されます。以下は実装例です:
from django.contrib.auth import authenticate\nuser = authenticate(username='john', password='secret')\nif user is not None:\n # A backend authenticated the credentials\nelse:\n # No backend authenticated the credentials\nDjango は リクエストオブジェクト に対して認証システムを接続させるのに セッション とミドルウェアを利用します。
それらは現在のユーザーを示す request.user 属性を付与します。もしユーザーが現在ログインしていない場合、この属性には AnonymousUser のインスタンスが、ログインしている場合は User のインスタンスがセットされます。
この二者は is_authenticated を用いて次のように識別する事ができます:
if request.user.is_authenticated:\n # Do something for authenticated users.\n ...\nelse:\n # Do something for anonymous users.\n ...\n現在のセッションにおいて認証を有効としたいユーザーがいる場合 - login() 関数によってそれを行う事ができます。
あるユーザーをログインさせる場合は、login() を利用してください。この関数は HttpRequest オブジェクトと User オブジェクトを受け取ります。login() は Django のセッションフレームワークを利用して、ユーザーのセッション中での ID を保持します。
匿名ユーザーとしてのセッション中にセットされたデータが、ログイン後も継続して利用できる事に注意してください。
\n以下の例では authenticate() および login() をどのように用いるかを示します:
from django.contrib.auth import authenticate, login\n\ndef my_view(request):\n username = request.POST['username']\n password = request.POST['password']\n user = authenticate(username=username, password=password)\n if user is not None:\n login(request, user)\n # Redirect to a success page.\n ...\n else:\n # Return an 'invalid login' error message.\n ...\nユーザーがログインする際、そのユーザーの ID と認証時に用いた認証バックエンドはセッション中保持されます。その仕組みによって、ユーザーの詳細情報を取得するリクエストが発生した場合に同じ 認証バックエンド を利用できます。セッション中に保持される認証バックエンドは下記の手順を経て選択されます:
\n省略可能な backend 引数が与えられている場合は利用します。
存在すれば属性 user.backend の値を利用する。authenticate() は返すユーザーオブジェクトに属性値 user.backend を付与するので、authenticate() と login() とで連携を図ることができる。
ただ一つだけ設定が存在すれば AUTHENTICATION_BACKENDS の backend を利用する。
いずれにも該当しなかった場合、例外が送出される。
1 もしくは 2 においては、引数 backend あるいは属性値 user.backend は(AUTHENTICATION_BACKENDS で定義されているのと同様に)ドット付きのインポート先を示すパスの文字列でなければなりません。
django.contrib.auth.login() を利用してログインしたユーザーをログアウトさせるためには、django.contrib.auth.logout() をビューの中で利用してください。この関数は HttpRequest オブジェクトを受け取り、値を返しません。実装例は下記のようになります:
from django.contrib.auth import logout\n\ndef logout_view(request):\n logout(request)\n # Redirect to a success page.\nlogout() は対象となるユーザーが最初からログインしていなかった場合でも例外を送出しない事に注意してください。
logout() を呼びだすと、現在処理しているリクエストに対応したセッション情報は完全に破棄されます。その時点までに存在している全てのデータが削除されます。これは別の人物が同じ Web ブラウザを利用してログインし、前のユーザーのセッションにアクセスして使用してしまう事態を防ぐためです。ログアウトした直後から利用できる何らかの情報をセッションに保存したい場合は、django.contrib.auth.logout() を呼び出した後に処理してください。
ページに対するアクセスを制限する原理的な方法は request.user.is_authenticated の確認と共にログインページへのリダイレクトを利用する事です:
from django.conf import settings\nfrom django.shortcuts import redirect\n\ndef my_view(request):\n if not request.user.is_authenticated:\n return redirect('%s?next=%s' % (settings.LOGIN_URL, request.path))\n # ...\nもしくはエラーメッセージを出力します。
\nfrom django.shortcuts import render\n\ndef my_view(request):\n if not request.user.is_authenticated:\n return render(request, 'myapp/login_error.html')\n # ...\nlogin_required デコレータLink to this heading#ショートカットとして、便利な login_required() デコレータを利用できます:
from django.contrib.auth.decorators import login_required\n\n@login_required\ndef my_view(request):\n ...\nlogin_required() は下記の処理を行います:
もしユーザがログインしていなければ、settings.LOGIN_URL にリダイレクトし、クエリ文字列に現在の絶対パスを渡します。リダイレクト先の例: /accounts/login/?next=/polls/3/
もしユーザがログインしていれば、通常通りビューを処理します。ビューのコードの中ではユーザがログインしているかを意識しなくて良いのです。
デフォルトでは、認証に成功したユーザがリダイレクトされる先のパスは "next" という名称のクエリパラメータに格納されています。もし異なるパラメータ名を利用したい場合、login_required() が redirect_field_name という省略可能な引数を受け取ります:
from django.contrib.auth.decorators import login_required\n\n@login_required(redirect_field_name='my_redirect_field')\ndef my_view(request):\n ...\nredirect_field_name に値を持たせた場合、ログインテンプレートもカスタマイズする必要があるでしょう。これは、リダイレクト先のパスを格納しているテンプレートコンテキスト変数が、キーとして (デフォルトの) "next" でなく redirect_field_name の値を使用してしまうためです。
login_required() はまた省略可能な引数として login_url を受け取る事ができます。以下の例のように利用します:
from django.contrib.auth.decorators import login_required\n\n@login_required(login_url='/accounts/login/')\ndef my_view(request):\n ...\n`login_url` のパラメータを定義しない場合、settings.LOGIN_URL が設定されかつログイン用ビューが適切に配置されている必要が有ります。例えば、デフォルトの設定を利用して下記の内容を URLconf に追加してください:
from django.contrib.auth import views as auth_views\n\nurl(r'^accounts/login/$', auth_views.login),\nsettings.LOGIN_URL はまたビュー関数名と 命名された URL パターン を受け付けます。この仕組みによって設定を更新することなく URLconf 内のログイン用ビューを再配置する事ができます。
LoginRequired mixinLink to this heading#When using class-based views, you can\nachieve the same behavior as with login_required by using the\nLoginRequiredMixin. This mixin should be at the leftmost position in the\ninheritance list.
If a view is using this mixin, all requests by non-authenticated users will\nbe redirected to the login page or shown an HTTP 403 Forbidden error,\ndepending on the\nraise_exception parameter.
You can set any of the parameters of\nAccessMixin to customize the handling\nof unauthorized users:
from django.contrib.auth.mixins import LoginRequiredMixin\n\nclass MyView(LoginRequiredMixin, View):\n login_url = '/login/'\n redirect_field_name = 'redirect_to'\nTo limit access based on certain permissions or some other test, you'd do\nessentially the same thing as described in the previous section.
\nThe simple way is to run your test on request.user in the view directly. For example, this view\nchecks to make sure the user has an email in the desired domain and if not,\nredirects to the login page:
from django.shortcuts import redirect\n\ndef my_view(request):\n if not request.user.email.endswith('@example.com'):\n return redirect('/login/?next=%s' % request.path)\n # ...\nAs a shortcut, you can use the convenient user_passes_test decorator\nwhich performs a redirect when the callable returns False:
from django.contrib.auth.decorators import user_passes_test\n\ndef email_check(user):\n return user.email.endswith('@example.com')\n\n@user_passes_test(email_check)\ndef my_view(request):\n ...\nuser_passes_test() takes a required\nargument: a callable that takes a\nUser object and returns True if\nthe user is allowed to view the page. Note that\nuser_passes_test() does not\nautomatically check that the User is\nnot anonymous.
user_passes_test() takes two\noptional arguments:
login_urlLets you specify the URL that users who don't pass the test will be\nredirected to. It may be a login page and defaults to\nsettings.LOGIN_URL if you don't specify one.
redirect_field_nameSame as for login_required().\nSetting it to None removes it from the URL, which you may want to do\nif you are redirecting users that don't pass the test to a non-login\npage where there's no "next page".
For example:
\n@user_passes_test(email_check, login_url='/login/')\ndef my_view(request):\n ...\nWhen using class-based views, you\ncan use the UserPassesTestMixin to do this.
You have to override the test_func() method of the class to\nprovide the test that is performed. Furthermore, you can set any of the\nparameters of AccessMixin to\ncustomize the handling of unauthorized users:
from django.contrib.auth.mixins import UserPassesTestMixin\n\nclass MyView(UserPassesTestMixin, View):\n\n def test_func(self):\n return self.request.user.email.endswith('@example.com')\nYou can also override the get_test_func() method to have the mixin\nuse a differently named function for its checks (instead of\ntest_func()).
permission_required decoratorLink to this heading#It's a relatively common task to check whether a user has a particular\npermission. For that reason, Django provides a shortcut for that case: the\npermission_required() decorator.:
from django.contrib.auth.decorators import permission_required\n\n@permission_required('polls.can_vote')\ndef my_view(request):\n ...\nJust like the has_perm() method,\npermission names take the form "<app label>.<permission codename>"\n(i.e. polls.can_vote for a permission on a model in the polls\napplication).
The decorator may also take an iterable of permissions, in which case the\nuser must have all of the permissions in order to access the view.
\nNote that permission_required()\nalso takes an optional login_url parameter:
from django.contrib.auth.decorators import permission_required\n\n@permission_required('polls.can_vote', login_url='/loginpage/')\ndef my_view(request):\n ...\nAs in the login_required() decorator,\nlogin_url defaults to settings.LOGIN_URL.
If the raise_exception parameter is given, the decorator will raise\nPermissionDenied, prompting the 403\n(HTTP Forbidden) view instead of redirecting to the\nlogin page.
If you want to use raise_exception but also give your users a chance to\nlogin first, you can add the\nlogin_required() decorator:
from django.contrib.auth.decorators import login_required, permission_required\n\n@login_required\n@permission_required('polls.can_vote', raise_exception=True)\ndef my_view(request):\n ...\nPermissionRequiredMixin mixinLink to this heading#To apply permission checks to class-based views, you can use the PermissionRequiredMixin:
This mixin, just like the permission_required\ndecorator, checks whether the user accessing a view has all given\npermissions. You should specify the permission (or an iterable of\npermissions) using the permission_required parameter:
from django.contrib.auth.mixins import PermissionRequiredMixin\n\nclass MyView(PermissionRequiredMixin, View):\n permission_required = 'polls.can_vote'\n # Or multiple of permissions:\n permission_required = ('polls.can_open', 'polls.can_edit')\nYou can set any of the parameters of\nAccessMixin to customize the handling\nof unauthorized users.
You may also override these methods:
\nReturns an iterable of permission names used by the mixin. Defaults to\nthe permission_required attribute, converted to a tuple if\nnecessary.
Returns a boolean denoting whether the current user has permission to\nexecute the decorated view. By default, this returns the result of\ncalling has_perms() with the\nlist of permissions returned by get_permission_required().
Django provides several views that you can use for handling login, logout, and\npassword management. These make use of the stock auth forms but you can pass in your own forms as well.
\nDjango provides no default template for the authentication views. You should\ncreate your own templates for the views you want to use. The template context\nis documented in each view, see All authentication views.
\nThere are different methods to implement these views in your project. The\neasiest way is to include the provided URLconf in django.contrib.auth.urls\nin your own URLconf, for example:
urlpatterns = [\n url('^', include('django.contrib.auth.urls')),\n]\nThis will include the following URL patterns:
\n^login/$ [name='login']\n^logout/$ [name='logout']\n^password_change/$ [name='password_change']\n^password_change/done/$ [name='password_change_done']\n^password_reset/$ [name='password_reset']\n^password_reset/done/$ [name='password_reset_done']\n^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']\n^reset/done/$ [name='password_reset_complete']\nThe views provide a URL name for easier reference. See the URL\ndocumentation for details on using named URL patterns.
\nIf you want more control over your URLs, you can reference a specific view in\nyour URLconf:
\nfrom django.contrib.auth import views as auth_views\n\nurlpatterns = [\n url('^change-password/$', auth_views.password_change),\n]\nThe views have optional arguments you can use to alter the behavior of the\nview. For example, if you want to change the template name a view uses, you can\nprovide the template_name argument. A way to do this is to provide keyword\narguments in the URLconf, these will be passed on to the view. For example:
urlpatterns = [\n url(\n '^change-password/$',\n auth_views.password_change,\n {'template_name': 'change-password.html'}\n ),\n]\nAll views return a TemplateResponse\ninstance, which allows you to easily customize the response data before\nrendering. A way to do this is to wrap a view in your own view:
from django.contrib.auth import views\n\ndef change_password(request):\n template_response = views.password_change(request)\n # Do something with `template_response`\n return template_response\nFor more details, see the TemplateResponse documentation.
\nThis is a list with all the views django.contrib.auth provides. For\nimplementation details see Using the views.
URL name: login
See the URL documentation for details on using\nnamed URL patterns.
\nOptional arguments:
\ntemplate_name: The name of a template to display for the view used to\nlog the user in. Defaults to registration/login.html.
redirect_field_name: The name of a GET field containing the\nURL to redirect to after login. Defaults to next.
authentication_form: A callable (typically just a form class) to\nuse for authentication. Defaults to\nAuthenticationForm.
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
redirect_authenticated_user: A boolean that controls whether or not\nauthenticated users accessing the login page will be redirected as if\nthey had just successfully logged in. Defaults to False.
Here's what django.contrib.auth.views.login does:
If called via GET, it displays a login form that POSTs to the\nsame URL. More on this in a bit.
If called via POST with user submitted credentials, it tries to log\nthe user in. If login is successful, the view redirects to the URL\nspecified in next. If next isn't provided, it redirects to\nsettings.LOGIN_REDIRECT_URL (which\ndefaults to /accounts/profile/). If login isn't successful, it\nredisplays the login form.
It's your responsibility to provide the html for the login template\n, called registration/login.html by default. This template gets passed\nfour template context variables:
form: A Form object representing the\nAuthenticationForm.
next: The URL to redirect to after successful login. This may\ncontain a query string, too.
site: The current Site,\naccording to the SITE_ID setting. If you don't have the\nsite framework installed, this will be set to an instance of\nRequestSite, which derives the\nsite name and domain from the current\nHttpRequest.
site_name: An alias for site.name. If you don't have the site\nframework installed, this will be set to the value of\nrequest.META['SERVER_NAME'].\nFor more on sites, see The "sites" framework.
If you'd prefer not to call the template registration/login.html,\nyou can pass the template_name parameter via the extra arguments to\nthe view in your URLconf. For example, this URLconf line would use\nmyapp/login.html instead:
url(r'^accounts/login/$', auth_views.login, {'template_name': 'myapp/login.html'}),\nYou can also specify the name of the GET field which contains the URL\nto redirect to after login by passing redirect_field_name to the view.\nBy default, the field is called next.
Here's a sample registration/login.html template you can use as a\nstarting point. It assumes you have a base.html template that\ndefines a content block:
{% extends "base.html" %}\n\n{% block content %}\n\n{% if form.errors %}\n<p>Your username and password didn't match. Please try again.</p>\n{% endif %}\n\n{% if next %}\n {% if user.is_authenticated %}\n <p>Your account doesn't have access to this page. To proceed,\n please login with an account that has access.</p>\n {% else %}\n <p>Please login to see this page.</p>\n {% endif %}\n{% endif %}\n\n<form method="post" action="{% url 'login' %}">\n{% csrf_token %}\n<table>\n<tr>\n <td>{{ form.username.label_tag }}</td>\n <td>{{ form.username }}</td>\n</tr>\n<tr>\n <td>{{ form.password.label_tag }}</td>\n <td>{{ form.password }}</td>\n</tr>\n</table>\n\n<input type="submit" value="login" />\n<input type="hidden" name="next" value="{{ next }}" />\n</form>\n\n{# Assumes you setup the password_reset view in your URLconf #}\n<p><a href="{% url 'password_reset' %}">Lost password?</a></p>\n\n{% endblock %}\nIf you have customized authentication (see\nCustomizing Authentication) you can pass\na custom authentication form to the login view via the\nauthentication_form parameter. This form must accept a request\nkeyword argument in its __init__ method, and provide a get_user()\nmethod which returns the authenticated user object (this method is only\never called after successful form validation).
Logs a user out.
\nURL name: logout
Optional arguments:
\nnext_page: The URL to redirect to after logout. Defaults to\nsettings.LOGOUT_REDIRECT_URL if not\nsupplied.
template_name: The full name of a template to display after\nlogging the user out. Defaults to\nregistration/logged_out.html if no argument is supplied.
redirect_field_name: The name of a GET field containing the\nURL to redirect to after log out. Defaults to next. Overrides the\nnext_page URL if the given GET parameter is passed.
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
Template context:
\ntitle: The string "Logged out", localized.
site: The current Site,\naccording to the SITE_ID setting. If you don't have the\nsite framework installed, this will be set to an instance of\nRequestSite, which derives the\nsite name and domain from the current\nHttpRequest.
site_name: An alias for site.name. If you don't have the site\nframework installed, this will be set to the value of\nrequest.META['SERVER_NAME'].\nFor more on sites, see The "sites" framework.
Logs a user out, then redirects to the login page.
\nURL name: No default URL provided
\nOptional arguments:
\nlogin_url: The URL of the login page to redirect to.\nDefaults to settings.LOGIN_URL if not supplied.
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
Allows a user to change their password.
\nURL name: password_change
Optional arguments:
\ntemplate_name: The full name of a template to use for\ndisplaying the password change form. Defaults to\nregistration/password_change_form.html if not supplied.
post_change_redirect: The URL to redirect to after a successful\npassword change.
password_change_form: A custom "change password" form which must\naccept a user keyword argument. The form is responsible for\nactually changing the user's password. Defaults to\nPasswordChangeForm.
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
Template context:
\nform: The password change form (see password_change_form above).
The page shown after a user has changed their password.
\nURL name: password_change_done
Optional arguments:
\ntemplate_name: The full name of a template to use.\nDefaults to registration/password_change_done.html if not\nsupplied.
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
パスワードをリセットするために使われる 1 回限り有効なリンクを生成し、ユーザがパスワードをリセットできるようにします。そのリンクはユーザーが登録した E メールアドレスに送信されます。
\nシステムに E メールアドレスが登録されていない場合、E メールは送信されませんが、ユーザはエラーメッセージを受け取りません。これは、情報が悪意を持った攻撃者に流出するのを防ぐためです。エラーメッセージを提供するように変更したいときは、PasswordResetForm をサブクラス化して、password_reset_form 引数を使用してください。
無効なパスワード (詳しくは set_unusable_password() ) でフラグが立てられたユーザは、パスワードリセットのリクエストができないようになっており、LDAP のような外部の認証ソースを使っているときに悪用されるのを防ぎます。アカウントの存在が漏洩しないように、ユーザーはエラーメッセージを受け取ることもメールが送信されることもありません。
URL 名: password_reset
Optional arguments:
\ntemplate_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\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
html_email_template_name: パスワードリセットのリンクとともに送信される text/html のマルチパートの E メールを生成するためのテンプレートの名前です。デフォルトでは、HTML メールは送信されません。
extra_email_context: E メールテンプレート内で使われるコンテキストデータのディクショナリです。
Template context:
\nform: ユーザーのパスワードをリセットするためのフォームです (詳細は上述の password_reset_form)。
E メールテンプレートのコンテキスト:
\nemail: user.email の別名 (エイリアス) です。
user: 現在の User で、email フォームフィールドから取得されます。アクティブなユーザ (User.is_active が True) だけがパスワードをリセットすることができます。
site_name: An alias for site.name. If you don't have the site\nframework installed, this will be set to the value of\nrequest.META['SERVER_NAME'].\nFor 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:\n{{ protocol}}://{{ domain }}{% url 'password_reset_confirm' uidb64=uid token=token %}\n表題のテンプレートにも同じテンプレートコンテキストが使われます。表題は 1 行のプレーンテキスト文字列の必要があります。
\nパスワードリセットのためのリンクが E メール送信された後にユーザに表示されるページです。デフォルトでは、password_reset() ビューに明示的に post_reset_redirect URL セットがない場合に呼ばれます。
URL 名: password_reset_done
Optional arguments:
\ntemplate_name: テンプレートの名前です。指定しない場合のデフォルトは registration/password_reset_done.html です。
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
新しいパスワードを入力するためのフォームを提供します。
\nURL 名: password_reset_confirm
Optional arguments:
\nuidb64: 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\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
Template context:
\nform: 新しいユーザーのパスワードをセットするためのフォーム (詳しくは上述の set_password_form) です。
validlink: 真偽値で、リンク (uidb64 と token の組み合わせ) が有効か、まだ使われていない場合に True となります。
パスワードの変更が成功したことをユーザに知らせるためのビューを提供します。
\nURL 名: password_reset_complete
Optional arguments:
\ntemplate_name: ビューを表示するためのテンプレートの名前です。デフォルトは registration/password_reset_complete.html です。
current_app: A hint indicating which application contains the current\nview. See the namespaced URL resolution strategy for more information.
extra_context: A dictionary of context data that will be added to the\ndefault context data passed to the template.
ログインページにリダイレクトし、ログイン成功後にもう 1 つの URL に戻ります。
\n必須の引数:
\nnext: ログイン成功後のリダイレクト先の URL です。
Optional arguments:
\nlogin_url: The URL of the login page to redirect to.\nDefaults to settings.LOGIN_URL if not supplied.
redirect_field_name: ログアウト後のリダイレクト先の URL を含む GET フィールドの名前です。指定された GET パラメータが与えられ場合、next をオーバーライドします。
ビルトインのビューを使いたくないけれども、ビューの機能を再利用したいと考えている場合、認証システムが提供しているビルトインのフォームを使うことができます。ビルトインのフォームは django.contrib.auth.forms にあります。
ユーザのパスワードを変更するために admin インターフェイス内で使われるフォームです。
\n第 1 引数として user を取ります。
ユーザーログインのためのフォームです。
\n第 1 引数として request を取り、サブクラスで使えるようにフォームのインスタンス上に保持されます。
デフォルトでは、AuthenticationForm は is_active フラグが False にセットされたユーザを拒否します。どのユーザがログインできるかを決定する独自のポリシーによって、この挙動をオーバーライドできます。AuthenticationForm をサブクラス化した独自のフォームを使って、confirm_login_allowed() メソッドを上書きしてください。指定されたユーザがログインできない場合、このメソッドは ValidationError を投げます。
例えば、"active" ステータスにかかわらず全てのユーザにログインを許可するには:
\nfrom django.contrib.auth.forms import AuthenticationForm\n\nclass AuthenticationFormWithInactiveUsersOkay(AuthenticationForm):\n def confirm_login_allowed(self, user):\n pass\n(この例では、非アクティブのユーザを許可する認証バックエンドの使用も必要となります。たとえば AllowAllUsersModelBackend などです。)
または、何人かのアクティブユーザのみにログインを許可するには、以下のようにします:
\nclass PickyAuthenticationForm(AuthenticationForm):\n def confirm_login_allowed(self, user):\n if not user.is_active:\n raise forms.ValidationError(\n _("This account is inactive."),\n code='inactive',\n )\n if user.username.startswith('b'):\n raise forms.ValidationError(\n _("Sorry, accounts starting with 'b' aren't welcome here."),\n code='no_b_users',\n )\nユーザがパスワードを変更できるようにするフォームです。
\nユーザのパスワードリセットするための 1 回限りのリンクを生成して E メール送信するためのフォームです。
\n引数を使って 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 メールのコンテキストに渡す変数と同じです。
古いパスワードを入力しないでパスワードを変更できるようにするフォームです。
\nユーザの情報とパーミッションを変更するために admin インターフェイスで使われるフォームです。
\n新しいユーザを作成するための ModelForm です。
3 つのフィールドがあります: username (ユーザモデルより)、password1、password2``です。``password1 と password2 が一致するか確認し、validate_password() を使ってパスワードを検証します。そして、set_password() を使ってユーザのパスワードをセットします。
RequestContext を使うと、現在ログインしているユーザとパーミッションを template context 内で使えるようにできます。
テンプレート RequestContext をレンダリングするとき、現在ログイン中のユーザ (User インスタンスか AnonymousUser のどちらか) はテンプレート変数 {{ user }} 内に格納されます:
{% if user.is_authenticated %}\n <p>Welcome, {{ user.username }}. Thanks for logging in.</p>\n{% else %}\n <p>Welcome, new user. Please log in.</p>\n{% endif %}\nRequestContext が使用されていない場合、このテンプレートコンテキスト変数は無効となります。
現在ログイン中のユーザのパーミッションは、テンプレート変数 {{ perms }} 内に保持されています。 これは django.contrib.auth.context_processors.PermWrapper のインスタンスで、パーミッションをテンプレートで使いやすくするための代替表現です。
{{ perms }} オブジェクトでは、単一属性のルックアップは User.has_module_perms の代替表現です。以下の例では、ログイン中のユーザが foo アプリケーションにおいて何かしらのパーミッションを有する場合、True を返します:
{{ perms.foo }}\n2 段階の属性のルックアップは User.has_perm の代替表現です。以下の例は、ログイン中のユーザがユーザがパーミッション foo.can_vote を有する場合に True を表示します:
{{ perms.foo.can_vote }}\nしたがって、テンプレート内の {% if %} ステートメントでパーミッションをチェックするには、以下のようにします:
{% if perms.foo %}\n <p>You have permission to do something in the foo app.</p>\n {% if perms.foo.can_vote %}\n <p>You can vote!</p>\n {% endif %}\n {% if perms.foo.can_drive %}\n <p>You can drive!</p>\n {% endif %}\n{% else %}\n <p>You don't have permission to do anything in the foo app.</p>\n{% endif %}\n{% if in %} ステートメントを使ってパーミッションをルックアップすることも可能です。例えば:
{% if 'foo' in perms %}\n {% if 'foo.can_vote' in perms %}\n <p>In lookup works, too.</p>\n {% endif %}\n{% endif %}\ndjango.contrib.admin と django.contrib.auth の両方をインストールしていれば、admin でユーザ、グループおよびパーミッションを見たり管理することが簡単にできます。ユーザは通常の Django モデルと同じく作成や削除ができます。グループも作成することができ、パーミッションはユーザやグループにアサインすることができます。admin でのユーザー編集のログも保管および表示されます。
admin のメインインデックスページの "Auth" セクションに "Users" へのリンクがあります。"Add user" ページは通常の admin ページとは異なり、他のユーザーのフィールドを編集する際に、ユーザ名とパスワードを選択する必要があります。
\nまた、Django の admin サイトを使用してユーザアカウントを作成できるようにするには、ユーザを追加 および 変更する権限をユーザに与える必要があります (つまり "Add user" と "Change user" パーミッション)。あるアカウントにユーザの追加権限のみが与えられ変更権限がない場合、そのアカウントはユーザを追加できません。なぜなら、追加権限によってスーパーユーザを作成することができ、そのスーパーユーザを使って他のユーザーを変更することができてしまうからです。 そのため、Django はちょっとしたセキュリティ対策として、追加と変更の 両方 の権限を必要とするのです。
\nユーザに与えるパーミッション管理の権限については、よく考える必要があります。たとえば非スーパーユーザにユーザ編集の権限を与えてしまうと、結果的に彼らにスーパーユーザと同じ能力を与えることになります。というのも、彼らはユーザ編集の権限によってユーザのパーミッションを昇格させることができるため、彼ら自身のパーミッションも昇格させられるのです！
\nUser passwords are not displayed in the admin (nor stored in the database), but\nthe password storage details are displayed.\nIncluded in the display of this information is a link to\na password change form that allows admins to change user passwords.
\n