Customizable Branding

src/Pixel.Identity.Core/Controllers/BrandingController.cs

@@ -0,0 +1,21 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Pixel.Identity.Shared.Branding;
+
+namespace Pixel.Identity.Core.Controllers;
+
+[ApiController]
+[AllowAnonymous]
+[Route("api/[controller]")]
+[ApiExplorerSettings(IgnoreApi = true)]
+public class BrandingController(IBrandingService brandService) : Controller
+{
+    private readonly IBrandingService _brandService = brandService;
+
+    [HttpGet]
+    public async Task<IActionResult> GetAsync()
+    {
+        var brand = await _brandService.GetBrandAsync();
+        return Ok(brand);
+    }
+}

src/Pixel.Identity.Core/Services/AppSettingsBrandService.cs

@@ -0,0 +1,22 @@
+using Pixel.Identity.Shared.Branding;
+
+namespace Pixel.Identity.UI.Client.Services;
+
+public class AppSettingsBrandService(IConfiguration configuration) : IBrandingService
+{
+    private readonly IConfiguration _configuration = configuration;
+
+    private Brand _brand;
+
+    public async Task<Brand> GetBrandAsync() => _brand ??= await BuildAsync();
+
+    private Task<Brand> BuildAsync()
+    {
+        var name = _configuration["Brand:Name"] ?? BrandingProperties.Name;
+        var shortName = _configuration["Brand:ShortName"] ?? BrandingProperties.ShortName;
+        var logoUriDark = _configuration["Brand:LogoUriDark"] ?? BrandingProperties.LogoUriDark;
+        var logoUriLight = _configuration["Brand:LogoUriLight"] ?? BrandingProperties.LogoUriLight;
+
+        return Task.FromResult(new Brand(name, shortName, logoUriDark, logoUriLight));
+    }
+}

src/Pixel.Identity.Provider/Startup.cs

@@ -12,6 +12,8 @@
 using Pixel.Identity.Provider.Components;
 using Pixel.Identity.Provider.Extensions;
 using Pixel.Identity.Shared;
+using Pixel.Identity.Shared.Branding;
+using Pixel.Identity.UI.Client.Services;
 using Quartz;
 using Serilog;
 using System.IO;
@@ -50,12 +52,12 @@ public void ConfigureServices(IServiceCollection services)
             });
 
             //Add plugin assembly type to application part so that controllers in this assembly can be discovered by asp.net
-            services.AddControllersWithViews();               
+            services.AddControllersWithViews();
             services.AddRazorPages(options =>
-            {               
+            {
                 //Allow unauthorized users to access registration page when allow user registration setting is true so that users can
                 //register for a new account on their own.
-                if(bool.TryParse(Configuration["AllowUserRegistration"] ?? "true", out bool allowUserRegistration) && allowUserRegistration)
+                if (bool.TryParse(Configuration["AllowUserRegistration"] ?? "true", out bool allowUserRegistration) && allowUserRegistration)
                 {
                     options.Conventions.AllowAnonymousToAreaPage("Identity", "/Account/Register");
                 }
@@ -69,7 +71,7 @@ public void ConfigureServices(IServiceCollection services)
             {
                 c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
             });
-           
+
             services.AddMudServices(config =>
             {
                 config.SnackbarConfiguration.PositionClass = Defaults.Classes.Position.TopRight;
@@ -83,7 +85,7 @@ public void ConfigureServices(IServiceCollection services)
 
             ConfigureCors(services);
 
-            services.AddPlugin<IServicePlugin>(pluginsOptions["EmailSender"].Single(), (p, s) => 
+            services.AddPlugin<IServicePlugin>(pluginsOptions["EmailSender"].Single(), (p, s) =>
             {
                 p.ConfigureService(s, this.Configuration);
             });
@@ -92,19 +94,21 @@ public void ConfigureServices(IServiceCollection services)
             foreach (var externalProvider in pluginsOptions["OAuthProvider"])
             {
                 services.AddPlugin<IExternalAuthProvider>(externalProvider, (p, s) =>
-                { 
-                    p.AddProvider(this.Configuration, authenticationBuilder); 
-                });              
-            }        
-       
+                {
+                    p.AddProvider(this.Configuration, authenticationBuilder);
+                });
+            }
+
             services.AddPlugin<IDataStoreConfigurator>(pluginsOptions["DbStore"].Single(), (p, s) =>
             {
                 p.ConfigureAutoMap(s);
                 ConfigureOpenIddict(s, p);
                 p.AddServices(services);
             });
 
+
             ConfigureAuthorizationPolicy(services);
+            ConfigureBranding(services);
             ConfigureQuartz(services);
         }
 
@@ -135,13 +139,13 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             }
 
             app.UsePathBase("/pauth");
-           
-            app.UseSerilogRequestLogging();         
-           
+
+            app.UseSerilogRequestLogging();
+
             //app.UseHttpsRedirection();
             app.UseBlazorFrameworkFiles();
             app.UseStaticFiles();
-         
+
             app.UseRouting();
             app.UseCors();
 
@@ -153,11 +157,11 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             {
                 endpoints.MapRazorPages();
                 endpoints.MapControllers();
-                endpoints.MapRazorComponents<App>();               
+                endpoints.MapRazorComponents<App>();
                 endpoints.MapFallbackToFile("index.html");
-               
+
             });
-        }      
+        }
 
         /// <summary>
         /// Configure the Cors so that different clients can consume api
@@ -222,15 +226,16 @@ private void ConfigureAuthorizationPolicy(IServiceCollection services)
         private void ConfigureOpenIddict(IServiceCollection services, IDataStoreConfigurator configurator)
         {
             //Configure Identity will call services.AddIdentity which will AddAuthentication  
-            configurator.ConfigureIdentity(this.Configuration, services) 
+            configurator.ConfigureIdentity(this.Configuration, services)
             .AddSignInManager()
             .AddDefaultTokenProviders();
 
-            services.ConfigureApplicationCookie(opts => {
-                opts.LoginPath = "/Identity/Account/Login";                
-            });           
+            services.ConfigureApplicationCookie(opts =>
+            {
+                opts.LoginPath = "/Identity/Account/Login";
+            });
 
-            var openIdBuilder = services.AddOpenIddict()        
+            var openIdBuilder = services.AddOpenIddict()
             // Register the OpenIddict server components.
             .AddServer(options =>
             {
@@ -322,5 +327,10 @@ private void ConfigureQuartz(IServiceCollection services)
             // Register the Quartz.NET service and configure it to block shutdown until jobs are complete.
             services.AddQuartzHostedService(options => options.WaitForJobsToComplete = true);
         }
+
+        private static void ConfigureBranding(IServiceCollection services)
+        {
+            services.AddScoped<IBrandingService, AppSettingsBrandService>();
+        }
     }
 }

src/Pixel.Identity.Shared/Branding/Brand.cs

@@ -0,0 +1,8 @@
+using System;
+
+namespace Pixel.Identity.Shared.Branding;
+
+public record Brand(String Name, String ShortName, String LogoUriDark, String LogoUriLight)
+{
+    public static readonly Brand Empty = new(BrandingDefaults.PleaseWait, BrandingDefaults.PleaseWait, String.Empty, String.Empty);
+}

src/Pixel.Identity.Shared/Branding/BrandingDefaults.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace Pixel.Identity.Shared.Branding;
+
+public static class BrandingDefaults
+{
+    public static readonly String PleaseWait = "Please wait ...";
+    public const String Name = "Pixel Identity Provider";
+    public const String ShortName = "Pixel Identity";
+    public const String LogoUriDark = "";
+    public const String LogoUriLight = "";
+}

src/Pixel.Identity.Shared/Branding/BrandingProperties.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace Pixel.Identity.Shared.Branding;
+
+public static class BrandingProperties
+{
+    public static String Name { get; set; } = BrandingDefaults.Name;
+    public static String ShortName { get; set; } = BrandingDefaults.ShortName;
+    public static String LogoUriDark { get; set; } = BrandingDefaults.LogoUriDark;
+    public static String LogoUriLight { get; set; } = BrandingDefaults.LogoUriLight;
+}

src/Pixel.Identity.Shared/Branding/IBrandingService.cs

@@ -0,0 +1,8 @@
+using System.Threading.Tasks;
+
+namespace Pixel.Identity.Shared.Branding;
+
+public interface IBrandingService
+{
+    Task<Brand> GetBrandAsync();
+}

src/Pixel.Identity.UI.Client/Pages/Account/Logins.razor → src/Pixel.Identity.UI.Client/Pages/Account/Password.razor

@@ -1,4 +1,4 @@
-@page "/Account/Logins"
+@page "/Account/Password"
 @using Pixel.Identity.Shared.Models
 @attribute [Authorize]
 

src/Pixel.Identity.UI.Client/Pages/Account/Logins.razor.cs → src/Pixel.Identity.UI.Client/Pages/Account/Password.razor.cs

@@ -7,11 +7,11 @@
 
 namespace Pixel.Identity.UI.Client.Pages.Account
 {
-    public partial class Logins : ComponentBase
+    public partial class Password : ComponentBase
     {
         [Inject]
         public ISnackbar SnackBar { get; set; }
-       
+
         [Inject]
         public IAccountService AccountService { get; set; }
 
@@ -26,7 +26,7 @@ public partial class Logins : ComponentBase
         protected override async Task OnInitializedAsync()
         {
             hasLocalAccount = await AccountService.GetHasPasswordAsync();
-            var userExternalLogins = await ExternalLoginsService.GetExternalLoginsAsync();          
+            var userExternalLogins = await ExternalLoginsService.GetExternalLoginsAsync();
             this.externalLogins.AddRange(userExternalLogins);
             await base.OnInitializedAsync();
         }

src/Pixel.Identity.UI.Client/Program.cs

@@ -5,6 +5,7 @@
 using MudBlazor;
 using MudBlazor.Services;
 using Pixel.Identity.Shared;
+using Pixel.Identity.Shared.Branding;
 using Pixel.Identity.Shared.ViewModels;
 using Pixel.Identity.UI.Client.Services;
 using Pixel.Identity.UI.Client.Validations;
@@ -65,6 +66,10 @@ public static async Task Main(string[] args)
             client => client.BaseAddress = new Uri(builder.HostEnvironment.BaseAddress))
              .AddHttpMessageHandler<BaseAddressAuthorizationMessageHandler>();
 
+            builder.Services.AddHttpClient<IBrandingService, RemoteBrandService>(
+            client => client.BaseAddress = new Uri(builder.HostEnvironment.BaseAddress))
+             .AddHttpMessageHandler<BaseAddressAuthorizationMessageHandler>();
+
             builder.Services.AddTransient<IValidator<ApplicationViewModel>, ApplicationDescriptionValidator>();
             builder.Services.AddTransient<IValidator<ScopeViewModel>, ScopeValidator>();
             builder.Services.AddTransient<IValidator<UserRoleViewModel>, UserRoleValidator>();

src/Pixel.Identity.UI.Client/Services/RemoteBrandService.cs

@@ -0,0 +1,22 @@
+using Pixel.Identity.Shared.Branding;
+using System.Net.Http;
+using System.Net.Http.Json;
+using System.Threading.Tasks;
+
+namespace Pixel.Identity.UI.Client.Services;
+
+public class RemoteBrandService(HttpClient httpClient) : IBrandingService
+{
+    private readonly HttpClient httpClient = httpClient;
+    private Brand _brand;
+
+    public async Task<Brand> GetBrandAsync()
+    {
+        if (_brand == null)
+        {
+            _brand = await httpClient.GetFromJsonAsync<Brand>("api/branding");
+        }
+
+        return _brand;
+    }
+}

src/Pixel.Identity.UI.Client/Shared/LoginDisplay.razor

@@ -10,7 +10,7 @@
                 <MudAvatar>@context.User.Identity.Name.First()</MudAvatar>
             </ActivatorContent>
             <ChildContent>
-                <MudMenuItem id="profileMenuItem" Href="./authentication/profile">Profile</MudMenuItem>
+                <MudMenuItem id="profileMenuItem" Href="account/profile">Profile</MudMenuItem>
                 <MudMenuItem id="signOutMenuItem" @onclick="BeginSignOut">Sign Out</MudMenuItem>
             </ChildContent>
         </MudMenu>

src/Pixel.Identity.UI.Client/Shared/MainLayout.razor

@@ -1,4 +1,6 @@
-@inherits LayoutComponentBase
+@using Pixel.Identity.Shared.Branding
+@inherits LayoutComponentBase
+@inject IBrandingService BrandingService
 
 <MudThemeProvider />
 <MudDialogProvider />
@@ -10,10 +12,10 @@
             <MudIconButton Icon="@Icons.Material.Outlined.Menu" Color="Color.Inherit" OnClick="@((e) => DrawerToggle())" />
         </MudToolBar>
         <MudHidden Breakpoint="Breakpoint.Xs">
-            <MudText Typo="Typo.h6" Class="ml-4">Pixel Identity</MudText>
+            <MudText Typo="Typo.h6" Class="ml-4">@_brand.Name</MudText>
         </MudHidden>
         <MudHidden Breakpoint="Breakpoint.Xs" Invert="true">
-            <MudText Typo="Typo.subtitle2">Identity Provider</MudText>
+            <MudText Typo="Typo.subtitle2">@_brand.ShortName</MudText>
         </MudHidden>
         <MudSpacer />
         <LoginDisplay />
@@ -33,10 +35,16 @@
 @code {
 
     public bool _drawerOpen = true;
+    public Brand _brand = Brand.Empty;
 
     void DrawerToggle()
     {
         _drawerOpen = !_drawerOpen;
     }
+
+    protected override async Task OnInitializedAsync()
+    {
+        _brand = await BrandingService.GetBrandAsync();
+    }
 }
 

src/Pixel.Identity.UI.Client/Shared/NavMenu.razor

@@ -5,7 +5,7 @@
     <AuthorizeView>
          <MudNavGroup Title="Account" Expanded="false" Icon="@Icons.Material.Outlined.Dashboard">
             <MudNavLink Href="./account/profile">Profile</MudNavLink>
-            <MudNavLink Href="./account/logins">Logins</MudNavLink>
+            <MudNavLink Href="./account/password">Password</MudNavLink>
             <MudNavLink Href="./account/authenticator/manage">Authenticator</MudNavLink>
         </MudNavGroup>
     </AuthorizeView>