diff --git a/src/Cli.Tests/SqlClientAuthenticationTests.cs b/src/Cli.Tests/SqlClientAuthenticationTests.cs new file mode 100644 index 0000000000..70fc3263bd --- /dev/null +++ b/src/Cli.Tests/SqlClientAuthenticationTests.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Reflection; +using Azure.DataApiBuilder.Core.AuthenticationHelpers; +using Microsoft.Data.SqlClient; + +namespace Cli.Tests; + +[TestClass] +[DoNotParallelize] +public sealed class SqlClientAuthenticationTests +{ + private const string CLIENT_ID = "11111111-1111-1111-1111-111111111111"; + private readonly string? _originalClientId = + Environment.GetEnvironmentVariable(UserDelegatedAuthOptions.DAB_OBO_CLIENT_ID_ENV_VAR); + private readonly Dictionary _originalProviders = + Enum.GetValues().ToDictionary(method => method, SqlAuthenticationProvider.GetProvider); + + [TestCleanup] + public void Cleanup() + { + Environment.SetEnvironmentVariable(UserDelegatedAuthOptions.DAB_OBO_CLIENT_ID_ENV_VAR, _originalClientId); + foreach ((SqlAuthenticationMethod method, SqlAuthenticationProvider? provider) in _originalProviders) + { + if (provider is not null) + { + Assert.IsTrue(SqlAuthenticationProvider.SetProvider(method, provider)); + } + } + } + + [TestMethod] + public void RegisterProviders_ConfiguredClientId_RegistersSharedProviderForEverySupportedMethod() + { + Environment.SetEnvironmentVariable(UserDelegatedAuthOptions.DAB_OBO_CLIENT_ID_ENV_VAR, CLIENT_ID); + + SqlClientAuthentication.RegisterProviders(); + + SqlAuthenticationProvider provider = SqlAuthenticationProvider.GetProvider(SqlAuthenticationMethod.ActiveDirectoryInteractive); + Assert.IsInstanceOfType(provider); + // SqlClient does not expose the constructor's client ID through its public API. + FieldInfo? clientIdField = typeof(ActiveDirectoryAuthenticationProvider) + .GetField("_applicationClientId", BindingFlags.Instance | BindingFlags.NonPublic); + Assert.IsNotNull(clientIdField); + Assert.AreEqual(CLIENT_ID, clientIdField.GetValue(provider)); + + foreach (SqlAuthenticationMethod method in Enum.GetValues()) + { + if (provider.IsSupported(method)) + { + Assert.AreSame(provider, SqlAuthenticationProvider.GetProvider(method), method.ToString()); + } + else + { + Assert.AreSame(_originalProviders[method], SqlAuthenticationProvider.GetProvider(method), method.ToString()); + } + } + } + + [TestMethod] + [DataRow(null)] + [DataRow("")] + [DataRow(" \t")] + public void RegisterProviders_NoClientId_PreservesExistingProviders(string? clientId) + { + Environment.SetEnvironmentVariable(UserDelegatedAuthOptions.DAB_OBO_CLIENT_ID_ENV_VAR, clientId); + + SqlClientAuthentication.RegisterProviders(); + + foreach ((SqlAuthenticationMethod method, SqlAuthenticationProvider? provider) in _originalProviders) + { + Assert.AreSame(provider, SqlAuthenticationProvider.GetProvider(method), method.ToString()); + } + } +} diff --git a/src/Cli/ConfigGenerator.cs b/src/Cli/ConfigGenerator.cs index 834b26f519..22bc9ed292 100644 --- a/src/Cli/ConfigGenerator.cs +++ b/src/Cli/ConfigGenerator.cs @@ -12,6 +12,7 @@ using Azure.DataApiBuilder.Config.ObjectModel; using Azure.DataApiBuilder.Config.ObjectModel.Embeddings; using Azure.DataApiBuilder.Core; +using Azure.DataApiBuilder.Core.AuthenticationHelpers; using Azure.DataApiBuilder.Core.Configurations; using Azure.DataApiBuilder.Core.Resolvers; using Azure.DataApiBuilder.Core.Telemetry.Product; @@ -4000,6 +4001,7 @@ public static bool TrySimulateAutoentities(AutoConfigSimulateOptions options, Fi try { + SqlClientAuthentication.RegisterProviders(); using SqlConnection connection = new(connectionString); connection.Open(); diff --git a/src/Config/ObjectModel/DataSource.cs b/src/Config/ObjectModel/DataSource.cs index 9bfd40034a..74edf7ae88 100644 --- a/src/Config/ObjectModel/DataSource.cs +++ b/src/Config/ObjectModel/DataSource.cs @@ -177,6 +177,12 @@ public record UserDelegatedAuthOptions( /// /// Environment variable name for the API App Registration client ID, required for either OBO credential method. /// This is not the client ID of the Managed Identity used for federation. + /// When set, DAB also passes this ID to SqlClient's ActiveDirectoryAuthenticationProvider + /// and registers it process-wide for all supported authentication methods, including metadata + /// and CLI autoentities connections. Blank values leave SqlClient's existing providers unchanged. + /// Public-client authentication flows require the corresponding Entra app registration configuration. + /// This does not change DefaultAzureCredential or override the identities selected by + /// managed identity, service principal, or workload identity authentication. /// Uses DAB-specific prefix to avoid conflict with AZURE_CLIENT_ID which is /// interpreted by DefaultAzureCredential/ManagedIdentityCredential as a /// User-Assigned Managed Identity ID. diff --git a/src/Core/AuthenticationHelpers/SqlClientAuthentication.cs b/src/Core/AuthenticationHelpers/SqlClientAuthentication.cs new file mode 100644 index 0000000000..229c2308ca --- /dev/null +++ b/src/Core/AuthenticationHelpers/SqlClientAuthentication.cs @@ -0,0 +1,35 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Azure.DataApiBuilder.Config.ObjectModel; +using Microsoft.Data.SqlClient; + +namespace Azure.DataApiBuilder.Core.AuthenticationHelpers; + +/// +/// Configures SqlClient authentication with the application identity used for OBO. +/// +internal static class SqlClientAuthentication +{ + /// + /// Registers a shared provider for every authentication method it supports. + /// Leaves SqlClient's existing providers unchanged when no application client ID is configured. + /// + internal static void RegisterProviders() + { + string? clientId = Environment.GetEnvironmentVariable(UserDelegatedAuthOptions.DAB_OBO_CLIENT_ID_ENV_VAR); + if (string.IsNullOrWhiteSpace(clientId)) + { + return; + } + + ActiveDirectoryAuthenticationProvider provider = new(clientId); + foreach (SqlAuthenticationMethod method in Enum.GetValues()) + { + if (provider.IsSupported(method) && !SqlAuthenticationProvider.SetProvider(method, provider)) + { + throw new InvalidOperationException($"Failed to register the SqlClient authentication provider for {method}."); + } + } + } +} diff --git a/src/Core/Resolvers/MsSqlQueryExecutor.cs b/src/Core/Resolvers/MsSqlQueryExecutor.cs index 26a4582c40..3d606b953f 100644 --- a/src/Core/Resolvers/MsSqlQueryExecutor.cs +++ b/src/Core/Resolvers/MsSqlQueryExecutor.cs @@ -10,6 +10,7 @@ using Azure.Core; using Azure.DataApiBuilder.Config; using Azure.DataApiBuilder.Config.ObjectModel; +using Azure.DataApiBuilder.Core.AuthenticationHelpers; using Azure.DataApiBuilder.Core.Authorization; using Azure.DataApiBuilder.Core.Configurations; using Azure.DataApiBuilder.Core.Models; @@ -101,6 +102,7 @@ public MsSqlQueryExecutor( httpContextAccessor, handler) { + SqlClientAuthentication.RegisterProviders(); _dataSourceAccessTokenUsage = new Dictionary(); _dataSourceToSessionContextUsage = new Dictionary(); _dataSourceUserDelegatedAuth = new Dictionary();