| Name | kal-middleware JSON |
| Version |
2.0.5
JSON |
| download |
| home_page | None |
| Summary | Kaleidoo middleware package |
| upload_time | 2024-10-09 09:18:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License |
| keywords |
kal-middleware
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# kal-middleware
[](https://pypi.python.org/pypi/kal-middleware)
`kal-middleware` is a Python package designed for FastAPI applications to provide robust JWT and Service-to-Service (STS) authentication using Firebase and Google Identity Platform.
## Features
- **JWT Authentication**: Ensures that the JWTs are valid and checks user roles against provided configurations.
- **STS Authentication**: Validates tokens for service-to-service communication ensuring that only verified services can communicate.
## Installation
Install `kal-middleware` using pip:
```bash
pip install kal-middleware
```
# Usage
## JWT Authentication
To add JWT authentication to your FastAPI endpoints, you can use the `jwt_authenticated` decorator provided by `kal-middleware`. This decorator checks if the JWT token in the `Authorization` header is valid and whether the user has the appropriate role based on a configuration map.
Here's an example of how to apply the `firebase_jwt_authenticated` decorator:
**Notice:** After the JWT is processed, the `request.state` holds:
1. `user_uid` - The Firebase unique ID.
2. `user_capabilities` - A list of capabilities for later use in the request processing, if needed.
3. `user` - If `check_access` is used, the user object will be attached to the request, so the entire process does not need to call the request again.
```python
from kal_middleware.jwt import firebase_jwt_authenticated
from typing import List
from utils import get_org, get_user_by_fb_uid, get_capability_by_service_action
async def get_user(firebase_uid):
user = await get_user_by_fb_uid(firebase_uid)
return user
# if there is specific variable in the body that needed checks of who access its data only
async def check_access(user: dict, body: dict):
# check in the db the user and his parameters
# for example:
capabilities = user.get("capabilities")
if "capability_id" in body:
access = any(capability for capability in capabilities if capability.get("id") == body["capability_id"] )
if not access:
return False, f"User can't access the request."
if "org_id" in body:
org = get_org(body["org_id"])
if not org:
return False, f"Org not found"
return True, {"org": org}
return False, f"User {user.get('id')} from another organization then the one that was requested."
async def get_capability(service, action):
capability = await get_capability_by_service_action(service, action)
return capability
@app.get("/your-route/<service>/<action>")
@firebase_jwt_authenticated(get_user, check_access)
async def your_route_function(
request: Request = None,
service: Union[str, None] = None,
action: Union[str, None] = None
):
# Your route logic
return {"message": "This is a protected route"}
# Or - if there is no need to check for specific data in the body
@app.get("/your-route-without-check-access/<service>/<action>")
@firebase_jwt_authenticated(get_user)
async def your_route_function_without_check_access(
request: Request = None,
service: Union[str, None] = None,
action: Union[str, None] = None
):
# Your route logic
return {"message": "This is a protected route"}
```
## STS Authentication
For service-to-service (STS) authentication using Google's Identity Platform, you can use the `sts_authenticated` decorator. This ensures that the calling service's token is verified to enable secure interactions between services.
Here's how to use the `sts_authenticated` decorator in your FastAPI app:
- Make sure first you have env variable named `ALLOWED_SERVICE_ACCOUNTS` with the following structure: `example1@gserviceaccount.com, example2@gserviceaccount.com`
```python
from kal_middleware.sts import sts_authenticated
@app.get("/secure-service")
@sts_authenticated
async def secure_service_function():
# Logic that requires service-to-service authentication
return {"message": "Service-to-service call is authenticated"}
```
This configuration will parse and verify the Authorization header, ensuring that only requests with a verified bearer token can access the endpoint.
Raw data
{
"_id": null,
"home_page": null,
"name": "kal-middleware",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "kal-middleware",
"author": null,
"author_email": "Bar Lander <barh@kaleidoo.ai>",
"download_url": "https://files.pythonhosted.org/packages/4a/e5/569fe9932a8bf669115da483be880caa6ba2f8b599090c00972f58b2b55a/kal_middleware-2.0.5.tar.gz",
"platform": null,
"description": "# kal-middleware\n\n\n[](https://pypi.python.org/pypi/kal-middleware)\n\n`kal-middleware` is a Python package designed for FastAPI applications to provide robust JWT and Service-to-Service (STS) authentication using Firebase and Google Identity Platform.\n\n## Features\n\n- **JWT Authentication**: Ensures that the JWTs are valid and checks user roles against provided configurations.\n- **STS Authentication**: Validates tokens for service-to-service communication ensuring that only verified services can communicate.\n\n## Installation\n\nInstall `kal-middleware` using pip:\n\n```bash\npip install kal-middleware\n```\n\n# Usage\n\n## JWT Authentication\n\nTo add JWT authentication to your FastAPI endpoints, you can use the `jwt_authenticated` decorator provided by `kal-middleware`. This decorator checks if the JWT token in the `Authorization` header is valid and whether the user has the appropriate role based on a configuration map.\n\nHere's an example of how to apply the `firebase_jwt_authenticated` decorator:\n\n**Notice:** After the JWT is processed, the `request.state` holds:\n1. `user_uid` - The Firebase unique ID.\n2. `user_capabilities` - A list of capabilities for later use in the request processing, if needed.\n3. `user` - If `check_access` is used, the user object will be attached to the request, so the entire process does not need to call the request again.\n\n```python\nfrom kal_middleware.jwt import firebase_jwt_authenticated\nfrom typing import List\nfrom utils import get_org, get_user_by_fb_uid, get_capability_by_service_action\n\nasync def get_user(firebase_uid):\n user = await get_user_by_fb_uid(firebase_uid)\n return user\n\n# if there is specific variable in the body that needed checks of who access its data only\nasync def check_access(user: dict, body: dict):\n # check in the db the user and his parameters\n # for example:\n capabilities = user.get(\"capabilities\")\n if \"capability_id\" in body:\n access = any(capability for capability in capabilities if capability.get(\"id\") == body[\"capability_id\"] )\n if not access:\n return False, f\"User can't access the request.\"\n if \"org_id\" in body:\n org = get_org(body[\"org_id\"])\n if not org:\n return False, f\"Org not found\"\n return True, {\"org\": org}\n return False, f\"User {user.get('id')} from another organization then the one that was requested.\"\n\n\nasync def get_capability(service, action):\n capability = await get_capability_by_service_action(service, action)\n return capability\n\n@app.get(\"/your-route/<service>/<action>\")\n@firebase_jwt_authenticated(get_user, check_access)\nasync def your_route_function(\n request: Request = None,\n service: Union[str, None] = None,\n action: Union[str, None] = None\n):\n # Your route logic\n return {\"message\": \"This is a protected route\"}\n\n# Or - if there is no need to check for specific data in the body\n@app.get(\"/your-route-without-check-access/<service>/<action>\")\n@firebase_jwt_authenticated(get_user)\nasync def your_route_function_without_check_access(\n request: Request = None,\n service: Union[str, None] = None,\n action: Union[str, None] = None\n):\n # Your route logic\n return {\"message\": \"This is a protected route\"}\n```\n\n## STS Authentication\nFor service-to-service (STS) authentication using Google's Identity Platform, you can use the `sts_authenticated` decorator. This ensures that the calling service's token is verified to enable secure interactions between services.\n\nHere's how to use the `sts_authenticated` decorator in your FastAPI app:\n- Make sure first you have env variable named `ALLOWED_SERVICE_ACCOUNTS` with the following structure: `example1@gserviceaccount.com, example2@gserviceaccount.com`\n```python\nfrom kal_middleware.sts import sts_authenticated\n\n@app.get(\"/secure-service\")\n@sts_authenticated\nasync def secure_service_function():\n # Logic that requires service-to-service authentication\n return {\"message\": \"Service-to-service call is authenticated\"}\n```\nThis configuration will parse and verify the Authorization header, ensuring that only requests with a verified bearer token can access the endpoint.\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Kaleidoo middleware package",
"version": "2.0.5",
"project_urls": {
"Homepage": "https://github.com/BarLanderK/kal-middleware"
},
"split_keywords": [
"kal-middleware"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba1ccb936971b1a9685a7e8041015f54de0df184990fb683d7b44148e80768d7",
"md5": "14436edfb1cf85b33e48f3ae04cbc460",
"sha256": "6ada343495e19751ac2f2b812d14d7f2149b804bf762b99d10b4f2a5dc0e2b52"
},
"downloads": -1,
"filename": "kal_middleware-2.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "14436edfb1cf85b33e48f3ae04cbc460",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 13469,
"upload_time": "2024-10-09T09:18:20",
"upload_time_iso_8601": "2024-10-09T09:18:20.003588Z",
"url": "https://files.pythonhosted.org/packages/ba/1c/cb936971b1a9685a7e8041015f54de0df184990fb683d7b44148e80768d7/kal_middleware-2.0.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ae5569fe9932a8bf669115da483be880caa6ba2f8b599090c00972f58b2b55a",
"md5": "577408d7e595096be7b5b7806c67f87a",
"sha256": "444d20379174d318d6a0061377f89daf507e66b9459d24469668dc79ee1d73df"
},
"downloads": -1,
"filename": "kal_middleware-2.0.5.tar.gz",
"has_sig": false,
"md5_digest": "577408d7e595096be7b5b7806c67f87a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20575,
"upload_time": "2024-10-09T09:18:22",
"upload_time_iso_8601": "2024-10-09T09:18:22.822815Z",
"url": "https://files.pythonhosted.org/packages/4a/e5/569fe9932a8bf669115da483be880caa6ba2f8b599090c00972f58b2b55a/kal_middleware-2.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 09:18:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BarLanderK",
"github_project": "kal-middleware",
"github_not_found": true,
"lcname": "kal-middleware"
}
