Skip to main content

Strong, Simple, and Precise security for Flask APIs

Project description

Latest Published Version Build Status Documentation Build Status

flask-praetorian

Strong, Simple, and Precise security for Flask APIs

API security should be strong, simple, and precise like a Roman Legionary. This package aims to provide that. Using JWT tokens as implemented by PyJWT, 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, 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.

The flask-praetorian package can be used to:

  • Encrypt (hash) passwords for storing in your database

  • Verify plaintext passwords against the encrypted, stored versions

  • Generate authorization tokens upon verification of passwords

  • Check requests to secured endpoints for authorized tokens

  • Ensure that the users associated with tokens have necessary roles for access

  • Parse user information from request headers for use in client route handlers

All of this is provided in a very simple to confiure 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 package.

Super-quick Start

  • requirements: python versions 3.4, 3.5, 3.6, and 3.7

  • install through pip: $ pip install flask-praetorian

  • minimal usage example: example/basic.py

Documentation

The complete documentation can be found at the flask-praetorian home page

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask-praetorian-0.4.6.tar.gz (14.9 kB view details)

Uploaded Source

File details

Details for the file flask-praetorian-0.4.6.tar.gz.

File metadata

File hashes

Hashes for flask-praetorian-0.4.6.tar.gz
Algorithm Hash digest
SHA256 9b44b65ead6a7641121c8ad5534c7da1b8239d0877920ea3ca695d1e8707211b
MD5 786352719d506391cbdfe8ec55534f34
BLAKE2b-256 0e21877b03499739b4d8b2b062f687630ea04b5874361ddb361000e1e838788e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page