mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-21 00:56:28 +08:00
9b034f8291
# Description Nullable reference types are now enabled once, in `common.props`, and every project in the repository builds warning-clean with them. **Configuration** - `<Nullable>enable</Nullable>` lives in `common.props`. All per-project `<Nullable>` settings are removed: 178 project files (enable, annotations, and the `disable` in the three Aot test projects). - 419 per-file `#nullable enable`/`restore` directives and the 4 `#nullable disable` directives are removed. - Kept on purpose: - The 5 `<auto-generated>` schema files (`UANodeSet.cs`, `UA Type Dictionary.cs`, `OPCBinarySchema.cs`, `SecuredApplication.cs`, `PInvokeHelper.cs`) keep `#nullable enable`. The compiler ignores the project setting in generated code, so the directive is required there. - `tests/Opc.Ua.Interop.LegacyPeer` keeps `disable`. It builds against the 1.5.378 packages and does not import the repository props. - `docs/DeveloperGuide.md` and `.github/copilot-instructions.md` now describe the central setting. **Migration** (the 43 unset and 13 annotations-only projects, roughly 10k diagnostics) - **Production code: annotated at the declarations.** Covers `tools/Opc.Ua.SourceGeneration.Core`, `src/Opc.Ua.Lds.Server` and the LDS sample. - Members, parameters and returns are nullable where null actually flows. - Null-check helpers carry `[NotNullWhen]` (`IsNull`, `IsValidXmlName`, `IsMethodTypeDesign`). - `CoreUtils.Format`, `Utils.Format`, `ITemplateWriter.WriteLine` take `params object?[]`. `Template.AddReplacement` takes `string?` (rendering already skips null replacements). - `IRegisteredServerStore.RegisterAsync` returns `Task<RegistrationEntry?>`: it returns null when a registration is removed. - Dereferences backed by an invariant (for example, the validated model) use `!`, so runtime behaviour is unchanged. - **Behavioural changes in production code** (small, deliberate): - `NodeSetToModelDesign` throws `InvalidOperationException` when the file is not a NodeSet. Before, it threw a NullReferenceException on the next line. - `ModelDesignValidator` starts its lookup tables empty instead of null. A redundant `if (m_nodes == null) return;` guard is gone. - **Test code: minimal annotations.** - `?` on values that can be null, `!` where the test asserts non-null. - `= null!` for fixture members assigned in SetUp. - `TryGetStructure<T>(out T? x)` where the inferred `T?` broke the `IEncodeable` constraint. - A few redundant `== null` checks on structs (`NodeId`, `ArrayOf<T>`) folded into the adjacent `IsNull`/`Count` checks. **Notes for reviewers** - The diff is large (~1,500 files) but almost entirely mechanical: `?`, `!` and directive removal. The non-annotation changes are listed above. - Known follow-up, not done here: `IModelDesign.Namespaces/TargetNamespace/NamespaceUris` stay non-nullable even though the validator returns null before it loads a dictionary. Making them nullable would ripple through every generator call site. ## Related Issues - Fixes #4439 ## Checklist - [ ] I have signed the [CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf) and read the [CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md) doc. - [ ] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added all necessary documentation. - [x] I have verified that my changes do not introduce (new) build or analyzer warnings. - [ ] I ran **all** tests locally using the **UA.slnx** solution against at least .net **framework** and .net **10**, and all passed. - [ ] I fixed **all** failing and flaky tests in the CI pipelines and **all** CodeQL warnings. - [ ] I have addressed **all** PR feedback received. The "no new warnings" box covers net10.0 and net48: full non-incremental builds of `UA.slnx`, `tools/SourceGeneration.slnx`, `tools/MigrationAnalyzer.slnx` and the Aot test projects finished with 0 warnings and 0 errors under the repository's warnings-as-errors settings. net9.0 and net8.0 also had no nullable diagnostics, but they were not rebuilt after the final fixes. Tests have not been run locally yet. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
163 lines
6.5 KiB
C#
163 lines
6.5 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
using System;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Client;
|
|
using Opc.Ua.Client.TestFramework;
|
|
using Opc.Ua.Security.Certificates;
|
|
|
|
namespace Opc.Ua.Core.Security.Tests
|
|
{
|
|
/// <summary>
|
|
/// compliance tests for Security None CreateSession ActivateSession 1.0.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Conformance")]
|
|
[Category("Security")]
|
|
[Category("SecurityNone")]
|
|
public class SecurityNoneSession10Tests : TestFixture
|
|
{
|
|
[Test]
|
|
public Task NoneSession001ClientSpecifiesCertWithNoSecurity()
|
|
{
|
|
// With SecurityMode.None, client may still specify a certificate
|
|
// The fixture session uses None security
|
|
Assert.That(Session.Connected, Is.True);
|
|
Assert.That(
|
|
Session.Endpoint.SecurityMode,
|
|
Is.EqualTo(MessageSecurityMode.None),
|
|
"Session should use None security mode.");
|
|
return Task.CompletedTask;
|
|
}
|
|
|
|
[Test]
|
|
public Task NoneSession002ClientSpecifiesExpiredCertAsync()
|
|
{
|
|
return AssertNoneChannelAcceptsCertAsync(
|
|
slug: "expired-none",
|
|
makeCert: (subject, uri) =>
|
|
TestCertificateFactory.CreateExpiredAppInstanceCert(subject, uri));
|
|
}
|
|
|
|
[Test]
|
|
public Task NoneSession003ClientSpecifiesCertForAnotherComputerAsync()
|
|
{
|
|
return AssertNoneChannelAcceptsCertAsync(
|
|
slug: "wrong-host-none",
|
|
makeCert: TestCertificateFactory.CreateWrongHostnameAppInstanceCert);
|
|
}
|
|
|
|
[Test]
|
|
public Task NoneSession004ClientSpecifiesCorruptedCertAsync()
|
|
{
|
|
return AssertNoneChannelAcceptsCertAsync(
|
|
slug: "corrupted-none",
|
|
makeCert: (subject, uri) =>
|
|
{
|
|
using Certificate valid =
|
|
TestCertificateFactory.CreateValidAppInstanceCert(subject, uri);
|
|
return TestCertificateFactory.CorruptCertSignature(valid);
|
|
});
|
|
}
|
|
|
|
private async Task AssertNoneChannelAcceptsCertAsync(
|
|
string slug,
|
|
Func<string, string, Certificate> makeCert)
|
|
{
|
|
string subject = "CN=" + slug + ", O=OPC Foundation";
|
|
string appUri = $"urn:localhost:opcfoundation.org:NoneSessionTest:{slug}:{Guid.NewGuid():N}";
|
|
Certificate cert = makeCert(subject, appUri);
|
|
|
|
// Per Part 4 §5.4.2.2 a SecurityMode.None channel does
|
|
// not transmit/validate the client application instance
|
|
// certificate, so a flawed client cert must NOT prevent
|
|
// session establishment. Either Connected=true or any
|
|
// failure unrelated to the cert (e.g. socket reset) is
|
|
// acceptable.
|
|
CertSessionContext ctx = await CertSessionContext.CreateAsync(
|
|
cert, appUri, Telemetry).ConfigureAwait(false);
|
|
await using (ctx.ConfigureAwait(false))
|
|
{
|
|
EndpointDescription noneEndpoint = await GetNoneEndpointAsync().ConfigureAwait(false);
|
|
if (noneEndpoint == null)
|
|
{
|
|
Assert.Ignore("Server does not expose a SecurityMode.None endpoint.");
|
|
}
|
|
|
|
var endpointConfig = EndpointConfiguration.Create(ctx.ClientConfig);
|
|
endpointConfig.OperationTimeout = 10000;
|
|
var configured = new ConfiguredEndpoint(null, noneEndpoint, endpointConfig);
|
|
|
|
ISession? session = null;
|
|
try
|
|
{
|
|
session = await ctx.OpenSessionAsync(configured, Telemetry).ConfigureAwait(false);
|
|
Assert.That(session.Connected, Is.True);
|
|
}
|
|
finally
|
|
{
|
|
if (session != null)
|
|
{
|
|
try
|
|
{
|
|
await session.CloseAsync(5000, true, CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{
|
|
// best effort
|
|
}
|
|
session.Dispose();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private async Task<EndpointDescription> GetNoneEndpointAsync()
|
|
{
|
|
var endpointConfiguration = EndpointConfiguration.Create(ClientFixture.Config);
|
|
using DiscoveryClient dc = await DiscoveryClient.CreateAsync(
|
|
ServerUrl, endpointConfiguration, Telemetry, ct: CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
ArrayOf<EndpointDescription> eps = await dc.GetEndpointsAsync(
|
|
default, CancellationToken.None).ConfigureAwait(false);
|
|
foreach (EndpointDescription ep in eps)
|
|
{
|
|
if (ep.SecurityMode == MessageSecurityMode.None)
|
|
{
|
|
return ep;
|
|
}
|
|
}
|
|
return null!;
|
|
}
|
|
}
|
|
}
|