Allow Explicit to set AllowAnonymous for the dashboard API. (#1335)

Author: yang-xiaodong

src/DotNetCore.CAP.Dashboard/CAP.BuilderExtension.cs

@@ -52,13 +52,13 @@ internal static IApplicationBuilder UseCapDashboard(this IApplicationBuilder app
                     httpContext.Response.StatusCode = 301;
                     httpContext.Response.Headers["Location"] = redirectUrl;
                     return Task.CompletedTask;
-                });
+                }).AllowAnonymousIf(options.AllowAnonymousExplicit);
 
                 endPointRouteBuilder.MapGet(options.PathMatch + "/index.html", async httpContext =>
                 {
                     if (!await Authentication(httpContext, options))
                     {
-                        if(httpContext.Response.StatusCode != StatusCodes.Status302Found)
+                        if (httpContext.Response.StatusCode != StatusCodes.Status302Found)
                             httpContext.Response.StatusCode = StatusCodes.Status401Unauthorized;
                         return;
                     }
@@ -74,7 +74,7 @@ internal static IApplicationBuilder UseCapDashboard(this IApplicationBuilder app
                     htmlBuilder.Replace("%(servicePrefix)", options.PathBase + options.PathMatch + "/api");
                     htmlBuilder.Replace("%(pollingInterval)", options.StatsPollingInterval.ToString());
                     await httpContext.Response.WriteAsync(htmlBuilder.ToString(), Encoding.UTF8);
-                });
+                }).AllowAnonymousIf(options.AllowAnonymousExplicit);
 
                 new RouteActionProvider(endPointRouteBuilder, options).MapDashboardRoutes();
             }
@@ -133,5 +133,10 @@ internal static async Task<bool> Authorize(HttpContext httpContext, DashboardOpt
             }
             return true;
         }
+
+        internal static IEndpointConventionBuilder AllowAnonymousIf(this IEndpointConventionBuilder builder, bool allowAnonymous)
+        {
+            return allowAnonymous ? builder.AllowAnonymous() : builder;
+        }
     }
 }

src/DotNetCore.CAP.Dashboard/CAP.DashboardOptions.cs

@@ -11,6 +11,7 @@ public DashboardOptions()
         {
             PathMatch = "/cap";
             StatsPollingInterval = 2000;
+            AllowAnonymousExplicit = true;
         }
 
         /// <summary>
@@ -52,5 +53,10 @@ public DashboardOptions()
         /// Authorization policy. If no policy is set, authorization will be inactive.
         /// </summary>
         public string AuthorizationPolicy { get; set; }
+
+        /// <summary>
+        /// Allow Explicit to set AllowAnonymous for the CAP dashboard API without use ASP.NET Core global authorization filter. Default true
+        /// </summary>
+        public bool AllowAnonymousExplicit { get; set; }
     }
 }

src/DotNetCore.CAP.Dashboard/RouteActionProvider.cs

@@ -41,23 +41,23 @@ public void MapDashboardRoutes()
         {
             var prefixMatch = _options.PathMatch + "/api";
 
-            _builder.MapGet(prefixMatch + "/metrics-realtime", Metrics);
-            _builder.MapGet(prefixMatch + "/meta", MetaInfo);
-            _builder.MapGet(prefixMatch + "/stats", Stats);
-            _builder.MapGet(prefixMatch + "/metrics-history", MetricsHistory);
-            _builder.MapGet(prefixMatch + "/health", Health);
-            _builder.MapGet(prefixMatch + "/published/message/{id:long}", PublishedMessageDetails);
-            _builder.MapGet(prefixMatch + "/received/message/{id:long}", ReceivedMessageDetails);
-
-            _builder.MapPost(prefixMatch + "/published/requeue", PublishedRequeue);
-            _builder.MapPost(prefixMatch + "/received/reexecute", ReceivedRequeue);
-
-            _builder.MapGet(prefixMatch + "/published/{status}", PublishedList);
-            _builder.MapGet(prefixMatch + "/received/{status}", ReceivedList);
-            _builder.MapGet(prefixMatch + "/subscriber", Subscribers);
-            _builder.MapGet(prefixMatch + "/nodes", Nodes);
+            _builder.MapGet(prefixMatch + "/metrics-realtime", Metrics).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/meta", MetaInfo).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/stats", Stats).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/metrics-history", MetricsHistory).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/health", Health).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/published/message/{id:long}", PublishedMessageDetails).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/received/message/{id:long}", ReceivedMessageDetails).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+
+            _builder.MapPost(prefixMatch + "/published/requeue", PublishedRequeue).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapPost(prefixMatch + "/received/reexecute", ReceivedRequeue).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+
+            _builder.MapGet(prefixMatch + "/published/{status}", PublishedList).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/received/{status}", ReceivedList).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/subscriber", Subscribers).AllowAnonymousIf(_options.AllowAnonymousExplicit);
+            _builder.MapGet(prefixMatch + "/nodes", Nodes).AllowAnonymousIf(_options.AllowAnonymousExplicit);
         }
-
+         
         public async Task Metrics(HttpContext httpContext)
         {
             if (_agent != null && await _agent.Invoke(httpContext)) return;