Auth0Net.DependencyInjection

Другие категории

v4.0.0

Скачать

Расширения внедрения зависимостей Auth0.NET

Интеграция Auth0.NET в ваш проект при соблюдении идиоматических соглашений .NET может быть обременительной и включать в себя значительный объем шаблонного кода, совместно используемого между проектами.

Эта библиотека надеется решить эту проблему, предлагая:

Расширения для Microsoft.Extensions.DependencyInjection .

Автоматическое кэширование и обновление токенов доступа для Management API и ваших собственных служб REST и Grpc.

Интеграция HttpClientFactory для централизованного расширения и управления внутренними обработчиками HTTP.

Расширения IHttpClientBuilder , предоставляющие обработчики для автоматического добавления токенов доступа к исходящим запросам.

Эта библиотека совместима со всеми средами выполнения .NET Standard 2.0 (рекомендуется .NET 8+) и подходит для использования в ASP.NET Core и автономных приложениях .NET Generic Host.

Установить

Добавьте Auth0Net.DependencyInjection в свой проект:

 Install-Package Auth0Net.DependencyInjection

Сценарии

Только клиент аутентификации

Auth0Аутентификация

Если вы просто используете AuthenticationApiClient и ничего больше, вы можете вызвать AddAuth0AuthenticationClientCore и передать свой домен Auth0. Эта интеграция является легкой и не поддерживает никаких других функций этой библиотеки.

 services . AddAuth0AuthenticationClientCore ( "your-auth0-domain.auth0.com" ) ;

Затем вы можете запросить IAuthenticationApiClient в своем классе:

 public class AuthController : ControllerBase
{
    private readonly IAuthenticationApiClient _authenticationApiClient ;

    public AuthController ( IAuthenticationApiClient authenticationApiClient )
    {
        _authenticationApiClient = authenticationApiClient ;
    }

Клиент аутентификации + Клиент управления

Auth0AuthenticationAndManagement

Добавьте AuthenticationApiClient с помощью AddAuth0AuthenticationClient и предоставьте конфигурацию приложения между компьютерами, которая будет использоваться интеграциями Management Client, Token Cache и IHttpClientBuilder. Это расширение необходимо вызвать перед использованием любых других расширений в этой библиотеке:

 services . AddAuth0AuthenticationClient ( config =>
{
   config . Domain = builder . Configuration [ "Auth0:Domain" ] ;
   config . ClientId = builder . Configuration [ "Auth0:ClientId" ] ;
   config . ClientSecret = builder . Configuration [ "Auth0:ClientSecret" ] ;
} ) ;

Добавьте ManagementApiClient с помощью AddAuth0ManagementClient() и добавьте DelegatingHandler с AddManagementAccessToken() который автоматически прикрепит токен доступа:

 services . AddAuth0ManagementClient ( ) . AddManagementAccessToken ( ) ;

Убедитесь, что ваше межмашинное приложение имеет право запрашивать токены из API управления и имеет правильные области для функций, которые вы хотите использовать.

Затем вы можете запросить IManagementApiClient (или IAuthenticationApiClient ) в своих службах:

 public class MyAuth0Service : IAuth0Service
{
    private readonly IManagementApiClient _managementApiClient ;

    public MyAuth0Service ( IManagementApiClient managementApiClient )
    {
        _managementApiClient = managementApiClient ;
    }

Обработка пользовательских доменов

Если вы используете собственный домен с клиентом Auth0, вы можете столкнуться с проблемой, связанной с неправильной настройкой audience Management API. Вы можете переопределить это с помощью свойства Audience :

 services . AddAuth0ManagementClient ( )
    . AddManagementAccessToken ( c =>
    {
        c . Audience = "my-tenant.au.auth0.com" ;
    } ) ;

С помощью служб HttpClient и/или Grpc (токены межмашинного взаимодействия)

Auth0AuthenticationВсе

Примечание. Эта функция зависит от вызова и настройки services.AddAuth0AuthenticationClient(config => ...) как описано в предыдущем сценарии.

Эта библиотека включает в себя обработчик делегирования (по сути, промежуточное программное обеспечение для вашего HttpClient), который будет добавлять токен доступа ко всем исходящим запросам. Это полезно для вызова других служб, защищенных Auth0. Эта интеграция требует, чтобы ваша реализация службы использовала IHttpClientFactory в рамках своей регистрации. Вы можете прочитать больше об этом здесь

HttpClient

Используйте AddAccessToken вместе с необходимой аудиторией:

config.Audience = builder.Configuration["MyHttpService:Audience"]);">

 services . AddHttpClient < MyHttpService > ( x => x . BaseAddress = new Uri ( builder . Configuration [ "MyHttpService:Url" ] ) )
        . AddAccessToken ( config => config . Audience = builder . Configuration [ "MyHttpService:Audience" ] ) ;

Грпк

Это расширение совместимо с любой регистрацией, которая возвращает IHttpClientBuilder , поэтому его можно использовать с клиентской фабрикой Grpc:

config.Audience = builder.Configuration["MyGrpcService:Audience"]);">

 services . AddGrpcClient < UserService . UserServiceClient > ( x => x . Address = new Uri ( builder . Configuration [ "MyGrpcService:Url" ] ) )
        . AddAccessToken ( config => config . Audience = builder . Configuration [ "MyGrpcService:Audience" ] ) ;

Передовой

AddAccessToken также имеет возможность передать функцию, которая может определять аудиторию во время выполнения. Это может быть полезно, если ожидаемая аудитория всегда следует определенному шаблону или если вы полагаетесь на обнаружение сервисов, например, от Steeltoe.NET:

config.AudienceResolver = request => request.RequestUri.GetLeftPart(UriPartial.Authority));">

 services . AddHttpClient < MyHttpService > ( x => x . BaseAddress = new Uri ( "https://MyServiceName/" ) )
        . AddServiceDiscovery ( )
        . AddAccessToken ( config => config . AudienceResolver = request => request . RequestUri . GetLeftPart ( UriPartial . Authority ) ) ;

Срок службы клиента

Клиенты аутентификации и авторизации регистрируются как одиночные и подходят для внедрения в любое другое время жизни.

Образцы

В каталоге примеров доступны как универсальный хост .NET, так и пример ASP.NET Core.

Внутренний кэш

Auth0TokenCache будет кэшировать токен для заданной аудитории как минимум до 95 % срока действия. Если запрос к кешу выполняется между 95% и 99% срока действия, токен будет обновлен в фоновом режиме до истечения срока действия.

Дополнительный 1% срока службы удален для защиты от дрейфа тактовой частоты между распределенными системами.

В некоторых ситуациях вам может потребоваться запросить токен доступа у Auth0 вручную. Этого можно добиться, внедрив IAuth0TokenCache в класс и вызвав GetTokenAsync с аудиторией API, для которого вы запрашиваете токен.

В качестве реализации кэширования используется экземпляр FusionCache, находящийся только в памяти. Этот экземпляр имеет имя и не повлияет на другое использование FusionCache.

Утилита

Эта библиотека предоставляет простое строковое расширение ToHttpsUrl() , которое можно использовать для форматирования чистого домена Auth0, находящегося в вашей конфигурации, в правильный URL-адрес.

Это идентично https://{Configuration["Auth0:Domain"]}/ который вы обычно пишете где-то в Startup.cs .

Например, форматирование домена для JWT Authority:

"https://my-tenant.auth0.com/" options.Authority = builder.Configuration["Auth0:Domain"].ToHttpsUrl(); //... });">

 . AddJwtBearer ( options =>
             {
                 // "my-tenant.auth0.com" -> "https://my-tenant.auth0.com/"
                 options . Authority = builder . Configuration [ "Auth0:Domain" ] . ToHttpsUrl ( ) ;
                 //...
             } ) ;

Отказ от ответственности

Я не связан и не представляю Auth0. Все проблемы реализации, касающиеся базовых ManagementApiClient и AuthenticationApiClient следует отправлять в официальный репозиторий Auth0.NET.