fix(opcuaclient): never pass checkDomain for a None endpoint; document both SDK check sites (#816 review)
SDK 2.0.1 checks the server host name in TWO places: Session.OpenAsync (after the chain is trusted) and DefaultSessionFactory.CreateChannelAsync, against the certificate in the GetEndpoints reply and before any security-mode test. opc-plc sends a certificate on its None endpoint, so `connect -u opc.tcp://10.100.0.35:50000 --validate-host-name` was refused on an unauthenticated channel, where a host check proves nothing. All three call sites now pass checkDomain only when the selected endpoint's SecurityMode != None: OpcUaEndpointSelection.CheckDomainFor for the driver (OpenSessionOnEndpointAsync, so the failover sweep too) and the AdminUI browser; the same expression in Client.Shared ConnectToEndpointAsync (shared by failover). New live tests: driver None + flag on vs :50000 reads; browser None + flag on vs the NAT fixture browses; the secure + flag refusals still hold. Docs: name both check sites; a zone-qualified IPv6 host never matches (FindDomain compares the zone too), so link-local needs validateServerHostName=false; the match is loose (first label alone, subject DC= parts count, no wildcards), which caveats the CA recommendation.
This commit is contained in:
@@ -56,21 +56,28 @@ public class OpcUaClientServiceTests : IDisposable
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gitea #816: the host-name check reaches the session factory (the SDK's checkDomain) — off by default, the
|
||||
/// pre-#816 behaviour — and survives the per-endpoint settings copy the connect path makes.
|
||||
/// Gitea #816: the host-name check reaches the session factory (the SDK's checkDomain) on a SECURED endpoint — off
|
||||
/// by default, the pre-#816 behaviour — and survives the per-endpoint settings copy the connect path makes. On a
|
||||
/// None endpoint it is never passed: SDK 2.0.1 would check the GetEndpoints certificate at channel creation even
|
||||
/// there (review of #816, reproduced against opc-plc).
|
||||
/// </summary>
|
||||
[Theory]
|
||||
[InlineData(null)]
|
||||
[InlineData(true)]
|
||||
[InlineData(false)]
|
||||
public async Task ConnectAsync_threads_ValidateServerHostName_to_the_session(bool? validate)
|
||||
[InlineData(SecurityMode.Sign, null, false)]
|
||||
[InlineData(SecurityMode.Sign, true, true)]
|
||||
[InlineData(SecurityMode.SignAndEncrypt, true, true)]
|
||||
[InlineData(SecurityMode.Sign, false, false)]
|
||||
[InlineData(SecurityMode.None, true, false)]
|
||||
[InlineData(SecurityMode.None, null, false)]
|
||||
public async Task ConnectAsync_threads_ValidateServerHostName_to_secured_sessions_only(
|
||||
SecurityMode mode, bool? validate, bool expectedCheckDomain)
|
||||
{
|
||||
var settings = ValidSettings();
|
||||
settings.SecurityMode = mode;
|
||||
if (validate is { } v) settings.ValidateServerHostName = v;
|
||||
|
||||
await _service.ConnectAsync(settings, TestContext.Current.CancellationToken);
|
||||
|
||||
_sessionFactory.LastValidateServerHostName.ShouldBe(validate ?? false);
|
||||
_sessionFactory.LastValidateServerHostName.ShouldBe(expectedCheckDomain);
|
||||
_configFactory.LastSettings!.ValidateServerHostName.ShouldBe(validate ?? false);
|
||||
}
|
||||
|
||||
|
||||
+15
@@ -190,6 +190,21 @@ public sealed class NatPublishedEndpointBrowseTests : IDisposable
|
||||
children.Count.ShouldBeGreaterThan(0);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Review of #816: with the host-name check ON, an unsecured browse still opens although the NAT certificate (sent
|
||||
/// in the GetEndpoints reply even for the None endpoint) names another host — the check never runs on None.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task Host_name_validation_does_not_apply_to_a_None_browse()
|
||||
{
|
||||
var endpoint = RequireFixture();
|
||||
var ct = TestContext.Current.CancellationToken;
|
||||
await AssertAdvertisesUnreachableAddressAsync(endpoint, ct);
|
||||
|
||||
await using var session = await Browser().OpenAsync(Json(endpoint, validateHostName: true), ct);
|
||||
(await session.RootAsync(ct)).Count.ShouldBeGreaterThan(0);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Unreachable_configured_endpoint_still_fails_cleanly()
|
||||
{
|
||||
|
||||
+21
@@ -89,6 +89,27 @@ public sealed class ServerHostNameValidationTests(OpcPlcFixture sim) : IDisposab
|
||||
snapshots[0].StatusCode.ShouldBe(0u, "the secured session must read once the server certificate is trusted");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Review of #816 (reproduced live): SDK 2.0.1 also checks the host at channel creation, against the certificate
|
||||
/// in the GetEndpoints reply — which opc-plc sends on its None endpoint too — before any security-mode test. The
|
||||
/// driver must not pass checkDomain for a None session, or the flag refuses an unsecured connect.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task With_host_name_validation_on_a_None_session_still_connects()
|
||||
{
|
||||
if (sim.SkipReason is not null) Assert.Skip(sim.SkipReason);
|
||||
var ct = TestContext.Current.CancellationToken;
|
||||
var options = OpcPlcProfile.BuildOptions(sim.EndpointUrl) with
|
||||
{
|
||||
AutoAcceptCertificates = false,
|
||||
CertificateValidation = new OpcUaCertificateValidationOptions { ValidateServerHostName = true },
|
||||
};
|
||||
|
||||
await using var drv = new OpcUaClientDriver(options, driverInstanceId: "opcua-816-none") { PkiRootOverride = _pkiRoot };
|
||||
await drv.InitializeAsync("{}", ct);
|
||||
(await drv.ReadAsync([OpcPlcProfile.StepUpRef], ct))[0].StatusCode.ShouldBe(0u);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task With_host_name_validation_the_certificate_is_checked_against_the_configured_host()
|
||||
{
|
||||
|
||||
+15
@@ -43,6 +43,21 @@ public sealed class OpcUaClientServerHostNameOptionTests
|
||||
json.ShouldNotContain("Effective");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Review of #816: SDK 2.0.1 also checks the host in <c>DefaultSessionFactory.CreateChannelAsync</c>, against the
|
||||
/// GetEndpoints certificate and before any security-mode test, so checkDomain is never passed for a None endpoint.
|
||||
/// </summary>
|
||||
[Theory]
|
||||
[InlineData(MessageSecurityMode.None, true, false)]
|
||||
[InlineData(MessageSecurityMode.None, false, false)]
|
||||
[InlineData(MessageSecurityMode.Sign, true, true)]
|
||||
[InlineData(MessageSecurityMode.SignAndEncrypt, true, true)]
|
||||
[InlineData(MessageSecurityMode.SignAndEncrypt, false, false)]
|
||||
public void CheckDomain_is_passed_only_for_secured_endpoints(MessageSecurityMode mode, bool validate, bool expected)
|
||||
{
|
||||
OpcUaEndpointSelection.CheckDomainFor(new EndpointDescription { SecurityMode = mode }, validate).ShouldBe(expected);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void A_host_name_refusal_names_the_opt_out()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user