ffba75bb93
#844: a success cleared the whole per-client count, so a client holding a valid key could make four guesses at another key id, sign in with its own, and repeat forever. Failures are now charged to the (client, credential identity) pair -- IOpcUaUserAuthenticator.DescribeCredential, key:<keyId> for API keys -- and to the client as a whole. A success clears only its own identity's count; the per-identity threshold locks that identity; a new per-client cap (OpcUa:CredentialLockout:MaxFailedAttemptsPerClient, default 2 x MaxFailedAttempts) that a success never resets bounds spraying across key ids and locks every credential. Slots are bounded on both counts; a waiter whose identity has room is not held behind one whose identity has none. #845: (1) store timeouts, miss-budget refusals, store/authenticator exceptions, an unset pepper and cancellation are reported Transient (OpcUaUserAuthResult.Unavailable) and released uncounted, so a ConfigDb stall can no longer lock every keyed client out; the client still sees the same opaque denial. (2) a full 4096-entry table defers its next prune until the earliest entry could age out instead of rescanning under the lock per failure. (3) ApplicationUri deliberately NOT added to the key: on a None channel it is a free string, so it would let an attacker reset the count per guess -- documented. (4) wire tests: distinct client certificates on a Sign endpoint are locked out separately; the ApplicationConfigPath branch keeps the SDK lockout off (falsified by removing the loaded-branch disable).
116 lines
4.8 KiB
C#
116 lines
4.8 KiB
C#
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.OtOpcUa.Host.Configuration;
|
|
using ZB.MOM.WW.OtOpcUa.OpcUaServer;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Host.IntegrationTests;
|
|
|
|
/// <summary>
|
|
/// Task 4 — verifies the net-new <see cref="OpcUaApplicationHostOptionsValidator"/> (built on the
|
|
/// shared <c>ZB.MOM.WW.Configuration</c> <c>OptionsValidatorBase</c>/<c>ValidationBuilder</c>) that
|
|
/// gates the OPC UA host options at startup. The C# defaults are all valid so a host with no
|
|
/// explicit <c>"OpcUa"</c> section still passes; the validator exists to reject explicit
|
|
/// prod/env overrides. Failure messages carry the real <c>"OpcUa:"</c> section prefix and the
|
|
/// exact shared-primitive wording so they read correctly when surfaced via <c>ValidateOnStart</c>.
|
|
/// </summary>
|
|
public sealed class OpcUaApplicationHostOptionsValidatorTests
|
|
{
|
|
private static readonly OpcUaApplicationHostOptionsValidator Sut = new();
|
|
|
|
/// <summary>The C# defaults (the as-bound shape when the section is absent) pass validation.</summary>
|
|
[Fact]
|
|
public void Default_options_succeed()
|
|
{
|
|
Sut.Validate(null, new OpcUaApplicationHostOptions()).Succeeded.ShouldBeTrue();
|
|
}
|
|
|
|
/// <summary>A port of 0 reports the shared port-range failure with the OpcUa prefix.</summary>
|
|
[Fact]
|
|
public void Zero_port_fails()
|
|
{
|
|
var result = Sut.Validate(null, new OpcUaApplicationHostOptions { OpcUaPort = 0 });
|
|
|
|
result.Failed.ShouldBeTrue();
|
|
result.Failures.ShouldContain("OpcUa:OpcUaPort must be between 1 and 65535 (was 0)");
|
|
}
|
|
|
|
/// <summary>A blank public hostname reports the shared required failure with the OpcUa prefix.</summary>
|
|
[Fact]
|
|
public void Blank_public_hostname_fails()
|
|
{
|
|
var result = Sut.Validate(null, new OpcUaApplicationHostOptions { PublicHostname = "" });
|
|
|
|
result.Failed.ShouldBeTrue();
|
|
result.Failures.ShouldContain("OpcUa:PublicHostname is required");
|
|
}
|
|
|
|
/// <summary>An empty security-profile list reports the shared min-count failure with the OpcUa prefix.</summary>
|
|
[Fact]
|
|
public void Empty_security_profiles_fails()
|
|
{
|
|
var result = Sut.Validate(null, new OpcUaApplicationHostOptions
|
|
{
|
|
EnabledSecurityProfiles = new List<OpcUaSecurityProfile>(),
|
|
});
|
|
|
|
result.Failed.ShouldBeTrue();
|
|
result.Failures.ShouldContain("OpcUa:EnabledSecurityProfiles must contain at least 1 item(s) (had 0)");
|
|
}
|
|
|
|
/// <summary>#833 review: an enabled lockout with a non-positive duration fails; a disabled one is not checked.</summary>
|
|
[Theory]
|
|
[InlineData(5, 0, 60, false)]
|
|
[InlineData(5, 300, 0, false)]
|
|
[InlineData(5, -1, -1, false)]
|
|
[InlineData(5, 30, 600, true)]
|
|
[InlineData(0, 0, 0, true)]
|
|
[InlineData(-1, 0, 0, true)]
|
|
public void Credential_lockout_durations_must_be_positive_while_enabled(
|
|
int maxFailedAttempts, int lockoutSeconds, int windowSeconds, bool valid)
|
|
{
|
|
var result = Sut.Validate(null, new OpcUaApplicationHostOptions
|
|
{
|
|
CredentialLockout = new ZB.MOM.WW.OtOpcUa.OpcUaServer.Security.OpcUaCredentialLockoutOptions
|
|
{
|
|
MaxFailedAttempts = maxFailedAttempts, LockoutSeconds = lockoutSeconds, FailureWindowSeconds = windowSeconds,
|
|
},
|
|
});
|
|
|
|
result.Succeeded.ShouldBe(valid);
|
|
if (!valid) result.Failures!.ShouldContain(f => f.Contains("OpcUa:CredentialLockout:LockoutSeconds"));
|
|
}
|
|
|
|
/// <summary>#833 review: the slot wait must be positive while the lockout is enabled.</summary>
|
|
[Fact]
|
|
public void Credential_lockout_slot_wait_must_be_positive_while_enabled()
|
|
{
|
|
var result = Sut.Validate(null, new OpcUaApplicationHostOptions
|
|
{
|
|
CredentialLockout = new ZB.MOM.WW.OtOpcUa.OpcUaServer.Security.OpcUaCredentialLockoutOptions { SlotWaitSeconds = 0 },
|
|
});
|
|
|
|
result.Failed.ShouldBeTrue();
|
|
result.Failures!.ShouldContain(f => f.Contains("OpcUa:CredentialLockout:SlotWaitSeconds"));
|
|
}
|
|
|
|
/// <summary>#844: the per-client cap may be unset (0) or at least the per-credential threshold.</summary>
|
|
[Theory]
|
|
[InlineData(0, true)]
|
|
[InlineData(5, true)]
|
|
[InlineData(20, true)]
|
|
[InlineData(4, false)]
|
|
public void Credential_lockout_per_client_cap_is_unset_or_at_least_the_per_credential_threshold(int perClient, bool valid)
|
|
{
|
|
var result = Sut.Validate(null, new OpcUaApplicationHostOptions
|
|
{
|
|
CredentialLockout = new ZB.MOM.WW.OtOpcUa.OpcUaServer.Security.OpcUaCredentialLockoutOptions
|
|
{
|
|
MaxFailedAttempts = 5, MaxFailedAttemptsPerClient = perClient,
|
|
},
|
|
});
|
|
|
|
result.Succeeded.ShouldBe(valid);
|
|
if (!valid) result.Failures!.ShouldContain(f => f.Contains("OpcUa:CredentialLockout:MaxFailedAttemptsPerClient"));
|
|
}
|
|
}
|