microsoft-agents-hosting-core 1.7.0.dev6__tar.gz → 1.7.0.dev9__tar.gz

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 1.7.0.dev6
+Version: 1.7.0.dev9
 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.7.0.dev6
+Requires-Dist: microsoft-agents-activity==1.7.0.dev9
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: python-dotenv>=1.1.1

microsoft_agents_hosting_core-1.7.0.dev9/VERSION.txt

@@ -0,0 +1 @@
+1.7.0.dev9

microsoft_agents_hosting_core-1.7.0.dev9/microsoft_agents/hosting/core/app/_utils.py

@@ -0,0 +1,36 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from email.message import Message
+from urllib.parse import urlparse
+
+_CONTENT_TYPE = "Content-Type"
+
+
+def _parse_content_type(content_type: str) -> tuple[str, dict[str, str]] | None:
+    """Parses the given content type string into its main type and parameters.
+
+    :param content_type: The content type string to parse.
+    :return: A tuple containing the main content type and a dictionary of parameters,
+             or None if parsing fails.
+    """
+    email = Message()
+    email[_CONTENT_TYPE] = content_type
+    params = email.get_params()
+    if params is None:
+        return None
+    # the first param is the mime-type
+    # the later ones are the attributes like "charset"
+    return params[0][0], dict(params[1:])
+
+
+def _basic_url_check(url: str) -> bool:
+    """Performs a basic check to see if the given string is a valid URL.
+
+    :param url: The URL string to check.
+    :return: True if the URL has a valid scheme and netloc, False otherwise.
+    """
+    parsed = urlparse(url)
+    return parsed.scheme == "https" or (
+        parsed.scheme == "http" and parsed.hostname == "localhost"
+    )

microsoft_agents_hosting_core-1.7.0.dev9/microsoft_agents/hosting/core/app/attachment_downloader.py

@@ -0,0 +1,104 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import json
+from typing import Callable
+
+import aiohttp
+
+from microsoft_agents.activity import (
+    Attachment,
+    Channels,
+    ChannelId,
+)
+
+from microsoft_agents.hosting.core.turn_context import TurnContext
+from microsoft_agents.hosting.core.outbound_host_validator import OutboundHostValidator
+
+from .input_file import InputFileDownloader, InputFile
+from ._utils import _parse_content_type, _basic_url_check
+
+
+class AttachmentDownloader(InputFileDownloader):
+    """Downloads attachments from a given turn context."""
+
+    def __init__(
+        self,
+        client_factory: Callable[[], aiohttp.ClientSession] | None = None,
+        host_validator: OutboundHostValidator | None = None,
+    ):
+        """Constructor for AttachmentDownloader.
+
+        :param client_factory: A callable that returns an aiohttp.ClientSession instance.
+        :param host_validator: An optional OutboundHostValidator instance.
+        """
+
+        self._client_factory = client_factory or aiohttp.ClientSession
+        self._host_validator = host_validator
+
+    async def download_files(self, context: TurnContext) -> list[InputFile]:
+        """Downloads files for the given turn context.
+
+        :param context: The TurnContext instance for the current turn.
+        :return: A list of InputFile instances representing the downloaded files.
+        """
+        if ChannelId.get_channel(context.activity.channel_id) == Channels.ms_teams:
+            return []
+
+        if not context.activity.attachments:
+            return []
+
+        files: list[InputFile] = []
+        for attachment in context.activity.attachments:
+            file = await self._download_file(attachment)
+            if file:
+                files.append(file)
+
+        return files
+
+    async def _download_file(self, attachment: Attachment) -> InputFile | None:
+        """Downloads a single file from the given attachment.
+
+        :param attachment: The attachment to download.
+        :return: An InputFile instance if the download is successful, None otherwise.
+        """
+        if attachment.content_url and _basic_url_check(attachment.content_url):
+            remote_file_url = attachment.content_url
+
+            if (
+                self._host_validator
+                and self._host_validator.enabled
+                and not self._host_validator.is_allowed(remote_file_url)
+            ):
+                return None
+
+            async with self._client_factory() as client:
+                async with client.get(remote_file_url) as response:
+
+                    if not (200 <= response.status < 300):
+                        return None
+
+                    content_type_val = response.headers.get("Content-Type", "")
+                    result = _parse_content_type(content_type_val)
+                    if result is None:
+                        return None
+                    content_type, _ = result
+                    if content_type.startswith("image/"):
+                        content_type = "image/png"
+
+                    res = await response.read()
+
+                    return InputFile(
+                        content=res,
+                        content_type=content_type,
+                        content_url=attachment.content_url,
+                        filename=attachment.name,
+                    )
+        else:
+            content = bytes(json.dumps(attachment.content), "utf-8")
+            return InputFile(
+                content=content,
+                content_type=attachment.content_type,
+                content_url=attachment.content_url,
+                filename=attachment.name,
+            )

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents/hosting/core/app/input_file.py

@@ -1,13 +1,10 @@
-"""
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the MIT License.
-"""
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
 
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from typing import Optional
 
 from microsoft_agents.hosting.core import TurnContext
 
@@ -21,12 +18,15 @@ class InputFile:
     :param content_type: The content type of the file.
     :type content_type: str
     :param content_url: Optional. URL to the content of the file.
-    :type content_url: Optional[str]
+    :type content_url: str | None
+    :param filename: Optional. The name of the file.
+    :type filename: str | None
     """
 
     content: bytes
     content_type: str
-    content_url: Optional[str]
+    content_url: str | None = None
+    filename: str | None = None
 
 
 class InputFileDownloader(ABC):

microsoft_agents_hosting_core-1.7.0.dev9/microsoft_agents/hosting/core/app/m365_attachment_downloader.py

@@ -0,0 +1,175 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import json
+from typing import Callable, cast, Any
+
+import aiohttp
+
+from microsoft_agents.activity import (
+    Attachment,
+    Channels,
+    ChannelId,
+)
+
+from microsoft_agents.hosting.core.authorization import (
+    AccessTokenProviderBase,
+    Connections,
+)
+from microsoft_agents.hosting.core.turn_context import TurnContext
+from microsoft_agents.hosting.core.outbound_host_validator import OutboundHostValidator
+
+from .input_file import InputFileDownloader, InputFile
+from ._utils import _parse_content_type, _basic_url_check
+
+
+class M365AttachmentDownloader(InputFileDownloader):
+    """Downloads attachments from M365/Teams using the configured Token Provider (from Connections)."""
+
+    def __init__(
+        self,
+        connections: Connections,
+        client_factory: Callable[[], aiohttp.ClientSession] | None = None,
+        host_validator: OutboundHostValidator | None = None,
+        *,
+        token_provider_name: str = "",
+        use_anonymous: bool = False,
+        scopes: list[str] | None = None,
+    ):
+        """Constructor for M365AttachmentDownloader.
+
+        :param connections: A Connections instance.
+        :param client_factory: A callable that returns an aiohttp.ClientSession instance.
+        :param host_validator: An optional OutboundHostValidator instance.
+        :param token_provider_name: The name of the token provider.
+        :param use_anonymous: Whether to use anonymous access.
+        :param scopes: A list of scopes for the access token.
+        :param connections: A Connections instance.
+        """
+
+        self._connections = connections
+        self._client_factory = client_factory or aiohttp.ClientSession
+        self._host_validator = host_validator
+
+        self._token_provider_name = token_provider_name
+        self._use_anonymous = use_anonymous
+        self._scopes = scopes or []
+
+    async def download_files(self, context: TurnContext) -> list[InputFile]:
+        """Download files from the given context.
+
+        :param context: The TurnContext instance.
+        :return: A list of InputFile instances.
+        """
+
+        if context.activity.channel_id not in (
+            Channels.ms_teams,
+            Channels.m365_copilot,
+        ):
+            return []
+
+        attachments: list[Attachment]
+        if not context.activity.attachments:
+            return []
+        attachments = [
+            att
+            for att in context.activity.attachments
+            if not att.content_type.startswith("text/html")
+        ]
+        if not attachments:
+            return []
+
+        access_token = ""
+
+        if not self._use_anonymous:
+
+            if not context.identity:
+                raise ValueError("No valid context identity found.")
+
+            outgoing_audience_claim = context.identity.get_outgoing_audience_claim()
+            if not outgoing_audience_claim:
+                raise ValueError("No valid outgoing App ID found.")
+
+            token_provider: AccessTokenProviderBase | None = None
+            if self._token_provider_name:
+                try:
+                    token_provider = self._connections.get_connection(
+                        self._token_provider_name
+                    )
+                except ValueError:
+                    pass
+            if not token_provider:
+                token_provider = self._connections.get_token_provider_from_activity(
+                    context.identity, context.activity
+                )
+            if not token_provider:
+                raise RuntimeError("No valid token provider found.")
+
+            access_token = await token_provider.get_access_token(
+                outgoing_audience_claim, self._scopes
+            )
+
+        files: list[InputFile] = []
+        for att in attachments:
+            file = await self._download_file(att, access_token)
+            if file:
+                files.append(file)
+
+        return files
+
+    async def _download_file(
+        self, attachment: Attachment, access_token: str
+    ) -> InputFile | None:
+        """Download a single file from the given attachment.
+
+        :param attachment: The Attachment instance.
+        :param access_token: The access token for authentication.
+        :return: An InputFile instance or None if the download fails.
+        """
+        name = attachment.name
+
+        download_url: str | None = None
+        if isinstance(attachment.content, dict):
+            content_dict = cast(dict[str, Any], attachment.content)
+            download_url = content_dict.get("downloadUrl", attachment.content_url)
+        else:
+            download_url = attachment.content_url
+
+        if download_url and _basic_url_check(download_url):
+            if (
+                self._host_validator is not None
+                and self._host_validator.enabled
+                and not self._host_validator.is_allowed(download_url)
+            ):
+                return None
+
+            async with self._client_factory() as client:
+                async with client.get(
+                    download_url, headers={"Authorization": f"Bearer {access_token}"}
+                ) as response:
+                    if not (200 <= response.status < 300):
+                        return None
+                    content = await response.read()
+                    result = _parse_content_type(
+                        response.headers.get("Content-Type", "")
+                    )
+                    if result is None:
+                        return None
+                    content_type, _ = result
+                    if content_type.startswith("image/"):
+                        content_type = "image/png"
+
+                    return InputFile(
+                        content=content,
+                        content_type=content_type,
+                        content_url=attachment.content_url,
+                        filename=name,
+                    )
+        else:
+            content = bytes(json.dumps(attachment.content), "utf-8")
+            return InputFile(
+                content=content,
+                content_type=attachment.content_type,
+                content_url=attachment.content_url,
+                filename=attachment.name,
+            )

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents/hosting/core/authorization/claims_identity.py

@@ -79,6 +79,14 @@ class ClaimsIdentity:
 
         return app_id
 
+    def get_outgoing_audience_claim(self) -> str | None:
+        """Retrieves the audience for an outgoing token from the given incoming activity."""
+        if self.is_agent_claim():
+            return f"api://{self.get_outgoing_app_id()}"
+        if self.is_gov_botframework_claim():
+            return AuthenticationConstants.GOV_AGENTS_SDK_TOKEN_ISSUER
+        return AuthenticationConstants.AGENTS_SDK_SCOPE
+
     def is_agent_claim(self) -> bool:
         """
         Checks if the current claims represents an agent claim (not coming from ABS/SMBA).
@@ -116,6 +124,15 @@ class ClaimsIdentity:
             else AuthenticationConstants.AGENTS_SDK_SCOPE
         )
 
+    def is_gov_botframework_claim(self) -> bool:
+        """Determines whether the specified incoming identity represents a government Bot Framework claim."""
+        aud = self.claims.get(AuthenticationConstants.AUDIENCE_CLAIM, None)
+        return (
+            aud.lower() == AuthenticationConstants.GOV_AGENTS_SDK_TOKEN_ISSUER.lower()
+            if aud
+            else False
+        )
+
     def get_token_scope(self) -> list[str]:
         """
         Gets the token scope from current claims.

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents/hosting/core/connector/attachments_base.py

@@ -15,3 +15,7 @@ class AttachmentsBase(Protocol):
     @abstractmethod
     async def get_attachment(self) -> Optional[AsyncIterator[bytes]]:
         pass
+
+    @abstractmethod
+    def get_attachment_uri(self, attachment_id: str, view_id: str = "original") -> str:
+        pass

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents/hosting/core/connector/client/connector_client.py

@@ -8,6 +8,7 @@ import re
 from typing import Any, Optional
 from aiohttp import ClientSession
 from io import BytesIO
+from urllib.parse import quote
 
 from microsoft_agents.activity import (
     Activity,
@@ -146,6 +147,37 @@ class AttachmentsOperations(AttachmentsBase, _BaseClient):
                 data = await response.read()
                 return BytesIO(data)
 
+    def get_attachment_uri(self, attachment_id: str, view_id: str = "original") -> str:
+        """
+        Gets the URI of an attachment view.
+
+        :param attachment_id: The ID of the attachment.
+        :param view_id: The ID of the view, defaults to "original".
+        :return: The URI of the attachment view.
+        """
+        if not attachment_id:
+            logger.error(
+                "AttachmentsOperations.get_attachment_uri(): attachmentId is required",
+                stack_info=True,
+            )
+            raise ValueError("attachmentId is required")
+
+        if not view_id:
+            logger.error(
+                "AttachmentsOperations.get_attachment_uri(): viewId is required",
+                stack_info=True,
+            )
+            raise ValueError("viewId is required")
+
+        base_url = str(self._client._base_url)
+        if not base_url.endswith("/"):
+            base_url += "/"
+
+        return (
+            f"{base_url}v3/attachments/{quote(attachment_id, safe='')}"
+            f"/views/{quote(view_id, safe='')}"
+        )
+
 
 class ConversationsOperations(ConversationsBase, _BaseClient):
 

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents/hosting/core/connector/mcs/mcs_connector_client.py

@@ -194,6 +194,14 @@ class MCSAttachments(AttachmentsBase):
             "GetAttachment is not supported for Microsoft Copilot Studio Connector"
         )
 
+    def get_attachment_uri(
+        self, attachment_id: str, view_id: str = "original", **kwargs
+    ) -> str:
+        """Not supported for MCS Connector."""
+        raise NotImplementedError(
+            "GetAttachmentUri is not supported for Microsoft Copilot Studio Connector"
+        )
+
 
 class MCSConnectorClient(ConnectorClientBase):
     """

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents_hosting_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 1.7.0.dev6
+Version: 1.7.0.dev9
 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.7.0.dev6
+Requires-Dist: microsoft-agents-activity==1.7.0.dev9
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: python-dotenv>=1.1.1

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents_hosting_core.egg-info/SOURCES.txt

@@ -27,10 +27,13 @@ microsoft_agents/hosting/core/_utils/__init__.py
 microsoft_agents/hosting/core/_utils/_service_set.py
 microsoft_agents/hosting/core/app/__init__.py
 microsoft_agents/hosting/core/app/_type_defs.py
+microsoft_agents/hosting/core/app/_utils.py
 microsoft_agents/hosting/core/app/agent_application.py
 microsoft_agents/hosting/core/app/app_error.py
 microsoft_agents/hosting/core/app/app_options.py
+microsoft_agents/hosting/core/app/attachment_downloader.py
 microsoft_agents/hosting/core/app/input_file.py
+microsoft_agents/hosting/core/app/m365_attachment_downloader.py
 microsoft_agents/hosting/core/app/query.py
 microsoft_agents/hosting/core/app/typing_indicator.py
 microsoft_agents/hosting/core/app/_routes/__init__.py

{microsoft_agents_hosting_core-1.7.0.dev6 → microsoft_agents_hosting_core-1.7.0.dev9}/microsoft_agents_hosting_core.egg-info/requires.txt

@@ -1,4 +1,4 @@
-microsoft-agents-activity==1.7.0.dev6
+microsoft-agents-activity==1.7.0.dev9
 pyjwt>=2.10.1
 isodate>=0.6.1
 python-dotenv>=1.1.1

microsoft_agents_hosting_core-1.7.0.dev6/VERSION.txt

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