# FastAPI/MSAL - MSAL (Microsoft Authentication Library) plugin for FastAPI
[](http://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://github.com/dudil/fastapi_msal/actions/workflows/lint.yml)
[](https://pypistats.org/packages/fastapi_msal)
FastAPI - https://github.com/tiangolo/fastapi
_FastAPI is a modern, fast (high-performance), web framework for building APIs based on standard Python type hints._
MSAL for Python - https://github.com/AzureAD/microsoft-authentication-library-for-python
_The Microsoft Authentication Library for Python enables applications to integrate with the
[Microsoft identity platform.](https://aka.ms/aaddevv2)
It allows you to sign in users or apps with Microsoft identities
and obtain tokens to call Microsoft APIs such as [Microsoft Graph](https://graph.microsoft.io/)
or your own APIs registered with the Microsoft identity platform.
It is built using industry standard OAuth2 and OpenID Connect protocols_
The **fastapi_msal** package was built to allow quick "out of the box" integration with MSAL.
As a result the pacage was built around simplicity and ease of use on the expense of flexability and versatility.
## Features
1. Includes Async implementation of MSAL confidential client class utilizaing Starlette threadpool model.
1. Use pydantic models to translate the MSAL objects to data objects which are code and easy to work with.
1. Have a built-in router which includes the required paths for the authentication flow.
1. Include a dependency class to authenticate and secure your application APIs
1. Includes a pydantic setting class for easy and secure configuration from your ENV (or .env or secrets directory)
1. Full support with FastAPI swagger documentations and authentication simulation
## Installation
```shell
pip install "fastapi_msal"
```
Or if you wish to have all the required packages straight forward
```shell
pipenv install "fastapi_msal[full]"
```
## Prerequisets
1. Python 3.7 and above
2. As part of your fastapi application the following packages should be included:
(if you use the **[full]** method it is not required.)
1. [python-multipart](https://andrew-d.github.io/python-multipart/),
_[From FastAPI documentation](https://fastapi.tiangolo.com/tutorial/security/first-steps/#run-it)_:
This is required since OAuth2 (Which MSAL is based upon) uses "form data" to send the credentials.
2. [itsdangerous](https://github.com/pallets/itsdangerous)
Used by Starlette [session middleware](https://www.starlette.io/middleware/)
## Usage
1. Follow the application [registration process
with the Microsoft Identity Platform](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v2-register-an-app). Finishing the processes will allow you to [register your app callback path with the platform](https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#add-a-redirect-uri), as well as to retrieve your application `client_id`, `tenant_id` and `client_credential` ([client secrets](https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#add-credentials)) - see images below:
2. Create a new main.py file and add the following lines.
Make sure to update the lines with the information retrieved in the previous step
``` python
import uvicorn
from fastapi import FastAPI, Depends
from starlette.middleware.sessions import SessionMiddleware
from fastapi_msal import MSALAuthorization, UserInfo, MSALClientConfig
client_config: MSALClientConfig = MSALClientConfig()
client_config.client_id = "The client_id retrieved at step #1"
client_config.client_credential = "The client_credential retrieved at step #1"
client_config.tenant = "Your tenant_id retrieved at step #1"
app = FastAPI()
app.add_middleware(SessionMiddleware, secret_key="SOME_SSH_KEY_ONLY_YOU_KNOW") # replace with your own!!!
msal_auth = MSALAuthorization(client_config=client_config)
app.include_router(msal_auth.router)
@app.get("/users/me", response_model=UserInfo, response_model_exclude_none=True, response_model_by_alias=False)
async def read_users_me(current_user: UserInfo = Depends(msal_auth.scheme)) -> UserInfo:
return current_user
if __name__ == "__main__":
uvicorn.run("main:app", host="localhost", port=5000, reload=True)
```
3. Run your app
```shell
(pipenv shell)$ python main.py
INFO: Uvicorn running on http://localhost:5000 (Press CTRL+C to quit)
INFO: Started reloader process [12785] using statreload
INFO: Started server process [12787]
INFO: Waiting for application startup.
INFO: Application startup complete.
```
4. Browse to http://localhost:5000/docs - this is the API docs generated by FastAPI (totaly cool!)
5. Using the "built-in" authenticaiton button (the little lock) you will be able to set the full authentication process
(Igonre the cline_id and client_secret - they are not relevant for the process as you already set them)
6. After you complete the process you will get a confirmation popup
7. Trying out the _ME_ api endpoint
## Working Example/Template
If you wish to try out a working example, clone the following project and adjust it to your needs:
[https://github.com/dudil/ms-identity-python-webapp](https://github.com/dudil/ms-identity-python-webapp)
**NB!** Make sure you are using the *fastapi_msal* branch!!!
## TODO List
- [ ] Add support for local/redis session cache
- [ ] Add Tests
- [ ] Proper Documentation
Raw data
{
"_id": null,
"home_page": "",
"name": "fastapi-msal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "AAD,FastAPI,MSAL,SSO,authentication,fastapi-middleware,fastapi-plugin,plugin",
"author": "",
"author_email": "Dudi Levy <4785835+dudil@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/63/ab/3065bb4fcdc230864ec9260a6c5226c189291cb2854b602eeef386fbad92/fastapi_msal-2.1.3.tar.gz",
"platform": null,
"description": "# FastAPI/MSAL - MSAL (Microsoft Authentication Library) plugin for FastAPI\n[](http://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://github.com/dudil/fastapi_msal/actions/workflows/lint.yml)\n[](https://pypistats.org/packages/fastapi_msal)\n\nFastAPI - https://github.com/tiangolo/fastapi\n_FastAPI is a modern, fast (high-performance), web framework for building APIs based on standard Python type hints._\n\nMSAL for Python - https://github.com/AzureAD/microsoft-authentication-library-for-python\n_The Microsoft Authentication Library for Python enables applications to integrate with the\n[Microsoft identity platform.](https://aka.ms/aaddevv2)\nIt allows you to sign in users or apps with Microsoft identities\nand obtain tokens to call Microsoft APIs such as [Microsoft Graph](https://graph.microsoft.io/)\nor your own APIs registered with the Microsoft identity platform.\nIt is built using industry standard OAuth2 and OpenID Connect protocols_\n\nThe **fastapi_msal** package was built to allow quick \"out of the box\" integration with MSAL.\nAs a result the pacage was built around simplicity and ease of use on the expense of flexability and versatility.\n\n## Features\n1. Includes Async implementation of MSAL confidential client class utilizaing Starlette threadpool model.\n1. Use pydantic models to translate the MSAL objects to data objects which are code and easy to work with.\n1. Have a built-in router which includes the required paths for the authentication flow.\n1. Include a dependency class to authenticate and secure your application APIs\n1. Includes a pydantic setting class for easy and secure configuration from your ENV (or .env or secrets directory)\n1. Full support with FastAPI swagger documentations and authentication simulation\n\n## Installation\n\n```shell\npip install \"fastapi_msal\"\n```\nOr if you wish to have all the required packages straight forward\n```shell\npipenv install \"fastapi_msal[full]\"\n```\n\n## Prerequisets\n1. Python 3.7 and above\n2. As part of your fastapi application the following packages should be included: \n(if you use the **[full]** method it is not required.)\n 1. [python-multipart](https://andrew-d.github.io/python-multipart/),\n _[From FastAPI documentation](https://fastapi.tiangolo.com/tutorial/security/first-steps/#run-it)_:\n This is required since OAuth2 (Which MSAL is based upon) uses \"form data\" to send the credentials.\n\n 2. [itsdangerous](https://github.com/pallets/itsdangerous)\n Used by Starlette [session middleware](https://www.starlette.io/middleware/)\n\n## Usage\n1. Follow the application [registration process\nwith the Microsoft Identity Platform](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v2-register-an-app). Finishing the processes will allow you to [register your app callback path with the platform](https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#add-a-redirect-uri), as well as to retrieve your application `client_id`, `tenant_id` and `client_credential` ([client secrets](https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#add-credentials)) - see images below:\n\n\n\n\n\n2. Create a new main.py file and add the following lines.\nMake sure to update the lines with the information retrieved in the previous step\n``` python\nimport uvicorn\nfrom fastapi import FastAPI, Depends\nfrom starlette.middleware.sessions import SessionMiddleware\nfrom fastapi_msal import MSALAuthorization, UserInfo, MSALClientConfig\n\nclient_config: MSALClientConfig = MSALClientConfig()\nclient_config.client_id = \"The client_id retrieved at step #1\"\nclient_config.client_credential = \"The client_credential retrieved at step #1\"\nclient_config.tenant = \"Your tenant_id retrieved at step #1\"\n\napp = FastAPI()\napp.add_middleware(SessionMiddleware, secret_key=\"SOME_SSH_KEY_ONLY_YOU_KNOW\") # replace with your own!!!\nmsal_auth = MSALAuthorization(client_config=client_config)\napp.include_router(msal_auth.router)\n\n\n@app.get(\"/users/me\", response_model=UserInfo, response_model_exclude_none=True, response_model_by_alias=False)\nasync def read_users_me(current_user: UserInfo = Depends(msal_auth.scheme)) -> UserInfo:\n return current_user\n\n\nif __name__ == \"__main__\":\n uvicorn.run(\"main:app\", host=\"localhost\", port=5000, reload=True)\n```\n\n3. Run your app\n```shell\n(pipenv shell)$ python main.py\nINFO: Uvicorn running on http://localhost:5000 (Press CTRL+C to quit)\nINFO: Started reloader process [12785] using statreload\nINFO: Started server process [12787]\nINFO: Waiting for application startup.\nINFO: Application startup complete.\n```\n\n4. Browse to http://localhost:5000/docs - this is the API docs generated by FastAPI (totaly cool!)\n\n\n5. Using the \"built-in\" authenticaiton button (the little lock) you will be able to set the full authentication process\n\n (Igonre the cline_id and client_secret - they are not relevant for the process as you already set them)\n\n6. After you complete the process you will get a confirmation popup\n\n\n7. Trying out the _ME_ api endpoint\n\n\n## Working Example/Template\nIf you wish to try out a working example, clone the following project and adjust it to your needs:\n[https://github.com/dudil/ms-identity-python-webapp](https://github.com/dudil/ms-identity-python-webapp)\n\n**NB!** Make sure you are using the *fastapi_msal* branch!!!\n\n## TODO List\n- [ ] Add support for local/redis session cache\n- [ ] Add Tests\n- [ ] Proper Documentation\n",
"bugtrack_url": null,
"license": "",
"summary": "FastAPI/MSAL - The MSAL (Microsoft Authentication Library) plugin for FastAPI!",
"version": "2.1.3",
"project_urls": {
"Documentation": "https://github.com/dudil/fastapi_msal#readme",
"Homepage": "https://github.com/dudil/fastapi_msal",
"Issues": "https://github.com/dudil/fastapi_msal/issues",
"Source": "https://github.com/dudil/fastapi_msal"
},
"split_keywords": [
"aad",
"fastapi",
"msal",
"sso",
"authentication",
"fastapi-middleware",
"fastapi-plugin",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c334756d7da169f0ed0da73e3a655fffdff3447535ef1aa75ac8f5f09f06427f",
"md5": "68df8a576d7b6998e5d273ea2d060d9a",
"sha256": "f8f33b63a7671f31dcc6fa8085f0147a5cf98c8a07f5ef7a9c84de57e610bee0"
},
"downloads": -1,
"filename": "fastapi_msal-2.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68df8a576d7b6998e5d273ea2d060d9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 22381,
"upload_time": "2024-03-13T11:22:23",
"upload_time_iso_8601": "2024-03-13T11:22:23.500682Z",
"url": "https://files.pythonhosted.org/packages/c3/34/756d7da169f0ed0da73e3a655fffdff3447535ef1aa75ac8f5f09f06427f/fastapi_msal-2.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63ab3065bb4fcdc230864ec9260a6c5226c189291cb2854b602eeef386fbad92",
"md5": "6b838428734097ce11b429083e4b0400",
"sha256": "75918d71c8e9bad0a58454723ca0fb862d97a56cfe701fed14e32cc85bad6e4c"
},
"downloads": -1,
"filename": "fastapi_msal-2.1.3.tar.gz",
"has_sig": false,
"md5_digest": "6b838428734097ce11b429083e4b0400",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17174,
"upload_time": "2024-03-13T11:22:25",
"upload_time_iso_8601": "2024-03-13T11:22:25.313108Z",
"url": "https://files.pythonhosted.org/packages/63/ab/3065bb4fcdc230864ec9260a6c5226c189291cb2854b602eeef386fbad92/fastapi_msal-2.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 11:22:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dudil",
"github_project": "fastapi_msal#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fastapi-msal"
}
JSON
