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>
639 lines
28 KiB
C#
639 lines
28 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.Collections.Generic;
|
|
using System.IO;
|
|
using System.Security.Cryptography;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Moq;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Security.Certificates;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Server.Tests
|
|
{
|
|
/// <summary>
|
|
/// Direct, fast unit tests of the small argument-validation helpers
|
|
/// <see cref="ConfigurationNodeManager"/> extracts for
|
|
/// <c>CreateSelfSignedCertificate</c> (OPC 10000-12 §7.10.6),
|
|
/// <c>GetCertificates</c> (§7.10.8) and <c>UpdateCertificate</c>
|
|
/// (§7.10.5), independent of the address-space / method-call plumbing
|
|
/// exercised by <see cref="ConfigurationNodeManagerPushTests"/>.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("ConfigurationNodeManager")]
|
|
[Parallelizable]
|
|
[FixtureLifeCycle(LifeCycle.InstancePerTestCase)]
|
|
public class ConfigurationNodeManagerPushValidationTests
|
|
{
|
|
private static readonly ITelemetryContext s_telemetry = NUnitTelemetryContext.Create();
|
|
|
|
private string m_basePath;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
m_basePath = Path.Combine(
|
|
TestContext.CurrentContext.WorkDirectory,
|
|
"cnmv",
|
|
Guid.NewGuid().ToString("N")[..8]);
|
|
}
|
|
|
|
[TearDown]
|
|
public void TearDown()
|
|
{
|
|
if (Directory.Exists(m_basePath))
|
|
{
|
|
Directory.Delete(m_basePath, true);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public void CreateDefaultApplicationCertificateSubjectNameUsesApplicationName()
|
|
{
|
|
string subjectName = ConfigurationNodeManager
|
|
.CreateDefaultApplicationCertificateSubjectName("MyTestApplication");
|
|
|
|
Assert.That(subjectName, Does.Contain("CN=MyTestApplication"));
|
|
Assert.That(subjectName, Does.Contain("O=OPC Foundation"));
|
|
}
|
|
|
|
[Test]
|
|
public void CreateDefaultApplicationCertificateSubjectNameFallsBackWhenApplicationNameIsEmpty()
|
|
{
|
|
Assert.That(
|
|
() => ConfigurationNodeManager.CreateDefaultApplicationCertificateSubjectName(null),
|
|
Throws.Nothing);
|
|
string subjectName = ConfigurationNodeManager
|
|
.CreateDefaultApplicationCertificateSubjectName(string.Empty);
|
|
|
|
Assert.That(subjectName, Does.Contain("CN="));
|
|
}
|
|
|
|
[Test]
|
|
public void CreateDefaultApplicationCertificateSubjectNameSanitizesSeparatorCharacters()
|
|
{
|
|
string subjectName = ConfigurationNodeManager
|
|
.CreateDefaultApplicationCertificateSubjectName("My/App,Name;Here");
|
|
|
|
// The sanitized value must still parse as exactly two RDN
|
|
// fields (CN and O); embedded field separators would
|
|
// otherwise be misinterpreted as additional RDN boundaries.
|
|
List<string> fields = X509Utils.ParseDistinguishedName(subjectName);
|
|
Assert.That(fields, Has.Count.EqualTo(2));
|
|
Assert.That(fields[0], Does.StartWith("CN="));
|
|
Assert.That(fields[0], Does.Not.Contain("/"));
|
|
Assert.That(fields[0], Does.Not.Contain(";"));
|
|
}
|
|
|
|
[Test]
|
|
public void SubjectCommonNameMatchesDomainReturnsTrueForExactMatch()
|
|
{
|
|
bool matches = ConfigurationNodeManager.SubjectCommonNameMatchesDomain(
|
|
"CN=my.host.name, O=OPC Foundation",
|
|
["other.host", "my.host.name"]);
|
|
|
|
Assert.That(matches, Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void SubjectCommonNameMatchesDomainIsCaseInsensitive()
|
|
{
|
|
bool matches = ConfigurationNodeManager.SubjectCommonNameMatchesDomain(
|
|
"CN=MY.HOST.NAME",
|
|
["my.host.name"]);
|
|
|
|
Assert.That(matches, Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void SubjectCommonNameMatchesDomainReturnsFalseWhenNoMatch()
|
|
{
|
|
bool matches = ConfigurationNodeManager.SubjectCommonNameMatchesDomain(
|
|
"CN=unrelated.host",
|
|
["my.host.name", "127.0.0.1"]);
|
|
|
|
Assert.That(matches, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void SubjectCommonNameMatchesDomainReturnsFalseWhenSubjectHasNoCommonName()
|
|
{
|
|
bool matches = ConfigurationNodeManager.SubjectCommonNameMatchesDomain(
|
|
"O=OPC Foundation",
|
|
["my.host.name"]);
|
|
|
|
Assert.That(matches, Is.False);
|
|
}
|
|
|
|
[TestCase((ushort)0, true)]
|
|
[TestCase((ushort)1024, true)]
|
|
[TestCase((ushort)2048, true)]
|
|
[TestCase((ushort)3072, true)]
|
|
[TestCase((ushort)4096, true)]
|
|
[TestCase((ushort)1536, false)]
|
|
public void ValidateKeySizeForGenericApplicationCertificateType(ushort keySize, bool supported)
|
|
{
|
|
Action action = () => ConfigurationNodeManager.ValidateKeySizeForCertificateType(
|
|
ObjectTypeIds.ApplicationCertificateType,
|
|
isRsaCertificateType: true,
|
|
keySize);
|
|
|
|
AssertSupportedOrBadOutOfRange(action, supported);
|
|
}
|
|
|
|
[TestCase((ushort)1024, true)]
|
|
[TestCase((ushort)2048, true)]
|
|
[TestCase((ushort)3072, false)]
|
|
[TestCase((ushort)4096, false)]
|
|
public void ValidateKeySizeForRsaMinApplicationCertificateType(ushort keySize, bool supported)
|
|
{
|
|
Action action = () => ConfigurationNodeManager.ValidateKeySizeForCertificateType(
|
|
ObjectTypeIds.RsaMinApplicationCertificateType,
|
|
isRsaCertificateType: true,
|
|
keySize);
|
|
|
|
AssertSupportedOrBadOutOfRange(action, supported);
|
|
}
|
|
|
|
[TestCase((ushort)1024, false)]
|
|
[TestCase((ushort)2048, true)]
|
|
[TestCase((ushort)3072, true)]
|
|
[TestCase((ushort)4096, true)]
|
|
public void ValidateKeySizeForRsaSha256ApplicationCertificateType(ushort keySize, bool supported)
|
|
{
|
|
Action action = () => ConfigurationNodeManager.ValidateKeySizeForCertificateType(
|
|
ObjectTypeIds.RsaSha256ApplicationCertificateType,
|
|
isRsaCertificateType: true,
|
|
keySize);
|
|
|
|
AssertSupportedOrBadOutOfRange(action, supported);
|
|
}
|
|
|
|
[TestCase((ushort)256, true)]
|
|
[TestCase((ushort)384, false)]
|
|
public void ValidateKeySizeForEccNistP256ApplicationCertificateType(ushort keySize, bool supported)
|
|
{
|
|
Action action = () => ConfigurationNodeManager.ValidateKeySizeForCertificateType(
|
|
ObjectTypeIds.EccNistP256ApplicationCertificateType,
|
|
isRsaCertificateType: false,
|
|
keySize);
|
|
|
|
AssertSupportedOrBadOutOfRange(action, supported);
|
|
}
|
|
|
|
[TestCase((ushort)384, true)]
|
|
[TestCase((ushort)256, false)]
|
|
public void ValidateKeySizeForEccNistP384ApplicationCertificateType(ushort keySize, bool supported)
|
|
{
|
|
Action action = () => ConfigurationNodeManager.ValidateKeySizeForCertificateType(
|
|
ObjectTypeIds.EccNistP384ApplicationCertificateType,
|
|
isRsaCertificateType: false,
|
|
keySize);
|
|
|
|
AssertSupportedOrBadOutOfRange(action, supported);
|
|
}
|
|
|
|
private static void AssertSupportedOrBadOutOfRange(Action action, bool supported)
|
|
{
|
|
if (supported)
|
|
{
|
|
Assert.DoesNotThrow(action);
|
|
return;
|
|
}
|
|
|
|
ServiceResultException exception = Assert.Throws<ServiceResultException>(action);
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void SelectOccupiedCertificateSlotsOmitsEmptySlotsAndPreservesOrder()
|
|
{
|
|
NodeId rsaType = ObjectTypeIds.RsaSha256ApplicationCertificateType;
|
|
NodeId eccType = ObjectTypeIds.EccNistP256ApplicationCertificateType;
|
|
NodeId httpsType = ObjectTypeIds.HttpsCertificateType;
|
|
|
|
ArrayOf<CertificateIdentifier> applicationCertificates =
|
|
[
|
|
new CertificateIdentifier { CertificateType = rsaType },
|
|
new CertificateIdentifier { CertificateType = eccType },
|
|
new CertificateIdentifier { CertificateType = httpsType }
|
|
];
|
|
|
|
using Certificate rsaCert = CertificateBuilder
|
|
.Create("CN=Occupied Slot " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
using Certificate httpsCert = CertificateBuilder
|
|
.Create("CN=Occupied Slot Https " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
using var emptyIssuerChain = new CertificateCollection();
|
|
|
|
using var rsaEntry = new CertificateEntry(rsaCert, emptyIssuerChain, rsaType);
|
|
using var httpsEntry = new CertificateEntry(httpsCert, emptyIssuerChain, httpsType);
|
|
|
|
(ArrayOf<NodeId> types, ArrayOf<ByteString> certificates) = ConfigurationNodeManager
|
|
.SelectOccupiedCertificateSlots(
|
|
applicationCertificates,
|
|
certificateType => certificateType == rsaType
|
|
? rsaEntry.AddRef()
|
|
: certificateType == httpsType
|
|
? httpsEntry.AddRef()
|
|
: null);
|
|
|
|
// eccType is unoccupied and must be omitted; rsaType/httpsType
|
|
// must be reported in their original configured order.
|
|
Assert.That(types.ToList(), Is.EqualTo(new[] { rsaType, httpsType }));
|
|
Assert.That(certificates.Count, Is.EqualTo(2));
|
|
using Certificate roundTrippedRsa = Certificate.FromRawData(certificates[0]);
|
|
Assert.That(roundTrippedRsa.Thumbprint, Is.EqualTo(rsaCert.Thumbprint));
|
|
}
|
|
|
|
[Test]
|
|
public void SelectOccupiedCertificateSlotsReturnsEmptyArraysForFullyEmptyGroup()
|
|
{
|
|
ArrayOf<CertificateIdentifier> applicationCertificates =
|
|
[
|
|
new CertificateIdentifier { CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType },
|
|
new CertificateIdentifier { CertificateType = ObjectTypeIds.EccNistP256ApplicationCertificateType }
|
|
];
|
|
|
|
(ArrayOf<NodeId> types, ArrayOf<ByteString> certificates) = ConfigurationNodeManager
|
|
.SelectOccupiedCertificateSlots(applicationCertificates, _ => null);
|
|
|
|
Assert.That(types.Count, Is.Zero);
|
|
Assert.That(certificates.Count, Is.Zero);
|
|
}
|
|
|
|
[Test]
|
|
public void SelectOccupiedCertificateSlotsThrowsForNullResolver()
|
|
{
|
|
Assert.Throws<ArgumentNullException>(() =>
|
|
ConfigurationNodeManager.SelectOccupiedCertificateSlots(
|
|
ArrayOf<CertificateIdentifier>.Empty,
|
|
null!));
|
|
}
|
|
|
|
[Test]
|
|
public async Task ValidateCertificateAgainstGroupTrustListAsyncAcceptsACertificateDirectlyTrustedAsync()
|
|
{
|
|
(CertificateStoreIdentifier trustedStore, CertificateStoreIdentifier issuerStore) = CreateEmptyStores();
|
|
using Certificate selfSigned = CertificateBuilder
|
|
.Create("CN=Directly Trusted " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
using (ICertificateStore store = trustedStore.OpenStore(s_telemetry))
|
|
{
|
|
await store.AddAsync(selfSigned, ct: CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
|
|
Assert.DoesNotThrowAsync(async () =>
|
|
await ConfigurationNodeManager.ValidateCertificateAgainstGroupTrustListAsync(
|
|
trustedStore,
|
|
issuerStore,
|
|
"TestGroup-" + Guid.NewGuid().ToString("N")[..8],
|
|
selfSigned,
|
|
new SecurityConfiguration(),
|
|
s_telemetry,
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false));
|
|
}
|
|
|
|
[Test]
|
|
public async Task ValidateCertificateAgainstGroupTrustListAsyncAcceptsAnUntrustedSelfSignedCertificateAsync()
|
|
{
|
|
// OPC 10000-12 §7.10.5: "All suppressible errors shall be
|
|
// ignored." BadCertificateUntrusted is suppressible, so a
|
|
// self-signed certificate absent from every store must still
|
|
// be accepted rather than rejected.
|
|
(CertificateStoreIdentifier trustedStore, CertificateStoreIdentifier issuerStore) = CreateEmptyStores();
|
|
using Certificate untrusted = CertificateBuilder
|
|
.Create("CN=Never Trusted " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
Assert.DoesNotThrowAsync(async () =>
|
|
await ConfigurationNodeManager.ValidateCertificateAgainstGroupTrustListAsync(
|
|
trustedStore,
|
|
issuerStore,
|
|
"TestGroup-" + Guid.NewGuid().ToString("N")[..8],
|
|
untrusted,
|
|
new SecurityConfiguration(),
|
|
s_telemetry,
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false));
|
|
}
|
|
|
|
[TestCase(true)]
|
|
[TestCase(false)]
|
|
public async Task ValidateCertificateAgainstGroupTrustListAsyncAcceptsACaSignedCertificateWhenTheCaIsInstalledAsync(
|
|
bool caInTrustedStore)
|
|
{
|
|
// OPC 10000-12 §7.10.5: "The validation process requires that
|
|
// the TrustList associated with the CertificateGroup already
|
|
// contains the IssuerCertificates." A renewal signed by a CA
|
|
// installed in either list of the group's TrustList must be
|
|
// accepted without any caller-supplied issuer chain.
|
|
(CertificateStoreIdentifier trustedStore, CertificateStoreIdentifier issuerStore) = CreateEmptyStores();
|
|
using Certificate ca = CreateCa("CN=Installed CA ");
|
|
using Certificate issued = CreateIssued(ca);
|
|
|
|
CertificateStoreIdentifier installTo = caInTrustedStore ? trustedStore : issuerStore;
|
|
using (ICertificateStore store = installTo.OpenStore(s_telemetry))
|
|
{
|
|
await store.AddAsync(ca, ct: CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
|
|
Assert.DoesNotThrowAsync(async () =>
|
|
await ConfigurationNodeManager.ValidateCertificateAgainstGroupTrustListAsync(
|
|
trustedStore,
|
|
issuerStore,
|
|
"TestGroup-" + Guid.NewGuid().ToString("N")[..8],
|
|
issued,
|
|
new SecurityConfiguration(),
|
|
s_telemetry,
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false));
|
|
}
|
|
|
|
[Test]
|
|
public void ValidateCertificateAgainstGroupTrustListAsyncRejectsACaSignedCertificateWhoseCaIsNotInstalled()
|
|
{
|
|
// OPC 10000-4 Table 100: "Build Certificate Chain ... An error
|
|
// during the chain creation may not be suppressed." The issuer
|
|
// must already be in the group's TrustList (OPC 10000-12
|
|
// §7.10.5), so accepting every suppressible error must still
|
|
// reject a certificate whose issuer the server does not know.
|
|
(CertificateStoreIdentifier trustedStore, CertificateStoreIdentifier issuerStore) = CreateEmptyStores();
|
|
using Certificate ca = CreateCa("CN=Uninstalled CA ");
|
|
using Certificate issued = CreateIssued(ca);
|
|
|
|
ServiceResultException sre = Assert.ThrowsAsync<ServiceResultException>(async () =>
|
|
await ConfigurationNodeManager.ValidateCertificateAgainstGroupTrustListAsync(
|
|
trustedStore,
|
|
issuerStore,
|
|
"TestGroup-" + Guid.NewGuid().ToString("N")[..8],
|
|
issued,
|
|
new SecurityConfiguration(),
|
|
s_telemetry,
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false));
|
|
Assert.That(ContainsStatusCode(sre.Result, StatusCodes.BadCertificateChainIncomplete), Is.True,
|
|
sre.Result.ToLongString());
|
|
}
|
|
|
|
[Test]
|
|
public void ValidateCertificateAgainstGroupTrustListAsyncThrowsForNullTrustedStore()
|
|
{
|
|
using Certificate certificate = CertificateBuilder
|
|
.Create("CN=Guard Clause Test")
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
Assert.ThrowsAsync<ArgumentNullException>(async () =>
|
|
await ConfigurationNodeManager.ValidateCertificateAgainstGroupTrustListAsync(
|
|
null!,
|
|
null,
|
|
"TestGroup",
|
|
certificate,
|
|
new SecurityConfiguration(),
|
|
s_telemetry,
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false));
|
|
}
|
|
|
|
[Test]
|
|
public void IsCertificateReferencedByEndpointMatchesTheEndpointServerCertificateThumbprint()
|
|
{
|
|
using Certificate referenced = CertificateBuilder
|
|
.Create("CN=Referenced " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
using Certificate other = CertificateBuilder
|
|
.Create("CN=Other " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
ArrayOf<EndpointDescription> endpoints = ArrayOf.Wrapped(new[]
|
|
{
|
|
new EndpointDescription
|
|
{
|
|
SecurityMode = MessageSecurityMode.None
|
|
},
|
|
new EndpointDescription
|
|
{
|
|
SecurityMode = MessageSecurityMode.SignAndEncrypt,
|
|
ServerCertificate = referenced.RawData.ToByteString()
|
|
}
|
|
});
|
|
|
|
Assert.That(
|
|
ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
referenced.Thumbprint, endpoints, null, s_telemetry),
|
|
Is.True,
|
|
"a certificate presented by an endpoint must be reported as referenced");
|
|
Assert.That(
|
|
ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
other.Thumbprint, endpoints, null, s_telemetry),
|
|
Is.False,
|
|
"a certificate not presented by any endpoint must not be reported as referenced");
|
|
}
|
|
|
|
[Test]
|
|
public void IsCertificateReferencedByEndpointReturnsFalseForAnEmptyEndpointSet()
|
|
{
|
|
using Certificate certificate = CertificateBuilder
|
|
.Create("CN=Unreferenced " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
Assert.That(
|
|
ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
certificate.Thumbprint, default, null, s_telemetry),
|
|
Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void IsCertificateReferencedByEndpointResolvesTheCurrentCertificateFromTheRegistry()
|
|
{
|
|
// Regression for the endpoint-reference check using startup-only
|
|
// EndpointDescription.ServerCertificate data (OPC 10000-12 §7.10.7):
|
|
// after a rotation the endpoint's cached ServerCertificate blob is
|
|
// the previous certificate (A) while the live registry maps the
|
|
// endpoint's SecurityPolicyUri to the rotated certificate (B). The
|
|
// check must protect B (the certificate presented right now) and
|
|
// must NOT protect A (no longer presented), resolving the
|
|
// assignment from the registry rather than the stale blob.
|
|
using Certificate previous = CertificateBuilder
|
|
.Create("CN=Rotated Out " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
using Certificate rotated = CertificateBuilder
|
|
.Create("CN=Currently Presented " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
// The endpoint still advertises the stale previous-certificate blob.
|
|
ArrayOf<EndpointDescription> endpoints = ArrayOf.Wrapped(new[]
|
|
{
|
|
new EndpointDescription
|
|
{
|
|
SecurityMode = MessageSecurityMode.SignAndEncrypt,
|
|
SecurityPolicyUri = SecurityPolicies.Basic256Sha256,
|
|
ServerCertificate = previous.RawData.ToByteString()
|
|
}
|
|
});
|
|
|
|
using var emptyIssuerChain = new CertificateCollection();
|
|
using var liveEntry = new CertificateEntry(
|
|
rotated, emptyIssuerChain, ObjectTypeIds.RsaSha256ApplicationCertificateType);
|
|
|
|
var registry = new Mock<ICertificateRegistry>();
|
|
registry
|
|
.Setup(r => r.AcquireApplicationCertificateBySecurityPolicy(It.IsAny<string>()))
|
|
.Returns(() => liveEntry.AddRef());
|
|
|
|
Assert.That(
|
|
ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
rotated.Thumbprint, endpoints, registry.Object, s_telemetry),
|
|
Is.True,
|
|
"the certificate currently presented (resolved from the registry) must be protected");
|
|
Assert.That(
|
|
ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
previous.Thumbprint, endpoints, registry.Object, s_telemetry),
|
|
Is.False,
|
|
"the stale endpoint blob must not keep a rotated-out certificate referenced");
|
|
}
|
|
|
|
[Test]
|
|
public void IsCertificateReferencedByEndpointIgnoresUnencryptedEndpointsWhenRegistryPresent()
|
|
{
|
|
// An endpoint that does not require encryption presents no channel
|
|
// certificate, so it must never keep a certificate referenced when
|
|
// the live registry is consulted.
|
|
using Certificate certificate = CertificateBuilder
|
|
.Create("CN=Unencrypted " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
|
|
ArrayOf<EndpointDescription> endpoints = ArrayOf.Wrapped(new[]
|
|
{
|
|
new EndpointDescription
|
|
{
|
|
SecurityMode = MessageSecurityMode.None,
|
|
SecurityPolicyUri = SecurityPolicies.None,
|
|
ServerCertificate = certificate.RawData.ToByteString()
|
|
}
|
|
});
|
|
|
|
using var emptyIssuerChain = new CertificateCollection();
|
|
using var liveEntry = new CertificateEntry(
|
|
certificate, emptyIssuerChain, ObjectTypeIds.RsaSha256ApplicationCertificateType);
|
|
|
|
var registry = new Mock<ICertificateRegistry>();
|
|
registry
|
|
.Setup(r => r.AcquireApplicationCertificateBySecurityPolicy(It.IsAny<string>()))
|
|
.Returns(() => liveEntry.AddRef());
|
|
|
|
Assert.That(
|
|
ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
certificate.Thumbprint, endpoints, registry.Object, s_telemetry),
|
|
Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public async Task NoneEndpointProtectsItsRsaTokenCertificateInsteadOfThePrimaryEccCertificateAsync()
|
|
{
|
|
using var registry = new CertificateManager(s_telemetry);
|
|
using Certificate ecc = CertificateBuilder.Create("CN=Primary ECC")
|
|
.SetECCurve(ECCurve.NamedCurves.nistP256).CreateForECDsa();
|
|
using Certificate rsa = CertificateBuilder.Create("CN=Token RSA").CreateForRSA();
|
|
await registry.UpdateApplicationCertificateAsync(ObjectTypeIds.EccNistP256ApplicationCertificateType, ecc)
|
|
.ConfigureAwait(false);
|
|
await registry.UpdateApplicationCertificateAsync(ObjectTypeIds.RsaSha256ApplicationCertificateType, rsa)
|
|
.ConfigureAwait(false);
|
|
ArrayOf<EndpointDescription> endpoints = [new EndpointDescription
|
|
{
|
|
SecurityMode = MessageSecurityMode.None,
|
|
SecurityPolicyUri = SecurityPolicies.None,
|
|
UserIdentityTokens = [new UserTokenPolicy(UserTokenType.UserName)
|
|
{
|
|
SecurityPolicyUri = SecurityPolicies.Basic256Sha256
|
|
}]
|
|
}];
|
|
|
|
Assert.That(ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
rsa.Thumbprint, endpoints, registry, s_telemetry), Is.True);
|
|
Assert.That(ConfigurationNodeManager.IsCertificateReferencedByEndpoint(
|
|
ecc.Thumbprint, endpoints, registry, s_telemetry), Is.False);
|
|
}
|
|
|
|
private static Certificate CreateCa(string subjectPrefix)
|
|
{
|
|
return CertificateBuilder
|
|
.Create(subjectPrefix + Guid.NewGuid().ToString("N")[..8])
|
|
.SetCAConstraint(0)
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
}
|
|
|
|
private static Certificate CreateIssued(Certificate ca)
|
|
{
|
|
return CertificateBuilder
|
|
.Create("CN=Issued " + Guid.NewGuid().ToString("N")[..8])
|
|
.SetIssuer(ca)
|
|
.SetRSAKeySize(2048)
|
|
.CreateForRSA();
|
|
}
|
|
|
|
private static bool ContainsStatusCode(ServiceResult result, StatusCode statusCode)
|
|
{
|
|
for (ServiceResult current = result; current != null; current = current.InnerResult!)
|
|
{
|
|
if (current.StatusCode == statusCode)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
private (CertificateStoreIdentifier TrustedStore, CertificateStoreIdentifier IssuerStore) CreateEmptyStores()
|
|
{
|
|
return (
|
|
new CertificateStoreIdentifier(Path.Combine(m_basePath, "trusted")),
|
|
new CertificateStoreIdentifier(Path.Combine(m_basePath, "issuer")));
|
|
}
|
|
}
|
|
}
|