Files
UA-.NETStandard/tests/Opc.Ua.Core.Tests/Stack/Server/NoneEndpointCertificateTests.cs
romanett 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

210 lines
11 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.Linq;
using System.Security.Cryptography;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Security.Certificates;
using Opc.Ua.Tests;
namespace Opc.Ua.Core.Tests.Stack.Server
{
[TestFixture]
public sealed class NoneEndpointCertificateTests
{
[Test]
[Combinatorial]
public async Task NoneEndpointUsesRsaForEncryptedTokensWithEccFirstAsync(
[Values(UserTokenType.UserName, UserTokenType.IssuedToken)] UserTokenType type,
[Values] bool sendChain,
[Values(
ObjectTypes.ApplicationCertificateType,
ObjectTypes.RsaMinApplicationCertificateType,
ObjectTypes.RsaSha256ApplicationCertificateType)] uint certificateType)
{
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
using var registry = new CertificateManager(telemetry);
await registry.UpdateAsync(new SecurityConfiguration { SendCertificateChain = sendChain })
.ConfigureAwait(false);
using Certificate ecc = CertificateBuilder.Create("CN=Ecc First")
.SetECCurve(ECCurve.NamedCurves.nistP256).CreateForECDsa();
using Certificate rsa = CertificateBuilder.Create("CN=Rsa Token Encryption").CreateForRSA();
await registry.UpdateApplicationCertificateAsync(ObjectTypeIds.EccNistP256ApplicationCertificateType, ecc)
.ConfigureAwait(false);
await registry.UpdateApplicationCertificateAsync(
new NodeId(certificateType), rsa)
.ConfigureAwait(false);
using var server = new ServerBase(telemetry);
ApplicationConfiguration configuration = CreateConfiguration(registry, type, null!);
EndpointDescription endpoint = CreateEndpoint();
endpoint.UserIdentityTokens = server.GetUserTokenPolicies(configuration, endpoint);
ServerBase.SetServerCertificateInEndpointDescription(endpoint, registry);
Assert.That(endpoint.UserIdentityTokens.Count, Is.EqualTo(3));
Assert.That(endpoint.UserIdentityTokens.ToArray()!.Single(policy => policy.TokenType == type)
.SecurityPolicyUri, Is.EqualTo(SecurityPolicies.Basic256Sha256));
using CertificateCollection advertised = Utils.ParseCertificateChainBlob(
endpoint.ServerCertificate.ToArray(), telemetry);
Assert.That(advertised[0].RawData, Is.EqualTo(rsa.RawData));
using RSA publicKey = advertised[0].GetRSAPublicKey()!;
using RSA privateKey = rsa.GetRSAPrivateKey()!;
byte[] plaintext = [1, 2, 3, 4];
byte[] encrypted = publicKey!.Encrypt(plaintext, RSAEncryptionPadding.OaepSHA256);
Assert.That(privateKey!.Decrypt(encrypted, RSAEncryptionPadding.OaepSHA256), Is.EqualTo(plaintext));
}
[TestCase(UserTokenType.UserName, ObjectTypes.RsaSha256ApplicationCertificateType, (ushort)1024)]
[TestCase(UserTokenType.IssuedToken, ObjectTypes.RsaSha256ApplicationCertificateType, (ushort)1024)]
[TestCase(UserTokenType.UserName, ObjectTypes.EccNistP256ApplicationCertificateType, (ushort)2048)]
[TestCase(UserTokenType.IssuedToken, ObjectTypes.EccNistP256ApplicationCertificateType, (ushort)2048)]
public async Task NoneEndpointRejectsIncompatibleRsaTypeOrKeySizeAsync(
UserTokenType type, uint certificateType, ushort keySize)
{
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
using var registry = new CertificateManager(telemetry);
using Certificate certificate = CertificateBuilder.Create("CN=Incompatible Token Certificate")
.SetRSAKeySize(keySize).CreateForRSA();
await registry.UpdateApplicationCertificateAsync(new NodeId(certificateType), certificate)
.ConfigureAwait(false);
using var server = new ServerBase(telemetry);
ApplicationConfiguration configuration = CreateConfiguration(registry, type, null!);
ArrayOf<UserTokenPolicy> policies = server.GetUserTokenPolicies(configuration, CreateEndpoint());
Assert.That(policies.ToArray()!.Select(policy => policy.TokenType),
Is.EquivalentTo([UserTokenType.Anonymous, UserTokenType.Certificate]));
Assert.That(configuration.ServerConfiguration!.UserTokenPolicies.Count, Is.EqualTo(3));
}
[TestCase(UserTokenType.UserName, null, false)]
[TestCase(UserTokenType.IssuedToken, SecurityPolicies.Basic256Sha256, false)]
[TestCase(UserTokenType.UserName, SecurityPolicies.ECC_nistP256, false)]
[TestCase(UserTokenType.UserName, SecurityPolicies.ECC_nistP256, true)]
[TestCase(UserTokenType.IssuedToken, SecurityPolicies.RSA_DH_AesGcm, false)]
[TestCase(UserTokenType.IssuedToken, SecurityPolicies.RSA_DH_AesGcm, true)]
public async Task NoneEndpointOmitsEncryptedTokensWithoutCompatibleRsaPolicyAsync(
UserTokenType type, string? policyUri, bool hasRsa)
{
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
using var registry = new CertificateManager(telemetry);
using Certificate ecc = CertificateBuilder.Create("CN=Ecc Only")
.SetECCurve(ECCurve.NamedCurves.nistP256).CreateForECDsa();
await registry.UpdateApplicationCertificateAsync(ObjectTypeIds.EccNistP256ApplicationCertificateType, ecc)
.ConfigureAwait(false);
if (hasRsa)
{
using Certificate rsa = CertificateBuilder.Create("CN=Rsa Available").CreateForRSA();
await registry.UpdateApplicationCertificateAsync(
ObjectTypeIds.RsaSha256ApplicationCertificateType, rsa)
.ConfigureAwait(false);
}
using var server = new ServerBase(telemetry);
ApplicationConfiguration configuration = CreateConfiguration(registry, type, policyUri!);
ArrayOf<UserTokenPolicy> policies = server.GetUserTokenPolicies(configuration, CreateEndpoint());
Assert.That(policies.ToArray()!.Select(policy => policy.TokenType),
Is.EquivalentTo([UserTokenType.Anonymous, UserTokenType.Certificate]));
Assert.That(configuration.ServerConfiguration!.UserTokenPolicies.Count, Is.EqualTo(3));
}
[Test]
public async Task NoneEndpointCertificateSatisfiesAllAdvertisedEncryptionPoliciesAsync()
{
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
using var registry = new CertificateManager(telemetry);
using Certificate minimum = CertificateBuilder.Create("CN=Minimum RSA First")
.SetRSAKeySize(1024).CreateForRSA();
using Certificate sha256 = CertificateBuilder.Create("CN=SHA256 RSA Second").CreateForRSA();
await registry.UpdateApplicationCertificateAsync(ObjectTypeIds.RsaMinApplicationCertificateType, minimum)
.ConfigureAwait(false);
await registry.UpdateApplicationCertificateAsync(ObjectTypeIds.RsaSha256ApplicationCertificateType, sha256)
.ConfigureAwait(false);
using var server = new ServerBase(telemetry);
ApplicationConfiguration configuration = CreateConfiguration(
registry, UserTokenType.UserName, SecurityPolicies.Basic128Rsa15);
configuration.ServerConfiguration!.UserTokenPolicies += new UserTokenPolicy(UserTokenType.IssuedToken)
{
SecurityPolicyUri = SecurityPolicies.Aes256_Sha256_RsaPss
};
EndpointDescription endpoint = CreateEndpoint();
endpoint.UserIdentityTokens = server.GetUserTokenPolicies(configuration, endpoint);
ServerBase.SetServerCertificateInEndpointDescription(endpoint, registry);
Assert.That(endpoint.UserIdentityTokens.Count, Is.EqualTo(4));
Assert.That(endpoint.ServerCertificate, Is.EqualTo(sha256.RawData.ToByteString()));
}
[Test]
public void ExplicitUnencryptedTokenPolicyOnNoneIsPreserved()
{
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
using var registry = new CertificateManager(telemetry);
using var server = new ServerBase(telemetry);
ApplicationConfiguration configuration = CreateConfiguration(
registry, UserTokenType.UserName, SecurityPolicies.None);
ArrayOf<UserTokenPolicy> policies = server.GetUserTokenPolicies(configuration, CreateEndpoint());
Assert.That(policies.ToArray()!.Single(policy => policy.TokenType == UserTokenType.UserName)
.SecurityPolicyUri, Is.EqualTo(SecurityPolicies.None));
}
private static EndpointDescription CreateEndpoint()
{
return new EndpointDescription
{
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None,
EndpointUrl = "opc.tcp://localhost:4840"
};
}
private static ApplicationConfiguration CreateConfiguration(
CertificateManager registry, UserTokenType type, string policyUri)
{
return new ApplicationConfiguration
{
CertificateManager = registry,
ServerConfiguration = new ServerConfiguration
{
UserTokenPolicies =
[
new UserTokenPolicy(UserTokenType.Anonymous),
new UserTokenPolicy(UserTokenType.Certificate),
new UserTokenPolicy(type) { SecurityPolicyUri = policyUri }
]
}
};
}
}
}