Enhance Bearer Authentication Support with Azure IMDS #2523
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Schema Registry client with Azure Instance Metadata Service (IMDS) authentication support, adding a new OAuth bearer authentication method that uses Azure's metadata service for secret-less token retrieval.
- Introduces
OAuthBearerAzureIMDSauthentication method with supporting infrastructure - Refactors existing authentication providers to use a builder pattern for better extensibility
- Adds comprehensive test coverage for the new Azure IMDS authentication scenarios
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
src/Confluent.SchemaRegistry/AuthCredentialsSource.cs |
Adds new OAuthBearerAzureIMDS enum value |
src/Confluent.SchemaRegistry/SchemaRegistryConfig.cs |
Adds new token endpoint query property and configuration mapping |
src/Confluent.SchemaRegistry/Rest/RestService.cs |
Refactors authentication provider creation to use builder pattern |
src/Confluent.SchemaRegistry/Rest/Authentication/OAuth/AzureIMDS/ |
Implements Azure IMDS authentication provider and builder |
src/Confluent.SchemaRegistry/Rest/Authentication/OAuth/ |
Introduces builder pattern classes for authentication providers |
src/Confluent.SchemaRegistry/Rest/Authentication/AbstractBearerAuthenticationHeaderValueProvider.cs |
Creates abstract base class for bearer authentication providers |
src/Confluent.SchemaRegistry/Rest/Authentication/BearerAuthenticationHeaderValueProvider.cs |
Refactors to extend abstract base class |
src/Confluent.SchemaRegistry/CachedSchemaRegistryClient.cs |
Updates property validation to include new Azure IMDS configuration |
test/Confluent.SchemaRegistry.UnitTests/CachedSchemaRegistryClient.cs |
Adds comprehensive test cases for Azure IMDS authentication |
examples/ |
Adds example demonstrating Azure IMDS usage |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
...chemaRegistry.UnitTests/Rest/Authentication/StaticBearerAuthenticationHeaderValueProvider.cs
Show resolved
Hide resolved
...stry/Rest/Authentication/OAuth/AzureIMDS/AzureIMDSBearerAuthenticationHeaderValueProvider.cs
Outdated
Show resolved
Hide resolved
This comment has been minimized.
This comment has been minimized.
- Introduced OAuthBearerAzureIMDS as a new authentication method in AuthCredentialsSource. - Updated CachedSchemaRegistryClient to support new Azure IMDS authentication configuration. - Implemented AzureIMDSBearerAuthenticationHeaderValueProvider for token retrieval using Azure Instance Metadata Service. - Added AzureIMDSBearerAuthenticationHeaderValueProviderBuilder to construct the new provider. - Refactored existing authentication header value providers to use a builder pattern for better extensibility. - Updated SchemaRegistryConfig to include new properties for Azure IMDS token endpoint and query parameters. - Enhanced unit tests to cover new Azure IMDS authentication scenarios.
airlock-confluentinc
bot
force-pushed
the
dev_sr_oautbearer_azure_imds
branch
from
62fd1b8 to
8ac4f79
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
Analysis Details0 Issues
Coverage and Duplications
Project ID: confluent-kafka-dotnet |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OAuthBearerAzureIMDSas a new authentication method inAuthCredentialsSource.CachedSchemaRegistryClientto support new Azure IMDS authentication configuration.AzureIMDSBearerAuthenticationHeaderValueProviderfor token retrieval using Azure Instance Metadata Service.AzureIMDSBearerAuthenticationHeaderValueProviderBuilderto construct the new provider.SchemaRegistryConfigto include new properties for Azure IMDS token endpoint and query parameters.What
Checklist
References
JIRA:
Test & Review
Unit tests are present. Will attach test results on an Azure instance.
Open questions / Follow-ups