ag2 0.10.2__py3-none-any.whl

autogen/mcp/mcp_proxy/security.py

@@ -0,0 +1,399 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+import base64
+import json
+import logging
+from typing import Any, ClassVar, Literal, TypeAlias
+
+import requests
+from pydantic import BaseModel, model_validator
+
+# Get the logger
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+BaseSecurityType: TypeAlias = type["BaseSecurity"]
+
+
+class BaseSecurity(BaseModel):
+    """Base class for security classes."""
+
+    type: ClassVar[Literal["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect", "unsupported"]]
+    in_value: ClassVar[Literal["header", "query", "cookie", "bearer", "basic", "tls", "unsupported"]]
+    name: str
+
+    @model_validator(mode="after")  # type: ignore[misc]
+    def __post_init__(
+        self,
+    ) -> "BaseSecurity":  # dataclasses uses __post_init__ instead of model_validator
+        """Validate the in_value based on the type."""
+        valid_in_values = {
+            "apiKey": ["header", "query", "cookie"],
+            "http": ["bearer", "basic"],
+            "oauth2": ["bearer"],
+            "openIdConnect": ["bearer"],
+            "mutualTLS": ["tls"],
+            "unsupported": ["unsupported"],
+        }
+        if self.in_value not in valid_in_values[self.type]:
+            raise ValueError(f"Invalid in_value '{self.in_value}' for type '{self.type}'")
+        return self
+
+    def accept(self, security_params: "BaseSecurityParameters") -> bool:
+        return isinstance(self, security_params.get_security_class())
+
+    @classmethod
+    def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
+        return cls.type == type and cls.in_value == schema_parameters.get("in")
+
+    @classmethod
+    def get_security_class(cls, type: str, schema_parameters: dict[str, Any]) -> BaseSecurityType:
+        sub_classes = cls.__subclasses__()
+
+        for sub_class in sub_classes:
+            if sub_class.is_supported(type, schema_parameters):
+                return sub_class
+
+        logger.error(f"Unsupported type '{type}' and schema_parameters '{schema_parameters}' combination")
+        return UnsuportedSecurityStub
+
+    @classmethod
+    def get_security_parameters(cls, schema_parameters: dict[str, Any]) -> str:
+        return f'{cls.__name__}(name="{schema_parameters.get("name")}")'
+
+    @classmethod
+    def parse_security_parameters(cls, unparsed_params: dict[str, Any]) -> "BaseSecurityParameters":
+        type = unparsed_params.pop("type")
+        schema_parameters = unparsed_params.pop("schema_parameters")
+        security_class = cls.get_security_class(type, schema_parameters)
+        return security_class.Parameters.model_validate(unparsed_params)
+
+    @classmethod
+    def parse_security_parameters_from_env(cls, env: dict[str, str]) -> "BaseSecurityParameters":
+        """Parse security parameters from environment variables."""
+        security_str = env.get("SECURITY")
+        if not security_str:
+            logger.warning("No security parameters found in environment variables.")
+
+        return cls.parse_security_parameters(json.loads(security_str))
+
+
+class BaseSecurityParameters(BaseModel):
+    """Base class for security parameters."""
+
+    def apply(
+        self,
+        q_params: dict[str, Any],
+        body_dict: dict[str, Any],
+        security: BaseSecurity,
+    ) -> None: ...
+
+    def get_security_class(self) -> type[BaseSecurity]: ...
+
+    def dump(self) -> dict[str, Any]:
+        raise NotImplementedError("Subclasses must implement the dump method")
+
+    def to_env(self) -> dict[str, Any]:
+        """Convert the security parameters to a dictionary."""
+        return {
+            "SECURITY": json.dumps(self.dump()),
+        }
+
+
+class UnsuportedSecurityStub(BaseSecurity):
+    """Unsupported security stub class."""
+
+    type: ClassVar[Literal["unsupported"]] = "unsupported"
+    in_value: ClassVar[Literal["unsupported"]] = "unsupported"
+
+    @classmethod
+    def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
+        return False
+
+    def accept(self, security_params: "BaseSecurityParameters") -> bool:
+        if isinstance(self, security_params.get_security_class()):
+            raise RuntimeError("Trying to set UnsuportedSecurityStub params")
+        return False
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """API Key Header security parameters class."""
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            pass
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return UnsuportedSecurityStub
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "unsupported",
+            }
+
+
+class APIKeyHeader(BaseSecurity):
+    """API Key Header security class."""
+
+    type: ClassVar[Literal["apiKey"]] = "apiKey"
+    in_value: ClassVar[Literal["header"]] = "header"
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """API Key Header security parameters class."""
+
+        value: str = "API_KEY"
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            api_key_header: APIKeyHeader = security  # type: ignore[assignment]
+
+            if "headers" not in body_dict:
+                body_dict["headers"] = {}
+
+            body_dict["headers"][api_key_header.name] = self.value
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return APIKeyHeader
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "apiKey",
+                "schema_parameters": {"in": "header"},
+                **self.model_dump(),
+            }
+
+
+class APIKeyQuery(BaseSecurity):
+    """API Key Query security class."""
+
+    type: ClassVar[Literal["apiKey"]] = "apiKey"
+    in_value: ClassVar[Literal["query"]] = "query"
+
+    @classmethod
+    def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
+        return super().is_supported(type, schema_parameters)
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """API Key Query security parameters class."""
+
+        value: str = "API_KEY"
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            api_key_query: APIKeyQuery = security  # type: ignore[assignment]
+
+            q_params[api_key_query.name] = self.value
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return APIKeyQuery
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "apiKey",
+                "schema_parameters": {"in": "query"},
+                **self.model_dump(),
+            }
+
+
+class APIKeyCookie(BaseSecurity):
+    """API Key Cookie security class."""
+
+    type: ClassVar[Literal["apiKey"]] = "apiKey"
+    in_value: ClassVar[Literal["cookie"]] = "cookie"
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """API Key Cookie security parameters class."""
+
+        value: str = "API_KEY"
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            api_key_cookie: APIKeyCookie = security  # type: ignore[assignment]
+
+            if "cookies" not in body_dict:
+                body_dict["cookies"] = {}
+
+            body_dict["cookies"][api_key_cookie.name] = self.value
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return APIKeyCookie
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "apiKey",
+                "schema_parameters": {"in": "cookie"},
+                **self.model_dump(),
+            }
+
+
+class HTTPBearer(BaseSecurity):
+    """HTTP Bearer security class."""
+
+    type: ClassVar[Literal["http"]] = "http"
+    in_value: ClassVar[Literal["bearer"]] = "bearer"
+
+    @classmethod
+    def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
+        return cls.type == type and cls.in_value == schema_parameters.get("scheme")
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """HTTP Bearer security parameters class."""
+
+        value: str = "BEARER_TOKEN"
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            if "headers" not in body_dict:
+                body_dict["headers"] = {}
+
+            body_dict["headers"]["Authorization"] = f"Bearer {self.value}"
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return HTTPBearer
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "http",
+                "schema_parameters": {"scheme": "bearer"},
+                **self.model_dump(),
+            }
+
+
+class HTTPBasic(BaseSecurity):
+    """HTTP Bearer security class."""
+
+    type: ClassVar[Literal["http"]] = "http"
+    in_value: ClassVar[Literal["basic"]] = "basic"
+
+    @classmethod
+    def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
+        return cls.type == type and cls.in_value == schema_parameters.get("scheme")
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """HTTP Basic security parameters class."""
+
+        username: str = "USERNAME"
+        password: str = "PASSWORD"
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            if "headers" not in body_dict:
+                body_dict["headers"] = {}
+
+            credentials = f"{self.username}:{self.password}"
+            encoded_credentials = base64.b64encode(credentials.encode("utf-8")).decode("utf-8")
+
+            body_dict["headers"]["Authorization"] = f"Basic {encoded_credentials}"
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return HTTPBasic
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "http",
+                "schema_parameters": {"scheme": "basic"},
+                **self.model_dump(),
+            }
+
+
+class OAuth2PasswordBearer(BaseSecurity):
+    """OAuth2 Password Bearer security class."""
+
+    type: ClassVar[Literal["oauth2"]] = "oauth2"
+    in_value: ClassVar[Literal["bearer"]] = "bearer"
+    token_url: str
+
+    @classmethod
+    def is_supported(cls, type: str, schema_parameters: dict[str, Any]) -> bool:
+        return type == cls.type and "password" in schema_parameters.get("flows", {})
+
+    @classmethod
+    def get_security_parameters(cls, schema_parameters: dict[str, Any]) -> str:
+        name = schema_parameters.get("name")
+        token_url = f"{schema_parameters.get('server_url')}/{schema_parameters['flows']['password']['tokenUrl']}"
+        return f'{cls.__name__}(name="{name}", token_url="{token_url}")'
+
+    class Parameters(BaseSecurityParameters):  # BaseSecurityParameters
+        """OAuth2 Password Bearer security class."""
+
+        username: str = "USERNAME"
+        password: str = "PASSWORD"
+        bearer_token: str | None = None
+        token_url: str = "TOKEN_URL"
+
+        # @model_validator(mode="before")
+        # def check_credentials(cls, values: dict[str, Any]) -> Any:  # noqa
+        #     username = values.get("username")
+        #     password = values.get("password")
+        #     bearer_token = values.get("bearer_token")
+
+        #     if not bearer_token and (not username or not password):
+        #         # If bearer_token is not provided, both username and password must be defined
+        #         raise ValueError("Both username and password are required if bearer_token is not provided.")
+
+        #     return values
+
+        def get_token(self, token_url: str) -> str:
+            # Get the token
+            request = requests.post(
+                token_url,
+                data={
+                    "username": self.username,
+                    "password": self.password,
+                },
+                timeout=5,
+            )
+            request.raise_for_status()
+            return request.json()["access_token"]  # type: ignore
+
+        def apply(
+            self,
+            q_params: dict[str, Any],
+            body_dict: dict[str, Any],
+            security: BaseSecurity,
+        ) -> None:
+            if not self.bearer_token:
+                if security.token_url is None:  # type: ignore
+                    raise ValueError("Token URL is not defined")
+                self.bearer_token = self.get_token(security.token_url)  # type: ignore
+
+            if "headers" not in body_dict:
+                body_dict["headers"] = {}
+
+            body_dict["headers"]["Authorization"] = f"Bearer {self.bearer_token}"
+
+        def get_security_class(self) -> type[BaseSecurity]:
+            return OAuth2PasswordBearer
+
+        def dump(self) -> dict[str, Any]:
+            return {
+                "type": "oauth2",
+                "schema_parameters": {"flows": {"password": {"tokenUrl": self.token_url or ""}}},
+                "username": self.username,
+                "password": self.password,
+                "bearer_token": self.bearer_token,
+            }

autogen/mcp/mcp_proxy/security_schema_visitor.py

@@ -0,0 +1,37 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+from pathlib import Path
+
+from autogen.import_utils import optional_import_block
+from autogen.mcp.mcp_proxy.security import BaseSecurity
+
+with optional_import_block() as result:
+    from fastapi_code_generator.parser import OpenAPIParser
+    from fastapi_code_generator.visitor import Visitor
+
+
+def custom_visitor(parser: "OpenAPIParser", model_path: Path) -> dict[str, object]:
+    if "components" not in parser.raw_obj or "securitySchemes" not in parser.raw_obj["components"]:
+        return {}
+    security_schemes = parser.raw_obj["components"]["securitySchemes"]
+    server_url = parser.raw_obj["servers"][0]["url"]
+
+    security_classes = []
+    security_parameters = {}
+    for k, v in security_schemes.items():
+        v["server_url"] = server_url
+        security_class = BaseSecurity.get_security_class(type=v["type"], schema_parameters=v)
+
+        security_classes.append(security_class.__name__)
+
+        security_parameters[k] = security_class.get_security_parameters(schema_parameters=v)
+
+    return {
+        "security_schemes": security_schemes,
+        "security_classes": security_classes,
+        "security_parameters": security_parameters,
+    }
+
+
+visit: "Visitor" = custom_visitor

autogen/messages/__init__.py

@@ -0,0 +1,7 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from .base_message import BaseMessage, get_annotated_type_for_message_classes, wrap_message
+
+__all__ = ["BaseMessage", "get_annotated_type_for_message_classes", "wrap_message"]