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.

exceptions.py 1.3 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
123456789101112131415161718192021222324252627282930313233343536373839404142
  1. from fastapi import HTTPException
  2. class AuthException(HTTPException):
  3. """Base class for authentication exceptions."""
  4. def __init__(self, detail: str, headers: dict | None = None):
  5. super().__init__(status_code=401, detail=detail, headers=headers)
  6. class InvalidTokenException(AuthException):
  7. """Exception raised when token is invalid."""
  8. def __init__(self):
  9. super().__init__(detail="Invalid or expired token")
  10. class MissingTokenException(AuthException):
  11. """Exception raised when token is missing."""
  12. def __init__(self):
  13. super().__init__(detail="Authentication token is missing")
  14. class ProviderAuthException(AuthException):
  15. """Exception raised when authentication with provider fails."""
  16. def __init__(self, provider: str, detail: str):
  17. super().__init__(detail=f"Authentication failed with {provider}: {detail}")
  18. class ConfigurationException(Exception):
  19. """Exception raised when there's an issue with auth configuration."""
  20. pass
  21. class ForbiddenException(HTTPException):
  22. """Exception raised when user doesn't have permission."""
  23. def __init__(self, detail: str = "You don't have permission to access this resource"):
  24. super().__init__(status_code=403, detail=detail)