Middleware¶

Dokumen ini menjelaskan semua komponen middleware yang datang dengan Django. Untuk informasi pada bagaimana menggunakan mereka dan bagaimana menulis middleware anda sendiri, lihat middleware usage guide.

Middleware tersedia¶

Middleware tembolok¶

class UpdateCacheMiddleware[sumber]¶

class FetchFromCacheMiddleware[sumber]¶

Enable the site-wide cache. If these are enabled, each Django-powered page will be cached for as long as the CACHE_MIDDLEWARE_SECONDS setting defines. See the cache documentation.

Middleware "Umum"¶

class CommonMiddleware[sumber]¶

response_redirect_class¶: Awalan pada HttpResponsePermanentRedirect. Sub kelas CommonMiddleware dan menimpa atribut untuk menyesuaikan pengalihan diterbitkan oleh middleware.

Tambah sedikit kenyamanan untuk perfeksionis:

Larang akses ke agen pengguna dalam pengaturan DISALLOWED_USER_AGENTS, yang harus berupa daftar dari obyek-obyek regular expression tersusun.
Lakukan penulisan kembali URL pada pengaturan APPEND_SLASH dan PREPEND_WWW.

Jika APPEND_SLASH adalah True dan URL permulaan tidak berakhir dengan garis miring, dan itu tidak ditemukan dalam URLconf, kemudian URL baru dibentuk dengan menambahkan sebuah garis miring pada akhiran. Jika URL baru ini ditemukan dalam URLconf, kemudian Django mengalihkan permintaan ke URL baru ini. Sebaliknya, URL permulaan diolah seperti biasa.

Sebagai contoh, foo.com/bar akan dialihkan ke foo.com/bar/ jika anda tidak memiliki pola URL sah untuk foo.com/bar tetapi punya pola sah untuk foo.com/bar/.

Jika PREPEND_WWW adalah True, URL yang tidak memiliki awalan "www." akan dialihkan ke URL sama dengan sebuah awalan "www."

Both of these options are meant to normalize URLs. The philosophy is that each URL should exist in one, and only one, place. Technically a URL foo.com/bar is distinct from foo.com/bar/ -- a search-engine indexer would treat them as separate URLs -- so it's best practice to normalize URLs.

If necessary, individual views may be excluded from the APPEND_SLASH behavior using the no_append_slash() decorator:
```
from django.views.decorators.common import no_append_slash


@no_append_slash
def sensitive_fbv(request, *args, **kwargs):
    """View to be excluded from APPEND_SLASH."""
    return HttpResponse()
```
Setel kepala Content-Length untuk tanggapan bukan-aliran.

class BrokenLinkEmailsMiddleware[sumber]¶

Mengirim surel pemberitahuan tautan rusak pada MANAGERS (see Bagaimana mengelola pelaporan kesalahan).

Middleware GZip¶

class GZipMiddleware[sumber]¶

max_random_bytes¶: Defaults to 100. Subclass GZipMiddleware and override the attribute to change the maximum number of random bytes that is included with compressed responses.

Catatan

Security researchers revealed that when compression techniques (including GZipMiddleware) are used on a website, the site may become exposed to a number of possible attacks.

To mitigate attacks, Django implements a technique called Heal The Breach (HTB). It adds up to 100 bytes (see max_random_bytes) of random bytes to each response to make the attacks less effective.

For more details, see the BREACH paper (PDF), breachattack.com, and the Heal The Breach (HTB) paper.

The django.middleware.gzip.GZipMiddleware compresses content for browsers that understand GZip compression (all modern browsers).

Middleware ini harus ditempatkan sebelum middleware lain apapun yang butuh membaca atau menulis tanggapan badan sehingga pemampatan terjadi kemudian.

Itu TIDAK akan memampatkan isi jika apapun dari berikut adalah true:

Isi badan kurang dari panjang 200 byte.
Tanggapan telah menyetel kepala Content-Encoding.
Permintaan (peramban) belum mengirim sebuah kepala Accept-Encoding mengandung gzip.

If the response has an ETag header, the ETag is made weak to comply with RFC 9110 Section 8.8.1.

You can apply GZip compression to individual views using the gzip_page() decorator.

Middleware GET bersyarat¶

class ConditionalGetMiddleware[sumber]¶

Menangani tindakan GET bersyarat. Jika tanggapan tidak memiliki sebuah kepala ETag, middleware menambahkan satu jika dibutuhkan. Jika tanggapan mempunyai sebuah kepala ETag atau Last-Modified, dan permintaan memiliki If-None-Match atau If-Modified-Since, tanggapan diganti oleh sebuah HttpResponseNotModified.

You can handle conditional GET operations with individual views using the conditional_page() decorator.

Middleware lokal¶

class LocaleMiddleware[sumber]¶

response_redirect_class¶: Awalan pada HttpResponseRedirect. Sub kelas LocaleMiddleware dan menimpa atribut untuk menyesuaikan pengalihan diterbitkan oleh middleware.

Enables language selection based on data from the request. It customizes content for each user. See the internationalization documentation.

Middleware pesan¶

class MessageMiddleware[sumber]¶

Enables cookie- and session-based message support. See the messages documentation.

Middleware keamanan¶

Peringatan

If your deployment situation allows, it's usually a good idea to have your front-end web server perform the functionality provided by the SecurityMiddleware. That way, if there are requests that aren't served by Django (such as static media or user-uploaded files), they will have the same protections as requests to your Django application.

class SecurityMiddleware[sumber]¶

django.middleware.security.SecurityMiddleware menyediakan beberapa peningkatan keamanan pada siklus permintaan/tanggapan. Setiap satu dapat berdiri sendiri mengadakan atau mentiadakan dengan sebuah pengaturan.

HTTP Strict Transport Security¶

For sites that should only be accessed over HTTPS, you can instruct modern browsers to refuse to connect to your domain name via an insecure connection (for a given period of time) by setting the "Strict-Transport-Security" header. This reduces your exposure to some SSL-stripping man-in-the-middle (MITM) attacks.

SecurityMiddleware akan menyetel kepala ini untuk anda pada semua tanggapan HTTPS jika anda mensetel pengaturan SECURE_HSTS_SECONDS pada nilai integer bukan-nol.

When enabling HSTS, it's a good idea to first use a small value for testing, for example, SECURE_HSTS_SECONDS = 3600 for one hour. Each time a web browser sees the HSTS header from your site, it will refuse to communicate non-securely (using HTTP) with your domain for the given period of time. Once you confirm that all assets are served securely on your site (i.e. HSTS didn't break anything), it's a good idea to increase this value so that infrequent visitors will be protected (31536000 seconds, i.e. 1 year, is common).

Additionally, if you set the SECURE_HSTS_INCLUDE_SUBDOMAINS setting to True, SecurityMiddleware will add the includeSubDomains directive to the Strict-Transport-Security header. This is recommended (assuming all subdomains are served exclusively using HTTPS), otherwise your site may still be vulnerable via an insecure connection to a subdomain.

Jika anda berharap mengajukan situs anda ke browser preload list, setel pengaturan SECURE_HSTS_PRELOAD menjadi True. Itu menambahkan preload menunjuk ke kepala Strict-Transport-Security.

Peringatan

The HSTS policy applies to your entire domain, not just the URL of the response that you set the header on. Therefore, you should only use it if your entire domain is served via HTTPS only.

Browsers properly respecting the HSTS header will refuse to allow users to bypass warnings and connect to a site with an expired, self-signed, or otherwise invalid SSL certificate. If you use HSTS, make sure your certificates are in good shape and stay that way!

Catatan

If you are deployed behind a load-balancer or reverse-proxy server, and the Strict-Transport-Security header is not being added to your responses, it may be because Django doesn't realize that it's on a secure connection; you may need to set the SECURE_PROXY_SSL_HEADER setting.

Referrer Policy¶

Browsers use the Referer header as a way to send information to a site about how users got there. When a user clicks a link, the browser will send the full URL of the linking page as the referrer. While this can be useful for some purposes -- like figuring out who's linking to your site -- it also can cause privacy concerns by informing one site that a user was visiting another site.

Some browsers have the ability to accept hints about whether they should send the HTTP Referer header when a user clicks a link; this hint is provided via the Referrer-Policy header. This header can suggest any of three behaviors to browsers:

Full URL: send the entire URL in the Referer header. For example, if the user is visiting https://example.com/page.html, the Referer header would contain "https://example.com/page.html".
Origin only: send only the "origin" in the referrer. The origin consists of the scheme, host and (optionally) port number. For example, if the user is visiting https://example.com/page.html, the origin would be https://example.com/.
No referrer: do not send a Referer header at all.

There are two types of conditions this header can tell a browser to watch out for:

Same-origin versus cross-origin: a link from https://example.com/1.html to https://example.com/2.html is same-origin. A link from https://example.com/page.html to https://not.example.com/page.html is cross-origin.
Protocol downgrade: a downgrade occurs if the page containing the link is served via HTTPS, but the page being linked to is not served via HTTPS.

Peringatan

When your site is served via HTTPS, Django's CSRF protection system requires the Referer header to be present, so completely disabling the Referer header will interfere with CSRF protection. To gain most of the benefits of disabling Referer headers while also keeping CSRF protection, consider enabling only same-origin referrers.

SecurityMiddleware can set the Referrer-Policy header for you, based on the SECURE_REFERRER_POLICY setting (note spelling: browsers send a Referer header when a user clicks a link, but the header instructing a browser whether to do so is spelled Referrer-Policy). The valid values for this setting are:

no-referrer: Instructs the browser to send no referrer for links clicked on this site.
no-referrer-when-downgrade: Instructs the browser to send a full URL as the referrer, but only when no protocol downgrade occurs.
origin: Instructs the browser to send only the origin, not the full URL, as the referrer.
origin-when-cross-origin: Instructs the browser to send the full URL as the referrer for same-origin links, and only the origin for cross-origin links.

same-origin Instructs the browser to send a full URL, but only for same-origin links. No referrer will be sent for cross-origin links.

strict-origin Instructs the browser to send only the origin, not the full URL, and to send no referrer when a protocol downgrade occurs.

strict-origin-when-cross-origin: Instructs the browser to send the full URL when the link is same-origin and no protocol downgrade occurs; send only the origin when the link is cross-origin and no protocol downgrade occurs; and no referrer when a protocol downgrade occurs.
unsafe-url: Instructs the browser to always send the full URL as the referrer.

Unknown Policy Values

Where a policy value is unknown by a user agent, it is possible to specify multiple policy values to provide a fallback. The last specified value that is understood takes precedence. To support this, an iterable or comma-separated string can be used with SECURE_REFERRER_POLICY.

Cross-Origin Opener Policy¶

Some browsers have the ability to isolate top-level windows from other documents by putting them in a separate browsing context group based on the value of the Cross-Origin Opener Policy (COOP) header. If a document that is isolated in this way opens a cross-origin popup window, the popup’s window.opener property will be null. Isolating windows using COOP is a defense-in-depth protection against cross-origin attacks, especially those like Spectre which allowed exfiltration of data loaded into a shared browsing context.

SecurityMiddleware can set the Cross-Origin-Opener-Policy header for you, based on the SECURE_CROSS_ORIGIN_OPENER_POLICY setting. The valid values for this setting are:

same-origin: Isolates the browsing context exclusively to same-origin documents. Cross-origin documents are not loaded in the same browsing context. This is the default and most secure option.
same-origin-allow-popups: Isolates the browsing context to same-origin documents or those which either don't set COOP or which opt out of isolation by setting a COOP of unsafe-none.
unsafe-none: Allows the document to be added to its opener's browsing context group unless the opener itself has a COOP of same-origin or same-origin-allow-popups.

`X-Content-Type-Options: nosniff`¶

Some browsers will try to guess the content types of the assets that they fetch, overriding the Content-Type header. While this can help display sites with improperly configured servers, it can also pose a security risk.

If your site serves user-uploaded files, a malicious user could upload a specially-crafted file that would be interpreted as HTML or JavaScript by the browser when you expected it to be something harmless.

To prevent the browser from guessing the content type and force it to always use the type provided in the Content-Type header, you can pass the X-Content-Type-Options: nosniff header. SecurityMiddleware will do this for all responses if the SECURE_CONTENT_TYPE_NOSNIFF setting is True.

Note that in most deployment situations where Django isn't involved in serving user-uploaded files, this setting won't help you. For example, if your MEDIA_URL is served directly by your front-end web server (nginx, Apache, etc.) then you'd want to set this header there. On the other hand, if you are using Django to do something like require authorization in order to download files and you cannot set the header using your web server, this setting will be useful.

Pengalihan SSL¶

If your site offers both HTTP and HTTPS connections, most users will end up with an unsecured connection by default. For best security, you should redirect all HTTP connections to HTTPS.

If you set the SECURE_SSL_REDIRECT setting to True, SecurityMiddleware will permanently (HTTP 301) redirect all HTTP connections to HTTPS.

Catatan

For performance reasons, it's preferable to do these redirects outside of Django, in a front-end load balancer or reverse-proxy server such as nginx. SECURE_SSL_REDIRECT is intended for the deployment situations where this isn't an option.

If the SECURE_SSL_HOST setting has a value, all redirects will be sent to that host instead of the originally-requested host.

If there are a few pages on your site that should be available over HTTP, and not redirected to HTTPS, you can list regular expressions to match those URLs in the SECURE_REDIRECT_EXEMPT setting.

Catatan

If you are deployed behind a load-balancer or reverse-proxy server and Django can't seem to tell when a request actually is already secure, you may need to set the SECURE_PROXY_SSL_HEADER setting.

Middleware sesi¶

class SessionMiddleware[sumber]¶

Mengadakan dukungan sesi. Lihat session documentation.

Situs middleware¶

class CurrentSiteMiddleware[sumber]¶

Adds the site attribute representing the current site to every incoming HttpRequest object. See the sites documentation.

Middleware otentifikasi¶

class AuthenticationMiddleware[sumber]¶

Adds the user attribute, representing the currently-logged-in user, to every incoming HttpRequest object. See Authentication in web requests.

class LoginRequiredMiddleware[sumber]¶

Subclass the middleware and override the following attributes and methods to customize behavior for unauthenticated requests.

redirect_field_name¶: Defaults to "next".

get_login_url()[sumber]¶: Returns the URL that unauthenticated requests will be redirected to. This result is either the login_url set on the login_required() decorator (if not None), or settings.LOGIN_URL.

get_redirect_field_name()[sumber]¶: Returns the name of the query parameter that contains the URL the user should be redirected to after a successful login. This result is either the redirect_field_name set on the login_required() decorator (if not None), or redirect_field_name. If None is returned, a query parameter won't be added.

Redirects all unauthenticated requests to a login page, except for views excluded with login_not_required(). The login page defaults to settings.LOGIN_URL, but can be customized.

Enable this middleware by adding it to the MIDDLEWARE setting after AuthenticationMiddleware:

MIDDLEWARE = [
    "...",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.auth.middleware.LoginRequiredMiddleware",
    "...",
]

Make a view public, allowing unauthenticated requests, with login_not_required(). For example:

from django.contrib.auth.decorators import login_not_required


@login_not_required
def contact_us(request): ...

Customize the login URL or field name for authenticated views with the login_required() decorator to set login_url or redirect_field_name respectively. For example:

from django.contrib.auth.decorators import login_required
from django.utils.decorators import method_decorator
from django.views.generic import View


@login_required(login_url="/books/login/", redirect_field_name="redirect_to")
def book_dashboard(request): ...


@method_decorator(
    login_required(login_url="/books/login/", redirect_field_name="redirect_to"),
    name="dispatch",
)
class BookMetrics(View):
    pass

Ensure that your login view does not require a login.

To prevent infinite redirects, ensure you have enabled unauthenticated requests to your login view.

class RemoteUserMiddleware[sumber]¶

Middleware for utilizing web server provided authentication. See Bagaimana mengotentikasi menggunakan REMOTE_USER for usage details.

class PersistentRemoteUserMiddleware[sumber]¶

Middleware for utilizing web server provided authentication when enabled only on the login page. See Menggunakan REMOTE_USER hanya pada halaman masuk for usage details.

Middleware perlindungan CSRF¶

class CsrfViewMiddleware[sumber]¶

Adds protection against Cross Site Request Forgeries by adding hidden form fields to POST forms and checking requests for the correct value. See the Cross Site Request Forgery protection documentation.

You can add Cross Site Request Forgery protection to individual views using the csrf_protect() decorator.

Middleware `X-Frame-Options`¶

class XFrameOptionsMiddleware[sumber]¶

Simple clickjacking protection via the X-Frame-Options header.

Content Security Policy middleware¶

class ContentSecurityPolicyMiddleware[sumber]¶

New in Django 6.0.

Adds support for Content Security Policy (CSP), which helps mitigate risks such as Cross-Site Scripting (XSS) and data injection attacks by controlling the sources of content that can be loaded in the browser. See the Ikhtisar documentation for details on configuring policies.

This middleware sets the following headers on the response depending on the available settings:

Content-Security-Policy, based on SECURE_CSP.
Content-Security-Policy-Report-Only, based on SECURE_CSP_REPORT_ONLY.

Pengurutan middleware¶

Disini adalah beberapa petunjuk tentang pengurutan beragam kelas-kelas middleware Django:

SecurityMiddleware

It should go near the top of the list if you're going to turn on the SSL redirect as that avoids running through a bunch of other unnecessary middleware.
UpdateCacheMiddleware

Sebelum itu yang merubah kepala Vary (SessionMiddleware, GZipMiddleware, LocaleMiddleware).
GZipMiddleware

Sebelum middleware apapun yang mungkin merubah atau menggunakan tanggapan badan.

Setelah UpdateCacheMiddleware: Rubah kepala Vary.
SessionMiddleware

Before any middleware that may raise an exception to trigger an error view (such as PermissionDenied) if you're using CSRF_USE_SESSIONS.

Setelah UpdateCacheMiddleware: Rubah kepala Vary.
ConditionalGetMiddleware

Sebelum middleware apapun yang mungkin merubah tanggapan (itu menyetel kepala ETag).

Setelah GZipMiddleware jadi itu tidak akan menghitung sebuah kepala ETag pada isi ter-gzip.
LocaleMiddleware

Salah satu yang paling atas, setelah SessionMiddleware (menggunakan data sesi) dan UpdateCacheMiddleware (merubah kepala Vary).
CommonMiddleware

Sebelum middleware apapun yang mungkin merubah tanggapan (itu menyetel kepala Content-Length). Sebuah middleware yang muncul sebelum CommonMiddleware dan merubah tanggapan harus menyetel kembali Content-Length.

Tutup ke atas: Itu akan mengalihkan ketika APPEND_SLASH atau PREPEND_WWW menjadi True.

After SessionMiddleware if you're using CSRF_USE_SESSIONS.
CsrfViewMiddleware

Sebelum tampilan middleware apapunyang menganggap bahwa serangan CSRF telah ditangani.

Before RemoteUserMiddleware, or any other authentication middleware that may perform a login, and hence rotate the CSRF token, before calling down the middleware chain.

After SessionMiddleware if you're using CSRF_USE_SESSIONS.
AuthenticationMiddleware

Setelah SessionMiddleware: gunakan penyimpanan sesi.
LoginRequiredMiddleware

After AuthenticationMiddleware: uses user object.
MessageMiddleware

Setelah SessionMiddleware: dapat menggunakan penyimpanan berdasar-sesi.
FetchFromCacheMiddleware

Setelah middleware apapun yang merubah kepala vary: kepala itu digunakan untuk mengambil nilai untuk kunci-campuran cache.
ContentSecurityPolicyMiddleware

Can be placed near the bottom, but ensure any middleware that accesses csp_nonce is positioned after it, so the nonce is properly included in the response header.
FlatpageFallbackMiddleware

Should be near the bottom as it's a last-resort type of middleware.
RedirectFallbackMiddleware

Should be near the bottom as it's a last-resort type of middleware.

Middleware¶

Middleware tersedia¶

Middleware tembolok¶

Middleware "Umum"¶

Middleware GZip¶

Middleware GET bersyarat¶

Middleware lokal¶

Middleware pesan¶

Middleware keamanan¶

HTTP Strict Transport Security¶

Referrer Policy¶

Cross-Origin Opener Policy¶

`X-Content-Type-Options: nosniff`¶

Pengalihan SSL¶

Middleware sesi¶

Situs middleware¶

Middleware otentifikasi¶

Middleware perlindungan CSRF¶

Middleware `X-Frame-Options`¶

Content Security Policy middleware¶

Pengurutan middleware¶

Informasi Tambahan

Support Django!

Isi

Mendapatkan bantuan

Unduh:

Diamond and Platinum Members

Middleware¶

Middleware tersedia¶

Middleware tembolok¶

Middleware "Umum"¶

Middleware GZip¶

Middleware GET bersyarat¶

Middleware lokal¶

Middleware pesan¶

Middleware keamanan¶

HTTP Strict Transport Security¶

Referrer Policy¶

Cross-Origin Opener Policy¶

X-Content-Type-Options: nosniff¶

Pengalihan SSL¶

Middleware sesi¶

Situs middleware¶

Middleware otentifikasi¶

Middleware perlindungan CSRF¶

Middleware X-Frame-Options¶

Content Security Policy middleware¶

Pengurutan middleware¶

Informasi Tambahan

Support Django!

Isi

Mendapatkan bantuan

Unduh:

Diamond and Platinum Members

`X-Content-Type-Options: nosniff`¶

Middleware `X-Frame-Options`¶