SqlAuthenticationProvider Класс

Определение

Пространство имен:

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.Extensions.Abstractions.dll

Пакет:

Microsoft.Data.SqlClient.Extensions.Abstractions v1.0.0

Определяет основное поведение поставщиков проверки подлинности и предоставляет базовый класс для производных классов.

public ref class SqlAuthenticationProvider abstract

public abstract class SqlAuthenticationProvider

type SqlAuthenticationProvider = class

Public MustInherit Class SqlAuthenticationProvider

Наследование

Object

SqlAuthenticationProvider

Производный

Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider

Примеры

В следующем примере показано, как реализовать пользовательский sqlAuthenticationProvider и предоставить то же самое SqlClient для переопределения режима проверки подлинности потока кода устройства:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.Data.SqlClient;
using Microsoft.Identity.Client;

namespace CustomAuthenticationProviderExamples
{
    /// <summary>
    /// Example demonstrating creating a custom device code flow authentication provider and attaching it to the driver.
    /// This is helpful for applications that wish to override the Callback for the Device Code Result implemented by the SqlClient driver.
    /// </summary>
    public class CustomDeviceCodeFlowAzureAuthenticationProvider : SqlAuthenticationProvider
    {
        private const string ClientId = "my-client-id";
        private const string ClientName = "My Application Name";
        private const string DefaultScopeSuffix = "/.default";

        // Maintain a copy of the PublicClientApplication object to cache the underlying access tokens it provides
        private static IPublicClientApplication pcApplication;

        public override async Task<SqlAuthenticationToken> AcquireTokenAsync(SqlAuthenticationParameters parameters)
        {
            string[] scopes = [ parameters.Resource.EndsWith(DefaultScopeSuffix) ? parameters.Resource : parameters.Resource + DefaultScopeSuffix ];

            IPublicClientApplication app = pcApplication;
            if (app == null)
            {
                pcApplication = app = PublicClientApplicationBuilder.Create(ClientId)
                    .WithAuthority(parameters.Authority)
                    .WithClientName(ClientName)
                    .WithRedirectUri("https://login.microsoftonline.com/common/oauth2/nativeclient")
                    .Build();
            }

            AuthenticationResult result;
            using CancellationTokenSource connectionTimeoutCancellation = new CancellationTokenSource(TimeSpan.FromSeconds(parameters.ConnectionTimeout));

            try
            {
                IEnumerable<IAccount> accounts = await app.GetAccountsAsync();
                result = await app.AcquireTokenSilent(scopes, accounts.FirstOrDefault())
                    .ExecuteAsync(connectionTimeoutCancellation.Token);
            }
            catch (MsalUiRequiredException)
            {
                result = await app.AcquireTokenWithDeviceCode(scopes, deviceCodeResult => CustomDeviceFlowCallback(deviceCodeResult))
                    .ExecuteAsync(connectionTimeoutCancellation.Token);
            }

            return new SqlAuthenticationToken(result.AccessToken, result.ExpiresOn);
        }

        public override bool IsSupported(SqlAuthenticationMethod authenticationMethod) =>
            authenticationMethod.Equals(SqlAuthenticationMethod.ActiveDirectoryDeviceCodeFlow);

        private Task CustomDeviceFlowCallback(DeviceCodeResult result)
        {
            Console.WriteLine(result.Message);
            return Task.CompletedTask;
        }
    }

    public class Program
    {
        public static void Main()
        {
            // Register our custom authentication provider class to override Active Directory Device Code Flow
            SqlAuthenticationProvider.SetProvider(SqlAuthenticationMethod.ActiveDirectoryDeviceCodeFlow, new CustomDeviceCodeFlowAzureAuthenticationProvider());
            using (SqlConnection sqlConnection = new SqlConnection("Server=<myserver>.database.windows.net;Authentication=Active Directory Device Code Flow;Database=<db>;"))
            {
                sqlConnection.Open();
                Console.WriteLine("Connected successfully!");
            }
        }
    }
}

Комментарии

Производные классы должны предоставить конструктор без параметров, если их можно создать из файла app.config.

Конструкторы

Имя	Описание
SqlAuthenticationProvider()	Определяет основное поведение поставщиков проверки подлинности и предоставляет базовый класс для производных классов.

Методы

Имя	Описание
AcquireTokenAsync(SqlAuthenticationParameters)	Получает маркер доступа от центра.
BeforeLoad(SqlAuthenticationMethod)	Этот метод вызывается непосредственно перед добавлением поставщика в реестр поставщика проверки подлинности SQL.
BeforeUnload(SqlAuthenticationMethod)	Этот метод вызывается непосредственно перед удалением поставщика из реестра поставщика проверки подлинности SQL.
GetProvider(SqlAuthenticationMethod)	Возвращает поставщик проверки подлинности по методу.
IsSupported(SqlAuthenticationMethod)	Указывает, поддерживается ли указанный метод проверки подлинности.
SetProvider(SqlAuthenticationMethod, SqlAuthenticationProvider)	Задает поставщик проверки подлинности по методу.