aiohttp-msal 0.6.4__py3-none-any.whl → 0.6.6__py3-none-any.whl

aiohttp_msal/__init__.py

@@ -8,12 +8,12 @@ from aiohttp import ClientSession, web
 from aiohttp_session import get_session
 from aiohttp_session import setup as _setup
 
-from .msal_async import AsyncMSAL
-from .settings import ENV
+from aiohttp_msal.msal_async import AsyncMSAL
+from aiohttp_msal.settings import ENV
 
 _LOGGER = logging.getLogger(__name__)
 
-VERSION = "0.6.4"
+VERSION = "0.6.6"
 
 
 def msal_session(*args: Callable[[AsyncMSAL], Union[Any, Awaitable[Any]]]) -> Callable:

aiohttp_msal/msal_async.py

@@ -14,7 +14,7 @@ from aiohttp.client import ClientResponse, ClientSession, _RequestContextManager
 from aiohttp_session import Session
 from msal import ConfidentialClientApplication, SerializableTokenCache
 
-from .settings import ENV
+from aiohttp_msal.settings import ENV
 
 HTTP_GET = "get"
 HTTP_POST = "post"
@@ -23,7 +23,7 @@ HTTP_PATCH = "patch"
 HTTP_DELETE = "delete"
 HTTP_ALLOWED = [HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_PATCH, HTTP_DELETE]
 
-MY_SCOPE = ["User.Read", "User.Read.All"]
+DEFAULT_SCOPES = ["User.Read", "User.Read.All"]
 
 
 def async_wrap(func: Callable) -> Callable:
@@ -148,12 +148,14 @@ class AsyncMSAL:
             if hasattr(self, "save_token_cache"):
                 self.save_token_cache(self.token_cache)
 
-    def build_auth_code_flow(self, redirect_uri: str) -> str:
+    def build_auth_code_flow(
+        self, redirect_uri: str, scopes: Optional[list[str]] = None
+    ) -> str:
         """First step - Start the flow."""
         self.session[TOKEN_CACHE] = None  # type: ignore
         self.session[USER_EMAIL] = None  # type: ignore
         self.session[FLOW_CACHE] = res = self.app.initiate_auth_code_flow(
-            MY_SCOPE,
+            scopes or DEFAULT_SCOPES,
             redirect_uri=redirect_uri,
             response_mode="form_post"
             # max_age=1209600,
@@ -183,11 +185,13 @@ class AsyncMSAL:
             None, self.acquire_token_by_auth_code_flow, auth_response
         )
 
-    def get_token(self) -> Optional[dict[str, Any]]:
+    def get_token(self, scopes: Optional[list[str]] = None) -> Optional[dict[str, Any]]:
         """Acquire a token based on username."""
         accounts = self.app.get_accounts()
         if accounts:
-            result = self.app.acquire_token_silent(scopes=MY_SCOPE, account=accounts[0])
+            result = self.app.acquire_token_silent(
+                scopes=scopes or DEFAULT_SCOPES, account=accounts[0]
+            )
             self._save_token_cache()
             return result
         return None

aiohttp_msal/redis_tools.py

@@ -42,10 +42,13 @@ async def session_iter(
     match: Filter based on session content (i.e. mail/name)
     key_match: Filter the Redis keys. Defaults to ENV.cookie_name
     """
+    if match and not all(isinstance(v, str) for v in match.values()):
+        raise ValueError("match values must be strings")
     async for key in redis.scan_iter(
         count=100, match=key_match or f"{ENV.COOKIE_NAME}*"
     ):
         sval = await redis.get(key)
+        _LOGGER.debug("Session: %s = %s", key, sval)
         created, ses = 0, {}
         try:
             val = json.loads(sval)  # type: ignore
@@ -55,7 +58,12 @@ async def session_iter(
             pass
         if match:
             # Ensure we match all the supplied terms
-            if not all(k in ses and v in ses[k] for k, v in match.items()):
+            matches = 0
+            for mkey, mval in match.items():
+                if not (isinstance(ses.get(mkey), str) and mval in ses[mkey]):
+                    break
+                matches += 1
+            if matches != len(match):
                 continue
         yield key, created, ses
 

aiohttp_msal/routes.py

@@ -7,19 +7,16 @@ from urllib.parse import urljoin
 from aiohttp import web
 from aiohttp_session import get_session, new_session
 
+from aiohttp_msal import _LOGGER, ENV, authenticated, msal_session
+from aiohttp_msal.msal_async import FLOW_CACHE, AsyncMSAL
 from aiohttp_msal.user_info import get_manager_info, get_user_info
 
-from . import _LOGGER, ENV, authenticated, msal_session
-from .msal_async import FLOW_CACHE, AsyncMSAL
-
 ROUTES = web.RouteTableDef()
 
 URI_USER_LOGIN = "/user/login"
 URI_USER_AUTHORIZED = "/user/authorized"
 SESSION_REDIRECT = "redirect"
 
-# ic.disable()  # remove debug prints
-
 
 def get_route(request: web.Request, url: str) -> str:
     """Retrieve server route from request.
@@ -70,14 +67,12 @@ async def user_authorized(request: web.Request) -> web.Response:
         )
 
     if not request.cookies.get(ENV.COOKIE_NAME):
-        # ic(request.cookies.keys())
         cookies = dict(request.cookies.items())
         msg.append(f"<b>Expecting '{ENV.COOKIE_NAME}' in cookies</b>")
         _LOGGER.fatal("Cookie should be set with Samesite:None")
         msg.append(html_table(cookies))
 
     elif not session.get(FLOW_CACHE):
-        # ic(session)
         msg.append(f"<b>Expecting '{FLOW_CACHE}' in session</b>")
         msg.append(f"- Session.new: {session.new}")
         msg.append(html_table(session))
@@ -145,7 +140,6 @@ async def user_debug(request: web.Request) -> web.Response:
             "X-Forw-For IP": request.headers.get("X-Forwarded-For", ""),
         },
     }
-    # ic(debug)
     session["debug_previous"] = time.time()
     return web.json_response(debug)
 

aiohttp_msal/settings.py

@@ -1,7 +1,7 @@
 """Settings."""
 from typing import Any, Awaitable, Callable, Union
 
-from .settings_base import SettingsBase, Var
+from aiohttp_msal.settings_base import SettingsBase, Var
 
 
 class MSALSettings(SettingsBase):

aiohttp_msal/user_info.py

@@ -3,7 +3,7 @@ import asyncio
 from functools import wraps
 from typing import Any, Callable
 
-from .msal_async import AsyncMSAL
+from aiohttp_msal.msal_async import AsyncMSAL
 
 
 def retry(func: Callable) -> Callable:

{aiohttp_msal-0.6.4.dist-info → aiohttp_msal-0.6.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aiohttp-msal
-Version: 0.6.4
+Version: 0.6.6
 Summary: Helper Library to use the Microsoft Authentication Library (MSAL) with aiohttp
 Home-page: https://github.com/kellerza/aiohttp_msal
 Author: Johann Kellerman

aiohttp_msal-0.6.6.dist-info/RECORD

@@ -0,0 +1,18 @@
+aiohttp_msal/__init__.py,sha256=R-OEq-FJnT_uYiiSYeltrUqTSnPTcFqR8SKSbVszues,3025
+aiohttp_msal/msal_async.py,sha256=HjLJ5gOengQNjuN1Nod1U7J4sqChTN_B4QuXjVJkheA,9964
+aiohttp_msal/redis_tools.py,sha256=3Zyl3-sdT_SgxACdWeeBtWGywBzwyF9Ekm9CC2oCb90,4082
+aiohttp_msal/routes.py,sha256=UmUQkFFubFK2N1IAryDPwN7UBMCgow87H6zhNbKiE1I,8227
+aiohttp_msal/settings.py,sha256=Nz0GO62IMtQdfdZqJ8o8w331i1sxfGuaIo4j533u4NM,1243
+aiohttp_msal/settings_base.py,sha256=pmVmzTtaGEgRh-AMGy0HdhF1JvoZhZp42G3PL_ILHLw,2892
+aiohttp_msal/user_info.py,sha256=02DYVbP8lnLNCm1HQEGZY7tktWRHvEAuHf6fLj2Kcp8,1765
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_init.py,sha256=sHmt7yNDlcu5JHrpM_gim0NeLce0NwUAMM3HAdGoo58,75
+tests/test_msal_async.py,sha256=Vi2Jx8_GG-iMfKPY4UCvmX-0U1Bl2xswrAyWGIRP-Ac,364
+tests/test_redis_tools.py,sha256=x9Yd9WOGd2ZW5fJwyiAta5wMRkSM3prsCPhkVe6CS3Q,1868
+tests/test_settings.py,sha256=z-qtUs1zl5Q9NEux051eebyPnArLZ_OfZu65FKz0N4Y,333
+aiohttp_msal-0.6.6.dist-info/LICENSE,sha256=H1aGfkSfZFwK3q4INn9mUldOJGZy-ZXu5-65K9Glunw,1080
+aiohttp_msal-0.6.6.dist-info/METADATA,sha256=XDKJEJXQkOyLveVhob8NukGwprF14ZRLX_geNu8rJm4,4565
+aiohttp_msal-0.6.6.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+aiohttp_msal-0.6.6.dist-info/top_level.txt,sha256=QPWOi5JtacVEdbaU5bJExc9o-cCT2Lufx0QhUpsv5_E,19
+aiohttp_msal-0.6.6.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+aiohttp_msal-0.6.6.dist-info/RECORD,,

tests/test_msal_async.py

@@ -1,3 +1,4 @@
+"""Test the AsyncMSAL class."""
 from aiohttp_msal.msal_async import AsyncMSAL, Session
 
 

tests/test_redis_tools.py

@@ -0,0 +1,59 @@
+"""Test redis tools."""
+from json import dumps
+from typing import AsyncGenerator
+from unittest.mock import AsyncMock, MagicMock, Mock, call
+
+import pytest
+
+from aiohttp_msal.redis_tools import Redis, session_iter
+
+
+@pytest.fixture
+def redis() -> Redis:
+    """Get a redis Mock instance."""
+    testdata = {
+        "a": dumps({"created": 1, "session": {"key": "a", "a": 1, "b": "2a"}}),
+        "b": dumps({"created": 2, "session": {"key": "b", "a": 1, "b": "2b"}}),
+        "c": dumps({"created": 3, "session": {"key": "c", "a": 5, "b": "6c"}}),
+    }
+
+    async def scan_iter(*, count: int, match: str) -> AsyncGenerator[str, None]:
+        """Mock keys."""
+        assert count == 100
+        assert match == "a*"
+        for key in testdata:
+            yield key
+
+    red = Mock()
+    red.scan_iter = MagicMock(side_effect=scan_iter)
+    red.get = AsyncMock(side_effect=list(testdata.values()))
+    return red
+
+
+@pytest.mark.asyncio
+async def test_session_iter_fail(redis: Redis) -> None:
+    """Test session iter."""
+    match = {"a": 1}
+    with pytest.raises(ValueError):
+        async for _ in session_iter(redis, match=match, key_match="a*"):
+            pass
+
+    match = {"a": "1"}
+    async for _ in session_iter(redis, match=match, key_match="a*"):
+        assert False, "no match expected"
+
+
+@pytest.mark.asyncio
+async def test_session_iter(redis: Redis) -> None:
+    """Test session iter."""
+    match = {"b": "2"}
+    expected = ["a", "b"]
+    async for key, created, ses in session_iter(redis, match=match, key_match="a*"):
+        assert expected.pop(0) == key
+        assert key == ses["key"]
+        assert created in (1, 2)
+        assert key in ("a", "b")
+
+    assert redis.scan_iter.call_args[1]["match"] == "a*"
+    assert redis.scan_iter.call_args[1]["count"] == 100
+    assert redis.scan_iter.call_args_list == [call(count=100, match="a*")]

aiohttp_msal-0.6.4.dist-info/RECORD

@@ -1,17 +0,0 @@
-aiohttp_msal/__init__.py,sha256=78mjldM51U-GlDF4XnAqMJKEsUveWQSknwKPazzXv3o,3001
-aiohttp_msal/msal_async.py,sha256=lyiNFS8iJpg2WTwOz7ogmrTwN3WYaRQXos9hYiPLLwI,9798
-aiohttp_msal/redis_tools.py,sha256=eEYGJTCWtpyBvmI7IAs2jInypsyzbQP_RAVQnAyRgtE,3737
-aiohttp_msal/routes.py,sha256=c-w5wHaLAYGEqZvfZ8PnzzRh60asLqdUa30lvSANdYM,8319
-aiohttp_msal/settings.py,sha256=ZZn7D6QmIyQSvuqCAoTacKRXYfopqK4P74eVdPCw-uI,1231
-aiohttp_msal/settings_base.py,sha256=pmVmzTtaGEgRh-AMGy0HdhF1JvoZhZp42G3PL_ILHLw,2892
-aiohttp_msal/user_info.py,sha256=oIu90lgi71G27MVkw4pGH8wZqjXk8kxmW0fn2LKxOHc,1753
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_init.py,sha256=sHmt7yNDlcu5JHrpM_gim0NeLce0NwUAMM3HAdGoo58,75
-tests/test_msal_async.py,sha256=31MCoAbUiyUhc4SkebUKpjLDHozEBko-QgEBSHjfSoM,332
-tests/test_settings.py,sha256=z-qtUs1zl5Q9NEux051eebyPnArLZ_OfZu65FKz0N4Y,333
-aiohttp_msal-0.6.4.dist-info/LICENSE,sha256=H1aGfkSfZFwK3q4INn9mUldOJGZy-ZXu5-65K9Glunw,1080
-aiohttp_msal-0.6.4.dist-info/METADATA,sha256=67u7FqAWttPQktDdb20TQyxIsv-zDEXcmOFmdDILcmk,4565
-aiohttp_msal-0.6.4.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-aiohttp_msal-0.6.4.dist-info/top_level.txt,sha256=QPWOi5JtacVEdbaU5bJExc9o-cCT2Lufx0QhUpsv5_E,19
-aiohttp_msal-0.6.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-aiohttp_msal-0.6.4.dist-info/RECORD,,