ApplicationBuilderExtensions Class

Definition

Namespace: Cuemon.Extensions.AspNetCore.Authentication

Assemblies: Cuemon.Extensions.AspNetCore.Authentication.dll

Source: src/Cuemon.Extensions.AspNetCore.Authentication/ApplicationBuilderExtensions.cs

Extension methods for the IApplicationBuilder interface.

public static class ApplicationBuilderExtensions

Inheritance: object

ApplicationBuilderExtensions

Examples

The following example demonstrates how to register the Basic, Digest, and HMAC authentication middleware in an ASP.NET Core request pipeline. Each extension configures a different credential scheme and returns the same application builder so additional middleware can be appended. The final checks make that fluent-pipeline contract visible without depending on an implementation type name.

using System;
using System.Security.Claims;
using Cuemon.Extensions.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;

namespace MyApp.Examples;

public static class ApplicationBuilderExtensionsExample
{
    public static void Demonstrate()
    {
        var services = new ServiceCollection();

        services.AddLogging();
        services.AddInMemoryDigestAuthenticationNonceTracker();
        services.AddAuthentication("docs")
            .AddScheme<Cuemon.AspNetCore.Authentication.Basic.BasicAuthenticationOptions, Cuemon.AspNetCore.Authentication.Basic.BasicAuthenticationHandler>(Cuemon.AspNetCore.Authentication.Basic.BasicAuthorizationHeader.Scheme, _ => { })
            .AddScheme<Cuemon.AspNetCore.Authentication.Digest.DigestAuthenticationOptions, Cuemon.AspNetCore.Authentication.Digest.DigestAuthenticationHandler>(Cuemon.AspNetCore.Authentication.Digest.DigestAuthorizationHeader.Scheme, _ => { })
            .AddScheme<Cuemon.AspNetCore.Authentication.Hmac.HmacAuthenticationOptions, Cuemon.AspNetCore.Authentication.Hmac.HmacAuthenticationHandler>("hmac-docs", _ => { });

        var app = new ApplicationBuilder(services.BuildServiceProvider());

        var basicBuilder = app.UseBasicAuthentication(options =>
        {
            options.Realm = "SecureArea";
            options.Authenticator = (username, password) =>
            {
                if (username == "admin" && password == "secret")
                {
                    return new ClaimsPrincipal(new ClaimsIdentity(new[] { new Claim(ClaimTypes.Name, username) }, "Basic"));
                }

                return null;
            };
            options.RequireSecureConnection = false;
        });

        var digestBuilder = app.UseDigestAccessAuthentication(options =>
        {
            options.Realm = "SecureArea";
            options.Authenticator = (string username, out string password) =>
            {
                password = "storedPassword";
                return new ClaimsPrincipal(new ClaimsIdentity(new[] { new Claim(ClaimTypes.Name, username) }, "Digest"));
            };
            options.RequireSecureConnection = false;
        });

        var hmacBuilder = app.UseHmacAuthentication(options =>
        {
            options.AuthenticationScheme = "MyHmac";
            options.Authenticator = (string clientId, out string clientSecret) =>
            {
                clientSecret = "storedSecret";
                return new ClaimsPrincipal(new ClaimsIdentity(new[] { new Claim(ClaimTypes.Name, clientId) }, "Hmac"));
            };
            options.RequireSecureConnection = false;
        });

        Console.WriteLine($"Basic middleware returned the application builder: {ReferenceEquals(app, basicBuilder)}");
        Console.WriteLine($"Digest middleware returned the application builder: {ReferenceEquals(app, digestBuilder)}");
        Console.WriteLine($"HMAC middleware returned the application builder: {ReferenceEquals(app, hmacBuilder)}");
    }
}

Methods

Name	Description
UseBasicAuthentication(IApplicationBuilder, Action<BasicAuthenticationOptions>)	Adds a HTTP Basic Authentication scheme to the IApplicationBuilder request execution pipeline.
UseDigestAccessAuthentication(IApplicationBuilder, Action<DigestAuthenticationOptions>)	Adds a HTTP Digest Authentication scheme to the IApplicationBuilder request execution pipeline.
UseHmacAuthentication(IApplicationBuilder, Action<HmacAuthenticationOptions>)	Adds a HTTP HMAC Authentication scheme to the IApplicationBuilder request execution pipeline.

Table of Contents

ApplicationBuilderExtensions Class

Definition

Examples

Methods