Implement new interface properties IgnoredModules and IgnoredCmdlets …

…to bypass unnecessary secrets detection (Azure#25594)
azure-sdk · Jul 25, 2024 · 508b8c0 · 508b8c0
1 parent 39db20f
commit 508b8c0
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 34 deletions.
diff --git a/src/Accounts/Accounts/CommonModule/AzModule.cs b/src/Accounts/Accounts/CommonModule/AzModule.cs
@@ -368,13 +368,14 @@ public void SanitizerHandler(object sanitizingObject, string telemetryId)
         {
             if (AzureSession.Instance.TryGetComponent<IOutputSanitizer>(nameof(IOutputSanitizer), out var outputSanitizer))
             {
-                if (outputSanitizer?.RequireSecretsDetection == true)
+                _telemetry.TryGetValue(telemetryId, out var qos);
+                if (outputSanitizer != null
+                    && outputSanitizer.RequireSecretsDetection
+                    && !outputSanitizer.IgnoredModules.Contains(qos?.ModuleName)
+                    && !outputSanitizer.IgnoredCmdlets.Contains(qos?.CommandName))
                 {
                     outputSanitizer.Sanitize(sanitizingObject, out var telemetry);
-                    if (_telemetry.TryGetValue(telemetryId, out var qos))
-                    {
-                        qos?.SanitizerInfo?.Combine(telemetry);
-                    }
+                    qos?.SanitizerInfo?.Combine(telemetry);
                 }
             }
         }

diff --git a/src/Accounts/Authentication/Sanitizer/OutputSanitizer.cs b/src/Accounts/Authentication/Sanitizer/OutputSanitizer.cs
@@ -19,6 +19,7 @@
 using System;
 using Microsoft.Azure.Commands.Shared.Config;
 using Microsoft.Azure.Commands.Common.Authentication.Sanitizer.Providers;
+using System.Linq;
 
 namespace Microsoft.Azure.Commands.Common.Authentication.Sanitizer
 {
@@ -37,6 +38,15 @@ public bool RequireSecretsDetection
             }
         }
 
+        public IEnumerable<string> IgnoredModules => Enumerable.Empty<string>();
+
+        public IEnumerable<string> IgnoredCmdlets => new[]
+        {
+            "Get-AzActivityLog",
+            "Get-AzComputeResourceSku",
+            "Get-AzConsumptionUsageDetail",
+        };
+
         public void Sanitize(object sanitizingObject, out SanitizerTelemetry telemetry)
         {
             var watch = Stopwatch.StartNew();

diff --git a/src/Accounts/Authentication/Sanitizer/Providers/DefaultProviderResolver.cs b/src/Accounts/Authentication/Sanitizer/Providers/DefaultProviderResolver.cs
@@ -184,14 +184,7 @@ private bool IsOfTypeCustomObject(Type type)
 
         private bool IsIgnoredProperty(string typeName, string propertyName)
         {
-            bool ignored = false;
-
-            if (Service.IgnoredProperties.ContainsKey(typeName))
-            {
-                ignored = Service.IgnoredProperties[typeName].Contains(propertyName);
-            }
-
-            return ignored;
+            return Service.IgnoredProperties.TryGetValue(typeName, out var propertyNames) && propertyNames.Contains(propertyName);
         }
 
         private SanitizerProviderBase CreateCustomObjectProvider(Type objType)

diff --git a/src/Accounts/Authentication/Sanitizer/Services/DefaultSanitizerService.cs b/src/Accounts/Authentication/Sanitizer/Services/DefaultSanitizerService.cs
@@ -19,7 +19,7 @@ namespace Microsoft.Azure.Commands.Common.Authentication.Sanitizer.Services
 {
     internal class DefaultSanitizerService : ISanitizerService
     {
-        public Dictionary<string, IEnumerable<string>> IgnoredProperties => new Dictionary<string, IEnumerable<string>>()
+        public IReadOnlyDictionary<string, IEnumerable<string>> IgnoredProperties => new Dictionary<string, IEnumerable<string>>()
         {
             /*
              * This dictionary is used to store the properties that should be ignored during sanitization.
@@ -35,9 +35,11 @@ internal class DefaultSanitizerService : ISanitizerService
             { "Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileShare", new[] { "ShareProperties" } },
             { "Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileDirectory", new[] { "ShareDirectoryProperties" } },
 
-            // Skip infinite recursion properties that cause performance concern
+            // Skip large properties
+            { "Microsoft.Azure.Storage.Blob.CloudBlob", new[] { "ICloudBlob" } },
+            { "Microsoft.Azure.Storage.File.CloudFile", new[] { "CloudFile" } },
 
-            // Storage
+            // Skip infinite recursion properties
             { "Microsoft.Azure.Storage.Blob.CloudBlobDirectory", new[] { "Parent" } },
             { "Microsoft.Azure.Storage.File.CloudFileDirectory", new[] { "Parent" } },
         };

diff --git a/src/Accounts/Authentication/Sanitizer/Services/ISanitizerService.cs b/src/Accounts/Authentication/Sanitizer/Services/ISanitizerService.cs
@@ -18,7 +18,7 @@ namespace Microsoft.Azure.Commands.Common.Authentication.Sanitizer.Services
 {
     public interface ISanitizerService
     {
-        Dictionary<string, IEnumerable<string>> IgnoredProperties { get; }
+        IReadOnlyDictionary<string, IEnumerable<string>> IgnoredProperties { get; }
 
         bool TrySanitizeData(string data, out string sanitizedData);
     }

diff --git a/tools/Common.Netcore.Dependencies.targets b/tools/Common.Netcore.Dependencies.targets
@@ -3,22 +3,22 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Rest.ClientRuntime" Version="2.3.24"/>
     <PackageReference Include="Microsoft.Rest.ClientRuntime.Azure" Version="3.3.19"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Aks" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Authentication.Abstractions" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Authorization" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Common" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Compute" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Graph.Rbac" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.KeyVault" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Monitor" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Network" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.PolicyInsights" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.ResourceManager" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Storage" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Storage.Management" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Strategies" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Websites" Version="1.3.98-preview"/>
-    <PackageReference Include="Microsoft.Azure.PowerShell.Common.Share" Version="1.3.98-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Aks" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Authentication.Abstractions" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Authorization" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Common" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Compute" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Graph.Rbac" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.KeyVault" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Monitor" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Network" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.PolicyInsights" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.ResourceManager" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Storage" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Storage.Management" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Strategies" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Clients.Websites" Version="1.3.99-preview"/>
+    <PackageReference Include="Microsoft.Azure.PowerShell.Common.Share" Version="1.3.99-preview"/>
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
   </ItemGroup>
   <ItemGroup>
@@ -37,7 +37,7 @@
     <PackageReference Include="PowerShellStandard.Library" Version="5.1.0" PrivateAssets="All" />
   </ItemGroup>
   <PropertyGroup>
-    <StorageToolsPath>$(NugetPackageRoot)\microsoft.azure.powershell.storage\1.3.98-preview\tools\</StorageToolsPath>
+    <StorageToolsPath>$(NugetPackageRoot)\microsoft.azure.powershell.storage\1.3.99-preview\tools\</StorageToolsPath>
   </PropertyGroup>
   <ItemGroup Condition="'$(OmitJsonPackage)' != 'true'">
     <PackageReference Include="Newtonsoft.Json" Version="13.0.2"/>