OpenIddictClientExtensions.cs

/*
 * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
 * See https://github.com/openiddict/openiddict-core for more information concerning
 * the license and the contributors participating to this project.
 */

using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Options;
using OpenIddict.Client;

namespace Microsoft.Extensions.DependencyInjection;

/// <summary>
/// Exposes extensions allowing to register the OpenIddict client services.
/// </summary>
public static class OpenIddictClientExtensions
{
    /// <summary>
    /// Registers the OpenIddict client services in the DI container.
    /// </summary>
    /// <param name="builder">The services builder used by OpenIddict to register new services.</param>
    /// <remarks>This extension can be safely called multiple times.</remarks>
    /// <returns>The <see cref="OpenIddictClientBuilder"/> instance.</returns>
    public static OpenIddictClientBuilder AddClient(this OpenIddictBuilder builder)
    {
        ArgumentNullException.ThrowIfNull(builder);

        builder.Services.AddLogging();
        builder.Services.AddOptions();

        builder.Services.TryAddScoped<IOpenIddictClientDispatcher, OpenIddictClientDispatcher>();
        builder.Services.TryAddScoped<IOpenIddictClientFactory, OpenIddictClientFactory>();
        builder.Services.TryAddSingleton<OpenIddictClientService>();

        // Register the built-in filters used by the default OpenIddict client event handlers.
        builder.Services.TryAddSingleton<RequireAuthorizationCodeValidated>();
        builder.Services.TryAddSingleton<RequireBackchannelAccessTokenValidated>();
        builder.Services.TryAddSingleton<RequireBackchannelIdentityTokenNonceValidationEnabled>();
        builder.Services.TryAddSingleton<RequireBackchannelIdentityTokenValidated>();
        builder.Services.TryAddSingleton<RequireBackchannelIdentityTokenPrincipal>();
        builder.Services.TryAddSingleton<RequireChallengeClientAssertionGenerated>();
        builder.Services.TryAddSingleton<RequireClientAssertionGenerated>();
        builder.Services.TryAddSingleton<RequireDeviceAuthorizationGrantType>();
        builder.Services.TryAddSingleton<RequireDeviceAuthorizationRequest>();
        builder.Services.TryAddSingleton<RequireFrontchannelAccessTokenValidated>();
        builder.Services.TryAddSingleton<RequireFrontchannelIdentityTokenNonceValidationEnabled>();
        builder.Services.TryAddSingleton<RequireFrontchannelIdentityTokenValidated>();
        builder.Services.TryAddSingleton<RequireFrontchannelIdentityTokenPrincipal>();
        builder.Services.TryAddSingleton<RequireInteractiveGrantType>();
        builder.Services.TryAddSingleton<RequireIntrospectionClientAssertionGenerated>();
        builder.Services.TryAddSingleton<RequireIntrospectionRequest>();
        builder.Services.TryAddSingleton<RequireIssuedTokenValidated>();
        builder.Services.TryAddSingleton<RequireIssuerParameterValidationEnabled>();
        builder.Services.TryAddSingleton<RequireLoginStateTokenGenerated>();
        builder.Services.TryAddSingleton<RequireLogoutStateTokenGenerated>();
        builder.Services.TryAddSingleton<RequireJsonWebTokenFormat>();
        builder.Services.TryAddSingleton<RequirePostLogoutRedirectionRequest>();
        builder.Services.TryAddSingleton<RequirePushedAuthorizationRequest>();
        builder.Services.TryAddSingleton<RequireRedirectionRequest>();
        builder.Services.TryAddSingleton<RequireRefreshTokenValidated>();
        builder.Services.TryAddSingleton<RequireRevocationClientAssertionGenerated>();
        builder.Services.TryAddSingleton<RequireRevocationRequest>();
        builder.Services.TryAddSingleton<RequireStateTokenPrincipal>();
        builder.Services.TryAddSingleton<RequireStateTokenRedeemed>();
        builder.Services.TryAddSingleton<RequireStateTokenValidated>();
        builder.Services.TryAddSingleton<RequireTokenAudienceValidationEnabled>();
        builder.Services.TryAddSingleton<RequireTokenEntryCreated>();
        builder.Services.TryAddSingleton<RequireTokenIdResolved>();
        builder.Services.TryAddSingleton<RequireTokenLifetimeValidationEnabled>();
        builder.Services.TryAddSingleton<RequireTokenPayloadPersisted>();
        builder.Services.TryAddSingleton<RequireTokenPresenterValidationEnabled>();
        builder.Services.TryAddSingleton<RequireTokenRequest>();
        builder.Services.TryAddSingleton<RequireTokenStorageEnabled>();
        builder.Services.TryAddSingleton<RequireUserInfoRequest>();
        builder.Services.TryAddSingleton<RequireUserInfoTokenExtracted>();
        builder.Services.TryAddSingleton<RequireUserInfoTokenPrincipal>();
        builder.Services.TryAddSingleton<RequireUserInfoValidationEnabled>();
        builder.Services.TryAddSingleton<RequireWebServicesFederationClaimMappingEnabled>();

        // Register the built-in client event handlers used by the OpenIddict client components.
        // Note: the order used here is not important, as the actual order is set in the options.
        builder.Services.TryAdd(DefaultHandlers.Select(descriptor => descriptor.ServiceDescriptor));

        // Note: TryAddEnumerable() is used here to ensure the initializer is registered only once.
        builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<
            IPostConfigureOptions<OpenIddictClientOptions>, OpenIddictClientConfiguration>());

        return new OpenIddictClientBuilder(builder.Services);
    }

    /// <summary>
    /// Registers the OpenIddict client services in the DI container.
    /// </summary>
    /// <param name="builder">The services builder used by OpenIddict to register new services.</param>
    /// <param name="configuration">The configuration delegate used to configure the client services.</param>
    /// <remarks>This extension can be safely called multiple times.</remarks>
    /// <returns>The <see cref="OpenIddictBuilder"/> instance.</returns>
    public static OpenIddictBuilder AddClient(this OpenIddictBuilder builder, Action<OpenIddictClientBuilder> configuration)
    {
        ArgumentNullException.ThrowIfNull(builder);
        ArgumentNullException.ThrowIfNull(configuration);

        configuration(builder.AddClient());

        return builder;
    }
}