dc9c0c950c
Apply the ZB.MOM.WW. prefix to all gateway-side projects, folders,
.csproj/.sln contents, C# namespaces, using directives, generated proto
C# (csharp_namespace + checked-in generated files), InternalsVisibleTo
attributes, project-name string literals (LoadProject, .sln lookups,
worker exe paths, staticwebassets manifest), and the install/script/doc
references that point at any of the above. Migrate the solution from
.sln to .slnx via `dotnet sln migrate` and delete the old file.
External-runtime identifiers are intentionally NOT prefixed so external
configuration keeps working:
- GatewayMetrics.cs MeterName ("MxGateway.Server")
- DashboardAuthenticationDefaults Scheme/Policy ("MxGateway.Dashboard")
- GatewayRequestLoggingMiddleware logger category ("MxGateway.Request")
- StaRuntime thread name ("MxGateway.Worker.STA")
- appsettings.json root section "MxGateway" + env-var prefix
MxGateway__... and secret-name MxGateway:ApiKeyPepper
- C:\ProgramData\MxGateway\ data dir paths
Also fixes two tests that were not rename-related but became visible
while validating the rename:
- WorkerLiveMxAccessSmokeTests.ShutDownAsync: cancellation that the
gateway service correctly maps to RpcException(Cancelled) per gRPC
convention was being misclassified as a stream fault. Added a sibling
catch on RpcException with StatusCode.Cancelled.
- IntegrationTestEnvironment.ResolveRepositoryRoot: extracted IsRepositoryRoot
and made it accept either a .git marker OR a .sln/.slnx next to src/
so the worker-exe walker works in non-git working copies.
clients/proto/proto-inputs.json's protoRoot updated to point at
src/ZB.MOM.WW.MxGateway.Contracts/Protos.
Verified by `dotnet build` and a full `dotnet test` of the .slnx with
MXGATEWAY_RUN_LIVE_{MXACCESS,LDAP,GALAXY}_TESTS=1:
Tests: 472/472 pass
Worker.Tests: 280/280 pass (4 dev-rig [Fact(Skip=...)] skipped)
IntegrationTests: 18/18 pass
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
126 lines
4.5 KiB
C#
126 lines
4.5 KiB
C#
using System.Net;
|
|
using System.Security.Claims;
|
|
using Microsoft.AspNetCore.Authorization;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.Extensions.Options;
|
|
using ZB.MOM.WW.MxGateway.Server.Configuration;
|
|
using ZB.MOM.WW.MxGateway.Server.Dashboard;
|
|
using ZB.MOM.WW.MxGateway.Server.Security.Authorization;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Tests.Gateway.Dashboard;
|
|
|
|
public sealed class DashboardAuthorizationHandlerTests
|
|
{
|
|
/// <summary>Verifies that unauthenticated remote requests fail authorization.</summary>
|
|
[Fact]
|
|
public async Task HandleAsync_UnauthenticatedRemoteRequest_DoesNotSucceed()
|
|
{
|
|
AuthorizationHandlerContext context = await AuthorizeAsync(
|
|
new ClaimsPrincipal(new ClaimsIdentity()),
|
|
IPAddress.Parse("10.0.0.5"),
|
|
allowAnonymousLocalhost: false);
|
|
|
|
Assert.False(context.HasSucceeded);
|
|
}
|
|
|
|
/// <summary>Verifies that anonymous localhost access succeeds when allowed.</summary>
|
|
[Fact]
|
|
public async Task HandleAsync_AnonymousLocalhostAllowed_Succeeds()
|
|
{
|
|
AuthorizationHandlerContext context = await AuthorizeAsync(
|
|
new ClaimsPrincipal(new ClaimsIdentity()),
|
|
IPAddress.Loopback,
|
|
allowAnonymousLocalhost: true);
|
|
|
|
Assert.True(context.HasSucceeded);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verifies that the anonymous-localhost bypass is denied when <c>AllowAnonymousLocalhost</c>
|
|
/// is off, even on a loopback connection — the misconfiguration must not expose the dashboard.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task HandleAsync_AnonymousLocalhostDisallowed_DoesNotSucceed()
|
|
{
|
|
AuthorizationHandlerContext context = await AuthorizeAsync(
|
|
new ClaimsPrincipal(new ClaimsIdentity()),
|
|
IPAddress.Loopback,
|
|
allowAnonymousLocalhost: false);
|
|
|
|
Assert.False(context.HasSucceeded);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verifies that the anonymous-localhost bypass stays scoped to loopback: an anonymous
|
|
/// request from a non-loopback address is denied even when <c>AllowAnonymousLocalhost</c> is on.
|
|
/// </summary>
|
|
[Fact]
|
|
public async Task HandleAsync_AnonymousLocalhostAllowedFromRemoteAddress_DoesNotSucceed()
|
|
{
|
|
AuthorizationHandlerContext context = await AuthorizeAsync(
|
|
new ClaimsPrincipal(new ClaimsIdentity()),
|
|
IPAddress.Parse("10.0.0.5"),
|
|
allowAnonymousLocalhost: true);
|
|
|
|
Assert.False(context.HasSucceeded);
|
|
}
|
|
|
|
/// <summary>Verifies that authenticated users without admin scope fail authorization.</summary>
|
|
[Fact]
|
|
public async Task HandleAsync_AuthenticatedWithoutAdminScope_DoesNotSucceed()
|
|
{
|
|
AuthorizationHandlerContext context = await AuthorizeAsync(
|
|
CreatePrincipal(GatewayScopes.EventsRead),
|
|
IPAddress.Loopback,
|
|
allowAnonymousLocalhost: false);
|
|
|
|
Assert.False(context.HasSucceeded);
|
|
}
|
|
|
|
/// <summary>Verifies that authenticated users with admin scope succeed.</summary>
|
|
[Fact]
|
|
public async Task HandleAsync_AuthenticatedWithAdminScope_Succeeds()
|
|
{
|
|
AuthorizationHandlerContext context = await AuthorizeAsync(
|
|
CreatePrincipal(GatewayScopes.Admin),
|
|
IPAddress.Parse("10.0.0.5"),
|
|
allowAnonymousLocalhost: false);
|
|
|
|
Assert.True(context.HasSucceeded);
|
|
}
|
|
|
|
private static async Task<AuthorizationHandlerContext> AuthorizeAsync(
|
|
ClaimsPrincipal principal,
|
|
IPAddress remoteAddress,
|
|
bool allowAnonymousLocalhost)
|
|
{
|
|
DashboardAuthorizationRequirement requirement = new();
|
|
DefaultHttpContext httpContext = new();
|
|
httpContext.Connection.RemoteIpAddress = remoteAddress;
|
|
DashboardAuthorizationHandler handler = new(
|
|
new HttpContextAccessor { HttpContext = httpContext },
|
|
Options.Create(new GatewayOptions
|
|
{
|
|
Dashboard = new DashboardOptions
|
|
{
|
|
AllowAnonymousLocalhost = allowAnonymousLocalhost,
|
|
RequireAdminScope = true
|
|
}
|
|
}));
|
|
AuthorizationHandlerContext context = new([requirement], principal, httpContext);
|
|
|
|
await handler.HandleAsync(context);
|
|
|
|
return context;
|
|
}
|
|
|
|
private static ClaimsPrincipal CreatePrincipal(string scope)
|
|
{
|
|
ClaimsIdentity identity = new(
|
|
[new Claim(DashboardAuthenticationDefaults.ScopeClaimType, scope)],
|
|
DashboardAuthenticationDefaults.AuthenticationScheme);
|
|
|
|
return new ClaimsPrincipal(identity);
|
|
}
|
|
}
|