Skip to main content

Strong, Simple, (now async!) and Precise security for Sanic APIs

Project description

Latest Published Version Build Testing Status Supported Python versions Documentation Build Status Codecov Report https://static.pepy.tech/personalized-badge/sanic-beskar?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads Codacy Badge Interrogate Badge Security Status Code style: black

sanic-beskar

Strong, Simple, and Precise security for Sanic APIs

This project’s beginning was fully lifted from the awesome Flask-Praetorian.

Why beskar? Why not – what is better than star wars (provided you ignore the fact ~the mandolorian~ was almost as lame as ~book of boba fett~)? Superior armour should be used if you want superior protection.

This package aims to provide that. Using token implemented by either PySETO or PyJWT, sanic-beskar uses a very simple interface to make sure that the users accessing your API’s endpoints are provisioned with the correct roles for access.

The goal of this project is to offer simplistic protection, without forcing nonsense, excessivly complicatated implementation, or mandated/opinionated ORM usage. Providing this usability for small scaled Sanic applications, while allowing the flexibility and scalability for enterprise grade solutions, separates this from your other options.

The sanic-beskar 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

  • Support OTP authentication as a dual factor

  • Provide RBAC based protection of endpoints and resources

All of this is provided in a very simple to configure and initialize flask extension. Though simple, the security provided by sanic-beskar is strong due to the usage of the proven security technology of PASETO or JWT, along with python’s PassLib package.

Super-quick Start

  • requirements: python versions 3.7+

  • install through pip: $ pip install sanic-beskar

  • minimal usage example: example/basic.py

Documentation

The complete documentation can be found at the sanic-beskar 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

sanic_beskar-2.3.4.post1.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

sanic_beskar-2.3.4.post1-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

Details for the file sanic_beskar-2.3.4.post1.tar.gz.

File metadata

  • Download URL: sanic_beskar-2.3.4.post1.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1024-azure

File hashes

Hashes for sanic_beskar-2.3.4.post1.tar.gz
Algorithm Hash digest
SHA256 43c08ca40eddab8aa833e9b47d7eb73478b645f118d80c3d46a6e0f385f59bb9
MD5 be255c8e1f7d1c97a177a76f058b72c3
BLAKE2b-256 1670577f6d301c80279d41af00d00b9c2fd0a8ac2986bdefa6c3cb54a389043c

See more details on using hashes here.

File details

Details for the file sanic_beskar-2.3.4.post1-py3-none-any.whl.

File metadata

  • Download URL: sanic_beskar-2.3.4.post1-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1024-azure

File hashes

Hashes for sanic_beskar-2.3.4.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f8c305a5688db6a04b1827f731695187f6f1992724318b2fdb848080ddd993d
MD5 59c9a23dd15d40e2ec2832078351e385
BLAKE2b-256 0e09f5d0801a15391480937899385a1a0b60433b6449019d461a8cfe24ca40c4

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