mirror of
https://github.com/microsoft/autogen.git
synced 2025-07-07 00:51:38 +00:00

<!-- Thank you for your contribution! Please review https://microsoft.github.io/autogen/docs/Contribute before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? https://github.com/user-attachments/assets/b649053b-c377-40c7-aa51-ee64af766fc2 <img width="100%" alt="image" src="https://github.com/user-attachments/assets/03ba1df5-c9a2-4734-b6a2-0eb97ec0b0e0" /> ## Authentication This PR implements an experimental authentication feature to enable personalized experiences (multiple users). Currently, only GitHub authentication is supported. You can extend the base authentication class to add support for other authentication methods. By default authenticatio is disabled and only enabled when you pass in the `--auth-config` argument when running the application. ### Enable GitHub Authentication To enable GitHub authentication, create a `auth.yaml` file in your app directory: ```yaml type: github jwt_secret: "your-secret-key" token_expiry_minutes: 60 github: client_id: "your-github-client-id" client_secret: "your-github-client-secret" callback_url: "http://localhost:8081/api/auth/callback" scopes: ["user:email"] ``` Please see the documentation on [GitHub OAuth](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app) for more details on obtaining the `client_id` and `client_secret`. To pass in this configuration you can use the `--auth-config` argument when running the application: ```bash autogenstudio ui --auth-config /path/to/auth.yaml ``` Or set the environment variable: ```bash export AUTOGENSTUDIO_AUTH_CONFIG="/path/to/auth.yaml" ``` ```{note} - Authentication is currently experimental and may change in future releases - User data is stored in your configured database - When enabled, all API endpoints require authentication except for the authentication endpoints - WebSocket connections require the token to be passed as a query parameter (`?token=your-jwt-token`) ``` ## Related issue number <!-- For example: "Closes #1234" --> Closes #4350 ## Checks - [ ] I've included any doc changes needed for <https://microsoft.github.io/autogen/>. See <https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to build and test documentation locally. - [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed. --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
230 lines
7.5 KiB
Python
230 lines
7.5 KiB
Python
# api/deps.py
|
|
import logging
|
|
import os
|
|
from contextlib import contextmanager
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
|
|
from fastapi import Depends, FastAPI, HTTPException, Request, WebSocket, status
|
|
|
|
from ..database import DatabaseManager
|
|
from ..teammanager import TeamManager
|
|
from .auth import AuthConfig, AuthManager, AuthMiddleware
|
|
from .auth.dependencies import get_auth_manager
|
|
from .config import settings
|
|
from .managers.connection import WebSocketManager
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Global manager instances
|
|
_db_manager: Optional[DatabaseManager] = None
|
|
_websocket_manager: Optional[WebSocketManager] = None
|
|
_team_manager: Optional[TeamManager] = None
|
|
_auth_manager: Optional[AuthManager] = None
|
|
# Context manager for database sessions
|
|
|
|
|
|
@contextmanager
|
|
def get_db_context():
|
|
"""Provide a transactional scope around a series of operations."""
|
|
if not _db_manager:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="Database manager not initialized"
|
|
)
|
|
try:
|
|
yield _db_manager
|
|
except Exception as e:
|
|
logger.error(f"Database operation failed: {str(e)}")
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="Database operation failed"
|
|
) from e
|
|
|
|
|
|
async def get_db() -> DatabaseManager:
|
|
"""Dependency provider for database manager"""
|
|
if not _db_manager:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="Database manager not initialized"
|
|
)
|
|
return _db_manager
|
|
|
|
|
|
async def get_websocket_manager() -> WebSocketManager:
|
|
"""Dependency provider for connection manager"""
|
|
if not _websocket_manager:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="Connection manager not initialized"
|
|
)
|
|
return _websocket_manager
|
|
|
|
|
|
async def get_team_manager() -> TeamManager:
|
|
"""Dependency provider for team manager"""
|
|
if not _team_manager:
|
|
raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="Team manager not initialized")
|
|
return _team_manager
|
|
|
|
|
|
# Authentication dependency
|
|
|
|
|
|
async def get_current_user(request: Request) -> str:
|
|
"""Get the current authenticated user."""
|
|
if hasattr(request.state, "user"):
|
|
return request.state.user.id
|
|
|
|
# Fallback for routes not protected by auth middleware
|
|
auth_manager = await get_auth_manager(request)
|
|
if auth_manager.config.type == "none":
|
|
return settings.DEFAULT_USER_ID
|
|
|
|
raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, detail="Authentication required")
|
|
|
|
|
|
def init_auth_manager(config_dir: Path) -> AuthManager:
|
|
"""Initialize authentication manager"""
|
|
auth_config_path = os.environ.get("AUTOGENSTUDIO_AUTH_CONFIG")
|
|
|
|
if auth_config_path and os.path.exists(auth_config_path):
|
|
try:
|
|
auth_manager = AuthManager.from_yaml(auth_config_path)
|
|
logger.info(f"Authentication initialized with provider: {auth_manager.config.type}")
|
|
return auth_manager
|
|
except Exception as e:
|
|
logger.error(f"Failed to initialize authentication from config file: {str(e)}")
|
|
logger.warning("Falling back to no authentication")
|
|
|
|
# Default or fallback
|
|
config = AuthConfig(type="none")
|
|
auth_manager = AuthManager(config)
|
|
logger.info("Authentication disabled (no config provided)")
|
|
return auth_manager
|
|
|
|
|
|
async def register_auth_dependencies(app: FastAPI, auth_manager: AuthManager) -> None:
|
|
"""Register authentication manager with application"""
|
|
global _auth_manager
|
|
_auth_manager = auth_manager
|
|
app.state.auth_manager = auth_manager
|
|
|
|
for route in app.routes:
|
|
# print(" *** Route: ", route.path)
|
|
if hasattr(route, "app") and isinstance(route.app, FastAPI):
|
|
route.app.state.auth_manager = auth_manager
|
|
|
|
|
|
# Manager initialization and cleanup
|
|
|
|
|
|
async def init_managers(database_uri: str, config_dir: str | Path, app_root: str | Path) -> None:
|
|
"""Initialize all manager instances"""
|
|
global _db_manager, _websocket_manager, _team_manager
|
|
|
|
logger.info("Initializing managers...")
|
|
|
|
try:
|
|
# Initialize database manager
|
|
_db_manager = DatabaseManager(engine_uri=database_uri, base_dir=app_root)
|
|
_db_manager.initialize_database(auto_upgrade=settings.UPGRADE_DATABASE)
|
|
|
|
# init default team config
|
|
await _db_manager.import_teams_from_directory(config_dir, settings.DEFAULT_USER_ID, check_exists=True)
|
|
|
|
# Initialize connection manager
|
|
_websocket_manager = WebSocketManager(db_manager=_db_manager)
|
|
logger.info("Connection manager initialized")
|
|
|
|
# Initialize team manager
|
|
_team_manager = TeamManager()
|
|
logger.info("Team manager initialized")
|
|
|
|
except Exception as e:
|
|
logger.error(f"Failed to initialize managers: {str(e)}")
|
|
await cleanup_managers() # Cleanup any partially initialized managers
|
|
raise
|
|
|
|
|
|
async def cleanup_managers() -> None:
|
|
"""Cleanup and shutdown all manager instances"""
|
|
global _db_manager, _websocket_manager, _team_manager, _auth_manager
|
|
|
|
logger.info("Cleaning up managers...")
|
|
|
|
# Cleanup connection manager first to ensure all active connections are closed
|
|
if _websocket_manager:
|
|
try:
|
|
await _websocket_manager.cleanup()
|
|
except Exception as e:
|
|
logger.error(f"Error cleaning up connection manager: {str(e)}")
|
|
finally:
|
|
_websocket_manager = None
|
|
|
|
# TeamManager doesn't need explicit cleanup since WebSocketManager handles it
|
|
_team_manager = None
|
|
|
|
_auth_manager = None
|
|
|
|
# Cleanup database manager last
|
|
if _db_manager:
|
|
try:
|
|
await _db_manager.close()
|
|
except Exception as e:
|
|
logger.error(f"Error cleaning up database manager: {str(e)}")
|
|
finally:
|
|
_db_manager = None
|
|
|
|
logger.info("All managers cleaned up")
|
|
|
|
|
|
# Utility functions for dependency management
|
|
|
|
|
|
def get_manager_status() -> dict:
|
|
"""Get the initialization status of all managers"""
|
|
return {
|
|
"database_manager": _db_manager is not None,
|
|
"websocket_manager": _websocket_manager is not None,
|
|
"team_manager": _team_manager is not None,
|
|
"auth_manager": _auth_manager is not None,
|
|
}
|
|
|
|
|
|
# Combined dependencies
|
|
|
|
|
|
async def get_managers():
|
|
"""Get all managers in one dependency"""
|
|
return {"db": await get_db(), "connection": await get_websocket_manager(), "team": await get_team_manager()}
|
|
|
|
|
|
# Error handling for manager operations
|
|
|
|
|
|
class ManagerOperationError(Exception):
|
|
"""Custom exception for manager operation errors"""
|
|
|
|
def __init__(self, manager_name: str, operation: str, detail: str):
|
|
self.manager_name = manager_name
|
|
self.operation = operation
|
|
self.detail = detail
|
|
super().__init__(f"{manager_name} failed during {operation}: {detail}")
|
|
|
|
|
|
# Dependency for requiring specific managers
|
|
|
|
|
|
def require_managers(*manager_names: str):
|
|
"""Decorator to require specific managers for a route"""
|
|
|
|
async def dependency():
|
|
manager_status = get_manager_status() # Different name
|
|
missing = [name for name in manager_names if not manager_status.get(f"{name}_manager")]
|
|
if missing:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_503_SERVICE_UNAVAILABLE, # Now this refers to the imported module
|
|
detail=f"Required managers not available: {', '.join(missing)}",
|
|
)
|
|
return True
|
|
|
|
return Depends(dependency)
|