This document explains all middleware components that come with Django. For\ninformation on how to use them and how to write your own middleware, see\nthe middleware usage guide.
\nサイト全体でキャッシュを有効にします。有効にすると、Django を利用している各ページは CACHE_MIDDLEWARE_SECONDS 設定で指定した時間だけキャッシュされます。詳しくは the cache documentation を読んでください。
完璧主義者のためにいくつかの便利な機能を提供します。
\nDISALLOWED_USER_AGENTS 設定に含まれるユーザーエージェントのアクセスを禁止します。この設定は、コンパイルした正規表現オブジェクトのリストである必要があります。
APPEND_SLASH および PREPEND_WWW 設定に基づいて、URL の書き換えを実行します。
APPEND_SLASH が True で、与えられた URL がスラッシュで終わっていなくて、さらに URLconf に URL が見つからなければ、Django は / が最後に追加された新しい URL を作り、この新しい URL へリクエストをリダイレクトします。それ以外のときには、最初の URL を通常通りに処理します。
たとえば、 foo.com/bar は、 foo.com/bar に対する有効な URL パタンがなく、foo.com/bar/ に対しては有効なパタンが 存在する 場合に、 foo.com/bar/ にリダイレクトされます。
PREPEND_WWW を True にすると、先頭に "www." がない URL は "www." で始まる同じ URL にリダイレクトされます。
2つのオプションが意味するのは、URL を正規化するということです。これは、1つの URL には1つの、かつただ1つだけの場所を指すべきだという考えです。技術的には URL foo.com/bar は foo.com/bar/ とは区別されます。実際、サーチエンジンのインデクスはこれらを区別して作成されます。よって、URL を正規化するというのがベストプラクティスなのです。
If necessary, individual views may be excluded from the APPEND_SLASH\nbehavior using the no_append_slash()\ndecorator:
from django.views.decorators.common import no_append_slash\n\n@no_append_slash\ndef sensitive_fbv(request, *args, **kwargs):\n """View to be excluded from APPEND_SLASH."""\n return HttpResponse()\nSets the Content-Length header for non-streaming responses.
Defaults to HttpResponsePermanentRedirect. Subclass\nCommonMiddleware and override the attribute to customize the redirects\nissued by the middleware.
The django.middleware.gzip.GZipMiddleware compresses content for browsers\nthat understand GZip compression (all modern browsers).
This middleware should be placed before any other middleware that need to\nread or write the response body so that compression happens afterward.
\nIt will NOT compress content if any of the following are true:
\nThe content body is less than 200 bytes long.
The response has already set the Content-Encoding header.
The request (the browser) hasn't sent an Accept-Encoding header\ncontaining gzip.
If the response has an ETag header, the ETag is made weak to comply with\nRFC 7232 Section 2.1.
You can apply GZip compression to individual views using the\ngzip_page() decorator.
Handles conditional GET operations. If the response doesn't have an ETag\nheader, the middleware adds one if needed. If the response has an ETag or\nLast-Modified header, and the request has If-None-Match or\nIf-Modified-Since, the response is replaced by an\nHttpResponseNotModified.
リクエストからのデータに基づいた言語セクションを有効化します。この機能は、それぞれのユーザに対してコンテンツをカスタマイズします。 国際化のドキュメント を参照してください。
\nデフォルトは HttpResponseRedirect です。LocaleMiddleware をサブクラス化して属性をオーバーライドし、ミドルウェアによって発行されたリダイレクトをカスタマイズします。
クッキーおよびセッションをベースとしたメッセージサポートを有効化します。メッセージのドキュメント を参照してください。
\nThe django.middleware.security.SecurityMiddleware provides several security\nenhancements to the request/response cycle. Each one can be independently\nenabled or disabled with a setting.
For sites that should only be accessed over HTTPS, you can instruct modern\nbrowsers to refuse to connect to your domain name via an insecure connection\n(for a given period of time) by setting the "Strict-Transport-Security"\nheader. This reduces your exposure to some SSL-stripping man-in-the-middle\n(MITM) attacks.
\nSecurityMiddleware will set this header for you on all HTTPS responses if\nyou set the SECURE_HSTS_SECONDS setting to a non-zero integer value.
When enabling HSTS, it's a good idea to first use a small value for testing,\nfor example, SECURE_HSTS_SECONDS = 3600 for one\nhour. Each time a Web browser sees the HSTS header from your site, it will\nrefuse to communicate non-securely (using HTTP) with your domain for the given\nperiod of time. Once you confirm that all assets are served securely on your\nsite (i.e. HSTS didn't break anything), it's a good idea to increase this value\nso that infrequent visitors will be protected (31536000 seconds, i.e. 1 year,\nis common).
Additionally, if you set the SECURE_HSTS_INCLUDE_SUBDOMAINS setting\nto True, SecurityMiddleware will add the includeSubDomains directive\nto the Strict-Transport-Security header. This is recommended (assuming all\nsubdomains are served exclusively using HTTPS), otherwise your site may still\nbe vulnerable via an insecure connection to a subdomain.
If you wish to submit your site to the browser preload list, set the\nSECURE_HSTS_PRELOAD setting to True. That appends the\npreload directive to the Strict-Transport-Security header.
Browsers use the Referer header as a way to send information to a site\nabout how users got there. When a user clicks a link, the browser will send the\nfull URL of the linking page as the referrer. While this can be useful for some\npurposes -- like figuring out who's linking to your site -- it also can cause\nprivacy concerns by informing one site that a user was visiting another site.
\nSome browsers have the ability to accept hints about whether they should send\nthe HTTP Referer header when a user clicks a link; this hint is provided\nvia the Referrer-Policy header. This header can suggest any of three\nbehaviors to browsers:
Full URL: send the entire URL in the Referer header. For example, if the\nuser is visiting https://example.com/page.html, the Referer header\nwould contain "https://example.com/page.html".
Origin only: send only the "origin" in the referrer. The origin consists of\nthe scheme, host and (optionally) port number. For example, if the user is\nvisiting https://example.com/page.html, the origin would be\nhttps://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\nfor:
\nSame-origin versus cross-origin: a link from https://example.com/1.html\nto https://example.com/2.html is same-origin. A link from\nhttps://example.com/page.html to https://not.example.com/page.html is\ncross-origin.
Protocol downgrade: a downgrade occurs if the page containing the link is\nserved via HTTPS, but the page being linked to is not served via HTTPS.
SecurityMiddleware can set the Referrer-Policy header for you, based on\nthe SECURE_REFERRER_POLICY setting (note spelling: browsers send a\nReferer header when a user clicks a link, but the header instructing a\nbrowser whether to do so is spelled Referrer-Policy). The valid values for\nthis setting are:
no-referrerInstructs the browser to send no referrer for links clicked on this site.
\nno-referrer-when-downgradeInstructs the browser to send a full URL as the referrer, but only when no\nprotocol downgrade occurs.
\noriginInstructs the browser to send only the origin, not the full URL, as the\nreferrer.
\norigin-when-cross-originInstructs the browser to send the full URL as the referrer for same-origin\nlinks, and only the origin for cross-origin links.
\nsame-originInstructs the browser to send a full URL, but only for same-origin links. No\nreferrer will be sent for cross-origin links.
\nstrict-originInstructs the browser to send only the origin, not the full URL, and to send\nno referrer when a protocol downgrade occurs.
\nstrict-origin-when-cross-originInstructs the browser to send the full URL when the link is same-origin and\nno protocol downgrade occurs; send only the origin when the link is\ncross-origin and no protocol downgrade occurs; and no referrer when a\nprotocol downgrade occurs.
\nunsafe-urlInstructs the browser to always send the full URL as the referrer.
\nX-Content-Type-Options: nosniffLink to this heading#Some browsers will try to guess the content types of the assets that they\nfetch, overriding the Content-Type header. While this can help display\nsites with improperly configured servers, it can also pose a security\nrisk.
If your site serves user-uploaded files, a malicious user could upload a\nspecially-crafted file that would be interpreted as HTML or JavaScript by\nthe browser when you expected it to be something harmless.
\nTo prevent the browser from guessing the content type and force it to\nalways use the type provided in the Content-Type header, you can pass\nthe X-Content-Type-Options: nosniff header. SecurityMiddleware will\ndo this for all responses if the SECURE_CONTENT_TYPE_NOSNIFF setting\nis True.
Note that in most deployment situations where Django isn't involved in serving\nuser-uploaded files, this setting won't help you. For example, if your\nMEDIA_URL is served directly by your front-end Web server (nginx,\nApache, etc.) then you'd want to set this header there. On the other hand, if\nyou are using Django to do something like require authorization in order to\ndownload files and you cannot set the header using your Web server, this\nsetting will be useful.
X-XSS-Protection: 1; mode=blockLink to this heading#Some browsers have the ability to block content that appears to be an XSS\nattack. They work by looking for JavaScript content in the GET or POST\nparameters of a page. If the JavaScript is replayed in the server's response,\nthe page is blocked from rendering and an error page is shown instead.
\nThe X-XSS-Protection header is used to control the operation of the\nXSS filter.
\nTo enable the XSS filter in the browser, and force it to always block\nsuspected XSS attacks, you can pass the X-XSS-Protection: 1; mode=block\nheader. SecurityMiddleware will do this for all responses if the\nSECURE_BROWSER_XSS_FILTER setting is True.
サイトが HTTP と HTTPS 接続の両方をサポートしている場合、多くのユーザーはデフォルトでセキュアでない接続を行ってしまいます。最善のセキュリティのためには、すべての HTTP 接続を HTTPS 接続にリダイレクトするべきです。
\nSECURE_SSL_REDIRECT 設定を True に設定すれば、 SecurityMiddleware が すべての HTTP 接続を HTTPS に parmanent (HTTP 301) にリダイレクトしてくれます。
If the SECURE_SSL_HOST setting has a value, all redirects will be\nsent 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\nnot redirected to HTTPS, you can list regular expressions to match those URLs\nin the SECURE_REDIRECT_EXEMPT setting.
セッションのサポートを有効にします。詳しくは セッションのドキュメント を読んでください。
\n受信側のすべての HttpRequest オブジェクトに、現在のサイトを表す site 属性を追加します。詳しくは sites documentation を読んでください。
受信側のすべての HttpRequest オブジェクトに、現在のログイン中のユーザを表す user 属性を追加します。詳しくは Authentication in Web requests を読んでください。
Web サーバが提供する認証機能を利用するミドルウェアです。詳しい使い方については REMOTE_USER を使用した認証 を読んでください。
\nログインページでのみ有効になる、Web サーバが提供する認証機能を利用するミドルウェアです。詳しくい使い方については ログインページでのみ REMOTE_USER を使用する を読んでください。
\nPOST フォームに隠しフォームフィールドを追加し、リクエストの値が正しいかチェックすることで、Cross Site Request Forgery に対するプロテクションを追加します。詳しくは Cross Site Request Forgery プロテクションのドキュメント を読んでください。
\nX-Frame-Options middlewareLink to this heading#Django の多様なミドルウェアクラスの順序に関する注意点を挙げておきます。
\nSSL リダイレクトを有効にしているなら、他のたくさんの必要のないミドルウェアが実行されないように、リストの先頭付近に置くべきです。
\nVary ヘッダに変更を加えるミドルウェア (SessionMiddleware, GZipMiddleware, LocaleMiddleware) の前に置きます。
response body を変更・使用する可能性のあるミドルウェアの前に置きます。
\nVary ヘッダを修正するため、 UpdateCacheMiddleware の後に置きます。
Before any middleware that may raise an exception to trigger an error\nview (such as PermissionDenied) if you're\nusing CSRF_USE_SESSIONS.
Vary ヘッダを修正するため、 UpdateCacheMiddleware の後に置きます。
Before any middleware that may change the response (it sets the ETag\nheader).
gzip されたコンテンツに対して ETag ヘッダを計算しないように、 GZipMiddleware の後に置きます。
SessionMiddleware (session データを使う) と UpdateCacheMiddleware (Vary ヘッダを修正する) の後のできるだけ高い位置に置きます。
Before any middleware that may change the response (it sets the\nContent-Length header). A middleware that appears before\nCommonMiddleware and changes the response must reset Content-Length.
APPEND_SLASH か PREPEND_WWW が True に設定されているとリダイレクトされるので、先頭の近くに置きます。
After SessionMiddleware if you're using CSRF_USE_SESSIONS.
CSRF 攻撃が可能なすべての view ミドルウェアの前に置きます。
\nBefore RemoteUserMiddleware, or any\nother authentication middleware that may perform a login, and hence rotate\nthe CSRF token, before calling down the middleware chain.
After SessionMiddleware if you're using CSRF_USE_SESSIONS.
session ストレージを使うので、 SessionMiddleware の後に置きます。
After SessionMiddleware: can use session-based storage.
キャッシュのハッシュキーを生成するのに Vary ヘッダを使用するため、このヘッダを修正するすべてのミドルウェアのあとに置きます。
最後に実行されるタイプのミドルウェアなので、できるだけ下に置く必要があります。
\n最後に実行されるタイプのミドルウェアなので、できるだけ下に置く必要があります。
\n