معرفی شرکت ها
fastapi-keycloak-middleware-0.2.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Middleware for FastAPI to authenticate a user against keycloak
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | fastapi-keycloak-middleware-0.2.2 |
| نام | fastapi-keycloak-middleware |
| نسخه کتابخانه | 0.2.2 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Daniel Herrmann |
| ایمیل نویسنده | daniel.herrmann1@gmail.com |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/fastapi-keycloak-middleware/ |
| مجوز | - |
[](https://fastapi-keycloak-middleware.readthedocs.io/en/latest/?badge=latest)
[](https://opensource.org/licenses/MIT)
[](https://results.pre-commit.ci/latest/github/waza-ari/fastapi-keycloak-middleware/development)
# FastAPI Keycloak Middleware
**Full documentation** is [available at Read The Docs](https://fastapi-keycloak-middleware.readthedocs.io/en/latest/)
This package provides a middleware for [FastAPI](http://fastapi.tiangolo.com>) that
simplifies integrating with [Keycloak](http://http://keycloak.org>) for
authentication and authorization. It supports OIDC and supports validating access
tokens, reading roles and basic authentication. In addition it provides several
decorators and dependencies to easily integrate into your FastAPI application.
It relies on the [python-keycloak](http://python-keycloak.readthedocs.io) package,
which is the only dependency outside of the FastAPI ecosystem which would be installed
anyway. Shoutout to the author of [fastapi-auth-middleware](https://github.com/code-specialist/fastapi-auth-middleware>)
which served as inspiration for this package and some of its code.
In the future, I plan to add support for fine grained authorization using Keycloak
Authorization services.
## Motivation
Using FastAPI and Keycloak quite a lot, and keeping to repeat myself quite a lot when
it comes to authentiating users, I decided to create this library to help with this.
There is a clear separation between the authentication and authorization:
- **Authentication** is about verifying the identity of the user
(who they are). This is done by an authentication backend
that verifies the users access token obtained from the
identity provider (Keycloak in this case).
- **Authorization** is about deciding which resources can be
accessed. This package providers convenience decoraters to
enforce certain roles or permissions on FastAPI endpoints.
## Installation
Install the package using poetry:
```bash
poetry add fastapi-keycloak-middleware
```
or `pip`:
```bash
pip install fastapi-keycloak-middleware
```
## Features
The package helps with:
* An easy to use middleware that validates the request for an access token
* Validation can done in one of two ways:
* Validate locally using the public key obtained from Keycloak
* Validate using the Keycloak token introspection endpoint
* Using Starlette authentication mechanisms to store both the user object as well as the authorization scopes in the Request object
* Ability to provide custom callback functions to retrieve the user object (e.g. from your database) and to provide an arbitrary mapping to authentication scopes (e.g. roles to permissions)
* A decorator to use previously stored information to enforce certain roles or permissions on FastAPI endpoints
* Convenience dependencies to retrieve the user object or the authorization result after evaluation within the FastAPI endpoint
## Acknowledgements
This package is heavily inspired by [fastapi-auth-middleware](https://github.com/code-specialist/fastapi-auth-middleware)
which provides some of the same functionality but without the direct integration
into Keycloak. Thanks for writing and providing this great piece of software!
## Development
This project is using [Act](https://github.com/nektos/act) to handle local development tasks. It is used
to work locally and also to test Github actions before deploying them.
نیازمندی
| مقدار | نام |
|---|---|
| >=0.73.0 | fastapi |
| >=1.3.5,<2.0.0 | install |
| >=2.14.0,<3.0.0 | python-keycloak |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.10,<4.0 | Python |
نحوه نصب
نصب پکیج whl fastapi-keycloak-middleware-0.2.2:
pip install fastapi-keycloak-middleware-0.2.2.whl
نصب پکیج tar.gz fastapi-keycloak-middleware-0.2.2:
pip install fastapi-keycloak-middleware-0.2.2.tar.gz