Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zx80/flask-simple-auth
FlaskSimpleAuth: The Secure Flask Framework
https://github.com/zx80/flask-simple-auth
Last synced: 6 days ago
JSON representation
FlaskSimpleAuth: The Secure Flask Framework
- Host: GitHub
- URL: https://github.com/zx80/flask-simple-auth
- Owner: zx80
- License: other
- Created: 2021-02-21T06:52:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T08:16:14.000Z (19 days ago)
- Last Synced: 2024-10-27T08:40:47.947Z (19 days ago)
- Language: Python
- Homepage: https://zx80.github.io/flask-simple-auth/
- Size: 4.45 MB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# FlaskSimpleAuth: The Secure Flask Framework
FlaskSimpleAuth is a [Flask](https://flask.palletsprojects.com/) wrapper to add
a declarative security layer to routes with authentification, authorization and
parameter management.
With FlaskSimpleAuth, application and security concerns are separated:
- the **application** focusses on *what* to do, and *declares* its security
requirements.
- the **configuration** declares *how* the authentification and authorization
constraints are checked by providing settings and hook functions.
- the **framework** *implements* and *enforces* the security on the application
routes, with safe defaults so that security cannot be overlooked.
The following Flask application provides two routes:
- `GET /store` allows any authenticated *user* in group *employee* to
access the store list.
- `POST /store/` allows an authenticated *user* who is a *manager* of
*store* number *sid* to add a quantity of product to the store inventory.
```python
# file "app.py"
from FlaskSimpleAuth import Flask
app = Flask("acme")
app.config.from_envvar("ACME_CONFIG")
@app.get("/store", authorize="employee")
def get_store(pattern: str = "%"):
# return the list of stores matching optional parameter pattern
return ..., 200
@app.post("/store//product", authorize=("store", "sid", "manager"))
def post_store_sid_product(sid: int, product: str, quantity: int):
# product is added in quantity to store sid
return ..., 201
```
In this code, there is *no* clue about how users are authenticated, as this is
set from the configuration.
Only authorizations are declared on the route with the mandatory ``authorize``
parameter.
How these are checked is also set from the configuration.
HTTP or JSON parameters are automatically converted to the expected type,
with features on par with [FastAPI](https://fastapi.tiangolo.com/).
Authentication and authorizations are provided to the framework with callback functions.
For our example, we will need to retrieve the salted hashed password for a user,
to check whether a user belongs to a group, and
to tell whether a user can access a given store in a particular role:
```python
# file "auth.py"
def get_user_pass(user: str) -> str|None:
return ... # hashed password retrieved from somewhere
def user_is_employee(user: str) -> bool:
return ... # whether user belongs to group employee
def store_perms(user: str, sid: int, role: str) -> bool|None:
return ... # whether user can access store sid in role
```
Here is an example of configuration for the above application:
Users are identified either with a JWT token or with a basic authentification.
```python
# file "acme.conf"
import os
import auth
FSA_MODE = "dev"
FSA_AUTH = ["token", "basic"]
FSA_TOKEN_TYPE = "jwt"
FSA_TOKEN_SECRET = os.environ["ACME_SECRET"]
FSA_GET_USER_PASS = auth.get_user_pass
FSA_GROUP_CHECK = { "employee": auth.user_is_employee }
FSA_OBJECT_PERMS = { "store": auth.store_perms }
```
The framework will ensure that routes are only called by authenticated users
who have the right authorizations.
Secure and reasonable defaults are provided.
Most features can be adjusted or extended to particular needs through numerous
directives and hooks.
Authentication and authorization callback invocations are cached for efficiency.
Also, [pydantic](https://docs.pydantic.dev/), dataclass and generic type
parameters are supported out of the box.
## More
- [documentation](https://zx80.github.io/flask-simple-auth/)
including a [tutorial](https://zx80.github.io/flask-simple-auth/TUTORIAL)
and convenient [recipes](https://zx80.github.io/flask-simple-auth/RECIPES),
[sources](https://github.com/zx80/flask-simple-auth) and
[issues](https://github.com/zx80/flask-simple-auth/issues) are hosted on
[GitHub](https://github.com/).
- install [package](https://pypi.org/project/FlaskSimpleAuth/) from
[PyPI](https://pypi.org/).
## License
This code is [Public Domain](https://creativecommons.org/publicdomain/zero/1.0/).
All software has bug, this is software, hence…
Beware that you may lose your hairs or your friends because of it.
If you like it, feel free to send a postcard to the author.