django-elevate

|pypi| |build-status| |readthedocs| |coverage|

.. |pypi| image:: https://img.shields.io/pypi/v/django-elevate.svg :target: https://pypi.python.org/pypi/django-elevate/ :alt: PyPI Version

.. |readthedocs| image:: https://readthedocs.org/projects/django-elevate/badge/?version=latest :target: https://django-elevate.readthedocs.io/en/latest/ :alt: Documentation Status

.. |build-status| image:: https://img.shields.io/github/workflow/status/justinmayer/django-elevate/build :target: https://github.com/justinmayer/django-elevate/actions :alt: Build Status

.. |coverage| image:: https://img.shields.io/codecov/c/github/justinmayer/django-elevate/main?token=LMQUrdXJXk :target: https://codecov.io/gh/justinmayer/django-elevate :alt: Code Coverage

..

| Elevate mode offers an extra layer of security for your most sensitive pages.
| This is an implementation of GitHub's `Sudo Mode`_ for `Django`_.

.. inclusion-marker-do-not-remove-start

What is this for?

Elevate provides an extra layer of security beyond initial user authentication.
Views can be decorated with ``@elevate_required``, and then users must
re-authenticate to access that resource. This might be useful for deleting objects,
canceling subscriptions, and other sensitive operations. After re-authentication,
the user has elevated permissions for the duration of ``ELEVATE_COOKIE_AGE``.
This duration is independent of the normal session duration, allowing for short
elevated permission durations while still retaining long user sessions.

Installation
~~~~~~~~~~~~

.. code-block:: console

    $ pip install django-elevate

Compatibility
~~~~~~~~~~~~~

* Django 2.2, 3.2, and 4.0
* Python 3.7 - 3.10
* pypy3

.. inclusion-marker-do-not-remove-end

Resources
~~~~~~~~~

* `Documentation <https://django-elevate.readthedocs.io/>`_
* `Security <https://django-elevate.readthedocs.io/en/latest/security/index.html>`_
* `Changelog <https://django-elevate.readthedocs.io/en/latest/changelog/index.html>`_


.. _Sudo Mode: https://github.com/blog/1513-introducing-github-sudo-mode
.. _Django: https://www.djangoproject.com/