[Inproc] Sanitize exception logs (#10462)

Author: surgupta-msft

src/WebJobs.Script/Sanitizer.cs

@@ -18,7 +18,7 @@ internal static class Sanitizer
 
         // List of keywords that should not be replaced with [Hidden Credential]
         private static readonly string[] AllowedTokens = new string[] { "PublicKeyToken=" };
-        internal static readonly string[] CredentialTokens = new string[] { "Token=", "DefaultEndpointsProtocol=http", "AccountKey=", "Data Source=", "Server=", "Password=", "pwd=", "&sig=", "&sig=", "?sig=", "SharedAccessKey=" };
+        internal static readonly string[] CredentialTokens = new string[] { "Token=", "DefaultEndpointsProtocol=http", "AccountKey=", "Data Source=", "Server=", "Password=", "pwd=", "&sig=", "&sig=", "?sig=", "SharedAccessKey=", "&code=", "&code=", "?code=", "key=" };
         private static readonly string[] CredentialNameFragments = new[] { "password", "pwd", "key", "secret", "token", "sas" };
 
         // Pattern of format : "<protocol>://<username>:<password>@<address>:<port>"

src/WebJobs.Script/Workers/Rpc/RpcException.cs

@@ -2,16 +2,17 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
+using Microsoft.Azure.WebJobs.Logging;
 
 namespace Microsoft.Azure.WebJobs.Script.Workers.Rpc
 {
     public class RpcException : Exception
     {
         public RpcException(string result, string message, string stack, string typeName = "", bool isUserException = false)
-            : base($"Result: {result}\nException: {message}\nStack: {stack}")
+            : base($"Result: {result}\nException: {Sanitizer.Sanitize(message)}\nStack: {stack}")
         {
             RemoteStackTrace = stack;
-            RemoteMessage = message;
+            RemoteMessage = Sanitizer.Sanitize(message);
             if (!string.IsNullOrEmpty(typeName))
             {
                 RemoteTypeName = typeName;

test/WebJobs.Script.Tests/SanitizerTests.cs

@@ -34,6 +34,9 @@ public class SanitizerTests
         [InlineData("SharedAccessKey=foo", "[Hidden Credential]")]
         [InlineData(@"Hey=AS1$@%#$%W-k2j"";SharedAccessKey=foo,Data Source=barzons,Server=bathouse'testing", @"Hey=AS1$@%#$%W-k2j"";[Hidden Credential]'testing")]
         [InlineData("test?sig=", "test[Hidden Credential]")]
+        [InlineData("test?code=XPAAAAAAAAAAAAAT-ag==", "test[Hidden Credential]")]
+        [InlineData("test?foo=bar&code=REAAAAAAAAAAAAAT-ag==", "test?foo=bar[Hidden Credential]")]
+        [InlineData("test&code=MiAAAAAAAAAAAAAAAAT-ag==", "test[Hidden Credential]")]
         [InlineData("aaa://aaa:[email protected]:1111", "[Hidden Credential]")]
         [InlineData("test,aaa://aaa:[email protected]:1111,test", "test,[Hidden Credential],test")]
         [InlineData(@"some text abc://abc:[email protected]:1111 some text abc://abc:[email protected]:1111 text", @"some text [Hidden Credential] some text [Hidden Credential] text")]

test/WebJobs.Script.Tests/Workers/Rpc/GrpcWorkerChannelTests.cs

@@ -939,6 +939,23 @@ public async Task ReceivesInboundEvent_FunctionLoadResponse()
             Assert.True(traces.Any(m => string.Equals(m.FormattedMessage, "Received FunctionLoadResponse for function: 'js1' with functionId: 'TestFunctionId1'.")), "FunctionLoadResponse TestFunctionId1");
         }
 
+        [Fact]
+        public async Task ReceivesInboundEvent_Error_FunctionLoadResponse()
+        {
+            await CreateDefaultWorkerChannel();
+            var functionMetadatas = GetTestFunctionsList("node");
+            _workerChannel.SetupFunctionInvocationBuffers(functionMetadatas);
+            _testFunctionRpcService.OnMessage(StreamingMessage.ContentOneofCase.FunctionLoadRequest,
+                _ => _testFunctionRpcService.PublishSystemErrorFunctionLoadResponseEvent("TestFunctionId1", "abc AccountKey== "));
+            _workerChannel.SendFunctionLoadRequests(null, TimeSpan.FromMinutes(5));
+
+            await Task.Delay(500);
+            var traces = _logger.GetLogMessages();
+            ShowOutput(traces);
+
+            Assert.True(traces.Any(m => m.Exception != null && m.Exception.Message.Contains("abc [Hidden Credential]")));
+        }
+
         [Fact]
         public async Task Receives_Individual_FunctionLoadResponses_Parallel()
         {

test/WebJobs.Script.Tests/Workers/Rpc/TestFunctionRpcService.cs

@@ -11,6 +11,7 @@
 using Microsoft.Azure.WebJobs.Script.Grpc.Eventing;
 using Microsoft.Azure.WebJobs.Script.Grpc.Messages;
 using Microsoft.Extensions.Logging;
+using static Microsoft.Azure.WebJobs.Script.Grpc.Messages.RpcLog.Types;
 
 namespace Microsoft.Azure.WebJobs.Script.Tests.Workers.Rpc
 {
@@ -153,6 +154,37 @@ public void PublishFunctionLoadResponseEvent(string functionId)
             Write(responseMessage);
         }
 
+        public void PublishSystemErrorFunctionLoadResponseEvent(string functionId, string exceptionMessage)
+        {
+            StatusResult statusResult = new StatusResult()
+            {
+                Status = StatusResult.Types.Status.Failure
+            };
+            FunctionLoadResponse functionLoadResponse = new FunctionLoadResponse()
+            {
+                FunctionId = functionId,
+                Result = statusResult
+            };
+
+            RpcLog rpcLog = new RpcLog()
+            {
+                LogCategory = RpcLogCategory.System,
+                Level = Level.Error,
+                Exception = new RpcException()
+                {
+                    Message = exceptionMessage
+                }
+            };
+
+            StreamingMessage responseMessage = new StreamingMessage()
+            {
+                FunctionLoadResponse = functionLoadResponse,
+                RpcLog = rpcLog
+            };
+
+            Write(responseMessage);
+        }
+
         public void PublishFunctionLoadResponsesEvent(List<string> functionIds, StatusResult statusResult)
         {
             FunctionLoadResponseCollection functionLoadResponseCollection = new FunctionLoadResponseCollection();