-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add token credential auth support (#17308)
- Loading branch information
Showing
20 changed files
with
576 additions
and
395 deletions.
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
213 changes: 213 additions & 0 deletions
213
...eventhub/Microsoft.Azure.WebJobs.Extensions.EventHubs/src/Config/EventHubClientFactory.cs
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,213 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.Collections.Concurrent; | ||
| using Azure.Core; | ||
| using Azure.Messaging.EventHubs.Consumer; | ||
| using Azure.Messaging.EventHubs.Producer; | ||
| using Azure.Storage.Blobs; | ||
| using Microsoft.Azure.WebJobs.EventHubs.Processor; | ||
| using Microsoft.Azure.WebJobs.Extensions.Clients.Shared; | ||
| using Microsoft.Azure.WebJobs.Host; | ||
| using Microsoft.Extensions.Azure; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Microsoft.Extensions.Options; | ||
|
|
||
| namespace Microsoft.Azure.WebJobs.EventHubs | ||
| { | ||
| internal class EventHubClientFactory | ||
| { | ||
| private readonly IConfiguration _configuration; | ||
| private readonly AzureComponentFactory _componentFactory; | ||
| private readonly EventHubOptions _options; | ||
| private readonly INameResolver _nameResolver; | ||
| private readonly ConcurrentDictionary<string, EventHubProducerClient> _producerCache; | ||
| private readonly ConcurrentDictionary<string, IEventHubConsumerClient> _consumerCache = new (); | ||
|
|
||
| public EventHubClientFactory( | ||
| IConfiguration configuration, | ||
| AzureComponentFactory componentFactory, | ||
| IOptions<EventHubOptions> options, | ||
| INameResolver nameResolver) | ||
| { | ||
| _configuration = configuration; | ||
| _componentFactory = componentFactory; | ||
| _options = options.Value; | ||
| _nameResolver = nameResolver; | ||
| _producerCache = new ConcurrentDictionary<string, EventHubProducerClient>(_options.RegisteredProducers); | ||
| } | ||
|
|
||
| internal EventHubProducerClient GetEventHubProducerClient(string eventHubName, string connection) | ||
| { | ||
| eventHubName = _nameResolver.ResolveWholeString(eventHubName); | ||
|
|
||
| return _producerCache.GetOrAdd(eventHubName, key => | ||
| { | ||
| if (!string.IsNullOrWhiteSpace(connection)) | ||
| { | ||
| var info = ResolveConnectionInformation(connection); | ||
|
|
||
| if (info.FullyQualifiedEndpoint != null && | ||
| info.TokenCredential != null) | ||
| { | ||
| return new EventHubProducerClient(info.FullyQualifiedEndpoint, eventHubName, info.TokenCredential); | ||
| } | ||
|
|
||
| return new EventHubProducerClient(NormalizeConnectionString(info.ConnectionString, eventHubName)); | ||
| } | ||
|
|
||
| throw new InvalidOperationException("No event hub sender named " + eventHubName); | ||
| }); | ||
| } | ||
|
|
||
| internal EventProcessorHost GetEventProcessorHost(string eventHubName, string connection, string consumerGroup) | ||
| { | ||
| eventHubName = _nameResolver.ResolveWholeString(eventHubName); | ||
| consumerGroup ??= EventHubConsumerClient.DefaultConsumerGroupName; | ||
|
|
||
| if (_options.RegisteredConsumerCredentials.TryGetValue(eventHubName, out var creds)) | ||
| { | ||
| return new EventProcessorHost(consumerGroup: consumerGroup, | ||
| connectionString: creds.EventHubConnectionString, | ||
| eventHubName: eventHubName, | ||
| options: _options.EventProcessorOptions, | ||
| eventBatchMaximumCount: _options.MaxBatchSize, | ||
| invokeProcessorAfterReceiveTimeout: _options.InvokeProcessorAfterReceiveTimeout, | ||
| exceptionHandler: _options.ExceptionHandler); | ||
| } | ||
| else if (!string.IsNullOrEmpty(connection)) | ||
| { | ||
| var info = ResolveConnectionInformation(connection); | ||
|
|
||
| if (info.FullyQualifiedEndpoint != null && | ||
| info.TokenCredential != null) | ||
| { | ||
| return new EventProcessorHost(consumerGroup: consumerGroup, | ||
| fullyQualifiedNamespace: info.FullyQualifiedEndpoint, | ||
| eventHubName: eventHubName, | ||
| credential: info.TokenCredential, | ||
| options: _options.EventProcessorOptions, | ||
| eventBatchMaximumCount: _options.MaxBatchSize, | ||
| invokeProcessorAfterReceiveTimeout: _options.InvokeProcessorAfterReceiveTimeout, | ||
| exceptionHandler: _options.ExceptionHandler); | ||
| } | ||
|
|
||
| return new EventProcessorHost(consumerGroup: consumerGroup, | ||
| connectionString: NormalizeConnectionString(info.ConnectionString, eventHubName), | ||
| eventHubName: eventHubName, | ||
| options: _options.EventProcessorOptions, | ||
| eventBatchMaximumCount: _options.MaxBatchSize, | ||
| invokeProcessorAfterReceiveTimeout: _options.InvokeProcessorAfterReceiveTimeout, | ||
| exceptionHandler: _options.ExceptionHandler); | ||
| } | ||
|
|
||
| throw new InvalidOperationException("No event hub receiver named " + eventHubName); | ||
| } | ||
|
|
||
| internal IEventHubConsumerClient GetEventHubConsumerClient(string eventHubName, string connection, string consumerGroup) | ||
| { | ||
| eventHubName = _nameResolver.ResolveWholeString(eventHubName); | ||
| consumerGroup ??= EventHubConsumerClient.DefaultConsumerGroupName; | ||
|
|
||
| return _consumerCache.GetOrAdd(eventHubName, name => | ||
| { | ||
| EventHubConsumerClient client = null; | ||
| if (_options.RegisteredConsumerCredentials.TryGetValue(eventHubName, out var creds)) | ||
| { | ||
| client = new EventHubConsumerClient(consumerGroup, creds.EventHubConnectionString, eventHubName); | ||
| } | ||
| else if (!string.IsNullOrEmpty(connection)) | ||
| { | ||
| var info = ResolveConnectionInformation(connection); | ||
|
|
||
| if (info.FullyQualifiedEndpoint != null && | ||
| info.TokenCredential != null) | ||
| { | ||
| client = new EventHubConsumerClient(consumerGroup, info.FullyQualifiedEndpoint, eventHubName, info.TokenCredential); | ||
| } | ||
| else | ||
| { | ||
| client = new EventHubConsumerClient(consumerGroup, NormalizeConnectionString(info.ConnectionString, eventHubName)); | ||
| } | ||
| } | ||
|
|
||
| if (client != null) | ||
| { | ||
| return new EventHubConsumerClientImpl(client); | ||
| } | ||
|
|
||
| throw new InvalidOperationException("No event hub receiver named " + eventHubName); | ||
| }); | ||
| } | ||
|
|
||
| internal BlobContainerClient GetCheckpointStoreClient(string eventHubName) | ||
| { | ||
| string storageConnectionString = null; | ||
| if (_options.RegisteredConsumerCredentials.TryGetValue(eventHubName, out var creds)) | ||
| { | ||
| storageConnectionString = creds.StorageConnectionString; | ||
| } | ||
|
|
||
| // Fall back to default if not explicitly registered | ||
| return new BlobContainerClient(storageConnectionString ?? _configuration.GetWebJobsConnectionString(ConnectionStringNames.Storage), _options.LeaseContainerName); | ||
| } | ||
|
|
||
| internal static string NormalizeConnectionString(string originalConnectionString, string eventHubName) | ||
| { | ||
| var connectionString = ConnectionString.Parse(originalConnectionString); | ||
|
|
||
| if (!connectionString.ContainsSegmentKey("EntityPath")) | ||
| { | ||
| connectionString.Add("EntityPath", eventHubName); | ||
| } | ||
|
|
||
| return connectionString.ToString(); | ||
| } | ||
|
|
||
| private EventHubsConnectionInformation ResolveConnectionInformation(string connection) | ||
| { | ||
| IConfigurationSection connectionSection = _configuration.GetWebJobsConnectionStringSection(connection); | ||
| if (!connectionSection.Exists()) | ||
| { | ||
| // Not found | ||
| throw new InvalidOperationException($"EventHub account connection string '{connection}' does not exist." + | ||
| $"Make sure that it is a defined App Setting."); | ||
| } | ||
|
|
||
| if (!string.IsNullOrWhiteSpace(connectionSection.Value)) | ||
| { | ||
| return new EventHubsConnectionInformation(connectionSection.Value); | ||
| } | ||
|
|
||
| var fullyQualifiedNamespace = connectionSection["fullyQualifiedNamespace"]; | ||
| if (string.IsNullOrWhiteSpace(fullyQualifiedNamespace)) | ||
| { | ||
| // Not found | ||
| throw new InvalidOperationException($"Connection should have an 'fullyQualifiedNamespace' property or be a string representing a connection string."); | ||
| } | ||
|
|
||
| var credential = _componentFactory.CreateTokenCredential(connectionSection); | ||
|
|
||
| return new EventHubsConnectionInformation(fullyQualifiedNamespace, credential); | ||
| } | ||
|
|
||
| private record EventHubsConnectionInformation | ||
| { | ||
| public EventHubsConnectionInformation(string connectionString) | ||
| { | ||
| ConnectionString = connectionString; | ||
| } | ||
|
|
||
| public EventHubsConnectionInformation(string fullyQualifiedEndpoint, TokenCredential tokenCredential) | ||
| { | ||
| FullyQualifiedEndpoint = fullyQualifiedEndpoint; | ||
| TokenCredential = tokenCredential; | ||
| } | ||
|
|
||
| public string ConnectionString { get; } | ||
| public string FullyQualifiedEndpoint { get; } | ||
| public TokenCredential TokenCredential { get; } | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.