Extend MinimalPermissionsPlugin by introducing the schemeName property

DevProxy.Plugins/Extensions/OpenApiDocumentExtensions.cs

@@ -16,6 +16,11 @@ namespace Microsoft.OpenApi.Models;
 static class OpenApiDocumentExtensions
 {
     public static ApiPermissionsInfo CheckMinimalPermissions(this OpenApiDocument openApiDocument, IEnumerable<RequestLog> requests, ILogger logger)
+    {
+        return CheckMinimalPermissions(openApiDocument, requests, logger, null);
+    }
+
+    public static ApiPermissionsInfo CheckMinimalPermissions(this OpenApiDocument openApiDocument, IEnumerable<RequestLog> requests, ILogger logger, string? schemeName)
     {
         logger.LogInformation("Checking minimal permissions for API {ApiName}...", openApiDocument.Servers.First().Url);
 
@@ -78,7 +83,7 @@ public static ApiPermissionsInfo CheckMinimalPermissions(this OpenApiDocument op
                 continue;
             }
 
-            var scopes = operation.GetEffectiveScopes(openApiDocument, logger);
+            var scopes = operation.GetEffectiveScopes(openApiDocument, logger, schemeName);
             if (scopes.Length != 0)
             {
                 operationsAndScopes[$"{method} {pathItem.Value.Key}"] = scopes;
@@ -176,12 +181,19 @@ [.. operationsFromRequests
         return null;
     }
 
-    public static string[] GetEffectiveScopes(this OpenApiOperation operation, OpenApiDocument openApiDocument, ILogger logger)
+    public static string[] GetEffectiveScopes(this OpenApiOperation operation, OpenApiDocument openApiDocument, ILogger logger, string? schemeName)
     {
-        var oauth2Scheme = openApiDocument.GetOAuth2Schemes().FirstOrDefault();
+        var oauth2Scheme = openApiDocument.GetOAuth2Schemes(schemeName).FirstOrDefault();
         if (oauth2Scheme is null)
         {
-            logger.LogDebug("No OAuth2 schemes found in OpenAPI document");
+            if (string.IsNullOrWhiteSpace(schemeName))
+            {
+                logger.LogDebug("No OAuth2 scheme '{SchemeName}' found in OpenAPI document", schemeName);
+            }
+            else
+            {
+                logger.LogDebug("No OAuth2 schemes found in OpenAPI document");
+            }
             return [];
         }
 
@@ -210,11 +222,17 @@ public static string[] GetEffectiveScopes(this OpenApiOperation operation, OpenA
         return [];
     }
 
-    public static OpenApiSecurityScheme[] GetOAuth2Schemes(this OpenApiDocument openApiDocument)
+    public static OpenApiSecurityScheme[] GetOAuth2Schemes(this OpenApiDocument openApiDocument, string? schemeName)
     {
-        return [.. openApiDocument.Components.SecuritySchemes
-            .Where(s => s.Value.Type == SecuritySchemeType.OAuth2)
-            .Select(s => s.Value)];
+        var schemes = openApiDocument.Components.SecuritySchemes
+            .Where(s => s.Value.Type == SecuritySchemeType.OAuth2);
+
+        if (!string.IsNullOrWhiteSpace(schemeName))
+        {
+            schemes = schemes.Where(s => string.Equals(schemeName, s.Key, StringComparison.Ordinal));
+        }
+
+        return [.. schemes.Select(s => s.Value)];
     }
 
     private static bool UrlMatchesServerUrl(string absoluteUrl, string serverUrl)

DevProxy.Plugins/Reporting/MinimalPermissionsPlugin.cs

@@ -17,6 +17,7 @@ namespace DevProxy.Plugins.Reporting;
 public sealed class MinimalPermissionsPluginConfiguration
 {
     public string? ApiSpecsFolderPath { get; set; }
+    public string? SchemeName { get; set; }
 }
 
 public sealed class MinimalPermissionsPlugin(
@@ -92,7 +93,7 @@ public override async Task AfterRecordingStopAsync(RecordingArgs e, Cancellation
 
         foreach (var (apiSpec, requests) in requestsByApiSpec)
         {
-            var minimalPermissions = apiSpec.CheckMinimalPermissions(requests, Logger);
+            var minimalPermissions = apiSpec.CheckMinimalPermissions(requests, Logger, Configuration.SchemeName);
 
             var result = new MinimalPermissionsPluginReportApiResult
             {
@@ -102,7 +103,8 @@ public override async Task AfterRecordingStopAsync(RecordingArgs e, Cancellation
                     .Select(o => $"{o.Method} {o.OriginalUrl}")
                     .Distinct()],
                 TokenPermissions = [.. minimalPermissions.TokenPermissions.Distinct()],
-                MinimalPermissions = minimalPermissions.MinimalScopes
+                MinimalPermissions = minimalPermissions.MinimalScopes,
+                SchemeName = Configuration.SchemeName
             };
             results.Add(result);
 
@@ -132,14 +134,22 @@ public override async Task AfterRecordingStopAsync(RecordingArgs e, Cancellation
                 );
             }
 
-            Logger.LogInformation("Minimal permissions: {MinimalScopes}", string.Join(", ", result.MinimalPermissions));
+            if (string.IsNullOrWhiteSpace(Configuration.SchemeName))
+            {
+                Logger.LogInformation("Minimal permissions: {MinimalScopes}", string.Join(", ", result.MinimalPermissions));
+            }
+            else
+            {
+                Logger.LogInformation("Minimal permissions of '{SchemeName}' scheme: {MinimalScopes}",
+                    Configuration.SchemeName, string.Join(", ", result.MinimalPermissions));
+            }
         }
 
         var report = new MinimalPermissionsPluginReport()
         {
             Results = [.. results],
             UnmatchedRequests = [.. unmatchedRequests],
-            Errors = [.. errors]
+            Errors = [.. errors],
         };
 
         StoreReport(report, e);

DevProxy.Plugins/Reporting/MinimalPermissionsPluginReport.cs

@@ -15,6 +15,7 @@ public sealed class MinimalPermissionsPluginReportApiResult
     public required IEnumerable<string> MinimalPermissions { get; init; }
     public required IEnumerable<string> Requests { get; init; }
     public required IEnumerable<string> TokenPermissions { get; init; }
+    public string? SchemeName { get; init; }
 }
 
 public sealed class MinimalPermissionsPluginReport : IMarkdownReport, IPlainTextReport
@@ -26,7 +27,7 @@ public sealed class MinimalPermissionsPluginReport : IMarkdownReport, IPlainText
     public string? ToMarkdown()
     {
         var sb = new StringBuilder();
-        _ = sb.AppendLine($"# Minimal permissions report");
+        _ = sb.AppendLine("# Minimal permissions report");
 
         foreach (var apiResult in Results)
         {
@@ -36,9 +37,18 @@ public sealed class MinimalPermissionsPluginReport : IMarkdownReport, IPlainText
                 .AppendLine("### Requests")
                 .AppendLine()
                 .AppendJoin(Environment.NewLine, apiResult.Requests.Select(r => $"- {r}"))
-                .AppendLine()
+                .AppendLine();
 
-                .AppendLine()
+            if (!string.IsNullOrWhiteSpace(apiResult.SchemeName))
+            {
+                _ = sb.AppendLine()
+                    .AppendLine("### Scheme definition name")
+                    .AppendLine()
+                    .AppendLine(CultureInfo.InvariantCulture, $"- {apiResult.SchemeName}")
+                    .AppendLine();
+            }
+
+            _ = sb.AppendLine()
                 .AppendLine("### Minimal permissions")
                 .AppendLine()
                 .AppendJoin(Environment.NewLine, apiResult.MinimalPermissions.Select(p => $"- {p}"))
@@ -65,7 +75,7 @@ public sealed class MinimalPermissionsPluginReport : IMarkdownReport, IPlainText
     {
         var sb = new StringBuilder();
 
-        _ = sb.AppendLine($"Minimal permissions report");
+        _ = sb.AppendLine("Minimal permissions report");
 
         foreach (var apiResult in Results)
         {
@@ -75,8 +85,18 @@ public sealed class MinimalPermissionsPluginReport : IMarkdownReport, IPlainText
                 .AppendLine("Requests:")
                 .AppendLine()
                 .AppendJoin(Environment.NewLine, apiResult.Requests.Select(r => $"- {r}"))
-                .AppendLine()
-                .AppendLine()
+                .AppendLine();
+
+            if (!string.IsNullOrWhiteSpace(apiResult.SchemeName))
+            {
+                _ = sb.AppendLine()
+                    .AppendLine("Scheme definition name:")
+                    .AppendLine()
+                    .AppendLine(CultureInfo.InvariantCulture, $"- {apiResult.SchemeName}")
+                    .AppendLine();
+            }
+
+            _ = sb.AppendLine()
                 .AppendLine("Minimal permissions:")
                 .AppendLine()
                 .AppendJoin(Environment.NewLine, apiResult.MinimalPermissions.Select(p => $"- {p}"));

schemas/v1.2.0/minimalpermissionsplugin.schema.json

@@ -10,6 +10,10 @@
     "apiSpecsFolderPath": {
       "type": "string",
       "description": "Relative or absolute path to the folder with API specs. Used to determine minimal permissions required for API calls."
+    },
+    "schemeName": {
+      "type": "string",
+      "description": "The name of the security scheme definition. Used to determine minimal permissions required for API calls."
     }
   },
   "required": [