durable task scheduler auth extension support #362
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net6.0</TargetFramework> | ||
| <PackageDescription>Azure Managed extensions for the Durable Task Framework client.</PackageDescription> | ||
| <EnableStyleCop>true</EnableStyleCop> | ||
| <VersionSuffix>preview.1</VersionSuffix> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="../../Client/Grpc/Client.Grpc.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Azure.Identity" Version="1.13.1" /> | ||
| <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="6.0.1" /> | ||
| <PackageReference Include="Grpc.Net.Client" Version="2.67.0" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <SharedSection Include="AzureManaged" /> | ||
| <SharedSection Include="Core" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using Azure.Core; | ||
| using Microsoft.DurableTask.Client.Grpc; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.DependencyInjection.Extensions; | ||
| using Microsoft.Extensions.Options; | ||
|
|
||
| namespace Microsoft.DurableTask.Client.AzureManaged; | ||
|
|
||
| /// <summary> | ||
| /// Extension methods for configuring Durable Task clients to use the Azure Durable Task Scheduler service. | ||
| /// </summary> | ||
| public static class DurableTaskSchedulerClientExtensions | ||
| { | ||
| /// <summary> | ||
| /// Configures Durable Task client to use the Azure Durable Task Scheduler service. | ||
| /// </summary> | ||
| /// <param name="builder">The Durable Task client builder to configure.</param> | ||
| /// <param name="endpointAddress">The endpoint address of the Durable Task Scheduler resource. Expected to be in the format "https://{scheduler-name}.{region}.durabletask.io".</param> | ||
| /// <param name="taskHubName">The name of the task hub resource associated with the Durable Task Scheduler resource.</param> | ||
| /// <param name="credential">The credential used to authenticate with the Durable Task Scheduler task hub resource.</param> | ||
| /// <param name="configure">Optional callback to dynamically configure DurableTaskSchedulerClientOptions.</param> | ||
| public static void UseDurableTaskScheduler( | ||
| this IDurableTaskClientBuilder builder, | ||
| string endpointAddress, | ||
| string taskHubName, | ||
| TokenCredential credential, | ||
| Action<DurableTaskSchedulerClientOptions>? configure = null) | ||
| { | ||
| ConfigureSchedulerOptions( | ||
| builder, | ||
| options => | ||
| { | ||
| options.EndpointAddress = endpointAddress; | ||
| options.TaskHubName = taskHubName; | ||
| options.Credential = credential; | ||
| }, | ||
| configure); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Configures Durable Task client to use the Azure Durable Task Scheduler service using a connection string. | ||
| /// </summary> | ||
| /// <param name="builder">The Durable Task client builder to configure.</param> | ||
| /// <param name="connectionString">The connection string used to connect to the Durable Task Scheduler service.</param> | ||
| /// <param name="configure">Optional callback to dynamically configure DurableTaskSchedulerClientOptions.</param> | ||
| public static void UseDurableTaskScheduler( | ||
| this IDurableTaskClientBuilder builder, | ||
| string connectionString, | ||
| Action<DurableTaskSchedulerClientOptions>? configure = null) | ||
| { | ||
| var connectionOptions = DurableTaskSchedulerClientOptions.FromConnectionString(connectionString); | ||
| ConfigureSchedulerOptions( | ||
| builder, | ||
| options => | ||
| { | ||
| options.EndpointAddress = connectionOptions.EndpointAddress; | ||
| options.TaskHubName = connectionOptions.TaskHubName; | ||
| options.Credential = connectionOptions.Credential; | ||
| }, | ||
| configure); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Configures Durable Task client to use the Azure Durable Task Scheduler service using configuration options. | ||
| /// </summary> | ||
| /// <param name="builder">The Durable Task client builder to configure.</param> | ||
| /// <param name="configure">Callback to configure DurableTaskSchedulerClientOptions.</param> | ||
| public static void UseDurableTaskScheduler( | ||
| this IDurableTaskClientBuilder builder, | ||
| Action<DurableTaskSchedulerClientOptions>? configure = null) | ||
| { | ||
| ConfigureSchedulerOptions(builder, _ => { }, configure); | ||
| } | ||
|
|
||
| static void ConfigureSchedulerOptions( | ||
| IDurableTaskClientBuilder builder, | ||
| Action<DurableTaskSchedulerClientOptions> initialConfig, | ||
| Action<DurableTaskSchedulerClientOptions>? additionalConfig) | ||
| { | ||
| builder.Services.AddOptions<DurableTaskSchedulerClientOptions>(builder.Name) | ||
| .Configure(initialConfig) | ||
| .Configure(additionalConfig ?? (_ => { })) | ||
| .ValidateDataAnnotations(); | ||
|
|
||
| builder.Services.TryAddEnumerable( | ||
| ServiceDescriptor.Singleton<IConfigureOptions<GrpcDurableTaskClientOptions>, ConfigureGrpcChannel>()); | ||
| builder.UseGrpc(_ => { }); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Configuration class that sets up gRPC channels for client options | ||
| /// using the provided Durable Task Scheduler options. | ||
| /// </summary> | ||
| /// <param name="schedulerOptions">Monitor for accessing the current scheduler options configuration.</param> | ||
| class ConfigureGrpcChannel(IOptionsMonitor<DurableTaskSchedulerClientOptions> schedulerOptions) : | ||
| IConfigureNamedOptions<GrpcDurableTaskClientOptions> | ||
| { | ||
| /// <summary> | ||
| /// Configures the default named options instance. | ||
| /// </summary> | ||
| /// <param name="options">The options instance to configure.</param> | ||
| public void Configure(GrpcDurableTaskClientOptions options) => this.Configure(Options.DefaultName, options); | ||
|
|
||
| /// <summary> | ||
| /// Configures a named options instance. | ||
| /// </summary> | ||
| /// <param name="name">The name of the options instance to configure.</param> | ||
| /// <param name="options">The options instance to configure.</param> | ||
| public void Configure(string? name, GrpcDurableTaskClientOptions options) | ||
| { | ||
| DurableTaskSchedulerClientOptions source = schedulerOptions.Get(name ?? Options.DefaultName); | ||
| options.Channel = source.CreateChannel(); | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
| using System.ComponentModel.DataAnnotations; | ||
| using Azure.Core; | ||
| using Azure.Identity; | ||
| using Grpc.Core; | ||
| using Grpc.Net.Client; | ||
|
|
||
| namespace Microsoft.DurableTask; | ||
|
|
||
| /// <summary> | ||
| /// Options for configuring the Durable Task Scheduler. | ||
| /// </summary> | ||
| public class DurableTaskSchedulerClientOptions | ||
| { | ||
| /// <summary> | ||
| /// Gets or sets the endpoint address of the Durable Task Scheduler resource. | ||
| /// Expected to be in the format "https://{scheduler-name}.{region}.durabletask.io". | ||
| /// </summary> | ||
| [Required(ErrorMessage = "Endpoint address is required")] | ||
| public string EndpointAddress { get; set; } = string.Empty; | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the name of the task hub resource associated with the Durable Task Scheduler resource. | ||
| /// </summary> | ||
| [Required(ErrorMessage = "Task hub name is required")] | ||
| public string TaskHubName { get; set; } = string.Empty; | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the credential used to authenticate with the Durable Task Scheduler task hub resource. | ||
| /// </summary> | ||
| public TokenCredential? Credential { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the resource ID of the Durable Task Scheduler resource. | ||
| /// The default value is https://durabletask.io. | ||
| /// </summary> | ||
| public string ResourceId { get; set; } = "https://durabletask.io"; | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets a value indicating whether to allow insecure channel credentials. | ||
| /// This should only be set to true in local development/testing scenarios. | ||
| /// </summary> | ||
| public bool AllowInsecureCredentials { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance of <see cref="DurableTaskSchedulerClientOptions"/> from a connection string. | ||
| /// </summary> | ||
| /// <param name="connectionString">The connection string to parse.</param> | ||
| /// <returns>A new instance of <see cref="DurableTaskSchedulerClientOptions"/>.</returns> | ||
| public static DurableTaskSchedulerClientOptions FromConnectionString(string connectionString) | ||
| { | ||
| return FromConnectionString(new DurableTaskSchedulerConnectionString(connectionString)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Creates a gRPC channel for communicating with the Durable Task Scheduler service. | ||
| /// </summary> | ||
| /// <returns>A configured <see cref="GrpcChannel"/> instance that can be used to make gRPC calls.</returns> | ||
| internal GrpcChannel CreateChannel() | ||
| { | ||
| Verify.NotNull(this.EndpointAddress, nameof(this.EndpointAddress)); | ||
| Verify.NotNull(this.TaskHubName, nameof(this.TaskHubName)); | ||
| string taskHubName = this.TaskHubName; | ||
| string endpoint = !this.EndpointAddress.Contains("://") | ||
| ? $"https://{this.EndpointAddress}" | ||
| : this.EndpointAddress; | ||
| AccessTokenCache? cache = | ||
| this.Credential is not null | ||
| ? new AccessTokenCache( | ||
| this.Credential, | ||
| new TokenRequestContext(new[] { $"{this.ResourceId}/.default" }), | ||
| TimeSpan.FromMinutes(5)) | ||
| : null; | ||
| CallCredentials managedBackendCreds = CallCredentials.FromInterceptor( | ||
| async (context, metadata) => | ||
| { | ||
| metadata.Add("taskhub", taskHubName); | ||
| if (cache == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| AccessToken token = await cache.GetTokenAsync(context.CancellationToken); | ||
| metadata.Add("Authorization", $"Bearer {token.Token}"); | ||
| }); | ||
|
|
||
| // Production will use HTTPS, but local testing will use HTTP | ||
| ChannelCredentials channelCreds = endpoint.StartsWith("https://", StringComparison.OrdinalIgnoreCase) ? | ||
| ChannelCredentials.SecureSsl : | ||
| ChannelCredentials.Insecure; | ||
| return GrpcChannel.ForAddress(endpoint, new GrpcChannelOptions | ||
| { | ||
| Credentials = ChannelCredentials.Create(channelCreds, managedBackendCreds), | ||
| UnsafeUseInsecureChannelCallCredentials = this.AllowInsecureCredentials, | ||
| }); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance of <see cref="DurableTaskSchedulerClientOptions"/> from a parsed connection string. | ||
| /// </summary> | ||
| /// <param name="connectionString">The connection string to parse.</param> | ||
| /// <returns>A new instance of <see cref="DurableTaskSchedulerClientOptions"/>.</returns> | ||
| internal static DurableTaskSchedulerClientOptions FromConnectionString( | ||
|
Check warning on line 104 in src/Client/AzureManaged/DurableTaskSchedulerClientOptions.cs
|
||
| DurableTaskSchedulerConnectionString connectionString) => new() | ||
| { | ||
| EndpointAddress = connectionString.Endpoint, | ||
| TaskHubName = connectionString.TaskHubName, | ||
| Credential = GetCredentialFromConnectionString(connectionString), | ||
| }; | ||
|
|
||
| static TokenCredential? GetCredentialFromConnectionString(DurableTaskSchedulerConnectionString connectionString) | ||
| { | ||
| string authType = connectionString.Authentication; | ||
|
|
||
| // Parse the supported auth types, in a case-insensitive way and without spaces | ||
| switch (authType.ToLowerInvariant()) | ||
| { | ||
| case "defaultazure": | ||
| return new DefaultAzureCredential(); | ||
| case "managedidentity": | ||
| return new ManagedIdentityCredential(connectionString.ClientId); | ||
| case "workloadidentity": | ||
| var opts = new WorkloadIdentityCredentialOptions(); | ||
| if (!string.IsNullOrEmpty(connectionString.ClientId)) | ||
| { | ||
| opts.ClientId = connectionString.ClientId; | ||
| } | ||
|
|
||
| if (!string.IsNullOrEmpty(connectionString.TenantId)) | ||
| { | ||
| opts.TenantId = connectionString.TenantId; | ||
| } | ||
|
|
||
| if (connectionString.AdditionallyAllowedTenants is not null) | ||
| { | ||
| foreach (string tenant in connectionString.AdditionallyAllowedTenants) | ||
| { | ||
| opts.AdditionallyAllowedTenants.Add(tenant); | ||
| } | ||
| } | ||
|
|
||
| return new WorkloadIdentityCredential(opts); | ||
| case "environment": | ||
| return new EnvironmentCredential(); | ||
| case "azurecli": | ||
| return new AzureCliCredential(); | ||
| case "azurepowershell": | ||
| return new AzurePowerShellCredential(); | ||
| case "none": | ||
| return null; | ||
| default: | ||
| throw new ArgumentException( | ||
| $"The connection string contains an unsupported authentication type '{authType}'.", | ||
| nameof(connectionString)); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.