microsoft-agents-hosting-core 1.6.1.dev3__tar.gz → 1.6.1.dev6__tar.gz

{microsoft_agents_hosting_core-1.6.1.dev3/microsoft_agents_hosting_core.egg-info → microsoft_agents_hosting_core-1.6.1.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 1.6.1.dev3
+Version: 1.6.1.dev6
 Summary: Core 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-activity==1.6.1.dev3
+Requires-Dist: microsoft-agents-activity==1.6.1.dev6
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: python-dotenv>=1.1.1
@@ -23,6 +23,7 @@ Requires-Dist: opentelemetry-api>=1.27.0
 Requires-Dist: opentelemetry-sdk>=1.27.0
 Requires-Dist: aiohttp>=3.11.11
 Requires-Dist: yarl<2.0,>=1.17.0
+Requires-Dist: azure-core
 Dynamic: license-file
 Dynamic: requires-dist
 

microsoft_agents_hosting_core-1.6.1.dev6/VERSION.txt

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

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/microsoft_agents/hosting/core/app/oauth/authorization.py

@@ -7,6 +7,8 @@ import logging
 from typing import Optional, Callable, Awaitable, cast
 from dataclasses import dataclass
 
+from azure.core.credentials_async import AsyncTokenCredential
+
 from microsoft_agents.activity import (
     Activity,
     Channels,
@@ -16,6 +18,10 @@ from microsoft_agents.activity import (
 )
 from microsoft_agents.activity.activity_types import ActivityTypes
 
+from microsoft_agents.hosting.core.authorization._helpers import (
+    _CallableTokenCredential,
+)
+
 from ...turn_context import TurnContext
 from ...storage import Storage
 from ...authorization import Connections
@@ -60,7 +66,7 @@ class Authorization:
         self,
         storage: Storage,
         connection_manager: Connections,
-        auth_handlers: Optional[dict[str, AuthHandler]] = None,
+        auth_handlers: dict[str, AuthHandler] | None = None,
         auto_sign_in: bool = False,
         use_cache: bool = False,
         **kwargs,
@@ -86,10 +92,10 @@ class Authorization:
         self._connection_manager = connection_manager
 
         self._sign_in_success_handler: Optional[
-            Callable[[TurnContext, TurnState, Optional[str]], Awaitable[None]]
+            Callable[[TurnContext, TurnState, str | None], Awaitable[None]]
         ] = None
         self._sign_in_failure_handler: Optional[
-            Callable[[TurnContext, TurnState, Optional[str]], Awaitable[None]]
+            Callable[[TurnContext, TurnState, str | None], Awaitable[None]]
         ] = None
 
         self._handlers = {}
@@ -165,13 +171,13 @@ class Authorization:
         """
         return f"auth:_SignInState:{context.activity.channel_id}:{context.activity.from_property.id}"
 
-    async def _load_sign_in_state(self, context: TurnContext) -> Optional[_SignInState]:
+    async def _load_sign_in_state(self, context: TurnContext) -> _SignInState | None:
         """Load the sign-in state from storage for the given context.
 
         :param context: The turn context for the current turn of conversation.
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :return: The sign-in state if found, None otherwise.
-        :rtype: Optional[:class:`microsoft_agents.hosting.core.app.oauth._sign_in_state._SignInState`]
+        :rtype: :class:`microsoft_agents.hosting.core.app.oauth._sign_in_state._SignInState` | None
         """
         key = self._sign_in_state_key(context)
         return (await self._storage.read([key], target_cls=_SignInState)).get(key)
@@ -205,9 +211,9 @@ class Authorization:
     @staticmethod
     def _get_cached_token(
         context: TurnContext, handler_id: str
-    ) -> Optional[TokenResponse]:
+    ) -> TokenResponse | None:
         key = Authorization._cache_key(context, handler_id)
-        return cast(Optional[TokenResponse], context.turn_state.get(key))
+        return cast(TokenResponse | None, context.turn_state.get(key))
 
     @staticmethod
     def _cache_token(
@@ -241,7 +247,7 @@ class Authorization:
         self,
         context: TurnContext,
         state: TurnState,
-        auth_handler_id: Optional[str] = None,
+        auth_handler_id: str | None = None,
     ) -> _SignInResponse:
         """Start or continue the sign-in process for the user with the given auth handler.
 
@@ -303,14 +309,14 @@ class Authorization:
         return sign_in_response
 
     async def sign_out(
-        self, context: TurnContext, auth_handler_id: Optional[str] = None
+        self, context: TurnContext, auth_handler_id: str | None = None
     ) -> None:
         """Attempts to sign out the user from a specified auth handler or the default handler.
 
         :param context: The turn context for the current turn of conversation.
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param auth_handler_id: The ID of the auth handler to sign out from. If None, sign out from all handlers.
-        :type auth_handler_id: Optional[str]
+        :type auth_handler_id: str | None
         :return: None
         """
         auth_handler_id = auth_handler_id or self._default_handler_id
@@ -372,7 +378,9 @@ class Authorization:
         )
 
     async def get_token(
-        self, context: TurnContext, auth_handler_id: Optional[str] = None
+        self,
+        context: TurnContext,
+        auth_handler_id: str | None = None,
     ) -> TokenResponse:
         """Gets the token for a specific auth handler or the default handler.
 
@@ -387,12 +395,34 @@ class Authorization:
         """
         return await self.exchange_token(context, auth_handler_id=auth_handler_id)
 
+    def get_token_as_token_credential(
+        self,
+        context: TurnContext,
+        auth_handler_id: str | None = None,
+    ) -> AsyncTokenCredential:
+        """Gets the token as an AsyncTokenCredential for a specific auth handler or the default handler.
+
+        :param context: The context object for the current turn.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param auth_handler_id: The ID of the auth handler to get the token for.
+        :type auth_handler_id: str | None
+        :return: An AsyncTokenCredential for the specified auth handler or the default handler.
+        :rtype: :class:`azure.core.credentials_async.AsyncTokenCredential`
+        """
+
+        async def func(*scopes: str, **_kwargs) -> TokenResponse:
+            return await self.exchange_token(
+                context, auth_handler_id=auth_handler_id, scopes=list(scopes)
+            )
+
+        return _CallableTokenCredential(func)
+
     async def exchange_token(
         self,
         context: TurnContext,
-        scopes: Optional[list[str]] = None,
-        auth_handler_id: Optional[str] = None,
-        exchange_connection: Optional[str] = None,
+        scopes: list[str] | None = None,
+        auth_handler_id: str | None = None,
+        exchange_connection: str | None = None,
     ) -> TokenResponse:
         """Exchanges or refreshes the token for a specific auth handler or the default handler.
 
@@ -400,13 +430,13 @@ class Authorization:
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param scopes: The scopes to request during the token exchange or refresh. Defaults
             to the list given in the AuthHandler configuration if None.
-        :type scopes: Optional[list[str]]
+        :type scopes: list[str] | None
         :param auth_handler_id: The ID of the auth handler to exchange or refresh the token for.
             If None, the default handler will be used.
-        :type auth_handler_id: Optional[str]
+        :type auth_handler_id: str | None
         :param exchange_connection: The name of the connection to use for token exchange. If None,
             the connection defined in the AuthHandler configuration will be used.
-        :type exchange_connection: Optional[str]
+        :type exchange_connection: str | None
         :return: The token response from the OAuth provider.
         :rtype: :class:`microsoft_agents.activity.TokenResponse`
         :raises ValueError: If the specified auth handler ID is not recognized or not configured.
@@ -441,26 +471,63 @@ class Authorization:
                 return res
         return TokenResponse()
 
+    def exchange_token_as_token_credential(
+        self,
+        context: TurnContext,
+        scopes: list[str] | None = None,
+        auth_handler_id: str | None = None,
+        exchange_connection: str | None = None,
+    ) -> AsyncTokenCredential:
+        """Gets a token credential that exchanges or refreshes the token for a specific auth handler or the default handler.
+
+        :param context: The context object for the current turn.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param scopes: The scopes to request during the token exchange or refresh. Defaults
+            to the list given in the AuthHandler configuration if None.
+        :type scopes: list[str] | None
+        :param auth_handler_id: The ID of the auth handler to exchange or refresh the token for.
+            If None, the default handler will be used.
+        :type auth_handler_id: str | None
+        :param exchange_connection: The name of the connection to use for token exchange. If None,
+            the connection defined in the AuthHandler configuration will be used.
+        :type exchange_connection: str | None
+        :return: An instance of `AsyncTokenCredential`.
+        :rtype: :class:`azure.core.credentials_async.AsyncTokenCredential`
+        :raises ValueError: If the specified auth handler ID is not recognized or not configured.
+        """
+        scopes = list(scopes) if scopes is not None else []
+
+        async def func(*new_scopes: str, **_kwargs) -> TokenResponse:
+            all_scopes = list(dict.fromkeys([*scopes, *new_scopes]))
+            return await self.exchange_token(
+                context,
+                scopes=all_scopes,
+                auth_handler_id=auth_handler_id,
+                exchange_connection=exchange_connection,
+            )
+
+        return _CallableTokenCredential(func)
+
     def on_sign_in_success(
         self,
-        handler: Callable[[TurnContext, TurnState, Optional[str]], Awaitable[None]],
+        handler: Callable[[TurnContext, TurnState, str | None], Awaitable[None]],
     ) -> None:
         """
         Sets a handler to be called when sign-in is successfully completed.
 
         :param handler: The handler function to call on successful sign-in.
-        :type handler: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`, :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`, Optional[str]], Awaitable[None]]
+        :type handler: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`, :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`, str | None], Awaitable[None]]
         """
         self._sign_in_success_handler = handler
 
     def on_sign_in_failure(
         self,
-        handler: Callable[[TurnContext, TurnState, Optional[str]], Awaitable[None]],
+        handler: Callable[[TurnContext, TurnState, str | None], Awaitable[None]],
     ) -> None:
         """
         Sets a handler to be called when sign-in fails.
 
         :param handler: The handler function to call on sign-in failure.
-        :type handler: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`, :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`, Optional[str]], Awaitable[None]]
+        :type handler: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`, :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`, str | None], Awaitable[None]]
         """
         self._sign_in_failure_handler = handler

microsoft_agents_hosting_core-1.6.1.dev6/microsoft_agents/hosting/core/authorization/_helpers.py

@@ -0,0 +1,69 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import datetime
+from typing import Protocol
+
+from azure.core.credentials_async import AsyncTokenCredential
+from azure.core.credentials import AccessToken
+
+from microsoft_agents.activity import TokenResponse
+
+
+class _TokenRetrieverProtocol(Protocol):
+    async def __call__(
+        self, *scopes: str, **kwargs
+    ) -> TokenResponse | AccessToken | None: ...
+
+
+def _access_token_from_token_response(token_response: TokenResponse) -> AccessToken:
+    """Convert a `TokenResponse` to an `AccessToken`.
+
+    :param token_response: An instance of `TokenResponse` to convert.
+    :return: An instance of `AccessToken`.
+    """
+    if not token_response:
+        raise ValueError("Failed to retrieve token")
+
+    expires_on = int(
+        (
+            datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(minutes=5)
+        ).timestamp()
+    )
+    if token_response.expiration:
+        exp = token_response.expiration
+        if exp.endswith("Z"):
+            exp = exp[:-1] + "+00:00"
+        dt = datetime.datetime.fromisoformat(exp)
+        if dt.tzinfo is None:
+            dt = dt.replace(tzinfo=datetime.timezone.utc)
+        else:
+            dt = dt.astimezone(datetime.timezone.utc)
+        expires_on = int(dt.timestamp())
+
+    return AccessToken(token=token_response.token, expires_on=expires_on)
+
+
+class _CallableTokenCredential(AsyncTokenCredential):
+    """A wrapper class that implements `AsyncTokenCredential` using a callable to retrieve tokens."""
+
+    def __init__(self, get_token_callable: _TokenRetrieverProtocol):
+        """Initialize the `_CallableTokenCredential` with a token retriever callable.
+
+        :param get_token_callable: A callable that retrieves tokens.
+        """
+        self._get_token_callable = get_token_callable
+
+    async def get_token(self, *scopes: str, **kwargs) -> AccessToken:
+        """Get an access token using the provided callable.
+
+        :param scopes: The scopes for which the access token is requested.
+        :param kwargs: Additional keyword arguments to pass to the token retriever callable.
+        :return: An instance of `AccessToken`.
+        """
+        res = await self._get_token_callable(*scopes, **kwargs)
+        if not res:
+            raise ValueError("Failed to retrieve token")
+        if isinstance(res, AccessToken):
+            return res
+        return _access_token_from_token_response(res)

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/microsoft_agents/hosting/core/authorization/access_token_provider_base.py

@@ -4,6 +4,8 @@
 from typing import Protocol
 from abc import abstractmethod
 
+from azure.core.credentials_async import AsyncTokenCredential
+
 from .agent_auth_configuration import AgentAuthConfiguration
 
 
@@ -33,6 +35,15 @@ class AccessTokenProviderBase(Protocol):
         """
         pass
 
+    @abstractmethod
+    def get_token_credential(self) -> AsyncTokenCredential:
+        """
+        Get the token credential for the access token provider.
+
+        :return: The token credential.
+        """
+        pass
+
     async def acquire_token_on_behalf_of(
         self, scopes: list[str], user_assertion: str
     ) -> str:

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/microsoft_agents/hosting/core/authorization/agent_auth_configuration.py

@@ -25,6 +25,7 @@ _RECOGNIZED_CONFIG_KEYS = frozenset(
         "TENANTID",
         "CLIENTSECRET",
         "CERTPFXFILE",
+        "SENDX5C",
         "CONNECTIONNAME",
         "FEDERATEDCLIENTID",
         "FEDERATEDTOKENFILE",
@@ -63,6 +64,7 @@ class AgentAuthConfiguration:
     AUTH_TYPE: The type of authentication to use (microsoft_agents.hosting.core.authorization.auth_types.AuthTypes).
     CLIENT_SECRET: The client secret for the Azure AD application (if using client secret authentication).
     CERT_PFX_FILE: The path to the PFX certificate file (if using certificate authentication).
+    SEND_X5C: Whether to include the public certificate in the x5c header for certificate authentication.
     CONNECTION_NAME: The name of the connection
     FEDERATED_CLIENT_ID: The client ID for federated credentials (if using federated credentials authentication).
     SCOPES: The scopes to request
@@ -91,6 +93,7 @@ class AgentAuthConfiguration:
     CLIENT_ID: str | None
     CLIENT_SECRET: str | None
     CERT_PFX_FILE: str | None
+    SEND_X5C: bool = False
     CONNECTION_NAME: str | None
     FEDERATED_CLIENT_ID: str | None
     SCOPES: list[str] | None
@@ -134,6 +137,7 @@ class AgentAuthConfiguration:
         issuers: list[str] | None = None,
         validate_issuer: bool | None = None,
         federated_token_file: str | None = None,
+        send_x5c: bool | None = None,
         **kwargs: Any,
     ):
 
@@ -149,6 +153,11 @@ class AgentAuthConfiguration:
         self.TENANT_ID = tenant_id or kwargs.get("TENANTID", None)
         self.CLIENT_SECRET = client_secret or kwargs.get("CLIENTSECRET", None)
         self.CERT_PFX_FILE = cert_pfx_file or kwargs.get("CERTPFXFILE", None)
+        self.SEND_X5C = coerce_bool(
+            send_x5c if send_x5c is not None else kwargs.get("SENDX5C", False),
+            default=False,
+            name="SENDX5C",
+        )
         self.CONNECTION_NAME = connection_name or kwargs.get("CONNECTIONNAME", None)
         self.FEDERATED_CLIENT_ID = federated_client_id or kwargs.get(
             "FEDERATEDCLIENTID", None

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/microsoft_agents/hosting/core/authorization/anonymous_token_provider.py

@@ -3,8 +3,14 @@
 
 from typing import Optional
 
+from azure.core.credentials import AccessToken
+from azure.core.credentials_async import AsyncTokenCredential
+
 from .access_token_provider_base import AccessTokenProviderBase
 from .agent_auth_configuration import AgentAuthConfiguration
+from ._helpers import _CallableTokenCredential
+
+_ANONYMOUS_TOKEN_EXPIRATION = 2**31 - 1
 
 
 class AnonymousTokenProvider(AccessTokenProviderBase):
@@ -26,6 +32,12 @@ class AnonymousTokenProvider(AccessTokenProviderBase):
     ) -> str:
         return ""
 
+    def get_token_credential(self) -> AsyncTokenCredential:
+        async def get_token(*scopes: str, **kwargs) -> AccessToken:
+            return AccessToken("", _ANONYMOUS_TOKEN_EXPIRATION)
+
+        return _CallableTokenCredential(get_token)
+
     async def acquire_token_on_behalf_of(
         self, scopes: list[str], user_assertion: str
     ) -> str:

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6/microsoft_agents_hosting_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 1.6.1.dev3
+Version: 1.6.1.dev6
 Summary: Core 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-activity==1.6.1.dev3
+Requires-Dist: microsoft-agents-activity==1.6.1.dev6
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: python-dotenv>=1.1.1
@@ -23,6 +23,7 @@ Requires-Dist: opentelemetry-api>=1.27.0
 Requires-Dist: opentelemetry-sdk>=1.27.0
 Requires-Dist: aiohttp>=3.11.11
 Requires-Dist: yarl<2.0,>=1.17.0
+Requires-Dist: azure-core
 Dynamic: license-file
 Dynamic: requires-dist
 

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/microsoft_agents_hosting_core.egg-info/SOURCES.txt

@@ -81,6 +81,7 @@ microsoft_agents/hosting/core/app/telemetry/metrics.py
 microsoft_agents/hosting/core/app/telemetry/spans.py
 microsoft_agents/hosting/core/authorization/__init__.py
 microsoft_agents/hosting/core/authorization/_entra_issuers.py
+microsoft_agents/hosting/core/authorization/_helpers.py
 microsoft_agents/hosting/core/authorization/_log_config.py
 microsoft_agents/hosting/core/authorization/access_token_provider_base.py
 microsoft_agents/hosting/core/authorization/agent_auth_configuration.py

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/microsoft_agents_hosting_core.egg-info/requires.txt

@@ -1,4 +1,4 @@
-microsoft-agents-activity==1.6.1.dev3
+microsoft-agents-activity==1.6.1.dev6
 pyjwt>=2.10.1
 isodate>=0.6.1
 python-dotenv>=1.1.1
@@ -6,3 +6,4 @@ opentelemetry-api>=1.27.0
 opentelemetry-sdk>=1.27.0
 aiohttp>=3.11.11
 yarl<2.0,>=1.17.0
+azure-core

{microsoft_agents_hosting_core-1.6.1.dev3 → microsoft_agents_hosting_core-1.6.1.dev6}/setup.py

@@ -20,5 +20,6 @@ setup(
         "opentelemetry-sdk>=1.27.0",
         "aiohttp>=3.11.11",
         "yarl>=1.17.0,<2.0",
+        "azure-core",
     ],
 )

microsoft_agents_hosting_core-1.6.1.dev3/VERSION.txt

@@ -1 +0,0 @@
-1.6.1.dev3