FastAPI/MSAL - MSAL (Microsoft Authentication Library) plugin for FastAPI
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. It allows you to sign in users or apps with Microsoft identities and obtain tokens to call Microsoft APIs such as Microsoft Graph 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
- Includes Async implementation of MSAL confidential client class utilizaing Starlette threadpool model.
- Use pydantic models to translate the MSAL objects to data objects which are code and easy to work with.
- Have a built-in router which includes the required paths for the authentication flow.
- Include a dependency class to authenticate and secure your application APIs
- Includes a pydantic setting class for easy and secure configuration from your ENV (or .env or secrets directory)
- Full support with FastAPI swagger documentations and authentication simulation
Installation
pip install "fastapi_msal"
Or if you wish to have all the required packages straight forward
pipenv install "fastapi_msal[full]"
Prerequisets
- Python 3.7 and above
- As part of your fastapi application the following packages should be included:
(if you use the [full] method it is not required.)-
python-multipart, From FastAPI documentation: This is required since OAuth2 (Which MSAL is based upon) uses "form data" to send the credentials.
-
itsdangerous Used by Starlette session middleware
-
Usage
-
Follow the application registration process with the microsoft identity platform. Finishing the processes will allow you to retrieve your app_code and app_credentials (app_secret) As well as register your app callback path with the platform.
-
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
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 rerived at step #1"
client_config.client_credential = "The Client secret retrived at step #1"
client_config.tenant = "Your tenant id"
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)
- Run your app
(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.
-
Browse to http://localhost:5000/docs - this is the API docs generated by FastAPI (totaly cool!)
-
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) -
After you complete the process you will get a confirmation popup
-
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
NB! Make sure you are using the fastapi_msal branch!!!
TODO List
- Add support for local/redis session cache
- Add Tests
- Proper Documentation
16 Oct 07, 2022
14 May 02, 2021
4 Mar 25, 2022
4 Dec 05, 2022
465 Jan 07, 2023
9 Nov 20, 2022
8 Dec 06, 2022
300 Dec 26, 2022
0 Sep 24, 2022
351 Jan 04, 2023
291 Jan 06, 2023
6 Nov 13, 2022
113 Dec 31, 2022
1.3k Dec 31, 2022
27 Oct 06, 2022
140 Dec 27, 2022
112 Dec 30, 2022
107 Jan 05, 2023