Added test: BodyLoggerMiddleware_Should_Redact_Password.

matthiasguentert · Feb 13, 2024 · 9c8fc01 · 9c8fc01
1 parent 6131757
commit 9c8fc01
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/src/ApplicationInsightsRequestLogging/Options/BodyLoggerOptions.cs b/src/ApplicationInsightsRequestLogging/Options/BodyLoggerOptions.cs
@@ -55,6 +55,7 @@ public BodyLoggerOptions()
         ///     Controls storage of client IP addresses https://learn.microsoft.com/en-us/azure/azure-monitor/app/ip-collection?tabs=net
         /// </summary>
         public bool DisableIpMasking { get; set; } = false;
+
         public List<string> PropertyNamesWithSensitiveData { get; set; } = new List<string>()
         {
             "password",

diff --git a/test/ApplicationInsightsRequestLoggingTests/BodyLoggerMiddlewareTests.cs b/test/ApplicationInsightsRequestLoggingTests/BodyLoggerMiddlewareTests.cs
@@ -14,6 +14,7 @@
 using Microsoft.ApplicationInsights.DataContracts;
 using Moq;
 using Microsoft.Extensions.DependencyInjection;
+using System.Collections.Generic;
 
 namespace ApplicationInsightsRequestLoggingTests
 {
@@ -152,6 +153,48 @@ public async void BodyLoggerMiddleware_Should_Leave_Body_intact()
             body.Should().Be("Hello from client");
         }
 
+        [Fact]
+        public async void BodyLoggerMiddleware_Should_Redact_Password()
+        {
+            // Arrange
+            var telemetryWriter = new Mock<ITelemetryWriter>();
+
+            using var host = await new HostBuilder()
+                .ConfigureWebHost(webBuilder =>
+                {
+                    webBuilder
+                        .UseTestServer()
+                        .ConfigureServices(services =>
+                        {
+                            services.AddTransient<IBodyReader, BodyReader>();
+                            services.AddTransient<ISensitiveDataFilter>(provider =>
+                            {
+                                return new SensitiveDataFilter(new List<string>() { "password" }, new List<string>());
+                            });
+                            services.AddSingleton(telemetryWriter.Object);
+                            services.AddTransient<BodyLoggerMiddleware>();
+                        })
+                        .Configure(app =>
+                        {
+                            app.UseMiddleware<BodyLoggerMiddleware>();
+                            app.Run(async context =>
+                            {
+                                // Send request body back in response body
+                                context.Response.StatusCode = StatusCodes.Status400BadRequest;
+                                await context.Request.Body.CopyToAsync(context.Response.Body);
+                            });
+                        });
+                })
+                .StartAsync();
+
+            // Act
+            var response = await host.GetTestClient().PostAsync("/", new StringContent("{\"email\":\"[email protected]\",\"password\":\"P@ssw0rd!\"}"));
+
+            // Assert
+            telemetryWriter.Verify(x => x.Write(It.IsAny<HttpContext>(), "RequestBody", "{\"email\":\"[email protected]\",\"password\":\"***MASKED***\"}"), Times.Once);
+            telemetryWriter.Verify(x => x.Write(It.IsAny<HttpContext>(), "ResponseBody", "{\"email\":\"[email protected]\",\"password\":\"***MASKED***\"}"), Times.Once);
+        }
+
         [Fact]
         public async void BodyLoggerMiddleware_Should_Properly_Pass()
         {