microsoft-agents-authentication-msal 0.9.0.dev6__tar.gz → 0.9.0.dev7__tar.gz

{microsoft_agents_authentication_msal-0.9.0.dev6 → microsoft_agents_authentication_msal-0.9.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-authentication-msal
-Version: 0.9.0.dev6
+Version: 0.9.0.dev7
 Summary: A msal-based authentication library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: microsoft-agents-hosting-core==0.9.0.dev6
+Requires-Dist: microsoft-agents-hosting-core==0.9.0.dev7
 Requires-Dist: msal>=1.34.0
 Requires-Dist: requests>=2.32.3
 Dynamic: license-file

microsoft_agents_authentication_msal-0.9.0.dev7/VERSION.txt

@@ -0,0 +1 @@
+0.9.0.dev7

{microsoft_agents_authentication_msal-0.9.0.dev6 → microsoft_agents_authentication_msal-0.9.0.dev7}/microsoft_agents/authentication/msal/msal_auth.py

@@ -25,6 +25,7 @@ from microsoft_agents.hosting.core import (
     AccessTokenProviderBase,
     AgentAuthConfiguration,
 )
+from microsoft_agents.hosting.core.authorization.telemetry import spans
 from microsoft_agents.authentication.msal.errors import authentication_errors
 
 logger = logging.getLogger(__name__)
@@ -65,40 +66,48 @@ class MsalAuth(AccessTokenProviderBase):
     async def get_access_token(
         self, resource_url: str, scopes: list[str], force_refresh: bool = False
     ) -> str:
-        logger.debug(
-            f"Requesting access token for resource: {resource_url}, scopes: {scopes}"
-        )
-        valid_uri, instance_uri = self._uri_validator(resource_url)
-        if not valid_uri:
-            raise ValueError(str(authentication_errors.InvalidInstanceUrl))
-        assert instance_uri is not None  # for mypy
-
-        local_scopes = self._resolve_scopes_list(instance_uri, scopes)
-        msal_auth_client = self._get_client()
-
-        if isinstance(msal_auth_client, ManagedIdentityClient):
-            logger.info("Acquiring token using Managed Identity Client.")
-            auth_result_payload = await _async_acquire_token_for_client(
-                msal_auth_client, resource=resource_url
-            )
-        elif isinstance(msal_auth_client, ConfidentialClientApplication):
-            logger.info("Acquiring token using Confidential Client Application.")
-            auth_result_payload = await _async_acquire_token_for_client(
-                msal_auth_client, scopes=local_scopes
+        with spans.GetAccessToken(
+            scopes,
+            self._msal_configuration.AUTH_TYPE,
+        ):
+            logger.debug(
+                f"Requesting access token for resource: {resource_url}, scopes: {scopes}"
             )
-        else:
-            auth_result_payload = None
-
-        res = auth_result_payload.get("access_token") if auth_result_payload else None
-        if not res:
-            logger.error("Failed to acquire token for resource %s", auth_result_payload)
-            raise ValueError(
-                authentication_errors.FailedToAcquireToken.format(
-                    str(auth_result_payload)
+            valid_uri, instance_uri = self._uri_validator(resource_url)
+            if not valid_uri:
+                raise ValueError(str(authentication_errors.InvalidInstanceUrl))
+            assert instance_uri is not None  # for mypy
+
+            local_scopes = self._resolve_scopes_list(instance_uri, scopes)
+            msal_auth_client = self._get_client()
+
+            if isinstance(msal_auth_client, ManagedIdentityClient):
+                logger.info("Acquiring token using Managed Identity Client.")
+                auth_result_payload = await _async_acquire_token_for_client(
+                    msal_auth_client, resource=resource_url
+                )
+            elif isinstance(msal_auth_client, ConfidentialClientApplication):
+                logger.info("Acquiring token using Confidential Client Application.")
+                auth_result_payload = await _async_acquire_token_for_client(
+                    msal_auth_client, scopes=local_scopes
                 )
+            else:
+                auth_result_payload = None
+
+            res = (
+                auth_result_payload.get("access_token") if auth_result_payload else None
             )
+            if not res:
+                logger.error(
+                    "Failed to acquire token for resource %s", auth_result_payload
+                )
+                raise ValueError(
+                    authentication_errors.FailedToAcquireToken.format(
+                        str(auth_result_payload)
+                    )
+                )
 
-        return res
+            return res
 
     async def acquire_token_on_behalf_of(
         self, scopes: list[str], user_assertion: str
@@ -109,44 +118,44 @@ class MsalAuth(AccessTokenProviderBase):
         :param user_assertion: The user assertion token.
         :return: The access token as a string.
         """
-
-        msal_auth_client = self._get_client()
-        if isinstance(msal_auth_client, ManagedIdentityClient):
-            logger.error(
-                "Attempted on-behalf-of flow with Managed Identity authentication."
-            )
-            raise NotImplementedError(
-                str(authentication_errors.OnBehalfOfFlowNotSupportedManagedIdentity)
-            )
-        elif isinstance(msal_auth_client, ConfidentialClientApplication):
-            # TODO: Handling token error / acquisition failed
-
-            # MSAL in Python does not support async, so we use asyncio.to_thread to run it in
-            # a separate thread and avoid blocking the event loop
-            token = await asyncio.to_thread(
-                lambda: msal_auth_client.acquire_token_on_behalf_of(
-                    scopes=scopes, user_assertion=user_assertion
-                )
-            )
-
-            if "access_token" not in token:
+        with spans.AcquireTokenOnBehalfOf(scopes):
+            msal_auth_client = self._get_client()
+            if isinstance(msal_auth_client, ManagedIdentityClient):
                 logger.error(
-                    f"Failed to acquire token on behalf of user: {user_assertion}"
+                    "Attempted on-behalf-of flow with Managed Identity authentication."
                 )
-                raise ValueError(
-                    authentication_errors.FailedToAcquireToken.format(str(token))
+                raise NotImplementedError(
+                    str(authentication_errors.OnBehalfOfFlowNotSupportedManagedIdentity)
+                )
+            elif isinstance(msal_auth_client, ConfidentialClientApplication):
+                # TODO: Handling token error / acquisition failed
+
+                # MSAL in Python does not support async, so we use asyncio.to_thread to run it in
+                # a separate thread and avoid blocking the event loop
+                token = await asyncio.to_thread(
+                    lambda: msal_auth_client.acquire_token_on_behalf_of(
+                        scopes=scopes, user_assertion=user_assertion
+                    )
                 )
 
-            return token["access_token"]
+                if "access_token" not in token:
+                    logger.error(
+                        f"Failed to acquire token on behalf of user: {user_assertion}"
+                    )
+                    raise ValueError(
+                        authentication_errors.FailedToAcquireToken.format(str(token))
+                    )
 
-        logger.error(
-            f"On-behalf-of flow is not supported with the current authentication type: {msal_auth_client.__class__.__name__}"
-        )
-        raise NotImplementedError(
-            authentication_errors.OnBehalfOfFlowNotSupportedAuthType.format(
-                msal_auth_client.__class__.__name__
+                return token["access_token"]
+
+            logger.error(
+                f"On-behalf-of flow is not supported with the current authentication type: {msal_auth_client.__class__.__name__}"
+            )
+            raise NotImplementedError(
+                authentication_errors.OnBehalfOfFlowNotSupportedAuthType.format(
+                    msal_auth_client.__class__.__name__
+                )
             )
-        )
 
     @staticmethod
     def _resolve_authority(
@@ -318,78 +327,80 @@ class MsalAuth(AccessTokenProviderBase):
         :return: A tuple containing the agentic instance token and the agent application token.
         :rtype: tuple[str, str]
         """
-
         if not agent_app_instance_id:
             raise ValueError(
                 str(authentication_errors.AgentApplicationInstanceIdRequired)
             )
 
-        logger.info(
-            "Attempting to get agentic instance token from agent_app_instance_id %s",
-            agent_app_instance_id,
-        )
-        agent_token_result = await self.get_agentic_application_token(
-            tenant_id, agent_app_instance_id
-        )
+        with spans.GetAgenticInstanceToken(agent_app_instance_id):
 
-        if not agent_token_result:
-            logger.error(
-                "Failed to acquire agentic instance token or agent token for agent_app_instance_id %s",
+            logger.info(
+                "Attempting to get agentic instance token from agent_app_instance_id %s",
                 agent_app_instance_id,
             )
-            raise Exception(
-                authentication_errors.FailedToAcquireAgenticInstanceToken.format(
-                    agent_app_instance_id
-                )
+            agent_token_result = await self.get_agentic_application_token(
+                tenant_id, agent_app_instance_id
             )
 
-        authority = MsalAuth._resolve_authority(self._msal_configuration, tenant_id)
+            if not agent_token_result:
+                logger.error(
+                    "Failed to acquire agentic instance token or agent token for agent_app_instance_id %s",
+                    agent_app_instance_id,
+                )
+                raise Exception(
+                    authentication_errors.FailedToAcquireAgenticInstanceToken.format(
+                        agent_app_instance_id
+                    )
+                )
 
-        instance_app = ConfidentialClientApplication(
-            client_id=agent_app_instance_id,
-            authority=authority,
-            client_credential={"client_assertion": agent_token_result},
-            # token_cache=self._token_cache,
-        )
+            authority = MsalAuth._resolve_authority(self._msal_configuration, tenant_id)
 
-        agentic_instance_token = await _async_acquire_token_for_client(
-            instance_app, ["api://AzureAdTokenExchange/.default"]
-        )
+            instance_app = ConfidentialClientApplication(
+                client_id=agent_app_instance_id,
+                authority=authority,
+                client_credential={"client_assertion": agent_token_result},
+                # token_cache=self._token_cache,
+            )
 
-        if not agentic_instance_token:
-            logger.error(
-                "Failed to acquire agentic instance token or agent token for agent_app_instance_id %s",
-                agent_app_instance_id,
+            agentic_instance_token = await _async_acquire_token_for_client(
+                instance_app, ["api://AzureAdTokenExchange/.default"]
             )
-            raise Exception(
-                authentication_errors.FailedToAcquireAgenticInstanceToken.format(
-                    agent_app_instance_id
+
+            if not agentic_instance_token:
+                logger.error(
+                    "Failed to acquire agentic instance token or agent token for agent_app_instance_id %s",
+                    agent_app_instance_id,
+                )
+                raise Exception(
+                    authentication_errors.FailedToAcquireAgenticInstanceToken.format(
+                        agent_app_instance_id
+                    )
                 )
-            )
 
-        # future scenario where we don't know the blueprint id upfront
+            # future scenario where we don't know the blueprint id upfront
 
-        token = agentic_instance_token.get("access_token")
-        if not token:
-            logger.error(
-                "Failed to acquire agentic instance token, %s", agentic_instance_token
-            )
-            raise ValueError(
-                authentication_errors.FailedToAcquireToken.format(
-                    str(agentic_instance_token)
+            token = agentic_instance_token.get("access_token")
+            if not token:
+                logger.error(
+                    "Failed to acquire agentic instance token, %s",
+                    agentic_instance_token,
                 )
-            )
-
-        logger.debug(
-            "Agentic blueprint id: %s",
-            _DeferredString(
-                lambda: jwt.decode(token, options={"verify_signature": False}).get(
-                    "xms_par_app_azp"
+                raise ValueError(
+                    authentication_errors.FailedToAcquireToken.format(
+                        str(agentic_instance_token)
+                    )
                 )
-            ),
-        )
 
-        return agentic_instance_token["access_token"], agent_token_result
+            logger.debug(
+                "Agentic blueprint id: %s",
+                _DeferredString(
+                    lambda: jwt.decode(token, options={"verify_signature": False}).get(
+                        "xms_par_app_azp"
+                    )
+                ),
+            )
+
+            return agentic_instance_token["access_token"], agent_token_result
 
     async def get_agentic_user_token(
         self,
@@ -414,71 +425,73 @@ class MsalAuth(AccessTokenProviderBase):
                 str(authentication_errors.AgentApplicationInstanceIdAndUserIdRequired)
             )
 
-        logger.info(
-            "Attempting to get agentic user token from agent_app_instance_id %s and agentic_user_id %s",
-            agent_app_instance_id,
-            agentic_user_id,
-        )
-        instance_token, agent_token = await self.get_agentic_instance_token(
-            tenant_id, agent_app_instance_id
-        )
+        with spans.GetAgenticUserToken(agent_app_instance_id, agentic_user_id, scopes):
 
-        if not instance_token or not agent_token:
-            logger.error(
-                "Failed to acquire instance token or agent token for agent_app_instance_id %s and agentic_user_id %s",
+            logger.info(
+                "Attempting to get agentic user token from agent_app_instance_id %s and agentic_user_id %s",
                 agent_app_instance_id,
                 agentic_user_id,
             )
-            raise Exception(
-                authentication_errors.FailedToAcquireInstanceOrAgentToken.format(
-                    agent_app_instance_id, agentic_user_id
-                )
+            instance_token, agent_token = await self.get_agentic_instance_token(
+                tenant_id, agent_app_instance_id
             )
 
-        authority = MsalAuth._resolve_authority(self._msal_configuration, tenant_id)
-
-        instance_app = ConfidentialClientApplication(
-            client_id=agent_app_instance_id,
-            authority=authority,
-            client_credential={"client_assertion": agent_token},
-            # token_cache=self._token_cache,
-        )
+            if not instance_token or not agent_token:
+                logger.error(
+                    "Failed to acquire instance token or agent token for agent_app_instance_id %s and agentic_user_id %s",
+                    agent_app_instance_id,
+                    agentic_user_id,
+                )
+                raise Exception(
+                    authentication_errors.FailedToAcquireInstanceOrAgentToken.format(
+                        agent_app_instance_id, agentic_user_id
+                    )
+                )
 
-        logger.info(
-            "Acquiring agentic user token for agent_app_instance_id %s and agentic_user_id %s",
-            agent_app_instance_id,
-            agentic_user_id,
-        )
-        # MSAL in Python does not support async, so we use asyncio.to_thread to run it in
-        # a separate thread and avoid blocking the event loop
-        auth_result_payload = await _async_acquire_token_for_client(
-            instance_app,
-            scopes,
-            data={
-                "user_id": agentic_user_id,
-                "user_federated_identity_credential": instance_token,
-                "grant_type": "user_fic",
-            },
-        )
+            authority = MsalAuth._resolve_authority(self._msal_configuration, tenant_id)
 
-        if not auth_result_payload:
-            logger.error(
-                "Failed to acquire agentic user token for agent_app_instance_id %s and agentic_user_id %s, %s",
-                agent_app_instance_id,
-                agentic_user_id,
-                auth_result_payload,
+            instance_app = ConfidentialClientApplication(
+                client_id=agent_app_instance_id,
+                authority=authority,
+                client_credential={"client_assertion": agent_token},
+                # token_cache=self._token_cache,
             )
-            return None
 
-        access_token = auth_result_payload.get("access_token")
-        if not access_token:
-            logger.error(
-                "Failed to acquire agentic user token for agent_app_instance_id %s and agentic_user_id %s, %s",
+            logger.info(
+                "Acquiring agentic user token for agent_app_instance_id %s and agentic_user_id %s",
                 agent_app_instance_id,
                 agentic_user_id,
-                auth_result_payload,
             )
-            return None
+            # MSAL in Python does not support async, so we use asyncio.to_thread to run it in
+            # a separate thread and avoid blocking the event loop
+            auth_result_payload = await _async_acquire_token_for_client(
+                instance_app,
+                scopes,
+                data={
+                    "user_id": agentic_user_id,
+                    "user_federated_identity_credential": instance_token,
+                    "grant_type": "user_fic",
+                },
+            )
+
+            if not auth_result_payload:
+                logger.error(
+                    "Failed to acquire agentic user token for agent_app_instance_id %s and agentic_user_id %s, %s",
+                    agent_app_instance_id,
+                    agentic_user_id,
+                    auth_result_payload,
+                )
+                return None
+
+            access_token = auth_result_payload.get("access_token")
+            if not access_token:
+                logger.error(
+                    "Failed to acquire agentic user token for agent_app_instance_id %s and agentic_user_id %s, %s",
+                    agent_app_instance_id,
+                    agentic_user_id,
+                    auth_result_payload,
+                )
+                return None
 
-        logger.info("Acquired agentic user token response.")
-        return access_token
+            logger.info("Acquired agentic user token response.")
+            return access_token

{microsoft_agents_authentication_msal-0.9.0.dev6 → microsoft_agents_authentication_msal-0.9.0.dev7}/microsoft_agents_authentication_msal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-authentication-msal
-Version: 0.9.0.dev6
+Version: 0.9.0.dev7
 Summary: A msal-based authentication library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: microsoft-agents-hosting-core==0.9.0.dev6
+Requires-Dist: microsoft-agents-hosting-core==0.9.0.dev7
 Requires-Dist: msal>=1.34.0
 Requires-Dist: requests>=2.32.3
 Dynamic: license-file

microsoft_agents_authentication_msal-0.9.0.dev7/microsoft_agents_authentication_msal.egg-info/requires.txt

@@ -0,0 +1,3 @@
+microsoft-agents-hosting-core==0.9.0.dev7
+msal>=1.34.0
+requests>=2.32.3

microsoft_agents_authentication_msal-0.9.0.dev6/VERSION.txt

@@ -1 +0,0 @@
-0.9.0.dev6

microsoft_agents_authentication_msal-0.9.0.dev6/microsoft_agents_authentication_msal.egg-info/requires.txt

@@ -1,3 +0,0 @@
-microsoft-agents-hosting-core==0.9.0.dev6
-msal>=1.34.0
-requests>=2.32.3