Enable configuration of the enricher through JSON

Author: sandermvanvliet

Changelog.md

@@ -1,5 +1,9 @@
 # Changelog for Serilog.Enrichers.Sensitive
 
+## 1.7.0
+
+- Allow configuration through `appsettings.json` files.
+
 ## 1.6.0
 
 - Pass match to `PreprocessMask` to allow for further customisation of mask value

Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>1.6.0.0</Version>
+		<Version>1.7.0.0</Version>
 		<Authors>Sander van Vliet, Huibert Jan Nieuwkamer, Scott Toberman</Authors>
 		<Company>Codenizer BV</Company>
 		<Copyright>2023 Sander van Vliet</Copyright>

README.md

@@ -238,3 +238,33 @@ var logger = new LoggerConfiguration()
     .WriteTo.Console()
     .CreateLogger();
 ```
+
+## JSON configuration
+
+If you are configuring your logger through `appsettings.json`, you can configure the enricher too. You will have to add a `Using` section if it doesn't exist already and include the `Serilog.Enrichers.Sensitive` assembly name there, otherwise configuration will silently fail.
+
+```json
+{
+  "Serilog": {
+    "Using": [
+      "Serilog.Enrichers.Sensitive"
+    ],
+    "Enrich": [
+      {
+        "Name": "WithSensitiveDataMasking",
+        "Args": {
+          "options": {
+            "MaskValue": "CUSTOM_MASK_FROM_JSON",
+            "ExcludeProperties": [
+              "email"
+            ],
+            "Mode": "Globally"
+          }
+        }
+      }
+    ]
+  }
+}
+```
+
+Note that `options` is the argument name of the `WithSensitiveDataMasking` extension method and must match exactly.

src/Serilog.Enrichers.Sensitive.Demo/Program.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Threading;
 using System.Threading.Tasks;
 using Serilog.Core;
 

src/Serilog.Enrichers.Sensitive/AssemblyInfo.cs

@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Serilog.Enrichers.Sensitive.Tests.Unit")]

src/Serilog.Enrichers.Sensitive/ExtensionMethods.cs

@@ -74,7 +74,15 @@ public static LoggerConfiguration WithSensitiveDataMasking(
 
         public static LoggerConfiguration WithSensitiveDataMasking(
             this LoggerEnrichmentConfiguration loggerConfiguration, 
-            Action<SensitiveDataEnricherOptions> options)
+            Action<SensitiveDataEnricherOptions> configure)
+        {
+            return loggerConfiguration
+                .With(new SensitiveDataEnricher(configure));
+        }
+
+        public static LoggerConfiguration WithSensitiveDataMasking(
+            this LoggerEnrichmentConfiguration loggerConfiguration, 
+            SensitiveDataEnricherOptions options)
         {
             return loggerConfiguration
                 .With(new SensitiveDataEnricher(options));

src/Serilog.Enrichers.Sensitive/SensitiveDataEnricher.cs

@@ -20,6 +20,11 @@ internal class SensitiveDataEnricher : ILogEventEnricher
         private readonly List<string> _maskProperties;
         private readonly List<string> _excludeProperties;
 
+        public SensitiveDataEnricher(SensitiveDataEnricherOptions options) 
+            : this(options.Apply)
+        {
+        }
+
         public SensitiveDataEnricher(
             Action<SensitiveDataEnricherOptions>? options)
         {

src/Serilog.Enrichers.Sensitive/SensitiveDataEnricherOptions.cs

@@ -31,5 +31,18 @@ public class SensitiveDataEnricherOptions
         /// <para>This property takes precedence over <see cref="MaskProperties"/> and the masking operators.</para>
         /// </remarks>
         public List<string> ExcludeProperties { get; set; } = new List<string>();
+
+        /// <summary>
+        /// Applies the settings of this <c>SensitiveDataEnricherOptions</c> instance to another <c>SensitiveDataEnricherOptions</c> instance
+        /// </summary>
+        /// <param name="other">The <c>SensitiveDataEnricherOptions</c> to apply the options to</param>
+        public void Apply(SensitiveDataEnricherOptions other)
+        {
+            other.Mode = Mode;
+            other.MaskValue = MaskValue;
+            other.MaskingOperators = MaskingOperators;
+            other.MaskProperties = MaskProperties;
+            other.ExcludeProperties = ExcludeProperties;
+        }
     }
 }

test/Serilog.Enrichers.Sensitive.Tests.Unit/Serilog.Enrichers.Sensitive.Tests.Unit.csproj

@@ -11,10 +11,14 @@
 
 	<ItemGroup>
 		<PackageReference Include="FluentAssertions" Version="6.7.0" />
+		<PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
 		<PackageReference Include="Serilog" Version="2.12.0" />
+		<PackageReference Include="Serilog.Settings.Configuration" Version="3.4.0" />
 		<PackageReference Include="Serilog.Sinks.InMemory" Version="0.11.0" />
 		<PackageReference Include="Serilog.Sinks.InMemory.Assertions" Version="0.11.0" />
+		<PackageReference Include="SerilogAnalyzer" Version="0.15.0" />
 		<PackageReference Include="xunit" Version="2.4.2" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
 			<PrivateAssets>all</PrivateAssets>

test/Serilog.Enrichers.Sensitive.Tests.Unit/WhenConfiguringFromJson.cs

@@ -0,0 +1,54 @@
+using System.IO;
+using System.Text;
+using Microsoft.Extensions.Configuration;
+using Serilog.Sinks.InMemory;
+using Serilog.Sinks.InMemory.Assertions;
+using Xunit;
+
+namespace Serilog.Enrichers.Sensitive.Tests.Unit;
+
+public class WhenConfiguringFromJson
+{
+    [Fact]
+    public void GivenJsonConfigurationWithMaskValue_EnricherIsConfiguredWithTheCorrectMaskValue()
+    {
+        var jsonConfiguration = @"
+{
+  ""Serilog"": {
+    ""Using"": [ ""Serilog.Enrichers.Sensitive"" ],
+    ""Enrich"": [ {
+        ""Name"": ""WithSensitiveDataMasking"",
+        ""Args"": {
+            ""options"": {
+                ""MaskValue"": ""^^"",
+                ""ExcludeProperties"": [ ""email"" ],
+                ""Mode"": ""Globally""
+            }
+        }
+    }]
+  }
+}
+";
+        var memoryStream = new MemoryStream();
+        memoryStream.Write(Encoding.UTF8.GetBytes(jsonConfiguration));
+        memoryStream.Seek(0, SeekOrigin.Begin);
+
+        var configuration = new ConfigurationBuilder()
+            .AddJsonStream(memoryStream)
+            .Build();
+
+        var inMemorySink = new InMemorySink();
+
+        var logger = new LoggerConfiguration()
+            .ReadFrom.Configuration(configuration)
+            .WriteTo.Sink(inMemorySink)
+            .CreateLogger();
+
+        logger.Information("Test value [email protected]");
+
+        inMemorySink
+            .Should()
+            .HaveMessage("Test value ^^", "the e-mail address is replaced with the configured masking value")
+            .Appearing().Once();
+    }
+}