Files
UA-.NETStandard/tests/Opc.Ua.Core.Tests/Security/Certificates/PaddingOffsetRegressionTests.cs
romanettandClaude Opus 5.5 9b034f8291 Enable nullable reference types centrally; migrate all unset and annotations-only projects (#4700)
# 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>
2026-10-08 08:48:13 +02:00

144 lines
6.4 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.Reflection;
using System.Security.Cryptography;
using NUnit.Framework;
namespace Opc.Ua.Core.Tests.Security.Certificates
{
/// <summary>
/// Covers symmetric padding validation for offset buffers and one- or two-byte padding lengths.
/// </summary>
[TestFixture]
[Category("CryptoUtils")]
public sealed class PaddingOffsetRegressionTests
{
/// <summary>
/// Verifies every corrupted padding byte is rejected even when its signature is valid and the payload is
/// offset.
/// </summary>
[TestCase(0)]
[TestCase(8)]
[TestCase(24)]
public void SignedEncryptedMessagesRejectEveryCorruptedPaddingByte(int offset)
{
const int dataLength = 18;
const int paddingLength = 13;
SecurityPolicyInfo policy = SecurityPolicies.Default.GetInfo(SecurityPolicies.Basic256Sha256)!;
using var aes = Aes.Create();
aes.KeySize = 256;
aes.Mode = CipherMode.CBC;
aes.Padding = PaddingMode.None;
aes.GenerateKey();
aes.GenerateIV();
using var hmac = new HMACSHA256();
for (int corrupt = -1; corrupt < paddingLength; corrupt++)
{
byte[] buffer = new byte[offset + 64];
buffer.AsSpan(0, offset).Fill(0x44);
buffer.AsSpan(offset, dataLength).Fill(0x31);
buffer.AsSpan(offset + dataLength, paddingLength + 1).Fill(paddingLength);
if (corrupt >= 0)
{
buffer[offset + dataLength + corrupt] ^= 1;
}
byte[] signature = hmac.ComputeHash(buffer, 0, offset + 32);
signature.CopyTo(buffer, offset + 32);
using (ICryptoTransform encryptor = aes.CreateEncryptor())
{
byte[] encrypted = encryptor.TransformFinalBlock(buffer, offset, 64);
encrypted.CopyTo(buffer, offset);
}
var message = new ArraySegment<byte>(buffer, offset, 64);
if (corrupt < 0)
{
ArraySegment<byte> plaintext = CryptoUtils.SymmetricDecryptAndVerify(
message, policy!, aes.Key, aes.IV, hmac.Key, false, 1, 1);
Assert.That(plaintext, Has.Count.EqualTo(offset + dataLength));
Assert.That(plaintext.Array.AsSpan(offset, dataLength).ToArray(), Is.All.EqualTo(0x31));
}
else
{
Assert.Throws<CryptographicException>(() => CryptoUtils.SymmetricDecryptAndVerify(
message, policy!, aes.Key, aes.IV, hmac.Key, false, 1, 1), $"padding byte {corrupt}");
}
}
}
/// <summary>
/// Verifies padding round trips retain the prefix and payload for both padding-length encodings.
/// </summary>
[TestCase(16, 0)]
[TestCase(16, 24)]
[TestCase(512, 0)]
[TestCase(512, 24)]
public void PaddingHelperPreservesOffsetAndBothLengthBytes(int blockSize, int offset)
{
var add = Bind<Func<ArraySegment<byte>, int, int, ArraySegment<byte>>>("AddPadding");
var remove = Bind<Func<ArraySegment<byte>, int, ArraySegment<byte>>>("RemovePadding");
byte[] bytes = new byte[offset + blockSize * 2];
bytes.AsSpan(0, offset + 2).Fill(0x31);
ArraySegment<byte> padded = add(new ArraySegment<byte>(bytes, offset, 2), blockSize, 0);
ArraySegment<byte> unpadded = remove(padded, blockSize);
Assert.That(unpadded.Offset, Is.Zero);
Assert.That(unpadded, Has.Count.EqualTo(offset + 2));
Assert.That(unpadded.AsSpan().ToArray(), Is.All.EqualTo(0x31));
}
/// <summary>
/// Verifies missing padding-length bytes produce a cryptographic protocol error rather than an indexing
/// failure.
/// </summary>
[TestCase(0, 16)]
[TestCase(0, 512)]
[TestCase(1, 512)]
public void TruncatedPaddingLengthIsAProtocolError(int count, int blockSize)
{
var remove = Bind<Func<ArraySegment<byte>, int, ArraySegment<byte>>>("RemovePadding");
Assert.Throws<CryptographicException>(() => remove(new ArraySegment<byte>(new byte[count]), blockSize));
}
/// <summary>
/// Binds a private padding helper to a typed delegate for direct boundary-condition checks.
/// </summary>
/// <typeparam name="T">The delegate signature matching the private padding helper.</typeparam>
private static T Bind<T>(string methodName) where T : Delegate
{
MethodInfo method = typeof(CryptoUtils).GetMethod(methodName, BindingFlags.NonPublic | BindingFlags.Static)!;
#if NET5_0_OR_GREATER
return method.CreateDelegate<T>();
#else
return (T)method.CreateDelegate(typeof(T));
#endif
}
}
}