Add credential support to ASP.NET Core integration layer #6805
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using Azure.Core.Extensions; | ||
|
|
||
| namespace Azure.ApplicationModel.Configuration | ||
| { | ||
| /// <summary> | ||
| /// Extension methods to add <see cref="ConfigurationClient"/> client to clients builder | ||
| /// </summary> | ||
| public static class AzureClientBuilderExtensions | ||
| { | ||
| /// <summary> | ||
| /// Registers a <see cref="ConfigurationClient"/> instance with the provided <paramref name="connectionString"/> | ||
| /// </summary> | ||
| public static IAzureClientBuilder<ConfigurationClient, ConfigurationClientOptions> AddConfigurationClient<TBuilder>(this TBuilder builder, string connectionString) | ||
| where TBuilder: IAzureClientFactoryBuilder | ||
| { | ||
| return builder.RegisterClientFactory<ConfigurationClient, ConfigurationClientOptions>(options => new ConfigurationClient(connectionString, options)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Registers a <see cref="ConfigurationClient"/> instance with connection options loaded from the provided <paramref name="configuration"/> instance. | ||
| /// </summary> | ||
| public static IAzureClientBuilder<ConfigurationClient, ConfigurationClientOptions> AddConfigurationClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration) | ||
| where TBuilder: IAzureClientFactoryBuilderWithConfiguration<TConfiguration> | ||
| { | ||
| return builder.RegisterClientFactory<ConfigurationClient, ConfigurationClientOptions>(configuration); | ||
| } | ||
| } | ||
| } |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||
| <PropertyGroup> | ||
| <RequiredTargetFrameworks>netcoreapp2.1</RequiredTargetFrameworks> | ||
| <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks> | ||
| <WarnOnPackingNonPackableProject>false</WarnOnPackingNonPackableProject> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.AspNetCore.App" IsImplicitlyDefined="true" /> | ||
|
There was a problem hiding this comment. Orthogonal to these changes: I'm not familiar with There was a problem hiding this comment. Sooooo, you are not supposed to have package version for Unfortunately, this conflicts with our central version management strategy that produces a warning when something outside of Packages.Data.props set a package version. IsImplicitlyDefined suppresses this warning. |
||
| <ProjectReference Include="..\..\..\keyvault\Azure.Security.KeyVault.Secrets\src\Azure.Security.KeyVault.Secrets.csproj" /> | ||
| <ProjectReference Include="..\src\Azure.Core.Extensions.csproj" /> | ||
| </ItemGroup> | ||
| </Project> | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using Azure.Core.Pipeline; | ||
| using Microsoft.AspNetCore.Hosting; | ||
|
|
||
| namespace Azure.Core.Extensions.Samples | ||
| { | ||
| internal class DependencyInjectionEnabledPolicy : SynchronousHttpPipelinePolicy | ||
| { | ||
| private readonly IHostingEnvironment _environment; | ||
|
|
||
| public DependencyInjectionEnabledPolicy(IHostingEnvironment environment) | ||
| { | ||
| this._environment = environment; | ||
| } | ||
|
|
||
| public override void OnSendingRequest(HttpPipelineMessage message) | ||
| { | ||
| message.Request.Headers.Add("application-name", _environment.ApplicationName); | ||
| base.OnSendingRequest(message); | ||
| } | ||
| } | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using Microsoft.AspNetCore; | ||
| using Microsoft.AspNetCore.Hosting; | ||
|
|
||
| namespace Azure.Core.Extensions.Samples | ||
| { | ||
| public class Program | ||
| { | ||
| public static void Main(string[] args) | ||
| { | ||
| CreateHostBuilder(args).Build().Run(); | ||
| } | ||
|
|
||
| public static IWebHostBuilder CreateHostBuilder(string[] args) => | ||
| WebHost.CreateDefaultBuilder(args) | ||
| .UseStartup<Startup>(); | ||
| } | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using Azure.Core.Pipeline; | ||
| using Azure.Identity; | ||
| using Azure.Security.KeyVault.Secrets; | ||
| using Microsoft.AspNetCore.Builder; | ||
| using Microsoft.AspNetCore.Hosting; | ||
| using Microsoft.AspNetCore.Http; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
|
|
||
| namespace Azure.Core.Extensions.Samples | ||
| { | ||
| public class Startup | ||
| { | ||
| public IConfiguration Configuration { get; } | ||
|
|
||
| public Startup(IConfiguration configuration) | ||
| { | ||
| Configuration = configuration; | ||
| } | ||
|
|
||
| // This method gets called by the runtime. Use this method to add services to the container. | ||
| // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940 | ||
| public void ConfigureServices(IServiceCollection services) | ||
| { | ||
| // Registering policy to use in ConfigureDefaults later | ||
| services.AddSingleton<DependencyInjectionEnabledPolicy>(); | ||
|
|
||
| services.AddAzureClients(builder => { | ||
|
|
||
| builder.AddSecretClient(Configuration.GetSection("KeyVault")) | ||
|
There was a problem hiding this comment. When I see it written like this, I wonder if we should be calling it There was a problem hiding this comment. We've been back and forth on this couple of times with @KrzysztofCwalina, I'm open to any naming schema but would prefer to follow up on this later. |
||
| .WithName("Default") | ||
| .WithCredential(new DefaultAzureCredential()) | ||
| .ConfigureOptions(options => options.Retry.MaxRetries = 10); | ||
|
|
||
| builder.AddSecretClient(new Uri("http://my.keyvault.com")); | ||
|
|
||
| builder.UseCredential(new DefaultAzureCredential()); | ||
pakrym marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // This would use configuration for auth and client settings | ||
| builder.ConfigureDefaults(Configuration.GetSection("Default")); | ||
|
|
||
| // Configure global defaults | ||
| builder.ConfigureDefaults(options => options.Retry.Mode = RetryMode.Exponential); | ||
|
|
||
| // Advanced configure global defaults | ||
| builder.ConfigureDefaults((options, provider) => options.AddPolicy(HttpPipelinePosition.PerCall, provider.GetService<DependencyInjectionEnabledPolicy>())); | ||
| }); | ||
| } | ||
|
|
||
| // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. | ||
| public void Configure(IApplicationBuilder app, IHostingEnvironment env, SecretClient secretClient) | ||
| { | ||
| if (env.IsDevelopment()) | ||
| { | ||
| app.UseDeveloperExceptionPage(); | ||
| } | ||
|
|
||
| app.Run(async context => { | ||
| context.Response.ContentType = "text"; | ||
| foreach (var secret in secretClient.GetSecrets()) | ||
| { | ||
| await context.Response.WriteAsync(secret.Value.Name + Environment.NewLine); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Debug" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*", | ||
| "Default": { | ||
| "ClientId": "<client_id>", | ||
| "ClientSecret": "<client_secret>", | ||
| "TenantId": "<tenant_id>", | ||
|
|
||
| "TelemetryPolicy": { | ||
| "ApplicationId": "AppId" | ||
| } | ||
| }, | ||
| "KeyVault": { | ||
| "VaultUri": "<vault_uri>" | ||
| } | ||
| } |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.Options; | ||
|
|
||
| namespace Azure.Core.Extensions | ||
| { | ||
| public static class AzureClientBuilderExtensions | ||
| { | ||
| public static IAzureClientBuilder<TClient, TOptions> WithName<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder, string name) where TOptions : class | ||
| { | ||
| builder.ToBuilder().Registration.Name = name; | ||
| return builder; | ||
| } | ||
|
|
||
| public static IAzureClientBuilder<TClient, TOptions> WithCredential<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder, TokenCredential credential) where TOptions : class | ||
|
There was a problem hiding this comment. Should we add a base credential type? We have other types like There was a problem hiding this comment. I'll follow up on this while working on storage extension methods. |
||
| { | ||
| return builder.WithCredential(_ => credential); | ||
| } | ||
|
|
||
| public static IAzureClientBuilder<TClient, TOptions> WithCredential<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder, Func<IServiceProvider, TokenCredential> credentialFactory) where TOptions : class | ||
| { | ||
| var impl = builder.ToBuilder(); | ||
| impl.ServiceCollection.AddSingleton<IConfigureOptions<AzureClientCredentialOptions<TClient>>>(new ConfigureClientCredentials<TClient,TOptions>(impl.Registration, credentialFactory)); | ||
| return builder; | ||
| } | ||
|
|
||
| public static IAzureClientBuilder<TClient, TOptions> ConfigureOptions<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder, Action<TOptions> configureOptions) where TOptions : class | ||
| { | ||
| return builder.ConfigureOptions((options, _) => configureOptions(options)); | ||
| } | ||
|
|
||
| public static IAzureClientBuilder<TClient, TOptions> ConfigureOptions<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder, IConfiguration configuration) where TOptions : class | ||
| { | ||
| return builder.ConfigureOptions(options => configuration.Bind(options)); | ||
| } | ||
|
|
||
| public static IAzureClientBuilder<TClient, TOptions> ConfigureOptions<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder, Action<TOptions, IServiceProvider> configureOptions) where TOptions : class | ||
| { | ||
| var impl = builder.ToBuilder(); | ||
| impl.ServiceCollection.AddSingleton<IConfigureOptions<TOptions>>(provider => new ConfigureClientOptions<TClient,TOptions>(provider, impl.Registration, configureOptions));; | ||
| return builder; | ||
| } | ||
|
|
||
| private static AzureClientBuilder<TClient, TOptions> ToBuilder<TClient, TOptions>(this IAzureClientBuilder<TClient, TOptions> builder) where TOptions : class | ||
| { | ||
| return (AzureClientBuilder<TClient, TOptions>)builder; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit - any reason not to follow our existing
.Samples.Testsapproach for testable samples?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really want to give folks outside our team an easy way to play with new APIs in ASP.NET Core app
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can also consider checking for
/samples/in the path.