using System.Net; using System.Net.Http; using System.Security.Claims; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authentication.Cookies; using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Options; using ZB.MOM.WW.Auth.ApiKeys.Admin; using ZB.MOM.WW.MxGateway.Server; using ZB.MOM.WW.MxGateway.Server.Dashboard; using ZB.MOM.WW.MxGateway.Server.Security.Authorization; using ZB.MOM.WW.MxGateway.Tests.TestSupport; namespace ZB.MOM.WW.MxGateway.Tests.Gateway; /// /// Host-level coverage of MxGateway:Metrics:RequireAuthentication=true (SEC-14): each case /// builds the real gateway with and drives the full /// middleware pipeline (authentication, authorization, the dashboard cookie scheme, the API-key /// store) over HTTP on an ephemeral loopback port. Requests therefore arrive from loopback, which /// is exactly the anonymous-localhost case the dashboard Viewer policy would admit and /metrics /// must not. /// public sealed class MetricsEndpointAuthenticationTests { // A fixed test pepper: the configuration-backed pepper provider reads MxGateway:ApiKeyPepper, // and the auth store itself is isolated per test process by TestHostEnvironmentInitializer. private const string TestPepper = "metrics-endpoint-tests-pepper-0123456789abcdef"; /// /// An anonymous loopback scrape gets a plain 401 Bearer challenge — not a 302 to /login, and not /// the anonymous-localhost admission the dashboard Viewer policy grants. /// /// A task that represents the asynchronous operation. [Fact] public async Task AnonymousLoopbackScrape_Returns401BearerNotLoginRedirect() { await using WebApplication app = await StartAsync(); using HttpClient client = CreateClient(app); using HttpResponseMessage response = await client.GetAsync("/metrics"); Assert.Equal(HttpStatusCode.Unauthorized, response.StatusCode); Assert.Null(response.Headers.Location); Assert.Contains(response.Headers.WwwAuthenticate, value => value.Scheme == "Bearer"); } /// /health/active stays anonymous: the off-repo Overview dashboard polls it without credentials. /// A task that represents the asynchronous operation. [Fact] public async Task HealthActive_StaysAnonymous() { await using WebApplication app = await StartAsync(); using HttpClient client = CreateClient(app); using HttpResponseMessage response = await client.GetAsync("/health/active"); Assert.Equal(HttpStatusCode.OK, response.StatusCode); } /// A dashboard login cookie holding the Viewer role is accepted. /// A task that represents the asynchronous operation. [Fact] public async Task DashboardViewerCookie_Returns200() { await using WebApplication app = await StartAsync(); using HttpClient client = CreateClient(app); using HttpRequestMessage request = new(HttpMethod.Get, "/metrics"); request.Headers.Add("Cookie", MintDashboardCookie(app, DashboardRoles.Viewer)); using HttpResponseMessage response = await client.SendAsync(request); Assert.Equal(HttpStatusCode.OK, response.StatusCode); } /// A real API key with the admin scope is accepted. /// A task that represents the asynchronous operation. [Fact] public async Task AdminScopedApiKey_Returns200() { await using WebApplication app = await StartAsync(); string token = await CreateKeyAsync(app, [GatewayScopes.Admin]); using HttpClient client = CreateClient(app); using HttpResponseMessage response = await SendWithBearerAsync(client, token); Assert.Equal(HttpStatusCode.OK, response.StatusCode); } /// A real API key without the admin scope authenticates but is forbidden. /// A task that represents the asynchronous operation. [Fact] public async Task NonAdminApiKey_Returns403() { await using WebApplication app = await StartAsync(); string token = await CreateKeyAsync(app, [GatewayScopes.EventsRead, GatewayScopes.InvokeRead]); using HttpClient client = CreateClient(app); using HttpResponseMessage response = await SendWithBearerAsync(client, token); Assert.Equal(HttpStatusCode.Forbidden, response.StatusCode); } /// /// Dev-only Dashboard:DisableLogin registers an always-succeeding auto-login handler under /// the cookie scheme name; /metrics must not fall back to it, or the flag would silently open /// an endpoint the operator explicitly asked to protect. /// /// A task that represents the asynchronous operation. [Fact] public async Task DisableLogin_DoesNotOpenMetrics() { await using WebApplication app = await StartAsync("--MxGateway:Dashboard:DisableLogin=true"); using HttpClient client = CreateClient(app); using HttpResponseMessage response = await client.GetAsync("/metrics"); Assert.Equal(HttpStatusCode.Unauthorized, response.StatusCode); } private static async Task StartAsync(params string[] extraArgs) { // Ephemeral port (:0): xUnit runs collections in parallel, so a fixed port would collide. WebApplication app = TestGatewayHost.Build( [ "--urls=http://127.0.0.1:0", "--MxGateway:Metrics:RequireAuthentication=true", $"--MxGateway:ApiKeyPepper={TestPepper}", .. extraArgs, ]); await app.StartAsync(); return app; } private static HttpClient CreateClient(WebApplication app) => new(new HttpClientHandler { AllowAutoRedirect = false, UseCookies = false }) { BaseAddress = new Uri(app.Urls.First()), }; private static async Task SendWithBearerAsync(HttpClient client, string token) { using HttpRequestMessage request = new(HttpMethod.Get, "/metrics"); request.Headers.TryAddWithoutValidation("Authorization", $"Bearer {token}"); return await client.SendAsync(request); } // Creates a key through the same admin command set the CLI and dashboard use. Key ids are unique // per call because the isolated auth store is shared by every test in the process. private static async Task CreateKeyAsync(WebApplication app, string[] scopes) { ApiKeyAdminCommands commands = app.Services.GetRequiredService(); await commands.InitDbAsync(remoteAddress: null, CancellationToken.None); CreateKeyResult created = await commands.CreateKeyAsync( $"metrics{Guid.NewGuid():N}", "Metrics test key", new HashSet(scopes, StringComparer.Ordinal), null, null, remoteAddress: null, CancellationToken.None); return created.Token ?? throw new InvalidOperationException("Key creation returned no token."); } // Protects a ticket with the running host's own cookie options (data-protection keys, ticket // format, cookie name) — the cookie a real dashboard login would issue, minus the LDAP bind. private static string MintDashboardCookie(WebApplication app, string role) { CookieAuthenticationOptions cookieOptions = app.Services .GetRequiredService>() .Get(DashboardAuthenticationDefaults.AuthenticationScheme); ClaimsIdentity identity = new( [new Claim(ClaimTypes.Name, "viewer-user"), new Claim(ClaimTypes.Role, role)], DashboardAuthenticationDefaults.AuthenticationScheme, ClaimTypes.Name, ClaimTypes.Role); AuthenticationTicket ticket = new( new ClaimsPrincipal(identity), DashboardAuthenticationDefaults.AuthenticationScheme); return $"{cookieOptions.Cookie.Name}={cookieOptions.TicketDataFormat.Protect(ticket)}"; } }