Skip to content

Commit

Permalink
Add elevator pitch to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattrobenolt committed May 17, 2014
1 parent 5d233d5 commit f415b06
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,17 @@ django-sudo
.. image:: https://coveralls.io/repos/mattrobenolt/django-sudo/badge.png?branch=master
:target: https://coveralls.io/r/mattrobenolt/django-sudo?branch=master

Sudo mode is an extra layer of security for your most sensitive pages.
``django-sudo`` is an implementation of GitHub's `Sudo Mode
<https://github.com/blog/1513-introducing-github-sudo-mode>`_ for `Django
<https://www.djangoproject.com/>`_.

What is this for?
~~~~~~~~~~~~~~~~~
``django-sudo`` provides an extra layer of security for after a user is already logged in. Views can
be decorated with :func:`@sudo_required <django_sudo.decorators.sudo_required>`, and then a user
must re-enter their password to view that page. After verifying their password, that user has
elevated permissions for the duration of ``SUDO_COOKIE_AGE``. This duration is independent of the
normal session duration allowing short elevated permission durations, but retain long user sessions.

Installation
~~~~~~~~~~~~
Expand Down

0 comments on commit f415b06

Please sign in to comment.