Async based MSAL helper for aiohttp - aiohttp_msal Python library
Authorization Code Flow Helper. Learn more about auth-code-flow at https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-auth-code-flow
Async based OAuth using the Microsoft Authentication Library (MSAL) for Python.
Blocking MSAL functions are executed in the executor thread. Should be useful until such time as MSAL Python gets a true async version.
Tested with MSAL Python 1.21.0 onward - MSAL Python docs
AsycMSAL class
The AsyncMSAL class wraps the behavior in the following example app https://github.com/Azure-Samples/ms-identity-python-webapp/blob/master/app.py#L76
It is responsible to manage tokens & token refreshes and as a client to retrieve data using these tokens.
Acquire the token
Firstly you should get the tokens via OAuth
-
initiate_auth_code_flowreferernceThe caller is expected to:
- somehow store this content, typically inside the current session of the server,
- guide the end user (i.e. resource owner) to visit that auth_uri, typically with a redirect
- and then relay this dict and subsequent auth response to acquire_token_by_auth_code_flow().
Step 1 and part of Step 3 is stored by this class in the aiohttp_session
-
acquire_token_by_auth_code_flowreferernce
Use the token
Now you are free to make requests (typically from an aiohttp server)
session = await get_session(request)
aiomsal = AsyncMSAL(session)
async with aiomsal.get("https://graph.microsoft.com/v1.0/me") as res:
res = await res.json()
Example web server
Complete routes can be found in routes.py
Start the login process
@ROUTES.get("/user/login")
async def user_login(request: web.Request) -> web.Response:
"""Redirect to MS login page."""
session = await new_session(request)
redir = AsyncMSAL(session).build_auth_code_flow(
redirect_uri=get_route(request, URI_USER_AUTHORIZED)
)
return web.HTTPFound(redir)
Acquire the token after being redirected back to the server
@ROUTES.post(URI_USER_AUTHORIZED)
async def user_authorized(request: web.Request) -> web.Response:
"""Complete the auth code flow."""
session = await get_session(request)
auth_response = dict(await request.post())
aiomsal = AsyncMSAL(session)
await aiomsal.async_acquire_token_by_auth_code_flow(auth_response)
Helper methods
-
@ROUTES.get("/user/photo")Serve the user's photo from their Microsoft profile
-
get_user_infoGet the user's email and display name from MS Graph
-
get_manager_infoGet the user's manager info from MS Graph
Redis tools to retrieve session tokens
from aiohttp_msal import ENV, AsyncMSAL
from aiohttp_msal.redis_tools import get_session
def main()
# Uses the redis.asyncio driver to retrieve the current token
# Will update the token_cache if a RefreshToken was used
ses = asyncio.run(get_session(MYEMAIL))
client = GraphClient(ses.get_token)
# ...
# use the Graphclient
Development
uv sync --all-extras
uv tool install ruff
uv tool install prek
prek install # add pre-commit hooks
1 maintainer
Metadata
1 maintainer
Release files for aiohttp-msal 1.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aiohttp_msal-1.1.5.tar.gz | 14.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aiohttp_msal-1.1.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.7 kB
Release files / aiohttp_msal-1.1.5.tar.gz
| Download URL | aiohttp_msal-1.1.5.tar.gz |
|---|---|
| Size | 14.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6f278f6d7299eb6c9f1605f767b4b4ffb5afdff5856d80faf4668a898f88d7cb
|
|
BLAKE2b-256 checksum How to use checksums |
2a54427ddd650b2adc4d675a7a3dbe284324ea9eab9ad56487c5268e90675aea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / aiohttp_msal-1.1.5-py3-none-any.whl
| Download URL | aiohttp_msal-1.1.5-py3-none-any.whl |
|---|---|
| Size | 17.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
65eeaaf86553825d07964dfc7a8e1eedb6e2b43925a69480e2670fc1d0ca5559
|
|
BLAKE2b-256 checksum How to use checksums |
9fa06d0642f5e7a51126e2a81111af84643c6089053773f61b37ced366348fb1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
