fix(auth): OtOpcUa 1.2 review fixes — startup insecure-transport guard + Ldaps in prod overlays, test fidelity, 0.1.1 pin

2026-06-02 01:37:29 -04:00
parent 257caa7bd1
commit c4f315ec90
9 changed files with 226 additions and 20 deletions
@@ -1,7 +1,9 @@
 using Microsoft.Extensions.Configuration;
 using Shouldly;
 using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host.Configuration;
 using ZB.MOM.WW.OtOpcUa.Security.Ldap;
+using LdapTransport = ZB.MOM.WW.Auth.Abstractions.Ldap.LdapTransport;

 namespace ZB.MOM.WW.OtOpcUa.Host.IntegrationTests;

@@ -60,3 +62,64 @@ public sealed class LdapOptionsBindingTests
        options.DevStubMode.ShouldBeFalse();
    }
 }
+
+/// <summary>
+/// End-to-end guard for the shipped production overlays: binds each of the three prod overlay
+/// files' real <c>Security:Ldap</c> section (the same files the host loads at boot, copied into the
+/// test output via the Host project reference) and runs the <see cref="LdapOptionsValidator"/> the
+/// host wires via <c>AddValidatedOptions</c>. Proves each prod overlay declares a TLS transport and
+/// therefore PASSES startup validation — i.e. the host actually boots with these overlays after the
+/// insecure-transport guard was added. The <c>Development</c> overlay (DevStubMode) is verified to
+/// pass via the guard exemption.
+/// </summary>
+public sealed class ProdOverlayValidationTests
+{
+    private static readonly LdapOptionsValidator Sut = new();
+
+    private static LdapOptions BindOverlay(string fileName)
+    {
+        var path = Path.Combine(AppContext.BaseDirectory, fileName);
+        File.Exists(path).ShouldBeTrue($"overlay '{fileName}' should be copied to the test output");
+
+        var configuration = new ConfigurationBuilder()
+            .AddJsonFile(path, optional: false, reloadOnChange: false)
+            .Build();
+
+        return configuration.GetSection(LdapOptions.SectionName).Get<LdapOptions>() ?? new LdapOptions();
+    }
+
+    [Theory]
+    [InlineData("appsettings.admin.json")]
+    [InlineData("appsettings.driver.json")]
+    [InlineData("appsettings.admin-driver.json")]
+    public void Prod_overlay_declares_ldaps_transport(string fileName)
+    {
+        var options = BindOverlay(fileName);
+
+        options.DevStubMode.ShouldBeFalse();
+        options.Transport.ShouldBe(LdapTransport.Ldaps);
+    }
+
+    [Theory]
+    [InlineData("appsettings.admin.json")]
+    [InlineData("appsettings.driver.json")]
+    [InlineData("appsettings.admin-driver.json")]
+    public void Prod_overlay_passes_startup_validation(string fileName)
+    {
+        var options = BindOverlay(fileName);
+
+        // Match the host: these overlays only set Security:Ldap fields, so backfill the required
+        // Server/SearchBase/Port the way the base C# defaults do (LdapOptions defaults are valid),
+        // then validate exactly as AddValidatedOptions would at boot.
+        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
+    }
+
+    [Fact]
+    public void Development_overlay_passes_startup_validation_via_devstub_exemption()
+    {
+        var options = BindOverlay("appsettings.Development.json");
+
+        options.DevStubMode.ShouldBeTrue();
+        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
+    }
+}
@@ -2,6 +2,7 @@ using Shouldly;
 using Xunit;
 using ZB.MOM.WW.OtOpcUa.Host.Configuration;
 using ZB.MOM.WW.OtOpcUa.Security.Ldap;
+using LdapTransport = ZB.MOM.WW.Auth.Abstractions.Ldap.LdapTransport;

 namespace ZB.MOM.WW.OtOpcUa.Host.IntegrationTests;

@@ -10,13 +11,18 @@ namespace ZB.MOM.WW.OtOpcUa.Host.IntegrationTests;
 /// <c>ZB.MOM.WW.Configuration</c> <c>OptionsValidatorBase</c>/<c>ValidationBuilder</c>) gates on
 /// <see cref="LdapOptions.Enabled"/>, and that when enabled it requires <c>Server</c>,
 /// <c>SearchBase</c>, and a valid <c>Port</c>. Failure messages carry the real <c>"Ldap:"</c>
-/// section prefix so they read correctly when surfaced at host startup.
+/// section prefix so they read correctly when surfaced at host startup. Also verifies the
+/// insecure-transport startup guard: a real-LDAP config selecting plaintext transport without
+/// <see cref="LdapOptions.AllowInsecure"/> fails fast at boot.
 /// </summary>
 public sealed class LdapOptionsValidatorTests
 {
    private static readonly LdapOptionsValidator Sut = new();

-    /// <summary>Valid enabled options pass validation.</summary>
+    private const string InsecureTransportFailure =
+        "LDAP transport is None (plaintext) but AllowInsecure is false — set Transport to Ldaps/StartTls or set AllowInsecure for dev.";
+
+    /// <summary>Valid enabled options (a TLS transport) pass validation.</summary>
    [Fact]
    public void Valid_enabled_options_succeed()
    {
@@ -26,6 +32,102 @@ public sealed class LdapOptionsValidatorTests
            Server = "ldap",
            SearchBase = "dc=x",
            Port = 389,
+            Transport = LdapTransport.Ldaps,
+        };
+
+        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
+    }
+
+    /// <summary>
+    /// Insecure-transport guard: an enabled real-LDAP config that selects plaintext
+    /// <see cref="LdapTransport.None"/> without <see cref="LdapOptions.AllowInsecure"/> fails
+    /// startup validation with the guard message.
+    /// </summary>
+    [Fact]
+    public void Enabled_with_plaintext_transport_and_not_allow_insecure_fails()
+    {
+        var options = new LdapOptions
+        {
+            Enabled = true,
+            Server = "ldap",
+            SearchBase = "dc=x",
+            Port = 389,
+            Transport = LdapTransport.None,
+            AllowInsecure = false,
+        };
+
+        var result = Sut.Validate(null, options);
+
+        result.Failed.ShouldBeTrue();
+        result.Failures.ShouldContain(InsecureTransportFailure);
+    }
+
+    /// <summary>A TLS transport (<see cref="LdapTransport.Ldaps"/>) satisfies the guard.</summary>
+    [Fact]
+    public void Enabled_with_ldaps_transport_passes_guard()
+    {
+        var options = new LdapOptions
+        {
+            Enabled = true,
+            Server = "ldap",
+            SearchBase = "dc=x",
+            Port = 636,
+            Transport = LdapTransport.Ldaps,
+        };
+
+        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
+    }
+
+    /// <summary>
+    /// Explicit opt-in: plaintext transport with <see cref="LdapOptions.AllowInsecure"/> set is
+    /// permitted (dev/test escape hatch), so the guard does not trip.
+    /// </summary>
+    [Fact]
+    public void Enabled_plaintext_with_allow_insecure_passes_guard()
+    {
+        var options = new LdapOptions
+        {
+            Enabled = true,
+            Server = "ldap",
+            SearchBase = "dc=x",
+            Port = 389,
+            Transport = LdapTransport.None,
+            AllowInsecure = true,
+        };
+
+        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
+    }
+
+    /// <summary>
+    /// DevStubMode is exempt from the insecure-transport guard: the dev stub bypasses the real
+    /// bind, so plaintext transport is irrelevant and must not block boot.
+    /// </summary>
+    [Fact]
+    public void DevStubMode_with_plaintext_transport_passes_guard()
+    {
+        var options = new LdapOptions
+        {
+            Enabled = true,
+            DevStubMode = true,
+            Transport = LdapTransport.None,
+            AllowInsecure = false,
+        };
+
+        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
+    }
+
+    /// <summary>
+    /// A disabled config is exempt from the insecure-transport guard even with plaintext
+    /// transport — LDAP login never runs, so the guard must not trip.
+    /// </summary>
+    [Fact]
+    public void Disabled_with_plaintext_transport_passes_guard()
+    {
+        var options = new LdapOptions
+        {
+            Enabled = false,
+            Transport = LdapTransport.None,
+            AllowInsecure = false,
        };

        Sut.Validate(null, options).Succeeded.ShouldBeTrue();
@@ -59,6 +59,11 @@ public sealed class AuthEndpointsIntegrationTests : IAsyncLifetime
                            ["Security:Jwt:SigningKey"] = "test-signing-key-with-at-least-32-bytes-of-utf8-content",
                            ["Security:Jwt:Issuer"] = "otopcua-test",
                            ["Security:Jwt:Audience"] = "otopcua-test",
+                            // GroupToRole baseline bound onto LdapOptions: the production
+                            // OtOpcUaGroupRoleMapper resolves "ConfigViewer" from the LDAP group
+                            // "ReadOnly". This exercises the real mapper path — the stub no longer
+                            // pre-populates roles, so ConfigViewer can only come from the mapper.
+                            ["Security:Ldap:GroupToRole:ReadOnly"] = "ConfigViewer",
                        }).Build();
                    services.AddOtOpcUaAuth(configuration);
                    services.AddSingleton<ILdapAuthService, StubLdapAuthService>();
@@ -187,8 +192,9 @@ public sealed class AuthEndpointsIntegrationTests : IAsyncLifetime
    [Fact]
    public async Task Login_merges_db_role_grant_into_claims()
    {
-        // StubLdapAuthService returns Groups ["ReadOnly"], baseline Roles ["ConfigViewer"].
-        // A system-wide row maps "ReadOnly" → FleetAdmin, so the merged set is both.
+        // StubLdapAuthService returns Groups ["ReadOnly"] with empty Roles (the real production
+        // shape). The mapper resolves the appsettings baseline "ReadOnly" → ConfigViewer, then a
+        // system-wide DB row maps "ReadOnly" → FleetAdmin, so the merged set is both.
        _roleMappings.Rows.Add(new LdapGroupRoleMapping
        {
            Id = Guid.NewGuid(),
@@ -214,18 +220,24 @@ public sealed class AuthEndpointsIntegrationTests : IAsyncLifetime
        roles.ShouldContain("FleetAdmin");   // DB grant merged in
    }

-    /// <summary>When the DB role-map lookup throws, sign-in still succeeds with the appsettings
-    /// baseline roles — a DB hiccup must never block login.</summary>
+    /// <summary>Fail-closed (review I3): when the role mapper throws on the real production path
+    /// (the auth result carries no pre-resolved roles — roles come only from the mapper), sign-in
+    /// still SUCCEEDS but the user is granted ZERO role claims. They are authenticated (can prove
+    /// identity) yet authorized for nothing role-gated until the mapper recovers — the safe
+    /// fail-closed behaviour, not a fail-open with a stale role set.</summary>
    [Fact]
-    public async Task Login_when_db_role_map_throws_falls_back_to_baseline_roles()
+    public async Task Login_when_role_mapper_throws_signs_in_with_no_role_claims()
    {
+        // Simulate a mapper fault on the real path. The whole MapAsync throws (the appsettings
+        // baseline is computed inside the mapper, so it does NOT survive the throw): the login
+        // endpoint falls back to result.Roles, which is empty on the real LDAP path.
        _roleMappings.Throws = true;

        var client = NewClient();
        var loginResponse = await client.PostAsJsonAsync("/auth/login",
            new AuthEndpoints.LoginRequest("alice", "valid-password"), Ct);

-        // Login proceeds despite the simulated DB outage.
+        // Login proceeds despite the simulated DB outage — authenticated.
        loginResponse.StatusCode.ShouldBe(HttpStatusCode.NoContent);

        var tokenReq = new HttpRequestMessage(HttpMethod.Post, "/auth/token");
@@ -233,9 +245,10 @@ public sealed class AuthEndpointsIntegrationTests : IAsyncLifetime
        var tokenResp = await client.SendAsync(tokenReq, Ct);
        tokenResp.StatusCode.ShouldBe(HttpStatusCode.OK);

+        // No role claims at all — fail closed.
        var payload = await tokenResp.Content.ReadFromJsonAsync<JsonElement>(Ct);
        var roles = JwtRoleClaims(payload.GetProperty("token").GetString()!);
-        roles.ShouldContain("ConfigViewer"); // baseline still present
+        roles.ShouldBeEmpty();
    }

    /// <summary>Extracts the "Role" claim values from a JWT's payload segment.</summary>
@@ -330,7 +343,11 @@ public sealed class AuthEndpointsIntegrationTests : IAsyncLifetime
                    DisplayName: "Alice User",
                    Username: username,
                    Groups: ["ReadOnly"],
-                    Roles: ["ConfigViewer"],
+                    // Roles empty — the real production path returns groups, never roles. Role
+                    // resolution is the mapper's job (OtOpcUaGroupRoleMapper applies the
+                    // GroupToRole baseline). This proves roles flow through the mapper, not via
+                    // pre-population of the auth result.
+                    Roles: [],
                    Error: null));
            return Task.FromResult(new LdapAuthResult(
                Success: false,