Skip to content

[Identity] Implement binding mode support in WorkloadIdentityCredential - #43287

Merged
pvaneck merged 14 commits into
Azure:mainfrom
pvaneck:identity-aks-fic
Nov 7, 2025
Merged

[Identity] Implement binding mode support in WorkloadIdentityCredential#43287
pvaneck merged 14 commits into
Azure:mainfrom
pvaneck:identity-aks-fic

Conversation

@pvaneck

@pvaneck pvaneck commented Oct 8, 2025

Copy link
Copy Markdown
Member

Adding support for AKS custom token endpoint proxies in WorkloadIdentityCredential. In this binding mode, an internal Kubernetes endpoint is used for token requests.

✔ Validated these changes in an actual AKS cluster with token binding enabled.

This is enabled with the use_token_proxy=True keyword argument in WorkloadIdentityCredential. This argument is not honored through DefaultAzureCredential.

Closes: https://github.com/Azure/azure-sdk-for-python-pr/issues/904

@github-actions

github-actions Bot commented Oct 16, 2025

Copy link
Copy Markdown
Contributor

API Change Check

APIView identified API level changes in this PR and created the following API reviews

azure-identity

- Implement a new http.client transport that will leverage Proxy, CA, SNI settings.

Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
@pvaneck
pvaneck requested a review from Copilot October 29, 2025 20:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds token proxy support to WorkloadIdentityCredential for both synchronous and asynchronous implementations. The changes enable the credential to use a token proxy server for acquiring tokens in Kubernetes environments with custom network configurations.

Key Changes:

  • Added use_token_proxy parameter to WorkloadIdentityCredential in both sync and async versions
  • Implemented custom transport classes (HttpClientTransport and WorkloadIdentityAioHttpTransport) with support for SNI, CA certificates, and proxy endpoints
  • Added TokenBindingTransportMixin to provide shared functionality for URL validation, CA file tracking, and proxy URL handling
  • Added comprehensive test coverage including unit tests, integration tests with a local test server, and test utilities

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
sdk/identity/azure-identity/azure/identity/_credentials/workload_identity.py Added token proxy support to sync WorkloadIdentityCredential
sdk/identity/azure-identity/azure/identity/aio/_credentials/workload_identity.py Added token proxy support to async WorkloadIdentityCredential with custom AioHttpTransport
sdk/identity/azure-identity/azure/identity/_internal/http_client_transport.py New sync HTTP transport implementation using http.client
sdk/identity/azure-identity/azure/identity/_internal/token_binding_transport_mixin.py New mixin providing shared transport functionality for URL validation, CA file tracking, and proxy handling
sdk/identity/azure-identity/azure/identity/_constants.py Added environment variable constants for Kubernetes token proxy configuration
sdk/identity/azure-identity/tests/test_workload_identity_credential.py Added comprehensive test cases for sync token proxy functionality
sdk/identity/azure-identity/tests/test_workload_identity_credential_async.py Added comprehensive test cases for async token proxy functionality
sdk/identity/azure-identity/tests/test_http_client_transport.py Added test coverage for sync HTTP client transport
sdk/identity/azure-identity/tests/proxy_server.py Added test server utility for integration testing

Comment thread sdk/identity/azure-identity/azure/identity/_credentials/workload_identity.py Outdated
Comment thread sdk/identity/azure-identity/azure/identity/aio/_credentials/workload_identity.py Outdated
Comment thread sdk/identity/azure-identity/azure/identity/_credentials/workload_identity.py Outdated
Comment thread sdk/identity/azure-identity/azure/identity/aio/_credentials/workload_identity.py Outdated
Comment thread sdk/identity/azure-identity/azure/identity/_credentials/workload_identity.py Outdated
Comment thread sdk/identity/azure-identity/azure/identity/aio/_credentials/workload_identity.py Outdated
Comment thread sdk/identity/azure-identity/azure/identity/aio/_credentials/workload_identity.py Outdated
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
@pvaneck
pvaneck requested a review from Copilot October 31, 2025 01:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.

Comment thread sdk/identity/azure-identity/tests/proxy_server.py Outdated
Comment thread sdk/identity/azure-identity/tests/test_workload_identity_credential.py Outdated
Comment thread sdk/identity/azure-identity/tests/test_workload_identity_credential_async.py Outdated
Comment thread sdk/identity/azure-identity/tests/test_workload_identity_credential_async.py Outdated
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
@pvaneck
pvaneck marked this pull request as ready for review October 31, 2025 22:38
@pvaneck
pvaneck requested review from a team and xiangyan99 as code owners October 31, 2025 22:38
Comment thread sdk/identity/azure-identity/azure/identity/_credentials/workload_identity.py Outdated
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Comment thread sdk/identity/azure-identity/azure/identity/_credentials/workload_identity.py Outdated
@pvaneck

pvaneck commented Nov 4, 2025

Copy link
Copy Markdown
Member Author

Successfully validated these changes in an actual AKS cluster with token binding enabled.

Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Comment thread sdk/identity/azure-identity/azure/identity/_internal/token_binding_transport.py Outdated
- Add fallback AsyncioRequestsTransport
- Add additonal error raise conditions
- Ensure token binding kwarg isn't respected in chained credentials

Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
Comment thread sdk/identity/azure-identity/tests/test_workload_identity_credential.py Outdated
Comment thread sdk/identity/azure-identity/tests/test_workload_identity_credential.py Outdated
Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
@pvaneck
pvaneck merged commit 4250940 into Azure:main Nov 7, 2025
21 checks passed
@github-project-automation github-project-automation Bot moved this from Untriaged to Done in Azure Identity SDK Improvements Nov 7, 2025
@pvaneck
pvaneck deleted the identity-aks-fic branch November 7, 2025 00:41
Copilot AI mentioned this pull request Jul 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Development

Successfully merging this pull request may close these issues.

4 participants