Промежуточный слой (Middleware)

Этот раздел описывает промежуточные слои, которые предоставляет Django. Как использовать и создавать свои промежуточные слои, смотрите соответствующий раздел.

Доступные промежуточные слои

Кэширующий промежуточный слой

class UpdateCacheMiddleware
class FetchFromCacheMiddleware

Активирует кэширование для всего сайта. При этом все страницы, которые генерируются Django, будут закэшированы на время, указанное в настройке CACHE_MIDDLEWARE_SECONDS. Смотрите раздел о кэшировании.

«Common» промежуточный слой

class CommonMiddleware

Добавляет несколько полезностей для перфекционистов:

  • Ограничивает доступ для клиентов, которые указанны в настройке DISALLOWED_USER_AGENTS. Настройка должна содержать список скомпилированных регулярных выражений.

  • Меняет URL в соответствии с настройками APPEND_SLASH и PREPEND_WWW.

    Если APPEND_SLASH равна True и вызванный URL не оканчивается на слеш, и он не найден в URLconf, создается новый URL путем добавления слеша в конец. Если новый URL найден в URLconf, Django отправляет перенаправление на этот URL. Иначе начальный URL обрабатывается как обычно.

    Например, foo.com/bar будет перенаправлен на foo.com/bar/, если нет URL-шаблона для foo.com/bar, но есть для foo.com/bar/.

    Если PREPEND_WWW равна True, URL-ы без «www.» будут перенаправлены на URL с добавлением «www.»

    Обе эти настройки предназначены для нормализации URL-ов. Философия такая – URL должен быть уникальным и единым. Технически URL foo.com/bar отличается от foo.com/bar/ – поисковик проиндексирует их как отдельные URL-ы – поэтому хорошей практикой является нормализация URL-ов.

  • Sets the Content-Length header for non-streaming responses.

CommonMiddleware.response_redirect_class

По умолчанию HttpResponsePermanentRedirect. Можете создать класс наследник CommonMiddleware и переопределить класс ответа, который используется для перенаправления.

class BrokenLinkEmailsMiddleware

GZip промежуточный слой

class GZipMiddleware

Предупреждение

Security researchers recently revealed that when compression techniques (including GZipMiddleware) are used on a website, the site may become exposed to a number of possible attacks. Before using GZipMiddleware on your site, you should consider very carefully whether you are subject to these attacks. If you’re in any doubt about whether you’re affected, you should avoid using GZipMiddleware. For more details, see the the BREACH paper (PDF) and breachattack.com.

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

Этот промежуточный слой должен находится перед любым другим промежуточный слоем, который читает или пишет содержимое ответа, чтобы сжатие происходило в самом конце.

Содержимое ответа НЕ будет сжато при следующих условиях:

  • Содержимое ответа меньше 200 байтов.
  • Ответ уже содержит заголовок Content-Encoding.
  • Браузер не отослал в запросе заголовок Accept-Encoding, который содержит gzip.

If the response has an ETag header, the ETag is made weak to comply with RFC 7232#section-2.1.

Вы можете добавить GZip сжатие для определенных представлений, используя декоратор gzip_page().

Промежуточный слой для обработки условных GET-запросов

class ConditionalGetMiddleware

Handles conditional GET operations. If the response doesn’t have an ETag header, the middleware adds one if needed. If the response has an ETag or Last-Modified header, and the request has If-None-Match or If-Modified-Since, the response is replaced by an HttpResponseNotModified.

Промежуточный слой локализации

class LocaleMiddleware

Выполняет выбор текущего языка на основе данных из запроса. Меняет содержимое для каждого пользователя отдельно. Смотрите раздел об интернационализации.

LocaleMiddleware.response_redirect_class

По умолчанию HttpResponseRedirect. Можете создать класс наследник LocaleMiddleware и переопределить класс ответа, который используется для перенаправления.

Промежуточный слой сообщений

class MessageMiddleware

Добавляет поддержку сообщений на основе кук или сессии. Смотрите раздел о сообщениях.

Промежуточный слой безопасности

Предупреждение

Лучший вариант – чтобы фронтенд веб-сервер выполнял действия, которые выполняет SecurityMiddleware. В таком случае все запросы, даже те, которые не обрабатываются Django (запросы к статическим и загруженным файлам), будут защищены как и запросы к приложению Django.

class SecurityMiddleware

django.middleware.security.SecurityMiddleware предоставляет ряд проверок безопасности при обработке запроса/ответа. Каждая из них может быть выключена/включена насройкой.

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 будет устанавливать этот заголовок для всех HTTPS ответов, если вы укажите в настройке SECURE_HSTS_SECONDS не нулевое значение.

При включении HSTS для начала лучше протестировать с небольшим значение, например, SECURE_HSTS_SECONDS = 3600. Каждый раз, когда браузер видит заголовок HSTS в ответе вашего сайта, он отказывается подключаться по небезопасному подключению (используя HTTP) к вашему домену в течении указанного времени. После проверки, что все статические файлы работают через HTTPS (то есть HSTS ничего не ломает), можно увеличить это значение, чтобы нечастые пользователи были защищены (обычно используют 31536000 секунд, то есть 1 год).

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.

If you wish to submit your site to the browser preload list, set the SECURE_HSTS_PRELOAD setting to True. That appends the preload directive to the Strict-Transport-Security header.

Предупреждение

HSTS применяется ко всему домену, а не только URL, который вернул ответ с заголовком. Поэтому вам следует использовать его только, если весь домен доступен через HTTPS.

Браузеры, которые поддерживают заголовки HSTS, не позволят пользователям игнорировать предупреждение и подключиться к сайту с устаревшим, самостоятельно подписанным, или неправильным SSL сертификатом. Если вы используете HSTS, убедитесь, что с вашими сертификатами все впорядке!

Примечание

Если ваш сервер находится за балансировщиком нагрузки, или прокси, и заголовок Strict-Transport-Security не добавляется к ответам, это может быть вызвано тем, что Django не определяет, что используется защищенное подключение. Возможно вам следует указать настройку SECURE_PROXY_SSL_HEADER.

Referrer Policy

New in Django 3.0.

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.

Предупреждение

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

X-Content-Type-Options: nosniff

Некоторые браузеры пытаются угадать тип содержимого(content type) полученных файлов, подменяя заголовок Content-Type. В то время, как такой подход помогает правильно отображать сайты с неправильно настроенных серверов, он может быть и уязвимостью.

Если ваш сайт позволяет пользователям загружать файлы, взломщик может загрузить специальный файл, который будет интерпретирован браузером как HTML или Javascript.

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.

Обратите внимание, что в большинстве случаев, когда Django не раздает файлы с сервера, эта опция вам не поможет. Например, если MEDIA_URL раздается напрямую сервером (nginx, Apache, и прочие), тогда вам следует добавить этот заголовок для него. Если же вы используете Django, чтобы, например, проверить авторизацию перед возвращением файла, эта настройка вам пригодится.

X-XSS-Protection: 1; mode=block

Некоторые браузеры умеют блокировать содержимое, которые может использоваться для XSS атаки. Они ищут Javascript в GET или POST параметрах на странице. Если Javascript возвращается сервером, страница блокируется и показывается пердупреждение.

The X-XSS-Protection header is used to control the operation of the XSS filter.

Чтобы включить XSS фильтр в браузере, и заставить его блокировать потенциальные XSS атаки, вы можете передать заголовок X-XSS-Protection: 1; mode=block. SecurityMiddleware добавит его ко всем ответам, если настройка SECURE_BROWSER_XSS_FILTER равна True.

Предупреждение

Фильтр XSS полезен, но вы не должны полностью полагаться на него. Браузер определяет не все XSS атаки и не все браузеры поддерживают этот фильтр. Вы все еще должны проверять весь ввод пользователя, чтобы избежать XSS атак.

SSL редирект

Если ваш сайт доступен по HTTP и HTTPS, большинство пользователей будут заходить по незащищенному подключению по умолчанию. Вам следует перенапралять их с HTTP на HTTPS.

Если установить True в SECURE_SSL_REDIRECT, SecurityMiddleware будет перманентно (HTTP 301) перенаправлять все HTTP запросы на HTTPS.

Примечание

Для повышения производительности лучше делать эти перенаправления не в Django, а на балансере нагрузки или прокси, таком как nginx. SECURE_SSL_REDIRECT следует использовать для разработки, чтобы не усложнять локальное окружение.

Если указать значение в настройке SECURE_SSL_HOST, все перенаправления будут выполняться на указанный хост, а не хост из запроса.

Если на сайте есть страницы, которые должны быть доступны по HTTP без перенаправления на HTTPS, вы можете указать в настройке SECURE_REDIRECT_EXEMPT регулярные выражение, которым удовлетворяют необходимые URL-ы.

Примечание

Если ваш сервер находится за балансировщиком нагрузки или прокси, Django может не определяет, что используется защищенное подключение. Возможно вам следует указать настройку SECURE_PROXY_SSL_HEADER.

Промежуточный слой сессии

class SessionMiddleware

Включает поддержку сессии. Смотрите раздел о сессии.

Промежуточный слой определения текущего сайта

class CurrentSiteMiddleware

Добавляет атрибут site, который указывает текущий сайт для каждого объекта HttpRequest. Смотрите раздел о поддержке нескольких сайтов.

Промежуточный слой авторизации

class AuthenticationMiddleware

Добавляет атрибут user, который указывает текущего авторизованного пользователя, для каждого объекта HttpRequest. Смотрите раздел об авторизации.

class RemoteUserMiddleware

Промежуточный слой для внешней авторизации. Смотрите Аутентификация при помощи REMOTE_USER.

class PersistentRemoteUserMiddleware

Промежуточный слой для внешней авторизации, которая используется только для страниц входа для оптимизации работы приложения. Смотрите Использование REMOTE_USER только на странице авторизации.

Промежуточный слой для CSRF защиты

class CsrfViewMiddleware

Включает CSRF защиту, добавляя скрытое поле в POST формы и проверяя значение при запросе. Смотрите раздел о Cross Site Request Forgery защите.

X-Frame-Options middleware

class XFrameOptionsMiddleware

Добавляет простую защиту от «clickjacking», используя заголовок X-Frame-Options.

Порядок промежуточных слоёв

Несколько советов о порядке промежуточных слоёв Django:

  1. SecurityMiddleware

    Должен следовать в начале списка промежуточных слоев, если вы используете SSL перенаправление, чтобы избежать обработки небезопасного запроса другими промежуточными слоями.

  2. UpdateCacheMiddleware

    Добавлять перед промежуточными слоями, которые могут изменить заголовок Vary (SessionMiddleware, GZipMiddleware, LocaleMiddleware).

  3. GZipMiddleware

    Добавлять перед промежуточными слоями, которые могут изменять или читать тело ответа.

    После UpdateCacheMiddleware: изменяет заголовок Vary.

  4. SessionMiddleware

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

    После UpdateCacheMiddleware: изменяет заголовок Vary.

  5. ConditionalGetMiddleware

    Before any middleware that may change the response (it sets the ETag header).

    После GZipMiddleware, чтобы заголовок ETag не вычислялся для сжатого ответа.

  6. LocaleMiddleware

    Следует одним из первых, после SessionMiddleware (использует сессию) и CacheMiddleware (изменяет заголовок Vary).

  7. CommonMiddleware

    Before any middleware that may change the response (it sets the Content-Length header). A middleware that appears before CommonMiddleware and changes the response must reset Content-Length.

    Ближе к верху: выполняет перенаправление при APPEND_SLASH или PREPEND_WWW равном True.

    After SessionMiddleware if you’re using CSRF_USE_SESSIONS.

  8. CsrfViewMiddleware

    Перед любым промежуточным слоем, который предполагает, что CSRF защита уже выполнена.

    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.

  9. AuthenticationMiddleware

    После SessionMiddleware: использует сессию.

  10. MessageMiddleware

    После SessionMiddleware: может использовать сессию для хранения данных.

  11. FetchFromCacheMiddleware

    После любого промежуточного слоя, который может изменить заголовок Vary: его значение используется для генерации ключа в кеше.

  12. FlatpageFallbackMiddleware

    Должен быть в низу.

  13. RedirectFallbackMiddleware

    Должен быть в низу.