Welcome to Elevate

Elevate, also known as django-elevate, is an implementation of GitHub’s Sudo Mode for Django.

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

$ pip install django-elevate

Compatibility

• Django 4.2, 5.1, and 5.2

• Python 3.9 - 3.13

• pypy3

Contents

• Getting Started
  • Installation
• Configuration
  • Settings
  • Set up URLs
  • Required Template
• Usage
  • elevate.decorators.elevate_required()
  • elevate.mixins.ElevateMixin
  • request.is_elevated()
  • elevate.middleware.ElevateMiddleware
  • grant_elevated_privileges()
  • revoke_elevated_privileges()
  • has_elevated_privileges()
• Contributing
  • Getting the Source
  • Setting Up the Environment
  • Running Tests
  • Submitting Patches
• How does this work?
• Security
• Changelog
  • 2.0.3 - 2022-07-28
  • 2.0.2 - 2021-06-02
  • 2.0.1 - 2021-04-11
  • 2.0.0 - 2020-10-25
  • 1.0.1 - 2019-06-06
  • 1.0.0 - 2018-06-25