You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

models.py 2.8 kB

Enable Auth in AGS (#5928) <!-- 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>
1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. import os
  2. from typing import Any, Dict, List, Literal, Optional, Union
  3. from pydantic import BaseModel, Field, field_validator
  4. class GithubAuthConfig(BaseModel):
  5. client_id: str
  6. client_secret: str
  7. callback_url: str
  8. scopes: List[str] = ["user:email"]
  9. class MSALAuthConfig(BaseModel):
  10. tenant_id: str
  11. client_id: str
  12. client_secret: str
  13. callback_url: str
  14. scopes: List[str] = ["User.Read"]
  15. class FirebaseAuthConfig(BaseModel):
  16. api_key: str
  17. auth_domain: str
  18. project_id: str
  19. class AuthConfig(BaseModel):
  20. """Authentication configuration model for the application."""
  21. type: Literal["none", "github", "msal", "firebase"] = "none"
  22. github: Optional[GithubAuthConfig] = None
  23. msal: Optional[MSALAuthConfig] = None
  24. firebase: Optional[FirebaseAuthConfig] = None
  25. jwt_secret: Optional[str] = None
  26. token_expiry_minutes: int = 60
  27. exclude_paths: List[str] = [
  28. "/", # root for serving frontend
  29. "/api/health",
  30. "/api/version",
  31. "/api/auth/login-url",
  32. "/api/auth/callback-handler",
  33. "/api/auth/callback",
  34. "/api/auth/type",
  35. ]
  36. @field_validator("github")
  37. @classmethod
  38. def validate_github_config(cls, v, info):
  39. """Validate GitHub config is present when github type is selected."""
  40. values = info.data
  41. if values.get("type") == "github" and v is None:
  42. raise ValueError("GitHub configuration required when type is 'github'")
  43. return v
  44. @field_validator("msal")
  45. @classmethod
  46. def validate_msal_config(cls, v, info):
  47. """Validate MSAL config is present when msal type is selected."""
  48. values = info.data
  49. if values.get("type") == "msal" and v is None:
  50. raise ValueError("MSAL configuration required when type is 'msal'")
  51. return v
  52. @field_validator("firebase")
  53. @classmethod
  54. def validate_firebase_config(cls, v, info):
  55. """Validate Firebase config is present when firebase type is selected."""
  56. values = info.data
  57. if values.get("type") == "firebase" and v is None:
  58. raise ValueError("Firebase configuration required when type is 'firebase'")
  59. return v
  60. @field_validator("jwt_secret")
  61. @classmethod
  62. def validate_jwt_secret(cls, v, info):
  63. """Validate JWT secret is present for auth types other than 'none'."""
  64. values = info.data
  65. if values.get("type") != "none" and not v:
  66. raise ValueError("JWT secret is required for authentication")
  67. return v
  68. class User(BaseModel):
  69. """User model for authenticated users."""
  70. id: str
  71. name: str
  72. email: Optional[str] = None
  73. avatar_url: Optional[str] = None
  74. provider: Optional[str] = None
  75. roles: List[str] = ["user"]
  76. metadata: Optional[Dict[str, Any]] = None