Beschikbaarheidspoort blokkeert alleen de API, niet de website en de admin
Een uitgeschakeld CMS gaf een kale 503 op de publieke website en op /admin, omdat de poort elk pad stopte dat niet op de bypass-lijst stond. Sinds de host website en admin zelf serveert, viel dat verkeer eronder en kon de admin-app de status niet lezen om de uitgeschakeld-kaart te tonen. Nu worden alleen paden onder /api/ beoordeeld; alle andere paden gaan door. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,224 @@
|
||||
using System.Net;
|
||||
using FluentAssertions;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.AspNetCore.Hosting;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.TestHost;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using NSubstitute;
|
||||
using SlpModularCms.Core.Availability;
|
||||
using SlpModularCms.Core.Hosting;
|
||||
using SlpModularCms.Core.Hosting.Security;
|
||||
using SlpModularCms.Core.Hosting.Website;
|
||||
using SlpModularCms.Modules.Availability.Middleware;
|
||||
using SlpModularCms.Modules.Availability.Services;
|
||||
|
||||
namespace SlpModularCms.Modules.Availability.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// The availability gate protects the API, nothing else. A disabled CMS must still serve its public website and
|
||||
/// let the admin app load (so the app can read the open status endpoint and show its "CMS disabled" card):
|
||||
/// a bare 503 on those is the defect this guards. Unit tests of the middleware first, then the real thing on an
|
||||
/// in-memory server with the prerendered website and the admin files.
|
||||
/// </summary>
|
||||
public class AvailabilityGateScopeTests
|
||||
{
|
||||
private static async Task<(int Status, bool Passed)> RunAsync(
|
||||
string path, AvailabilityStatus local = AvailabilityStatus.NotAvailable, bool masterAvailable = true)
|
||||
{
|
||||
var next = Substitute.For<RequestDelegate>();
|
||||
var localSvc = Substitute.For<IAvailabilityService>();
|
||||
localSvc.IsAvailableAsync().Returns(local);
|
||||
var masterSvc = Substitute.For<IMasterAvailabilityService>();
|
||||
masterSvc.GetMasterStatus().Returns(new MasterGateStatus(masterAvailable, masterAvailable ? null : "Down"));
|
||||
var validator = Substitute.For<IAdminTokenValidator>();
|
||||
var middleware = new AvailabilityMiddleware(next, NullLogger<AvailabilityMiddleware>.Instance, validator);
|
||||
var context = new DefaultHttpContext();
|
||||
context.Request.Path = path;
|
||||
context.Response.Body = new MemoryStream();
|
||||
|
||||
await middleware.InvokeAsync(context, localSvc, masterSvc);
|
||||
|
||||
return (context.Response.StatusCode, next.ReceivedCalls().Any());
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("/")]
|
||||
[InlineData("/over-mij")]
|
||||
[InlineData("/blog/een-bericht")]
|
||||
[InlineData("/robots.txt")]
|
||||
[InlineData("/favicon.png")]
|
||||
[InlineData("/admin")]
|
||||
[InlineData("/admin/")]
|
||||
[InlineData("/admin/index.html")]
|
||||
[InlineData("/admin/assets/index-abc123.js")]
|
||||
[InlineData("/admin/users")]
|
||||
[InlineData("/sentry-tunnel")]
|
||||
[InlineData("/health")]
|
||||
[InlineData("/does-not-exist")]
|
||||
public async Task EverythingOutsideTheApi_PassesThroughAdisabledCms_LocalOrMaster(string path)
|
||||
{
|
||||
foreach (var status in new[] { AvailabilityStatus.NotAvailable, AvailabilityStatus.Maintenance })
|
||||
{
|
||||
var (code, passed) = await RunAsync(path, status);
|
||||
passed.Should().BeTrue($"{path} is not an API call ({status})");
|
||||
code.Should().NotBe(StatusCodes.Status503ServiceUnavailable);
|
||||
}
|
||||
|
||||
var (masterCode, masterPassed) = await RunAsync(path, AvailabilityStatus.Available, masterAvailable: false);
|
||||
masterPassed.Should().BeTrue($"{path} is not an API call (master gate)");
|
||||
masterCode.Should().NotBe(StatusCodes.Status503ServiceUnavailable);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("/api/v1/Users")]
|
||||
[InlineData("/api/v1/Offerings/abc")]
|
||||
[InlineData("/api/v1/System/capabilities")]
|
||||
[InlineData("/API/V1/users")]
|
||||
public async Task ApiCalls_AreStillBlocked_WhenTheCmsIsDisabled(string path)
|
||||
{
|
||||
var (localCode, localPassed) = await RunAsync(path, AvailabilityStatus.NotAvailable);
|
||||
localPassed.Should().BeFalse();
|
||||
localCode.Should().Be(StatusCodes.Status503ServiceUnavailable);
|
||||
|
||||
var (maintenanceCode, _) = await RunAsync(path, AvailabilityStatus.Maintenance);
|
||||
maintenanceCode.Should().Be(StatusCodes.Status503ServiceUnavailable);
|
||||
|
||||
var (masterCode, masterPassed) = await RunAsync(path, AvailabilityStatus.Available, masterAvailable: false);
|
||||
masterPassed.Should().BeFalse();
|
||||
masterCode.Should().Be(StatusCodes.Status503ServiceUnavailable);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("/api/v1/Availability/status")]
|
||||
[InlineData("/api/v1/Auth/login")]
|
||||
[InlineData("/api/v1/Setup/status")]
|
||||
[InlineData("/api/v1/master/status")]
|
||||
[InlineData("/api/v1/SlaveStatus")]
|
||||
public async Task TheOpenApiEndpoints_StayOpen(string path)
|
||||
{
|
||||
var (_, passed) = await RunAsync(path, AvailabilityStatus.NotAvailable);
|
||||
|
||||
passed.Should().BeTrue();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ARequestOutsideTheApi_IsNotEvenCheckedForABearerToken()
|
||||
{
|
||||
// Static files and website pages are requested constantly; looking at their (often expired) token would only
|
||||
// produce noise in the security log.
|
||||
var validator = Substitute.For<IAdminTokenValidator>();
|
||||
var middleware = new AvailabilityMiddleware(Substitute.For<RequestDelegate>(), NullLogger<AvailabilityMiddleware>.Instance, validator);
|
||||
var context = new DefaultHttpContext();
|
||||
context.Request.Path = "/admin/assets/index-abc123.js";
|
||||
context.Request.Headers.Authorization = "Bearer an-expired-token";
|
||||
|
||||
await middleware.InvokeAsync(context, Substitute.For<IAvailabilityService>(), Substitute.For<IMasterAvailabilityService>());
|
||||
|
||||
validator.DidNotReceiveWithAnyArgs().Validate(default);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The same on a real pipeline: prerendered website, admin files, a stand-in API and the real gate.</summary>
|
||||
public sealed class AvailabilityGateOnTheRealPipelineTests : IDisposable
|
||||
{
|
||||
private readonly string _root = Path.Combine(Path.GetTempPath(), "slp-gate-" + Guid.NewGuid().ToString("N"));
|
||||
private readonly List<WebApplication> _apps = [];
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
foreach (var app in _apps) app.DisposeAsync().AsTask().GetAwaiter().GetResult();
|
||||
if (Directory.Exists(_root)) Directory.Delete(_root, recursive: true);
|
||||
}
|
||||
|
||||
private void Write(string area, string relative, string content)
|
||||
{
|
||||
var path = Path.Combine(_root, "wwwroot", area, relative);
|
||||
Directory.CreateDirectory(Path.GetDirectoryName(path)!);
|
||||
File.WriteAllText(path, content);
|
||||
}
|
||||
|
||||
private async Task<HttpClient> StartAsync(AvailabilityStatus local, bool masterAvailable = true)
|
||||
{
|
||||
Write("web", "index.html", "<!doctype html><title>Home</title>");
|
||||
Write("web", "404.html", "<!doctype html><title>Niet gevonden</title>");
|
||||
Write("web", "over-mij.html", "<!doctype html><title>Over mij</title>");
|
||||
Write("admin", "index.html", "<!doctype html><title>Admin</title>");
|
||||
Write("admin", "assets/index-abc123.js", "console.log(1)");
|
||||
|
||||
var builder = WebApplication.CreateBuilder(new WebApplicationOptions
|
||||
{
|
||||
EnvironmentName = Environments.Production,
|
||||
ContentRootPath = _root,
|
||||
WebRootPath = Path.Combine(_root, "wwwroot")
|
||||
});
|
||||
builder.WebHost.UseTestServer();
|
||||
builder.Logging.ClearProviders();
|
||||
builder.Configuration.AddInMemoryCollection(new Dictionary<string, string?>
|
||||
{
|
||||
["SecurityHeaders:DefaultPolicy"] = "StrictSite",
|
||||
["Website:NoIndex"] = "false"
|
||||
});
|
||||
builder.Services.AddCmsSecurityHeaders(builder.Configuration);
|
||||
builder.Services.AddCmsWebsite(builder.Configuration);
|
||||
|
||||
var localSvc = Substitute.For<IAvailabilityService>();
|
||||
localSvc.IsAvailableAsync().Returns(local);
|
||||
var masterSvc = Substitute.For<IMasterAvailabilityService>();
|
||||
masterSvc.GetMasterStatus().Returns(new MasterGateStatus(masterAvailable, masterAvailable ? null : "Down"));
|
||||
var validator = Substitute.For<IAdminTokenValidator>();
|
||||
builder.Services.AddSingleton(localSvc);
|
||||
builder.Services.AddSingleton(masterSvc);
|
||||
builder.Services.AddSingleton(validator);
|
||||
|
||||
var app = builder.Build();
|
||||
app.UseCmsSecurityHeaders();
|
||||
app.UseMiddleware<AvailabilityMiddleware>(); // as the Availability module does, before the website
|
||||
app.UseCmsStaticContent(WebsiteMode.PrerenderedPages);
|
||||
app.UseCmsPrerenderedSite();
|
||||
app.MapGet("/api/v1/Users", () => Results.Text("users"));
|
||||
app.MapGet("/api/v1/Availability/status", () => Results.Json(new { status = local.ToString() }));
|
||||
app.MapGet("/health", () => Results.Text("ok"));
|
||||
app.MapCmsSpaFallbacks(WebsiteMode.PrerenderedPages);
|
||||
app.MapCmsWebsiteNotFound();
|
||||
_apps.Add(app);
|
||||
await app.StartAsync();
|
||||
return app.GetTestClient();
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData(AvailabilityStatus.NotAvailable, true)]
|
||||
[InlineData(AvailabilityStatus.Maintenance, true)]
|
||||
[InlineData(AvailabilityStatus.Available, false)]
|
||||
public async Task ADisabledCms_StillServesWebsiteAndAdmin_ButNotTheApi(AvailabilityStatus status, bool blocked)
|
||||
{
|
||||
var client = await StartAsync(status);
|
||||
|
||||
(await client.GetAsync("/")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/over-mij")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/admin/")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/admin/index.html")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/admin/assets/index-abc123.js")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/admin/some/client/route")).StatusCode.Should().Be(HttpStatusCode.OK); // SPA fallback
|
||||
(await client.GetAsync("/health")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/available/status-open")).StatusCode.Should().Be(HttpStatusCode.NotFound); // the website 404 page, not a 503
|
||||
(await client.GetAsync("/api/v1/Availability/status")).StatusCode.Should().Be(HttpStatusCode.OK); // the admin app reads this
|
||||
(await client.GetAsync("/api/v1/Users")).StatusCode.Should().Be(blocked ? HttpStatusCode.ServiceUnavailable : HttpStatusCode.OK);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WhenTheMasterSwitchesTheCmsOff_ItIsTheSame()
|
||||
{
|
||||
var client = await StartAsync(AvailabilityStatus.Available, masterAvailable: false);
|
||||
|
||||
(await client.GetAsync("/")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/admin/")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/health")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/api/v1/Availability/status")).StatusCode.Should().Be(HttpStatusCode.OK);
|
||||
(await client.GetAsync("/api/v1/Users")).StatusCode.Should().Be(HttpStatusCode.ServiceUnavailable);
|
||||
}
|
||||
}
|
||||
+10
-10
@@ -1,4 +1,4 @@
|
||||
using FluentAssertions;
|
||||
using FluentAssertions;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using NSubstitute;
|
||||
@@ -36,7 +36,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_Passes_WhenMasterAndLocalBothAvailable()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
|
||||
await _middleware.InvokeAsync(context, _localSvc, _masterSvc);
|
||||
|
||||
@@ -46,7 +46,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_Returns503_WhenMasterGateBlocks()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
_masterSvc.GetMasterStatus().Returns(new MasterGateStatus(false, "Down for maintenance"));
|
||||
|
||||
@@ -59,7 +59,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_DoesNotCheckLocalGate_WhenMasterGateBlocks()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
_masterSvc.GetMasterStatus().Returns(new MasterGateStatus(false, null));
|
||||
|
||||
@@ -71,7 +71,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_Returns503_WhenLocalGateBlocksAndMasterPasses()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
_localSvc.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -84,7 +84,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_BypassesMasterAndLocalGate_ForMasterEndpoints()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/api/v1/master/register";
|
||||
_masterSvc.GetMasterStatus().Returns(new MasterGateStatus(false, null));
|
||||
_localSvc.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
@@ -98,7 +98,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_BypassesBothGates_ForMasterStatusEndpoint()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/api/v1/master/status";
|
||||
_masterSvc.GetMasterStatus().Returns(new MasterGateStatus(false, null));
|
||||
|
||||
@@ -110,7 +110,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_BypassesBothGates_WhenAdminJwtPresent()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Headers.Authorization = "Bearer owner-token";
|
||||
_adminTokenValidator.Validate("Bearer owner-token").Returns(new AdminTokenResult(true, default));
|
||||
_masterSvc.GetMasterStatus().Returns(new MasterGateStatus(false, null));
|
||||
@@ -125,7 +125,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_DoesNotBypass_WhenNonAdminJwtAndMasterBlocks()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
context.Request.Headers.Authorization = "Bearer user-token";
|
||||
_adminTokenValidator.Validate(Arg.Any<string>()).Returns(new AdminTokenResult(false, BypassRejectionReason.Absent));
|
||||
@@ -140,7 +140,7 @@ public class AvailabilityMiddlewareMasterGateTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_BypassesBothGates_ForHealthEndpoint()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/health";
|
||||
_masterSvc.GetMasterStatus().Returns(new MasterGateStatus(false, null));
|
||||
_localSvc.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
using System.IdentityModel.Tokens.Jwt;
|
||||
using System.IdentityModel.Tokens.Jwt;
|
||||
using System.Security.Claims;
|
||||
using System.Text;
|
||||
using FluentAssertions;
|
||||
@@ -43,7 +43,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowRequest_WhenSystemAvailable()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.Available);
|
||||
|
||||
await _middleware.InvokeAsync(context, _service, _masterService);
|
||||
@@ -54,7 +54,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldBlockRequest_WhenSystemUnavailable()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -67,7 +67,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowBypass_ForStatusEndpoint()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/api/v1/Availability/status";
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -79,7 +79,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowBypass_ForAuthEndpoints()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/api/v1/Auth/login";
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -91,7 +91,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowBypass_ForSetupStatusEndpoint()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/api/v1/Setup/status";
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -107,7 +107,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowBypass_ForHealthEndpoint_WhenSystemUnavailable()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/health";
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
@@ -119,7 +119,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowBypass_ForHealthEndpoint_WhenMasterGateClosed()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Path = "/health";
|
||||
_masterService.GetMasterStatus().Returns(new MasterGateStatus(false, "Disabled by master"));
|
||||
|
||||
@@ -131,7 +131,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldBlockRequest_WhenSystemInMaintenance()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.Maintenance);
|
||||
|
||||
@@ -144,7 +144,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldAllowAdminBypass_WhenValidatorAcceptsTheToken()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Headers.Authorization = "Bearer some-token";
|
||||
_adminTokenValidator.Validate("Bearer some-token").Returns(new AdminTokenResult(true, default));
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.Maintenance);
|
||||
@@ -157,7 +157,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldNotBypass_WhenValidatorRejectsTheToken()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
context.Request.Headers.Authorization = "Bearer some-token";
|
||||
_adminTokenValidator.Validate(Arg.Any<string>()).Returns(new AdminTokenResult(false, BypassRejectionReason.Absent));
|
||||
@@ -172,7 +172,7 @@ public class AvailabilityMiddlewareTests
|
||||
[Fact]
|
||||
public async Task InvokeAsync_ShouldNotBypass_WhenNoAuthorizationHeader()
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
_adminTokenValidator.Validate(Arg.Any<string>()).Returns(new AdminTokenResult(false, BypassRejectionReason.Absent));
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
@@ -225,7 +225,7 @@ public class AvailabilityMiddlewareTests
|
||||
claims: [new Claim(ClaimTypes.Role, "Owner")],
|
||||
expires: DateTime.UtcNow.AddHours(1)));
|
||||
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Response.Body = new MemoryStream();
|
||||
context.Request.Headers.Authorization = $"Bearer {forged}";
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
@@ -249,7 +249,7 @@ public class AvailabilityMiddlewareTests
|
||||
expires: DateTime.UtcNow.AddHours(1),
|
||||
signingCredentials: new SigningCredentials(key, SecurityAlgorithms.HmacSha256)));
|
||||
|
||||
var context = new DefaultHttpContext();
|
||||
var context = TestContexts.Api();
|
||||
context.Request.Headers.Authorization = $"Bearer {genuine}";
|
||||
_service.IsAvailableAsync().Returns(AvailabilityStatus.NotAvailable);
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
using Microsoft.AspNetCore.Http;
|
||||
|
||||
namespace SlpModularCms.Modules.Availability.Tests;
|
||||
|
||||
internal static class TestContexts
|
||||
{
|
||||
/// <summary>A request to an API endpoint that is not on the gate's bypass list: the kind the gate decides about.</summary>
|
||||
public static DefaultHttpContext Api(string path = "/api/v1/Items")
|
||||
{
|
||||
var context = new DefaultHttpContext();
|
||||
context.Request.Path = path;
|
||||
return context;
|
||||
}
|
||||
}
|
||||
@@ -33,6 +33,13 @@ public class AvailabilityMiddleware
|
||||
// /health bypasses because it reports infrastructure liveness, which is a different
|
||||
// question from whether the CMS is switched on: an instance that is deliberately
|
||||
// disabled is still perfectly healthy, and must not be reported as down.
|
||||
// Only the API is gated. The public website, the admin files (the SPA with its index.html and assets), the
|
||||
// 404 page, /sentry-tunnel and /health are not CMS data or actions: a disabled CMS must still show its
|
||||
// website and let the admin app load, so that the app can read /api/v1/Availability/status (open, see below)
|
||||
// and show the "CMS disabled" card instead of a bare 503. Before this the gate stopped EVERY path that was not
|
||||
// on the bypass list, which only went unnoticed while another server (nginx) served the website and the SPA.
|
||||
private const string GatedPrefix = "/api/";
|
||||
|
||||
private static readonly string[] _bypassPrefixes =
|
||||
[
|
||||
"/api/v1/Availability/status",
|
||||
@@ -49,6 +56,13 @@ public class AvailabilityMiddleware
|
||||
IMasterAvailabilityService masterAvailabilityService)
|
||||
{
|
||||
var path = context.Request.Path.Value ?? string.Empty;
|
||||
if (!path.StartsWith(GatedPrefix, StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
// Not an API call: nothing to protect, and no reason to look at (or log about) a bearer token either.
|
||||
await _next(context);
|
||||
return;
|
||||
}
|
||||
|
||||
if (_bypassPrefixes.Any(p => path.StartsWith(p, StringComparison.OrdinalIgnoreCase)))
|
||||
{
|
||||
await _next(context);
|
||||
|
||||
Reference in New Issue
Block a user