-
-| Middleware
- | Description
- | Configuration
- |
-| ClearSiteDataMiddleware
- | Send Clear-Site-Data header in HTTP response for any page that has been whitelisted. Recommended.
- | Required.
-
- |
-| ContentNoSniff
- | DEPRECATED: Will be removed in future releases, consider django.middleware.security.SecurityMiddleware via SECURE_CONTENT_TYPE_NOSNIFF setting.
Disable possibly insecure autodetection of MIME types in browsers. Recommended.
- | None.
-
- |
-| ContentSecurityPolicyMiddleware
- | Send Content Security Policy (CSP) header in HTTP response. Recommended, requires careful tuning.
- | Required.
-
- |
-| DoNotTrackMiddleware
- | Read user browser's DoNotTrack preference and pass it to application. Recommended, requires implementation in views and templates.
- | None.
-
- |
-| LoginRequiredMiddleware
- | Requires a user to be authenticated to view any page on the site that hasn't been white listed.
- | Required.
+ | Middleware |
+Description |
+Configuration |
+
-| MandatoryPasswordChangeMiddleware
- | Redirects any request from an authenticated user to the password change form if that user's password has expired.
- | Required.
+ | ClearSiteDataMiddleware |
+Send Clear-Site-Data header in HTTP response for any page that has been whitelisted. Recommended. |
+Required. |
+
-| NoConfidentialCachingMiddleware
- | Adds No-Cache and No-Store headers to confidential pages.
- | Required.
+ | ContentSecurityPolicyMiddleware |
+Send Content Security Policy (CSP) header in HTTP response. Recommended, requires careful tuning. |
+Required. |
+
-| P3PPolicyMiddleware
- | DEPRECATED: Will be removed in future releases.
Adds the HTTP header attribute specifying compact P3P policy.
- | Required.
+ | LoginRequiredMiddleware |
+Requires a user to be authenticated to view any page on the site that hasn't been white listed. |
+Required. |
+
-| ReferrerPolicyMiddleware
- | Specify when the browser will set a `Referer` header.
- | Optional.
+ | MandatoryPasswordChangeMiddleware |
+Redirects any request from an authenticated user to the password change form if that user's password has expired. |
+Required. |
+
-| SessionExpiryPolicyMiddleware
- | Expire sessions on browser close, and on expiry times stored in the cookie itself.
- | Required.
+ | NoConfidentialCachingMiddleware |
+Adds No-Cache and No-Store headers to confidential pages. |
+Required. |
+
-| StrictTransportSecurityMiddleware
- | DEPRECATED: Will be removed in future releases, consider django.middleware.security.SecurityMiddleware via SECURE_HSTS_SECONDS, SECURE_HSTS_INCLUDE_SUBDOMAINS and SECURE_HSTS_PRELOAD settings.
Enforce SSL/TLS connection and disable plaintext fall-back. Recommended for SSL/TLS sites.
- | Optional.
+ | ReferrerPolicyMiddleware |
+Specify when the browser will set a `Referer` header. |
+Optional. |
+
-| XFrameOptionsMiddleware
- | Disable framing of the website, mitigating Clickjacking attacks. Recommended.
- | Optional.
+ | SessionExpiryPolicyMiddleware |
+Expire sessions on browser close, and on expiry times stored in the cookie itself. |
+Required. |
+
-| XssProtectMiddleware
- | DEPRECATED: Will be removed in future releases, consider django.middleware.security.SecurityMiddleware via SECURE_BROWSER_XSS_FILTER setting.
Enforce browser's Cross Site Scripting protection. Recommended.
- | None.
+ | ProfilingMiddleware |
+A simple middleware to capture useful profiling information in Django. |
+Optional. |
+
diff --git a/conf.py b/docs/conf.py
similarity index 78%
rename from conf.py
rename to docs/conf.py
index fe10b06..bd66d82 100644
--- a/conf.py
+++ b/docs/conf.py
@@ -11,112 +11,115 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os
+import os
+import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append(os.path.dirname(__file__))
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testing.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test.settings")
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', ]
+extensions = [
+ "sphinx.ext.autodoc",
+]
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
# The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
# The encoding of source files.
-source_encoding = 'utf-8'
+source_encoding = "utf-8"
# The master toctree document.
-master_doc = 'index'
+master_doc = "index"
# General information about the project.
-project = u'django-security'
-copyright = u'2013, SD Elements'
+project = "django-security"
+copyright = "2013, SD Elements"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '1.0'
+version = "1.0"
# The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = "1.0"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = Python
+# language = Python
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
-#today = ''
+# today = ''
# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
-exclude_patterns = ['_build/*', '.tox/*']
+exclude_patterns = ["_build/*", ".tox/*"]
# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+html_theme = "default"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "