Menggunakan sistem pembuktian keaslian Django

Dokumen ini menjelaskan penggunaan dari sistem otentifikasi Django di konfigurasi awalannya. Konfigurasi ini telah berkembang untuk melayani kebutuhan proyek paling umum, menangani jangkauan luas beralasan dari tugas, dan mempunyai penerapan cermat dari sandi dan perizinan. Untuk proyek dimana otentifikasi butuh berbeda dari awalan, Django mendukung extension and customization luas dari otentifikasi.

Otentifikasi Django menyediakan kedua otentifikasi dan otorisasi bersama-sama dan umumnya mengacu pada sebagai sistem otentifikasi, ketika fitur ini agak digabungkan.

Obyek User

Obyek User adalah inti dari sistem autentifikasi. Mereka khususnya mewakili orang berinteraksi dengan situs anda dan digunakan untuk mengadakan hal-hal seperti membatasi akses, mendaftarkan profil pengguna, menyatukan isi dengan pembuat dll. Hanya satu kelas dari pengguna yang ada di otentifikasi kerangka kerja Django, yaitu, 'superusers' atau admin pengguna 'staff' hanya obyek user dengan sekumpulan atribut khusus, bukan kelas-kelas berbeda dari obyek user.

Atribut utama dari pengguna awal adalah:

Lihat :class:`full API documentation <django.contrib.auth.models.User>`untuk acuan penuh, dokumentasi yang mengikuti lebih berorientasi tugas.

Membuat pengguna

Cara paling langsung untuk membuat pengguna adalah menggunakan fungsi pembantu create_user() yang disertakan:

>>> from django.contrib.auth.models import User
>>> user = User.objects.create_user('john', '[email protected]', '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()

Jika anda mempunai admin Django dipasang, anda dapat juga create users interactively.

Membuat pengguna hebat

Membuat pengguna hebat menggunakan perintah createsuperuser:

$ python manage.py createsuperuser --username=joe [email protected]

Anda akan diminta untuk sandi. Setelah anda memasukkan satu, pengguna akan membuat dengan segera. Jika anda membiarkan mati pilihan --username atau --email, itu akan meminta anda untuk nilai-nilai tersebut.

Merubah sandi

Django tidak menyimpan sandi (teks bersih) mentah pada model user, tetapi hanya campuran (lihat documentation of how passwords are managed untuk rincian penuh). Karena dari ini, jangan mencoba untuk mengubah atribut sanddi dari pengguna secara langsung. Ini adalah mengapa fungsi pembantu digunakan ketika membuat pengguna.

Untuk merubah sandi pengguna, anda mempunyai beebrapa pilihan:

manage.py changepassword *username* menawarkan metode dari merubah sandi pengguna dari baris perintah. Itu mendorong anda merubah sandi dari pengguna yang diberikan yang anda harus masukkan dua kali. Jika mereka kedua cocok, sandi baru akan berubah segera. Jika anda tidak memasok pengguna, perintah akan berusaha merubah sandi yang nama pengguna cocok dengan pengguna sistem saat ini.

Anda dapat juga merubah sandi secara program, menggunakan set_password():

>>> from django.contrib.auth.models import User
>>> u = User.objects.get(username='john')
>>> u.set_password('new password')
>>> u.save()

Jika anda mempunyai admin Django terpasang, anda dapat juga merubah sandi pengguna pada halaman admin sistem pembuktian keaslian.

Django juga menyediakan views dan forms yang mungkin digunakan untuk mengizinkan pengguna merubah sandi mereka sendiri.

Merubah sandi pengguna akan keluar semua sesi mereka. Lihat Penghapusan sesi pada perubahan sandi untuk rincian.

Pembuktian keaslian pengguna

authenticate(request=None, **credentials)[sumber]

Gunakan authenticate() untuk memeriksa kumpulan dari mandat. Itu mengambil mandat sebagai argumen kata kunci, username dan password untuk kasus awal, periksa mereka kembali setiap authentication backend, dan kembalikan obyek User jika mandat sah untuk backend. Jika mandat tidak sah untuk setiap backend atau jika backend menampilkan PermissionDenied, itu mengembalikan None. Sebagai contoh:

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

request adalah sebuah pilihan HttpRequest yang dilewatkan pada metode authenticate() dari backend autentifikasi.

Changed in Django 1.11:

Argumen request pilihan telah ditambahkan.

Catatan

Ini adalah cara tingkat bawah untuk mengautentifikasi kumpulan dari kepercayaan; sebagai contoh, itu digunakan oleh RemoteUserMiddleware. Meskipun anda sedang menulis sisten autentifikasi anda sendiri, anda mungkin tidak menggunakan ini. Daripada jika anda sedang mencari cara untuk masuk seorang pengguna, gunakan LoginView.

Perizinan dan Pembuktian keaslian

Django datang dengan sistem perizinan sederhana. Dia menyediakan jalan memberikan perizinan ke pengguna dan kelompok khusus dari pengguna.

Digunakan oleh situs admin Django, tetapi anda dipersilahkan menggunakannya di kode anda sendiri.

Situs admin Django menggunakan perizinan sebagai berikut:

  • Akses ke tampilan formulir "add" dan menambah sebuah obyek adalah terbatas untuk pengguna dengan perizinan "add" untuk jenis itu dari obyek.
  • Akses ke tampilan daftar perubahan, tampilan formulir "change" dan merubah sebuah obyek adalah terbatas untuk pengguna dengan perizinan "change" untuk jenis obyek itu.
  • Akses untuk menghapus sebuah obyek adalah terbatas pada pengguna dengan perizinan "hapus" untuk jenis itu dari obyek.

Perizinan dapat disetel tidak hanya per jenis dari obyek, tetapi juga per instance obyek tertentu. Dengan menggunakan cara has_add_permission(), has_change_permission() and has_delete_permission() disediakan oleh kelas ModelAdmin, itu memungkinkan menyesuaikan perizinan untuk instance obyek berbeda dari jenis sama.

Obyek User mempunyai dua bidang many-to-many: groups dan user_permissions. Obyek User dapat mengakses obyek terkait mereka di cara yang sama seperti yang Django model lain:

myuser.groups.set([group_list])
myuser.groups.add(group, group, ...)
myuser.groups.remove(group, group, ...)
myuser.groups.clear()
myuser.user_permissions.set([permission_list])
myuser.user_permissions.add(permission, permission, ...)
myuser.user_permissions.remove(permission, permission, ...)
myuser.user_permissions.clear()

Perizinan pertama

Ketika django.contrib.auth terdaftar di pengaturan INSTALLED_APPS anda, itu akan memastikan bahwa tiga awalan perizinan -- menambah, merubah dan menghapus -- adalah dibuat untuk setiap model Django ditentukan di satu dari aplikasi terpasang anda.

Perizinan ini akan dibuat ketika anda menjalankan manage.py migrate; pertama kali anda menjalankan migrate setelah menambahkan django.contrib.auth pada INSTALLED_APPS, perizinan awalan akan dibuat untuk semua model sebelumnya-terpasang, sama halnya untuk tiap model baru sedang dipasang pada waktu itu. Kemudian, itu akan membuat perizinan awalan untuk model baru setiap kali anda menjalankan manage.py migrate (fungsi yang membuat perizinan adalah terhubung ke sinyal post_migrate).

Menganggap anda memiliki sebuah aplikasi dengan app_label foo dan model bernama Bar, pada percobaan untuk perizinan dasar anda harus gunakan:

  • tambah: user.has_perm('foo.add_bar')
  • rubah: user.has_perm('foo.change_bar')
  • hapus: user.has_perm('foo.delete_bar')

Model Permission jarang diakses secara langsung.

Kelompok

Model django.contrib.auth.models.Group adalah cara umum dari mengkategorikan pengguna sehingga anda dapat memberlakukan perizinan, atau beberapa label lain, ke penggun tersebut. Seorang pengguna dapat milik ke tiap sejumlah kelompok.

Seorang pengguna di kelompok secara otomatis mempunyai perizinan diberikan ke kelompok itu. Sebagai contoh, jika kelompok Site editors mempunyai perizinan can_edit_home_page, tiap pengguna di kelompok itu akan mempunyai perizinan itu.

Diluar perizinan, kelompok adalah cara nyaman untuk mengkategorikan pengguna untuk memberikan mereka beberapa label, atau memperpanjang kegunaan. Sebagai contoh, anda dapat membuat kelompok 'Special users', dan anda dapat menulis kode yang dapat, katakan, memberikan mereka akses ke bagian hanya-anggota dari situs anda, atau mengirim mereka pesan surel hanya-pesan.

Pemrograman membuat perizinan

Selagi custom permissions dapat ditentukan dalam kelas Meta model, anda dapat juga membuat perizinan secara langsung. Sebagai contoh, anda dapat membuat perizinan can_publish untuk model BlogPost di myapp:

from myapp.models import BlogPost
from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType

content_type = ContentType.objects.get_for_model(BlogPost)
permission = Permission.objects.create(
    codename='can_publish',
    name='Can Publish Posts',
    content_type=content_type,
)

Perizinan dapat kemudian diberikan pada User melalui atribut user_permissions nya atau ke Group melalui atribut permissions nya.

Perizinan penyimpanan sementara

Perizinan tembolok ModelBackend pada obyek user setelah pertama kali mereka butuh diambil untuk pemeriksaan perizinan. Ini adalah khususnya baik untuk siklus tanggapan-permintaan sejak perizinan tidak secara khusus memeriksa segera setelah mereka sitambahkan (dalam admin, sebagai contoh). Jika anda menambahkan perizinan dan memeriksa mereka segera setelahnya, dalam percobaan atau tampilan sebagai contoh, pemecahan termudah adalah mengambil kembali dari basisdata. Sebagai contoh:

from django.contrib.auth.models import Permission, User
from django.contrib.contenttypes.models import ContentType
from django.shortcuts import get_object_or_404

from myapp.models import BlogPost

def user_gains_perms(request, user_id):
    user = get_object_or_404(User, pk=user_id)
    # any permission check will cache the current set of permissions
    user.has_perm('myapp.change_blogpost')

    content_type = ContentType.objects.get_for_model(BlogPost)
    permission = Permission.objects.get(
        codename='change_blogpost',
        content_type=content_type,
    )
    user.user_permissions.add(permission)

    # Checking the cached permission set
    user.has_perm('myapp.change_blogpost')  # False

    # Request new instance of User
    # Be aware that user.refresh_from_db() won't clear the cache.
    user = get_object_or_404(User, pk=user_id)

    # Permission cache is repopulated from the database
    user.has_perm('myapp.change_blogpost')  # True

    ...

Pembuktian keaslian di permintaan Jaringan

Django menggunakan sessions dan middleware untuk menghubungkan sitem otentifikasi kedalam request objects.

Ini menyediakan sebuah atribut request.user pada setiap permintaan yang mewakili pengguna saat ini. Jika pengguna saat ini belum masuk, atribut ini akan disetel ke sebuah instance dari AnonymousUser, sebaliknya itu akan berupa sebuah instance dari User.

Anda dapat memberitahu mereka selain dengan is_authenticated, seperti begitu

if request.user.is_authenticated:
    # Do something for authenticated users.
    ...
else:
    # Do something for anonymous users.
    ...

Bagaimana cara masuk pengguna

Jika anda mempunyai pengguna terotentifikasi anda ingin lampirkan ke sesi saat ini - ini dilakukan dengan fungsi login().

login(request, user, backend=None)[sumber]

Untuk pengguna masuk, dari tampilan, gunakan login(). Itu mengambil sebuah obyek HttpRequest dan sebuah obyek User. login() menyimpan ID pengguna di sesi, menggunakan kerangka kerja sesi Django.

Catat bahwa tiap data disetel selama sesi anonim dipertahankan di sesi setelah pengguna masuk.

Contoh ini menunjukkan bagaimana anda mungkin menggunakan kedua authenticate() dan login():

from django.contrib.auth import authenticate, login

def my_view(request):
    username = request.POST['username']
    password = request.POST['password']
    user = authenticate(request, username=username, password=password)
    if user is not None:
        login(request, user)
        # Redirect to a success page.
        ...
    else:
        # Return an 'invalid login' error message.
        ...

Memilih backend otentifikasi

Ketika seorang pengguna masuk, ID pengguna dan backend yang telah digunakan untuk autentifikasi disimpan dalam sesi pengguna. Ini mengizinkan authentication backend sama untuk mengambil rincian pengguna pada permintaan akan datang. Backend autentifikasi untuk menyimpan sesi dipilih sebagai berikut:

  1. Gunakan nilai dai argumen backend pilihan, jika disediakan.
  2. Gunakan nilai dari atribut user.backend, jika hadir. Ini mengizinkan memasangkan authenticate() dan login(): authenticate() menyetel atribut user.backend pada obyek user dia kembalikan.
  3. Gunakan backend dalam AUTHENTICATION_BACKENDS, jika hanya ada satu.
  4. Sebaliknya, munculkan sebuah pengecualian.

Di kasus 1 dan 2, nilai dari argumen backend atau atribut user.backend harus di impor bertitik jalur deretan karakter (seperti yang ditemukan di AUTHENTICATION_BACKENDS), bukan kelas backend sebenarnya.

Bagaimana cara pengguna keluar

logout(request)[sumber]

Untuk keluar pengguna yang telah masuk melalui django.contrib.auth.login(), gunakan django.contrib.auth.logout() dalam tampilan anda. Itu mengambil sebuah obyek HttpRequest dan tidak nilai mempunyai kembalian. Contoh:

from django.contrib.auth import logout

def logout_view(request):
    logout(request)
    # Redirect to a success page.

Catat bahwa logout() tidak melempar kesalahan apapun jika pengguna tidak masuk.

Ketika anda memanggil logout(), data sesi untuk permintaan saat ini sepenuhnya dibersihkan. Semua data yang ada dipindahkan. Ini adalah untuk mencegah orang lain dari menggunakan peramban Jaringan sama untuk masuk dan memiliki akses ke data sesi pengguna sebelumnya. Jika anda ingin menaruh apapun kedalam sesi yang akan tersedia ke pengguna segera setelah keluar, lakukan itu setelah memanggil django.contrib.auth.logout().

Membatasi akses ke pengguna masuk

Cara mentah

Sederhana, cara mentah untuk membatasi akses ke halaman adalah memeriksa request.user.is_authenticated dan antara mengalihkan ke halaman masuk:

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))
    # ...

...atau menampilkan pesan kesalahan:

from django.shortcuts import render

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

Penghias login_required

login_required(redirect_field_name='next', login_url=None)[sumber]

Sebagai jalan pintas, anda dapat menggunakan penghias login_required() yang cocok.

from django.contrib.auth.decorators import login_required

@login_required
def my_view(request):
    ...

login_required() melakukan berikut:

  • Jika pengguna tidak masuk, alihkan ke settings.LOGIN_URL, melewati jalur mutlak saat ini di permintaan deretan karakter. Contoh: /accounts/login/?next=/polls/3/.
  • Jika pengguna masuk, jalankan tampilan secara biasa. Kode tampilan adalah bebas untuk menganggap pengguna adalah masuk.

Secara awalan, jalur yang pengguna harus dialihkan untuk atas keberhasilan otentifikasi adalah disimpan di permintaan parameter deretan karakter disebut "next". Jika anda akan memilih menggunakan nama berbeda untuk parameter ini, login_required() mengambil sebuah pilihan parameter redirect_field_name.

from django.contrib.auth.decorators import login_required

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

Catat bahwa jika anda menyediakan nilai pada redirect_field_name, anda akan paling disukai butuh menyesuaikan cetakan masuk anda juga, sejak cetakan varaibel konteks yang menyimpan jalur pengalihan akan menggunakan nilai dari redirect_field_name``sebagai kuncinya daripada ``"next" (awalan).

login_required() juga mengambil sebuah pilihan parameter login_url. Contoh:

from django.contrib.auth.decorators import login_required

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

Catat bahwa jika anda tidak menentukan parameter login_url, anda akan butuh memastikan bahwa settings.LOGIN_URL dan tampilan masuk anda benar terhubung. Sebagai contoh, menggunakan awalan, tambah baris berikut ke URLconf anda:

from django.contrib.auth import views as auth_views

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

settings.LOGIN_URL juga menerima nama-nama fungsi tampilan dan named URL patterns. Ini mengizinkan anda secara bebas memetakan kembali ke tampilan masuk anda dalam URLconf tanpa harus memperbaharui pengaturan.

Catatan

Penghias login_required TIDAK memeriksa bendera is_active pada pengguna, tetapi awalan AUTHENTICATION_BACKENDS menolak pengguna tidak aktif.

lihat juga

Jika anda sedang menulis tampilan penyesuaian untuk Django admin (atau butuh pemeriksaan otorisasi sama bahwa tampilan pasang-tetap digunakan), anda mungkin menemukan penghias django.contrib.admin.views.decorators.staff_member_required() cara lain yang berguna pada login_required().

Mixin LoginRequired

Ketika menggunakan class-based views, anda dapat mencapai kebiasaan lama seperti dengan login_required dengan menggunakan LoginRequiredMixin. Mixin harus di tempat paling kanan di daftar warisan.

class LoginRequiredMixin

Jika sebuah tampilan menggunakan mixin ini, semua permintaan oleh pengguna bukan-terotentifikasi akan dialihkan ke halaman masuk atau menampilkan kesalahan HTTP 403 Forbidden, tergantung pada parameter raise_exception.

Anda dapat menyetel tiap dari parameter dari AccessMixin untuk menyesuaikan menangani dari pengguna tidak sah:

from django.contrib.auth.mixins import LoginRequiredMixin

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

Catatan

Seperti penghias login_required mixin ini TIDAK memeriksa bendera is_active pada pengguna, tetapi awalan AUTHENTICATION_BACKENDS menolak pengguna tidak aktif.

Membatasi akses ke pengguna masuk yang melewatkan percobaan

Untuk membatasi akses berdasarkan pada perizinan tertentu atau beberapa percobaan lain, anda akan melakukan pada dasarnya hal sama seperti digambarkan di bagian sebelumnya.

Cara termudah untuk menjalankan percobaan anda pada request.user di tampilan secara langsung. Sebagai contoh, tampilan ini memeriksa untuk memastikan pengguna mempunyai sebuah surel di ranah yang diinginkan dan jika tidak, dialihkan ke halaman masuk:

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')[sumber]

Sebagai sebuah jalan pintas, anda dapat menggunakan penghias user_passes_test yang cocok yang melakukan sebuah pengalihan ketika callable mengembalikan False:

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() mengambil argumen wajib: sebuah callable yang mengambil obyek User dan mengembalikan True jika pengguna diizinkan melihat halaman. Catat bahwa user_passes_test() tidak secara otomatis memeriksa bahwa the User bukan anonim.

user_passes_test() mengambil dua argumen pilihan:

login_url
Biarkan anda menentukan URL yang pengguna tidak melewati percobaan akan dialihkan. Itu mungkin halaman masuk dan awalan ke settings.LOGIN_URL jika anda tidak menentukan satu.
redirect_field_name
Sama seperti login_required(). Atur itu ke None memindahkannya dari URL, yang anda mungkin ingin melakukannya jika anda mengalihkan pengguna yang tidak melewati percobaan ke halaman bukan-masuk dimana tidak ada "next page".

Sebagai contoh:

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

Ketika menggunakan class-based views, anda dapat menggunakan UserPassesTestMixin untuk melakukan ini.

test_func()

Anda harus menimpa metode test_func() dari kelas untuk menyediakan percobaan yang dilakukan. Lebih lanjut, anda dapat menyetel tiap parameter dari AccessMixin untuk menyesuaikan penangangan dari pengguna tidak sah:

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()

Anda dapat juga menimpa metode get_test_func() untuk memiliki penggunaan mixin fungsi bernama berbeda untuk pemeriksaannya (sebagai ganti test_func()).

Menumpuk UserPassesTestMixin

Diakrenakan cara UserPassesTestMixin diterapkan, anda tida dapat menumpuk mereka di daftar warisan anda. Berikut TIDAK bekerja:

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

class TestMixin2(UserPassesTestMixin):
    def test_func(self):
        return self.request.user.username.startswith('django')

class MyView(TestMixin1, TestMixin2, View):
    ...

Jika TestMixin1 akan memanggil super() dan mengambil hasi itu kedalam akun, TestMixin1 tidak akan bekerja berdiri sendiri lagi.

Penghias permission_required

permission_required(perm, login_url=None, raise_exception=False)[sumber]

Itu adalah cara lain tugas umum untuk memeriksa apakah seorang pengguna mempunyai perizinan khusus. Untuk alasan tersebut, Django menyediakan jalan pintas untuk kasus itu: penghias the permission_required().:

from django.contrib.auth.decorators import permission_required

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

Sama seperti metode has_perm(), nama-nama perizinan mengambil formulir "<app label>.<permission codename>" (yaitu polls.can_vote untuk perizinan pada model di apliaksi polls).

Penghias mungkin juga mengambil perizinan berulang, dalam hal ini pengguna harus memiliki semua perizinan untuk mengakses tampilan.

Catat bahwa permission_required() juga mengambil sebuah pilihan parameter login_url:

from django.contrib.auth.decorators import permission_required

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

Ketika di penghias login_required(), awalan login_url ke settings.LOGIN_URL.

Jika parameter raise_exception diberikan, penghias akan memunculkan PermissionDenied, mendorong the 403 (HTTP Forbidden) view daripada mengalihkan ke halaman masuk.

Jika anda ingin menggunakan raise_exception tetapi juga memberikan pengguna anda kesempatan untuk masuk terlebih dahulu, anda dapat menambahkan penghias login_required():

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

@login_required
@permission_required('polls.can_vote', 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.

Mixin PermissionRequiredMixin

Untuk memberlakukan pemeriksaan perizinan pada class-based views, anda dapat menggunakan PermissionRequiredMixin:

class PermissionRequiredMixin

Mixin ini, seperti penghias permission_required, memeriksa apakah pengguna mengakses sebuah tampilan mempunyai semua perizinan yang diberikan. Anda harus menentukan perizinan (atau perulangan dari perizinan) menggunakan parameter permission_required:

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')

Anda dapat menyetel tiap dari parameter dari AccessMixin untuk menyesuaikan menangani dari pengguna tidak sah.

Anda dapat juga menimpa metode ini:

get_permission_required()

Mengembalikan perulangan dari nama perizinan digunakan oleh mixin. Awalan pada atribut permission_required, dirubah ke sebuah tuple juka memungkinkan.

has_permission()

Mengembalikan sebuah boolean menunjukkan apakah pengguna saat ini mempunyai perizinan untuk menjalankan tampilan dihiasi. Secara awalan, ini mengembalikan hasil dari memanggil has_perms() dengan daftar perizinan dikembalikan oleh get_permission_required().

Mengalihkan permintaan tidak sah di tampilan berdasarkan-kelas

Untuk memudahkan penanganan dari pembatasan akses di class-based views, AccessMixin dapat digunakan untuk mengalihkan pengguna ke halaman masuk atau menampilkan sebuah tanggapan HTTP 403 Forbidden.

class AccessMixin
login_url

Nilai balik awalan untuk get_login_url(). Awalan pada None dalam hal ini get_login_url() jatuh kebelakang untuk settings.LOGIN_URL.

permission_denied_message

Nilai balik awalan untuk get_permission_denied_message(). Awalan pada sebuah deretan karakter kosong.

redirect_field_name

Nilai balikan awalan untuk get_redirect_field_name(). Awalan ke "next".

raise_exception

Atribut ini disetel ke``True``, sebuah pengecualian PermissionDenied akan dimunculkan daripada mengalihkan. Awalan ke False.

get_login_url()

Mengembalikan URL yang pengguna tidak melewati percobaan akan dialihkan. Mengembalikan login_url jika disetel, atau sebaliknya settings.LOGIN_URL.

get_permission_denied_message()

Ketika raise_exception adalah True, metode ini dapat digunakan untuk mengendalikan pesan kesalahan dilewatkan ke penangan kesalahan untuk menampilkan ke pengguna. Mengembalikan atribut permission_denied_message secara awalan.

get_redirect_field_name()

Mengembalikan nama dari permintaan parameter yang akan mengandung URL pengguna harus dialihkan setelah berhasil masuk. Jika anda menyetel ini ke None, sebuah permintaan parameter tidak akan ditambahkan. Mengembalikan atribut redirect_field_name secara awalan.

handle_no_permission()

Tergantung pada nilai dari raise_exception, metode antara memunculkan pengecualian PermissionDenied atau mengalihkan pengguna ke login_url, secara pilihan menyertakan redirect_field_name jika itu disetel.

Penghapusan sesi pada perubahan sandi

Jika AUTH_USER_MODEL anda warisan dari AbstractBaseUser atau menerapkan metode get_session_auth_hash() miliknya, sesi terotentifikasi akan menyertakan campuran dikembalikan oleh fungsi ini. Di kasus AbstractBaseUser, ini adalah HMAC dari bidang sandi. Django memeriksa bahwa campuran di sesi untuk setiap permintaan cocok satu yang dihitung selama permintaan. Ini mengizinkan pengguna untuk keluar dari sesi mereka dengan merubah sandi mereka.

Tampilan rubah sandi awalan disertakan dengan Django, tampilan PasswordChangeView dan the user_change_password dalam admin django.contrib.auth, perbaharui sesi dengan campuran sandi baru sehingga pengguna merubah sandi mereka sendiri tidak keluar. Jika anda mempunyai tampilan rubah sandi penyesuaian dan berharap memiliki perilaku sama, gunakan fungsi update_session_auth_hash().

update_session_auth_hash(request, user)[sumber]

Fungsi ini mengambil permintaan saat ini dan memperbaharui obyek user dari dimana campuran sesi baru akan berasal dan memperbaharui campuran sesi dengan benar. Itu juga memutar kunci sesi sehingga kue sesi tercuri akan menjadi tidak sah.

Contoh penggunaan:

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:
        ...
Changed in Django 1.11:

Memutar dari kunci sesi telah ditambahkan.

Catatan

Sejak get_session_auth_hash() adalah berdasarkan pada SECRET_KEY, memperbaharui situs anda untuk menggunakan rahasia baru akan menghapus semua sesi yang ada.

Tampilan Otentifikasi

Django menyediakan beberapa tampilan yang anda dapat gunakan untuk menangani masuk, keluarm dan pengelolaan sandi. Ini menggunakan dari stock auth forms tetapi anda dapat melewatkan nya ke dalam formulir anda sendiri juga.

Django menyediakan tidak ada awalan cetakan untuk tampilan otentifikasi. Anda harus membuat cetakan anda sendiri untuk tampilan anda ingin gunakan. Konteks cetakan adalah terdokumentasi di setiap tampilan, lihat Semua tempilan otentifikasi.

Menggunakan tamplian

Ada perbedaan metode untuk menerapkan tampilan ini di proyek anda. Cara termudah adalah menyertakan URLconf yang disediakan di django.contrib.auth.urls dalam URLConf anda sendiri, sebagai contoh:

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

Ini akan menyertakan pola URL berikut:

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']

Tampilan menyediakan nama URL untuk acuan lebih mudah. Lihat the URL documentation untuk rincian pada menggunakan corak URL bernama.

Jika anda ingin kendali lebih terhadap URL anda, anda dapat mengacu tampilan khusus di URLconf:

from django.contrib.auth import views as auth_views

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

Tampilan mempunyai argumen pilihan anda dapat gunakan untuk merubah kebiasaan dari tampilan. Sebagai contoh, jika anda ingin merubah nama cetakan tampilan kegunaan, anda dapat menyediakan argumen template_name. Sebuah cara untuk melakukan ini adalah menyediakan argumen kata kunci dalam URLconf, ini akan dilewatkan ke tampilan. Sebagai contoh:

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

Semua tampilan adalah class-based, yang mengizinkan anda dengan mudah menyesuaikan mereka dengan mensubkelaskan.

Semua tempilan otentifikasi

Ini adalah daftar dengan semua tamilan django.contrib.auth sediakan. Untuk penerapan rincian lihat Menggunakan tamplian.

login(request, template_name=`registration/login.html`, redirect_field_name='next', authentication_form=AuthenticationForm, extra_context=None, redirect_authenticated_user=False)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi login harus diganti dengan berdasarkan-kelas LoginView.

Argumen-argumen pilihan dari tampilan ini mirip pada atribut-atribut berdasarkan-kelas LoginView.

class LoginView
New in Django 1.11.

Nama URL: masuk

Lihat the URL documentation untuk rincian pada menggunakan corak URL bernama.

Atribut

  • template_name: Nama dari cetakan untuk ditampilkan untuk tampilan digunakan untuk pengguna masuk. Awalan ke registration/login.html.

  • redirect_field_name: Nama dari bidang GET mengandung URL untuk mengalihkan setelah masuk. Awalan ke next.

  • authentication_form:Sebuah callable (khususnya hanya kelas formulir) untuk menggunakan otentifikasi. Awalan pada AuthenticationForm.

  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.

  • redirect_authenticated_user: Sebuah boolean yang mengendalikan apakah atau tidak pengguna terotentifikasi mengakses halaman login akan dialihkan ketika mereka telah berhasil masuk. Awalan ke False.

    Peringatan

    Jika anda mengadakan redirect_authenticated_user, jaringan situs lainnya akan dapat menentukan jika pengunjung mereka adalah terotentifikasi pada situs anda dengan meminta pengalihan URL ke berkas gambar pada situs jaringan anda. Untuk menghindari ini "social media fingerprinting" kebocoran informasi, simpan semua gambar dan favicon anda pada ranah terpisah.

    Enabling redirect_authenticated_user can also result in a redirect loop when using the permission_required() decorator unless the raise_exception parameter is used.

  • success_url_allowed_hosts`: set dari rumah, sebagai tambahan pada request.get_host(), yang aman untuk pengalihan setelah masuk. Awalan ke set kosong.

Ini adalah apa LoginView lakukan:

  • Jika dipanggil melalui GET, itu menampilkan formulir masuk yang POST ke URL sama.Lebih dari ini dalam bit.
  • Jika dipanggil melalui POST dengan pengguna mengajukan surat kepercayaan, itu mencoba untuk masuk pengguna. Jika masuk berhasil, tampilan mengalihkan ke URL ditentukan di next tidak menyediakan, itu mengalihkan ke settings.LOGIN_REDIRECT_URL (yang awalan menjadi /accounts/profile/). Jika masuk tidak berhasil, itu menampilkan kembali formulir masuk.

Itu adalah tanggung jawab anda untuk menyediakan html untuk cetakan masuk, dipanggil registration/login.html secara awalan. Cetakan ini dilewatkan empat cetakan variabel konteks:

  • form: Sebuah obyek Form mewakili AuthenticationForm.
  • next: URL untuk dialihkan setelah berhasil masuk. Ini mungkin mengandung permintaan string, juga.
  • site: Site`saat ini, menurut pengaturan :setting:`SITE_ID. Jika anda tidak mempunyai kerangka kerja situs terpasang, ini akan disetel ke sebuah instance dari RequestSite, yang memperoleh nama situs dan ranah dari HttpRequest saat ini.
  • site_name: Sebuah nama lain untuk site.name. Jika anda tidak mempunyai kerangka kerja situs terpasang, ini akan disetel ke nilai dari request.META['SERVER_NAME']. Untuk lebih di situs, lihat The "sites" framework.

Jika anda memilih tidak memanggil cetakan registration/login.html, anda dapat melewatkan parameter template_name melalui argumen tambahan pada metode as_view dalam URLConf anda. Sebagai contoh, baris URLconf ini akan menggunakan myapp/login.html sebagai gantinya.

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

Anda dapat juga menentukan nama dari bidang GET yang mengandung URL untuk mengalihkan setelah masuk menggunakan redirect_field_name. Secara awalan, bidang dipanggil next.

Ini adalah sebuah contoh cetakan registration/login.html anda dapat gunakan sebagai titik awalan. Itu menganggap anda memiliki sebuah cetakan base.html yang menentukan sebuah blok content.

{% 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 %}

Jika anda telah menyesuaiakan autentifikasi (lihat Customizing Authentication 1) anda dapat menggunakan formulir autentifikasi penyesuaian dengan mengatur atribut authentication_form. Formulir ini harus menerima sebuah argumen katakunci request dalam metode __init__() nya dan menyediakan metode get_user() yang mengembalikan obyek pengguna terautentifikasi (metode ini hanya dipanggil setelah keberhasilan formulir pengesahan).

logout(request, next_page=None, template_name='registration/logged_out.html', redirect_field_name='next', extra_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi logout harus diganti oleh LogoutView berdasarkan-kelas.

Argumen-argumen pilihan dari tampilan ini mirip pada atribut-atribut berdasarkan-kelas LogoutView.

class LogoutView
New in Django 1.11.

Pengguna keluar

Nama URL: logout

Atribut

  • next_page: URL untuk mengalihkan setelah keluar. Awalan menjadi settings.LOGOUT_REDIRECT_URL.
  • template_name: Nama penuh dari sebuah cetakan setelah pengguna keluar. Awalan menjadi registration/logged_out.html.
  • redirect_field_name: Nama dari bidang GET mengandung URL untuk mengalihkan ke setelah keluar. Awalan pada next. Menimpa URL next_page jika parameter GET yang diberikan lolos.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.
  • success_url_allowed_hosts: set dari rumah, sebagai tambahan pada request.get_host(), yang aman untuk pengelihan setelah keluar. Awalan pada set kosong.

Kontek cetakan

  • title: String "Logged out", lokalisasi.
  • site: Site`saat ini, menurut pengaturan :setting:`SITE_ID. Jika anda tidak mempunyai kerangka kerja situs terpasang, ini akan disetel ke sebuah instance dari RequestSite, yang memperoleh nama situs dan ranah dari HttpRequest saat ini.
  • site_name: Sebuah nama lain untuk site.name. Jika anda tidak mempunyai kerangka kerja situs terpasang, ini akan disetel ke nilai dari request.META['SERVER_NAME']. Untuk lebih di situs, lihat The "sites" framework.
logout_then_login(request, login_url=None, extra_context=None)

Pengguna keluar, kemudian mengalihkan ke halaman masuk.

Nama URL: Tidak ada URL awal disediakan

Argumen pilihan

  • login_url: URL dari halaman masuk untuk mengalihkan. Awalan menjadi settings.LOGIN_URL jika tidak diberikan.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.

Ditinggalkan sejak versi 1.11: Parameter extra_context tidak digunakan diusangkan dan akan dipindahkan dalam Django 2.1.

password_change(request, template_name='registration/password_change_form.html', post_change_redirect=None, password_change_form=PasswordChangeForm, extra_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi password_change harus diganti oleh PasswordChangeView berdasarkan-kelas.

Argumen pilihan dari tampilan ini mirip pada atribut-atribut berdasarkan-kelas PasswordChangeView, kecuali argumen-argumen post_change_redirect dan password_change_form yang memetakan ke atribut success_url dan form_class dari tampilan berdasarkan-kelas.

class PasswordChangeView
New in Django 1.11.

Nama URL: password_change

Izinkan pengguna merubah sandi mereka.

Atribut

  • template_name: Nama penuh dari cetakan untuk digunakan untuk menampilkan formulir rubah sandi. Awalan menjadi registration/password_change_form.html jika tidak diberikan.
  • success_url: URL untuk mengalihkan setelah perubahan sandi berhasil.
  • form_class`: Formulir "rubah sandi" penyesuaian yang harus menerima sebuah argumen katakunci. Formulir bertanggungjawab untuk sebenarnya merubah sandi pengguna. Awalan pada PasswordChangeForm.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.

Kontek cetakan

  • form: Formulir rubah sandi (lihat form_class diatas).
password_change_done(request, template_name='registration/password_change_done.html', extra_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi password_change_done harus diganti oleh PasswordChangeDoneView berdasarkan-kelas.

Argumen-argumen pilihan dari tampilan ini mirip pada atribut-atribut berdasarkan-kelas PasswordChangeDoneView.

class PasswordChangeDoneView
New in Django 1.11.

Nama URL: password_change_done

Halaman muncul setelah pengguna telah merubah sandi mereka.

Atribut

  • template_name: Nama penuh dari cetakan untuk digunakan. Awalan menjadi registration/password_change_done.html jika tidak diberikan.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.
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, extra_context=None, html_email_template_name=None, extra_email_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi password_reset harus diganti oleh PasswordResetView berdasarkan-kelas.

Argumen pilihan dari tampilan ini mirip pada atribut berdasarkan-kelas PasswordResetView, kecuali argumen post_reset_redirect dan password_reset_form yang memetakan ke atribut success_url dan form_class dari tampilan berdasarkan-kelas.

class PasswordResetView
New in Django 1.11.

Nama URL: password_reset

Mengizinkan seorang pengguna menyetel kembali sandi dengan membangkitkan satu-kali penggunaan tautan yang dapat digunakan untuk menyetel kembali sandi, dan mengirim tautan itu ke alamat surel pengguna terdaftar.

Jika alamat sandi disediakan tidak ada dalam sistem, tampilan ini tidak akan mengirim sebuah surel, tetapi pengguna tidak akan menerima pesan kesalahan apapun juga. Ini mencegah kebocoran informasi pada penyerang potensial. Jika anda ingin menyediakan sebuah pesan kesalahan dalam kasus ini, anda dapat mensubkelaskan PasswordResetForm dan menggunakan atribut form_class.

Pengguna ditandai dengan sandi tidak digunakan (lihat set_unusable_password() tidak diizinkan untuk meminta menyetel kembali sandi untuk mencegah penyalahgunaan ketika menggunakan sumber autentifikasi luar seperti LDAP. Catat bahwa mereka tidak akan menerima pesan kesalahan apapun sejak ini akan membuat wujud akun mereka tetapi tidak ada surat akan dikirim juga.

Atribut

  • template_name: Nama penuh dari cetakan untuk digunakan untuk menampilkan formulir setel kembali sandi. Awalan menjadi registration/password_reset_form.html jika tidak diberikan.
  • form_class: Formulir yang akan digunakan mendapatkan surel dari pengguna untuk menyetel kembali sandi. Awalan pada PasswordResetForm.
  • email_template_name: Nama penuh dari cetakan untuk digunakan untuk membangkitkan surel dengan tautan sandi setel kembali. Awalan menjadi registration/password_reset_email.html jika tidak diberikan.
  • subject_template_name: Nama penuh dari cetakan untuk digunakan untuk subyek dari surel dengan tautan sandi setel kembali. Awalan menjadi registration/password_reset_subject.txt jika tidak diberikan.
  • token_generator: Instance dari kelas untuk memeriksa tautan satu waktu. Ini akan awalan menjadi default_token_generator, itu adalah sebuah instance dari django.contrib.auth.tokens.PasswordResetTokenGenerator.
  • success_url: URL dialihkan setelah berhasil permintaan setel kembali sandi.
  • from_email: Sebuah alamat surel sah. Secara awalan Django menggunakan DEFAULT_FROM_EMAIL.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.
  • html_email_template_name: Nama penuh dari cetakan untuk digunakan untuk membangkitkan sebuah surel banyak bagian text/html dengan tautan menyetel kembali sandi. Secara awalan, surel HTML tidak dikirim.
  • extra_email_context: Sebuah kamus dari data konteks yang akan tersedia di cetakan surel.

Kontek cetakan

  • form: Formulir (lihat form_class diatas) untuk mengatur kembali sandi pengguna.

Konteks cetakan surel:

  • email: Sebuah nama lain untuk user.email
  • user: User saat ini, menurut pada bidang formulir email. Hanya pengguna aktif yang dapa menyetel kembali sandi mereka (User.is_active adalah True).
  • site_name: Sebuah nama lain untuk site.name. Jika anda tidak mempunyai kerangka kerja situs terpasang, ini akan disetel ke nilai dari request.META['SERVER_NAME']. Untuk lebih di situs, lihat The "sites" framework.
  • domain: Sebuah nama lain untuk site.domain. Jika anda tidak mempunyai kerangka kerja situs terpasang, ini akan disetel ke nilai dari request.get_host().
  • protocol: http atau https
  • uid: Primary key pengguna disandikan dalam base 64.
  • token: Token untuk memeriksa bahwa tautan menyetel kembali adalah sah.

Contoh registration/password_reset_email.html (cetakan badan email):

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

Konteks cetakan sama digunakan untuk cetakan subyek. Subyek harus berupa strng teks polosbaris tunggal.

password_reset_done(request, template_name='registration/password_reset_done.html', extra_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi password_reset_done harus diganti oleh PasswordResetDoneView berdasarkan-kelas.

Argumen-argumen pilihan dari tampilan ini mirip pada atribut-atribut berdasarkan-kelas PasswordResetDoneView.

class PasswordResetDoneView
New in Django 1.11.

Nama URL: password_reset_done

Halaman muncul setelah pengguna telah disurelkan sebuah tautan untuk menyetel kembali sandi mereka. Tampilan ini dipanggil sebagai awalan jika PasswordResetView tidak mempunyai kumpulan URL success_url yang jelas.

Catatan

Jika alamat surel disediakan tidak ada di sistem, pengguna adalah tidak aktif, atau mempunyai sebuah sandi tidak berguna, pengguna akan masih dialihkan ke tampilan ini tetapi tidak ada surel yang akan dikirim.

Atribut

  • template_name: Nama penuh dari cetakan untuk digunakan. Awalan menjadi registration/password_reset_done.html jika tidak diberikan.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.
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, extra_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi password_reset_confirm harus diganti dengan PasswordResetConfirmView berdasarkan-kelas.

Argumen pilihan dari tampilan ini mirip pada atribut berdasarkan-kelas PasswordResetConfirmView , kecuali argumen post_reset_redirect dan set_password_form yang memetakan ke atribut success_url dan form_class dari tampilan berdasarkan-kelas.

class PasswordResetConfirmView
New in Django 1.11.

Nama URL: password_reset_confirm

Mengajukan sebuah formulir untuk memasukkan sebuah sandi baru.

Argumen katakunci dari URL:

  • uidb64: id pengguna disandikan dalam base 64.
  • token: Token untuk memeriksa bahwa sandi adalah sah.

Atribut

  • template_name: Nama penuh dari cetakan untuk memperlihatkan penegasan tampilan sandi. Nilai awalan adalah registration/password_reset_confirm.html.
  • token_generator: Instance dari kelas untuk memeriksa sandi. Ini akan awalan menjadi default_token_generator, itu adalah sebuah instance dari django.contrib.auth.tokens.PasswordResetTokenGenerator.
  • post_reset_login: Boolean menunjukkan jika pengguna harus otomatis diatutentifikasi setelah setel kembali sandi berhasil. Awalan pada False.
  • post_reset_login_backend: Jalur bertitik pada backend autentifikasi untuk menggunakan ketika mengautentifikasi pengguna jika post_reset_login adalah True. Dibutuhkan hanya jika anda mempunyai banyak AUTHENTICATION_BACKENDS dikonfigurasi. Awalan pada None.
  • form_class: Formulir yang akan digunakan menyetel sandi. Awalan pada SetPasswordForm.
  • success_url: URL untuk mengalihkan setelah penyetelan kembali sandi selesai. Awalan pada 'password_reset_complete'.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.

Kontek cetakan

  • form: Formulir (lihat set_password_form diatas) untuk mengatur sandi pengguna baru
  • validlink: Boolean, True jika tautan (perpaduan dari uidb64 dan token) adalah sah atau tidak digunakan.
password_reset_complete(request, template_name='registration/password_reset_complete.html', extra_context=None)

Ditinggalkan sejak versi 1.11: Tampilan berdasarkan-fungsi password_reset_complete harus diganti dengan PasswordResetCompleteView berdasarkan-kelas.

Argumen-argumen pilihan dari tampilan ini mirip pada atribut-atribut berdasarkan-kelas PasswordResetCompleteView.

class PasswordResetCompleteView
New in Django 1.11.

Nama URL: password_reset_complete

Menghadirkan sebuah tampilan yang menginformasikan pengguna bahwa sandi telah berhasil dirubah.

Atribut

  • template_name: Nama penuh dari cetakan untuk memperlihatkan tampilan. Nilai awalan menjadi registration/password_reset_complete.html.
  • extra_context: Sebuah kamus dari data konteks yang akan ditambahkan ke data konteks awalan dilewatkan ke cetakan.

Fungsi pembantu

redirect_to_login(next, login_url=None, redirect_field_name='next')

Dialihkan ke halaman masuk, dan kemudian kembali ke URL lain setelah berhasil masuk.

Argumen diwajibkan:

  • next: URL untuk mengalihkan setelah berhasil masuk.

Argumen pilihan

  • login_url: URL dari halaman masuk untuk mengalihkan. Awalan menjadi settings.LOGIN_URL jika tidak diberikan.
  • redirect_field_name: Nama dari bidang GET mengandung URL untuk mengalihkan ke setelah keluar. Menimpa next jika parameter GET yang diberikan lolos.

Formulir siap pakai

Jika anda tidak ingin menggunakan tampilan siap-pakai, tetapi ingin dengan meyakinkan tidak menulis formulir untuk kegunaan ini, sistem autentifikasi menyediakan beberapa formulir siap-pakai ditempatkan di django.contrib.auth.forms:

Catatan

Formulir autentifikasi siap-pakai membuat pendapat tertentu tentang model user yang mereka bekerja dengannya. Jika anda sedang menggunakan sebuah custom user model, itu mungkin diperlukan menentukan formulir anda sendiri untuk sistem autentifikasi. Untuk informasi lebih, mengacu pada dokumentasi tentang using the built-in authentication forms with custom user models.

class AdminPasswordChangeForm

Sebuah formulir digunakan di antarmuka admin untuk merubah sandi pengguna.

Mengambil argumen user sebagai argumen penempatan pertama.

class AuthenticationForm

Sebuah formulir untuk pengguna masuk.

Mengambil request sebagai argumen penempatan pertama, yang disimpan pada instance formulir untuk digunakan oleh sub-kelas.

confirm_login_allowed(user)

Secara awalan, AuthenticationForm menolak pengguna yang bendera is_active disetel menjadi False. Anda mungkin menimpa kebiasaan ini dengan kebijakan penyesuaian untuk menentukan pengguna mana dapat masuk. Lakukan ini dengan formulir penyesuaian yang mensubkelas AuthenticationForm dan menimpa metode confirm_login_allowed(). Metode ini harus memunculkan ValidationError jika pengguna yang diberikan tidak masuk.

Sebagai contoh, untuk mengizinkan semua pengguna masuk tanpa memperhatikan keadaan "active":

from django.contrib.auth.forms import AuthenticationForm

class AuthenticationFormWithInactiveUsersOkay(AuthenticationForm):
    def confirm_login_allowed(self, user):
        pass

(Di kasus ini, anda akan juga butuh menggunakan sebuah backend autentifikasi yang mengizinkan pengguna tidak aktif, seperti AllowAllUsersModelBackend.)

Atau mengizinkan hanya beberapa pengguna aktif untuk masuk:

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 PasswordChangeForm

Sebuah formulir untuk mengizinkan seorang pengguna merubah sandi mereka.

class PasswordResetForm

Sebuah formulir untuk membangkitkan dan mensurelkan tautan penggunaan satu-kali untuk menyetel kembali sandi pengguna.

send_mail(subject_template_name, email_template_name, context, from_email, to_email, html_email_template_name=None)

Menggunakan argumen untuk mengirimkan sebuah EmailMultiAlternatives. Dapat ditimpa untuk menyesuaikan bagaimana surel dikirim ke pengguna.

Parameter:
  • subject_template_name -- cetakan untuk subyek.
  • email_template_name -- cetakan untuk badan surel.
  • context -- konteks dilewatkan ke subject_template, email_template, dan html_email_template (jika itu bukan None).
  • from_email -- surel pengirim
  • to_email -- surel dari peminta.
  • html_email_template_name -- cetakan untuk badan HTML; awalan menjadi None, dimana kasus sebuah surel teks polos dikirim.

Secara awalan, save() mengumpulkan context dengan variabel sama yang PasswordResetView melewatkan ke konteks surelnya.

class SetPasswordForm

Formulir yang membiarkan pengguma merubah sandi mereka tanpa memasukkan sandi lama.

class UserChangeForm

Sebuah formulir digunakan di antarmuka admin untuk merubah infromasi dan perizinan pengguna.

class UserCreationForm

Sebuah ModelForm untuk membuat pengguna baru.

Itu mempunyai tiga bidang: username (dari model user), password1, dan password2. Itu memeriksa bahwa password1 dan password2 cocok, mensahkan sandi menggunakan validate_password(), dan menyetel sandi pengguna menggunakan set_password().

Pembuktian keaslian data di cetakan

Pengguna masuk saat ini dan perizinan mereka dibuat tersedia di template context ketika anda menggunakan RequestContext.

Secara teknis

Secara teknis, variabel-variabel ini hanya dibuat tersedia di konteks cetakan jika anda menggunakan pengolah konteks RequestContext dan 'django.contrib.auth.context_processors.auth' adalah diadakan. Itu berada di berkas pengaturan dibangkitkan awalan. Untuk lebih, lihat RequestContext docs.

Pengguna

Ketika membangun sebuah cetakan RequestContext, pengguna masuk saat ini, antara instance User atau instance AnonymousUser, disimpan di variabel cetakan {{ user }}:

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

Variabel konteks cetakan ini tidak tersedia jika sebuah RequestContext tidak sedang digunakan.

Hak akses

Perizinan pengguna masuk saat ini disimpan di variabel cetakan {{ perms }}. Ini adalah sebuah instance dari django.contrib.auth.context_processors.PermWrapper, yaitu sebuah proxy cetakan-ramah dari perizinan.

Menilai pencarian atribut-tunggal dari {{ perms }} sebagai boolean adalah wakil pada User.has_module_perms(). Sebagai contoh, untuk memeriksa jika pengguna masuk mempunyai perizinan apapun dalam aplikasi foo:

{% if perms.foo %}

Menilai penacrian atribua-tingkat-dua sebagai boolean adalah wakil pada User.has_perm(). Sebagai contoh, untuk memeriksa jika pengguna masuk mempunyai perizinan foo.can_vote:

{% if perms.foo.can_vote %}

Ini adalah beberapa contoh lengkap dari perizinan pemeriksaan dalam sebuah cetakan:

{% 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 %}

Itu memungkinkan juga mencari perizinan dengan pernyataan {% if in %}. Sebagai contoh:

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

Mengelola pengguna di admin

Ketika anda mempunyai kedua django.contrib.admin dan django.contrib.auth terpasang, admin menyediakan cara yang nyaman untuk menampilkan dan mengelola pengguna, kelompok, dan perizinan. Pengguna dapat dibuat dan dihapus seperti model Django apapun. Kelompok dapat dibuat, dan perizinan dapat diberikan ke pengguna atau kelompok. Sebuah catatan dari pengguna menyunting model dibuat dalam admin juga disimpan dan ditampilkan.

Membuat pengguna

Anda harus melihat sebuah tautan pada "Users" di bagian "Auth" dari halaman indeks admin utama. Halaman admin "Add user" adalah berbeda dari halaman admin standar karena itu membutuhkan anda memilis sebuah nama pengguna dan sandi sebelum mengizinkan anda menyunting sisa dari bidang pengguna.

Juga catat: jika anda ingin seorang akun pengguna dapat membuat pengguna menggunakan situs admin Django, anda akan butuh memberikan mereka perizinan untuk menambahkan pengguna dan merubah pengguna (yaitu, perizinan "Add user" dan "Change user"). Jika sebuah akun mempunyai perizinan untuk menambah pengguna tetapi tidak merubah mereka, yang akun tidak dapat menambah pengguna. Kenapa, Karena jika anda mempunyai perizinan menambahkan pengguna, anda mempunyai kekuasaan membuat superuser, yang dapat kemudian, di gilirannya, rubah pengguna lain. Sehingga Django membuatuhkan tambah dan merubah perizinan sebagai ukuran keamanan sedikit.

Bijaksanalah tentang bagaimana anda mengizinkan pengguna mengelola perizinan. Jika anda memberikan bukan-superuser kemampuan menyunting pengguna, ini adalah akhirnya sama seperti memberikan mereka keadaan superuser karena mereka akan dapat memperbaiki perizinan dari pengguna menyertakan mereka sendiri!

Merubah sandi

Sandi pengguna tidak diperlihatkan di admin (maupun disimpan di basisdata), tetapi password storage details diperlihatkan. Disertakan di layar dari informasi ini adalah sebuah tautan pada sebuah formulir rubah sandi yang mengizinkan admin merubah sandi pengguna.

Back to Top