mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-26 04:19:53 +08:00
# 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>
189 lines
7.1 KiB
C#
189 lines
7.1 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2026 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.Formats.Asn1;
|
|
using System.IO;
|
|
using System.Security.Cryptography;
|
|
using Opc.Ua.Security.Certificates;
|
|
|
|
namespace Opc.Ua.Fuzzing
|
|
{
|
|
/// <summary>
|
|
/// Certificate loading and concatenated DER-chain fuzz targets.
|
|
/// </summary>
|
|
public static partial class FuzzableCode
|
|
{
|
|
/// <summary>
|
|
/// Loads a standalone certificate from AFL input.
|
|
/// </summary>
|
|
public static void AflfuzzCertificateDecoder(Stream stream)
|
|
{
|
|
_ = FuzzCertificateDecoderCore(ReadAllBytes(stream));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads a standalone certificate from libFuzzer or OneFuzz input.
|
|
/// </summary>
|
|
public static void LibfuzzCertificateDecoder(ReadOnlySpan<byte> input)
|
|
{
|
|
_ = FuzzCertificateDecoderCore(input.ToArray());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Parses a certificate chain with the default platform path.
|
|
/// </summary>
|
|
public static void AflfuzzCertificateChainDecoder(Stream stream)
|
|
{
|
|
_ = FuzzCertificateChainDecoderCore(ReadAllBytes(stream), useAsnParser: false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Parses a certificate chain with the default platform path.
|
|
/// </summary>
|
|
public static void LibfuzzCertificateChainDecoder(ReadOnlySpan<byte> input)
|
|
{
|
|
_ = FuzzCertificateChainDecoderCore(input.ToArray(), useAsnParser: false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Parses a certificate chain with the forced ASN.1 path.
|
|
/// </summary>
|
|
public static void AflfuzzCertificateChainDecoderCustom(Stream stream)
|
|
{
|
|
_ = FuzzCertificateChainDecoderCore(ReadAllBytes(stream), useAsnParser: true);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Parses a certificate chain with the forced ASN.1 path.
|
|
/// </summary>
|
|
public static void LibfuzzCertificateChainDecoderCustom(ReadOnlySpan<byte> input)
|
|
{
|
|
_ = FuzzCertificateChainDecoderCore(input.ToArray(), useAsnParser: true);
|
|
}
|
|
|
|
internal static bool FuzzCertificateDecoderCore(byte[] input)
|
|
{
|
|
Certificate? certificate = null;
|
|
try
|
|
{
|
|
byte[] rawData;
|
|
try
|
|
{
|
|
certificate = Certificate.FromRawData(input);
|
|
// .NET Framework can defer invalid-handle detection until the first property read.
|
|
rawData = certificate.RawData;
|
|
}
|
|
catch (CryptographicException exception) when (IsExpectedCertificateInputException(exception))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
using Certificate reloaded = Certificate.FromRawData(rawData);
|
|
if (!rawData.AsSpan().SequenceEqual(reloaded.RawData) ||
|
|
!certificate.SubjectName.RawData.AsSpan().SequenceEqual(reloaded.SubjectName.RawData) ||
|
|
!certificate.IssuerName.RawData.AsSpan().SequenceEqual(reloaded.IssuerName.RawData) ||
|
|
certificate.SerialNumber != reloaded.SerialNumber ||
|
|
certificate.NotBefore != reloaded.NotBefore ||
|
|
certificate.NotAfter != reloaded.NotAfter ||
|
|
reloaded.HasPrivateKey)
|
|
{
|
|
throw new InvalidOperationException("Reloading a decoded certificate changed its fields.");
|
|
}
|
|
return true;
|
|
}
|
|
finally
|
|
{
|
|
certificate?.Dispose();
|
|
}
|
|
}
|
|
|
|
internal static bool FuzzCertificateChainDecoderCore(byte[] input, bool useAsnParser)
|
|
{
|
|
CertificateCollection chain;
|
|
try
|
|
{
|
|
chain = Utils.ParseCertificateChainBlob(input, telemetry: null, useAsnParser: useAsnParser);
|
|
}
|
|
catch (ServiceResultException exception) when (IsExpectedCertificateInputException(exception))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
using (chain)
|
|
{
|
|
foreach (Certificate certificate in chain)
|
|
{
|
|
_ = certificate.SubjectName.RawData;
|
|
_ = certificate.IssuerName.RawData;
|
|
_ = certificate.SerialNumber;
|
|
}
|
|
if (!input.AsSpan().SequenceEqual(Utils.CreateCertificateChainBlob(chain)))
|
|
{
|
|
throw new InvalidOperationException("Certificate-chain parsing changed the ordered DER bytes.");
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
internal static bool IsExpectedCertificateInputException(Exception exception)
|
|
{
|
|
while (true)
|
|
{
|
|
if (exception is ServiceResultException serviceException)
|
|
{
|
|
if (serviceException.StatusCode != StatusCodes.BadCertificateInvalid ||
|
|
serviceException.InnerException == null)
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
else if (exception is CryptographicException or AsnContentException)
|
|
{
|
|
if (exception is AsnContentException)
|
|
{
|
|
return true;
|
|
}
|
|
if (exception.InnerException == null)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// A status or crypto wrapper must not turn a programmer error into input rejection.
|
|
exception = exception.InnerException!;
|
|
}
|
|
}
|
|
}
|
|
}
|