fix: Merge 'n fix.

Author: sommmen

.gitignore

@@ -349,3 +349,5 @@ MigrationBackup/
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
 nuget.exe
+
+.vshistory/

README.md

@@ -58,45 +58,45 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 }
 ```
 
-## Authorization: configuration
+## Options
+Options can be found in the [UIOptions](src/Serilog.Ui.Web/Extensions/UiOptions.cs) class.
+`internal` properties can generally be set via extension methods, see [SerilogUiOptionBuilderExtensions](src/Serilog.Ui.Web/Extensions/SerilogUiOptionBuilderExtensions.cs)
+
+### Authorization
 
-By default serilog-ui allows access to the log page only for local requests. In order to give appropriate rights for production use, you need to configure authorization. You can secure the log page by allowing specific users or roles to view logs:
+By default serilog-ui allows access to the log page only for local requests. In order to give appropriate rights for production use, you need to configure authorization. You can add your own implementations of the `IUiAuthorizationFilter` interface, whose Authorize method is used to allow or prohibit a request. The first step is to provide your own implementation.:
 
 ```csharp
-public void ConfigureServices(IServiceCollection services)
+public void Configure(IApplicationBuilder appBuilder)
 {
-    services.AddSerilogUi(options => options
-        .EnableAuthorization(authOptions =>
+    appBuilder.UseSerilogUi(options =>
+    {
+        options.Authorization.AuthenticationType = AuthenticationType.Jwt;
+        options.Authorization.Filters = new[]
         {
-            authOption.AuthenticationType = AuthenticationType.Jwt; // or AuthenticationType.Cookie
-            authOptions.Usernames = new[] { "User1", "User2" };
-            authOptions.Roles = new[] { "AdminRole" };
-        })
-        .UseSqlServer(Configuration.GetConnectionString("DefaultConnection"), "LogTableName"));
+            new CustomAuthorizeFilter()
+        };
+    });
     // ...
 }
 ```
-Only `User1` and `User2` or users with `AdminRole` role can view logs.
 
 If you set `AuthenticationType` to `Jwt`, you can set a jwt token and an `Authorization` header will be added to the request and for `Cookie` just login into you website and no extra step is required.
 
-To disable anonymous access for local requests, (e.g. for testing authentication locally) set `AlwaysAllowLocalRequests` to `false`.
-
-To disable authorization on production, set `Enabled` to false.
+Here is an example of how you can implement your own authentication and authorization:
 
 ``` csharp
-services.AddSerilogUi(options => options
-    .EnableAuthorization(authOption =>
+public class CustomAuthorizeFilter : IUiAuthorizationFilter
+{
+    public bool Authorize(DashboardContext context)
     {
-        authOption.AlwaysAllowLocalRequests = false; // disable anonymous access on local
-        authOption.Enabled = false; // disable authorization access check on production
-    })
-    .UseSqlServer(Configuration.GetConnectionString("DefaultConnection"), "Logs"));
-```
+        var httpContext = context.GetHttpContext();
 
-## Options
-Options can be found in the [UIOptions](src/Serilog.Ui.Web/Extensions/UiOptions.cs) class.
-`internal` properties can generally be set via extension methods, see [SerilogUiOptionBuilderExtensions](src/Serilog.Ui.Web/Extensions/SerilogUiOptionBuilderExtensions.cs)
+        // Allow all authenticated users to see the Dashboard (potentially dangerous).
+        return httpContext.User.Identity?.IsAuthenticated ?? false;
+    }
+}
+```
 
 ### Log page URL
 
@@ -232,6 +232,9 @@ To run the tests, use Test Explorer in Visual Studio or run from the root folder
 dotnet test
 ```
 
+Please notice: to run the tests, you'll need a running Docker instance on your sistem.  
+Integration tests (identified by traits) on MS Sql, MySql, Postgres, use Docker to spin the integration database.
+
 ## JS UI assets
 
 Tests are located inside src/Serilog.Ui.Web/assets/__tests__

Serilog.Ui.sln

@@ -29,15 +29,15 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.MongoDbProvider.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.Common.Tests", "tests\Serilog.Ui.Common.Tests\Serilog.Ui.Common.Tests.csproj", "{96689D04-8B2F-4C06-AE1D-3483B1508D59}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serilog.Ui.PostgreSqlProvider.Tests", "tests\Serilog.Ui.PostgreSqlProvider.Tests\Serilog.Ui.PostgreSqlProvider.Tests.csproj", "{D1688095-7E1F-42B2-BC3F-8CB29975CAD5}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.PostgreSqlProvider.Tests", "tests\Serilog.Ui.PostgreSqlProvider.Tests\Serilog.Ui.PostgreSqlProvider.Tests.csproj", "{D1688095-7E1F-42B2-BC3F-8CB29975CAD5}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.Web.Tests", "tests\Serilog.Ui.Web.Tests\Serilog.Ui.Web.Tests.csproj", "{9AD9BF6A-0CB0-467C-BB84-BE1C701C0113}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serilog.Ui.MySqlProvider.Tests", "tests\Serilog.Ui.MySqlProvider.Tests\Serilog.Ui.MySqlProvider.Tests.csproj", "{6986AD9C-3B9E-4DAF-A45F-643D964CEBD3}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.MySqlProvider.Tests", "tests\Serilog.Ui.MySqlProvider.Tests\Serilog.Ui.MySqlProvider.Tests.csproj", "{6986AD9C-3B9E-4DAF-A45F-643D964CEBD3}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serilog.Ui.MsSqlServerProvider.Tests", "tests\Serilog.Ui.MsSqlServerProvider.Tests\Serilog.Ui.MsSqlServerProvider.Tests.csproj", "{1F6675BC-32FC-47DE-96AB-422632AB2730}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.MsSqlServerProvider.Tests", "tests\Serilog.Ui.MsSqlServerProvider.Tests\Serilog.Ui.MsSqlServerProvider.Tests.csproj", "{1F6675BC-32FC-47DE-96AB-422632AB2730}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serilog.Ui.ElastichSearchProvider.Tests", "tests\Serilog.Ui.ElastichSearchProvider.Tests\Serilog.Ui.ElastichSearchProvider.Tests.csproj", "{1AB759E4-61CD-4195-9CA9-E70B63AF28B9}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Ui.ElasticSearchProvider.Tests", "tests\Serilog.Ui.ElastichSearchProvider.Tests\Serilog.Ui.ElasticSearchProvider.Tests.csproj", "{1AB759E4-61CD-4195-9CA9-E70B63AF28B9}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{83E91BE7-19B3-4AE0-992C-9DFF30FC409E}"
 	ProjectSection(SolutionItems) = preProject

samples/SampleWebApp/Authentication/SerilogUiCustomAuthFilter.cs

@@ -0,0 +1,12 @@
+using Microsoft.AspNetCore.Http;
+using Serilog.Ui.Web.Authorization;
+
+namespace SampleWebApp.Authentication;
+
+public class SerilogUiCustomAuthFilter : IUiAuthorizationFilter
+{
+    public bool Authorize(HttpContext httpContext)
+    {
+        return httpContext.User.Identity is { IsAuthenticated: true };
+    }
+}

samples/SampleWebApp/SampleWebApp.csproj

@@ -25,10 +25,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\src\Serilog.Ui.ElasticSearchProvider\Serilog.Ui.ElasticSearchProvider.csproj" />
-    <ProjectReference Include="..\..\src\Serilog.Ui.MongoDbProvider\Serilog.Ui.MongoDbProvider.csproj" />
     <ProjectReference Include="..\..\src\Serilog.Ui.MsSqlServerProvider\Serilog.Ui.MsSqlServerProvider.csproj" />
-    <ProjectReference Include="..\..\src\Serilog.Ui.PostgreSqlProvider\Serilog.Ui.PostgreSqlProvider.csproj" />
     <ProjectReference Include="..\..\src\Serilog.Ui.Web\Serilog.Ui.Web.csproj" />
   </ItemGroup>
 

samples/SampleWebApp/Startup.cs

@@ -7,6 +7,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.IdentityModel.Tokens;
+using SampleWebApp.Authentication;
 using SampleWebApp.Authentication.Jwt;
 using SampleWebApp.Data;
 using SampleWebApp.Services.HostedServices;
@@ -40,11 +41,6 @@ public void ConfigureServices(IServiceCollection services)
             services.AddRazorPages();
 
             services.AddSerilogUi(options => options
-                .EnableAuthorization(authOption =>
-                {
-                    authOption.AuthenticationType = AuthenticationType.Jwt;
-                    authOption.Usernames = new[] { "[email protected]" };
-                })
                 .UseSqlServer(Configuration.GetConnectionString("DefaultConnection"), "Logs")
                 .UseSqlServer(Configuration.GetConnectionString("SecondLogConnection"), "Logs2")
             );
@@ -66,16 +62,17 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             else
             {
                 app.UseExceptionHandler("/Home/Error");
-                // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
+                // The default HSTS value is 30 days. You may want to change this for production
+                // scenarios, see https://aka.ms/aspnetcore-hsts.
                 app.UseHsts();
             }
             app.UseHttpsRedirection();
             app.UseStaticFiles();
 
             app.UseSwagger();
 
-            // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
-            // specifying the Swagger JSON endpoint.
+            // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), specifying the Swagger
+            // JSON endpoint.
             app.UseSwaggerUI(c =>
             {
                 c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
@@ -85,11 +82,16 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
             app.UseAuthentication();
             app.UseAuthorization();
-            app.UseSerilogUi(x =>
+            app.UseSerilogUi(options =>
             {
-                x.RoutePrefix = "serilog-ui";
-                x.HomeUrl = "/#Test";
-                x.InjectJavascript("/js/serilog-ui/custom.js");
+                options.RoutePrefix = "serilog-ui";
+                options.HomeUrl = "/#Test";
+                options.InjectJavascript("/js/serilog-ui/custom.js");
+                options.Authorization = new AuthorizationOptions
+                {
+                    AuthenticationType = AuthenticationType.Jwt,
+                    Filters = new[] { new SerilogUiCustomAuthFilter() }
+                };
             });
 
             app.UseEndpoints(endpoints =>

samples/SampleWebApp/appsettings.json

@@ -9,7 +9,7 @@
   "Jwt": {
     "Audience": "SampleClient",
     "Issuer": "http://localhost:5000",
-    "SecretKey": "Th!$P@ssw0rd",
+    "SecretKey": "Th!$AlongP@ssw0rdForJwt",
     "ExpireDays": "30"
   },
 

src/Serilog.Ui.ElasticSearchProvider/Extensions/SerilogUiOptionBuilderExtensions.cs

@@ -25,7 +25,7 @@ public static void UseElasticSearchDb(this SerilogUiOptionsBuilder optionsBuilde
             if (endpoint == null)
                 throw new ArgumentNullException(nameof(endpoint));
 
-            if (string.IsNullOrEmpty(indexName))
+            if (string.IsNullOrWhiteSpace(indexName))
                 throw new ArgumentNullException(nameof(indexName));
 
             var options = new ElasticSearchDbOptions

src/Serilog.Ui.ElasticSearchProvider/Serilog.Ui.ElasticSearchProvider.csproj

@@ -6,6 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.3" />
 	  <PackageReference Include="NEST" Version="7.11.1" />
     <PackageReference Include="NEST.JsonNetSerializer" Version="7.11.1" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />

src/Serilog.Ui.MongoDbProvider/Extensions/SerilogUiOptionBuilderExtensions.cs

@@ -26,16 +26,20 @@ public static void UseMongoDb(
             string collectionName
         )
         {
-            if (string.IsNullOrEmpty(connectionString))
+            if (string.IsNullOrWhiteSpace(connectionString))
                 throw new ArgumentNullException(nameof(connectionString));
 
-            if (string.IsNullOrEmpty(collectionName))
+            if (string.IsNullOrWhiteSpace(collectionName))
                 throw new ArgumentNullException(nameof(collectionName));
 
+            var databaseName = MongoUrl.Create(connectionString).DatabaseName;
+
+            if (string.IsNullOrWhiteSpace(databaseName)) throw new ArgumentException(nameof(MongoUrl.DatabaseName));
+
             var mongoProvider = new MongoDbOptions
             {
                 ConnectionString = connectionString,
-                DatabaseName = MongoUrl.Create(connectionString).DatabaseName,
+                DatabaseName = databaseName,
                 CollectionName = collectionName
             };
 
@@ -68,13 +72,13 @@ public static void UseMongoDb(
             string collectionName
         )
         {
-            if (string.IsNullOrEmpty(connectionString))
+            if (string.IsNullOrWhiteSpace(connectionString))
                 throw new ArgumentNullException(nameof(connectionString));
 
-            if (string.IsNullOrEmpty(databaseName))
+            if (string.IsNullOrWhiteSpace(databaseName))
                 throw new ArgumentNullException(nameof(databaseName));
 
-            if (string.IsNullOrEmpty(collectionName))
+            if (string.IsNullOrWhiteSpace(collectionName))
                 throw new ArgumentNullException(nameof(collectionName));
 
             var mongoProvider = new MongoDbOptions
@@ -92,7 +96,7 @@ string collectionName
                 throw new NotSupportedException($"Adding multiple registrations of '{typeof(MongoDbDataProvider).FullName}' is not (yet) supported.");
 
             ((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddSingleton(mongoProvider);
-            ((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddSingleton<IMongoClient>(o => new MongoClient(connectionString));
+            ((ISerilogUiOptionsBuilder)optionsBuilder).Services.TryAddSingleton<IMongoClient>(o => new MongoClient(connectionString));
             ((ISerilogUiOptionsBuilder)optionsBuilder).Services.AddScoped<IDataProvider, MongoDbDataProvider>();
         }
     }