Commit 993a9f6
authored
feat(ve_identity): Add Identity Service integration with OAuth2, API Key and Workload authentication (#263)
* feat(ve_identity): Add Identity Service integration with OAuth2, API Key, and Workload authentication
This commit introduces a comprehensive integration with Identity Service,
enabling ADK agents to securely manage authentication and credentials.
## Key Features
### 1. Unified Authentication Framework
- **Three Authentication Types**:
- OAuth2 (M2M and USER_FEDERATION flows)
- API Key authentication
- Workload access token authentication
- **Flexible Configuration**: Simple factory functions (`api_key_auth()`, `oauth2_auth()`, `workload_auth()`)
for easy setup
### 2. Tool Integration
- **VeIdentityFunctionTool**: Funtion tool wrapper with built-in Identity authentication
- **VeIdentityMcpTool**: MCP tool wrapper with built-in Identity authentication
- **VeIdentityMcpToolset**: Complete MCP toolset management with automatic credential handling
### 3. Authentication Processing
- **AuthRequestProcessor**: Handles OAuth2 flows in agent conversations with support for:
- Custom OAuth2 auth pollers
- Callback URL handling
- Token polling with configurable timeout
- Mock auth poller for testing
- **Auth Mixins**: Reusable authentication logic (`VeIdentityAuthMixin`, `ApiKeyAuthMixin`,
`OAuth2AuthMixin`, `WorkloadAuthMixin`) to avoid code duplication
### 4. Token Management
- **WorkloadTokenManager**: Manages workload access tokens with:
- Automatic caching in session state
- Token expiration handling
- Support for JWT, user ID, and workload-only authentication modes
- Automatic token refresh
### 5. Identity Client
- **IdentityClient**: Low-level async client for VolcEngine Identity Service API with:
- OAuth2 credential provider management
- API key credential provider management
- Workload token retrieval
- OAuth2 token and API key fetching
- Dynamic Client Registration (DCR) support
### 6. Data Models
- **OAuth2TokenResponse**: Structured response for OAuth2 token requests
- **WorkloadToken**: Workload token with expiration tracking
- **OAuth2AuthPoller**: Abstract base for custom token polling implementations
- **DCR Models**: Support for RFC 7591 Dynamic Client Registration Protocol
- **Authorization Server Metadata**: RFC 8414 compliant metadata handling
### 7. Utility Functions
- **is_pending_auth_event()**: Detect pending authentication requests in ADK events
- **get_function_call_id()**: Extract function call IDs from auth events
- **get_function_call_auth_config()**: Extract auth configuration from events
- **generate_headers()**: Convert credentials to HTTP authentication headers
* fix(identity): refactor imports to use absolute paths in ve_identity
- Fix Non-standard docstrings
- Remove veadk prefix in logger
* chore(identity):fix type hints for tool_context in auth mixins
* feat: add unit tests for ve_identity tools and improve credential refresh
Add unit tests for ve_identity auth_config, function_tool, mcp_tool, and mcp_toolset modules. Updated IdentityClient credential refresh logic to support fallback to VeFaaS IAM credentials if environment variables are not set, improving robustness in cloud environments.
* feat(ve_identity): Add Agent Identity authentication docs
Introduces documentation for Agent Identity authentication, including product overview, API Key outbound, OAuth2 M2M outbound, and OAuth2 USER_FEDERATION outbound.
* feat(identity): Integrate VeIdentity config and region support
Added VeIdentityConfig to global settings and improved region handling for Agent Identity authentication. Updated configuration files and environment variable documentation.
* chore(ve_identity): Make OAuth2 flow and scopes parameters optional
Updated OAuth2-related classes and functions to make 'auth_flow' and 'scopes' parameters optional, allowing control plane defaults to be used if not provided.
* chore(ve_identity): Remove redundant logging from identity and token modules
Eliminated unnecessary logger.info statements from IdentityClient and WorkloadTokenManager to reduce log verbosity and improve clarity. No changes to core logic or functionality.
* refactor(ve_identity): introduce BaseRunProcessor to decouple Agent Identity dependency
## Problem
Agent class had a hard dependency on Agent Identity's AuthRequestProcessor,
causing all agents to depend on Agent Identity even when authentication is
not needed. This violates the Dependency Inversion Principle and could
break existing agents.
## Solution
Introduce an abstract processor layer following the Dependency Inversion
Principle:
1. Created `veadk/processors/` package with:
- `BaseRunProcessor`: Abstract base class for runtime processors
- `NoOpRunProcessor`: Default no-op implementation
2. Modified `veadk/agent.py`:
- Added `run_processor: Optional[BaseRunProcessor]` field
- Changed dependency from AuthRequestProcessor to BaseRunProcessor
- Initialize with NoOpRunProcessor by default
- Updated `run()` method parameter from `auth_request_processor` to `run_processor`
3. Updated `veadk/integrations/ve_identity/auth_processor.py`:
- Made AuthRequestProcessor inherit from BaseRunProcessor
- Renamed main method from `with_auth_loop` to `process_run`
* chore(ve_identity): Remove unused _NoOpAuthProcessor import and cleanup
Eliminated the unused _NoOpAuthProcessor import and reference from ve_identity/__init__.py. Also removed a trailing blank line in processors/__init__.py and added a missing comma in NoOpRunProcessor's decorator signature for consistency.1 parent 0f48949 commit 993a9f6
File tree
27 files changed
+4798
-3
lines changed- docs/content
- 2.configurations
- 91.auth
- tests
- veadk
- configs
- integrations/ve_identity
- processors
27 files changed
+4798
-3
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
48 | | - | |
| 47 | + | |
| 48 | + | |
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
73 | 78 | | |
74 | 79 | | |
75 | 80 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
105 | 105 | | |
106 | 106 | | |
107 | 107 | | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
0 commit comments