API security should be strong, simple, and precise like a Roman Legionary. This package aims to provide that. Using JWT <https://jwt.io/>_ tokens as implemented by PyJWT <https://pyjwt.readthedocs.io/en/latest/>_, flask_praetorian uses a very simple interface to make sure that the users accessing your API's endpoints are provisioned with the correct roles for access.

This project was heavily influenced by Flask-Security <https://pythonhosted.org/Flask-Security/>_, but intends to supply only essential functionality. Instead of trying to anticipate the needs of all users, flask-praetorian will provide a simple and secure mechanism to provide security for APIs specifically.

This extension offers a batteries-included approach to security for your API. For essential security concerns for Flask-based APIs, flask-praetorian <https://github.com/dusktreader/flask-praetorian>_ should supply everything you need.

The flask-praetorian package can be used to:

Hash passwords for storing in your database
Verify plaintext passwords against the hashed, stored versions
Generate authorization tokens upon verification of passwords
Check requests to secured endpoints for authorized tokens
Supply expiration of tokens and mechanisms for refreshing them
Ensure that the users associated with tokens have necessary roles for access
Parse user information from request headers for use in client route handlers
Support inclusion of custom user claims in tokens
Register new users using email verification

All of this is provided in a very simple to configure and initialize flask extension. Though simple, the security provided by flask-praetorian is strong due to the usage of the proven security technology of JWT and python's PassLib <http://pythonhosted.org/passlib/>_ package.

Super-quick Start

requirements: python versions 3.8+
install through pip: $ pip install flask-praetorian
minimal usage example: example/basic.py <https://github.com/dusktreader/flask-praetorian/tree/master/example/basic.py>_

Documentation

The complete documentation can be found at the flask-praetorian home page <http://flask-praetorian.readthedocs.io>_

FAQs

What is flask-praetorian?

Is flask-praetorian well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install