Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 2.79 KB

index.rst

File metadata and controls

85 lines (58 loc) · 2.79 KB
Raw

Configuration

Settings

By default, all of the settings are optional and define sane and secure defaults.

SUDO_URL

The url or view name for the sudo view. Default: sudo.views.sudo

SUDO_REDIRECT_URL

Default url to be redirected to after elevating permissions. Default: /

SUDO_REDIRECT_FIELD_NAME

The querystring argument to be used for redirection. Default: next

SUDO_COOKIE_AGE

How long should sudo mode be active for? Duration in seconds. Default: 10800

SUDO_COOKIE_DOMAIN

The domain to bind the sudo cookie to. Default: current exact domain.

SUDO_COOKIE_HTTPONLY

Should the cookie only be accessible via http requests? Default: True

Note

If this is set to False, any JavaScript files have the ability to access this cookie, so this should only be changed if you have a good reason to do so.

SUDO_COOKIE_NAME

The name of the cookie to be used for sudo mode. Default: sudo

SUDO_COOKIE_PATH

Restrict the sudo cookie to a specific path. Default: /

SUDO_COOKIE_SECURE

Only transmit the sudo cookie over https if True. Default: matches current protocol

Note

By default, we will match the protocol that made the request. So if your sudo page is over https, we will set the secure flag on the cookie so it won't be transmitted over plain http. It is highly recommended that you only use django-sudo over https.

SUDO_COOKIE_SALT

An extra salt to be added into the cookie signature. Default: ''

SUDO_REDIRECT_TO_FIELD_NAME

The name of the session attribute used to preserve the redirect destination between the original page request and successful sudo login. Default: sudo_redirect_to

Set up URLs

We need to hook up one url to use django-sudo properly. At minimum, you need something like the following:

(r'^sudo/$',  # Whatever path you want
    'sudo.views.sudo',  # Required
    {'template_name': 'sudo/sudo.html'}  # Optionally change the template to be used
)

Required Template

To get up and running, we last need to create a template for the sudo page to render. By default, the package will look for sudo/sudo.html but can easily be overwritten by setting the template_name when defining the url definition as seen above.

sudo/sudo.html

This template gets rendered with the the following context:

form

An instance of ~sudo.forms.SudoForm.

SUDO_REDIRECT_FIELD_NAME

The value of ?next=/foo/. If SUDO_REDIRECT_FIELD_NAME is name, then expect to find {{ next }} in the context, with the value of /foo/.

After configuring things, we can now start securing pages </usage/index>.