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>
646 lines
29 KiB
C#
646 lines
29 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/
|
|
* ======================================================================*/
|
|
|
|
// CA2000: test code; many disposables are ownership-transferred to test fixtures or short-lived,
|
|
// making CA2000 noisy without a real leak risk. Disabled file-level for the suite.
|
|
#pragma warning disable CA2000
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using System.Threading.Tasks;
|
|
using System.Xml;
|
|
using System.Xml.Linq;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Security.Certificates;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Configuration.Tests
|
|
{
|
|
/// <summary>
|
|
/// Tests for the security configuration class.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("SecurityConfiguration")]
|
|
[SetCulture("en-us")]
|
|
public class SecurityConfigurationTests
|
|
{
|
|
[Test]
|
|
public void ValidConfgurationPasses()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
};
|
|
|
|
configuration.Validate(telemetry);
|
|
}
|
|
|
|
[TestCaseSource(nameof(GetInvalidConfigurations))]
|
|
public void InvalidConfigurationThrows(SecurityConfiguration configuration)
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
Assert.Throws<ServiceResultException>(() => configuration.Validate(telemetry));
|
|
}
|
|
|
|
[Test]
|
|
public void ApplicationCertificateWithoutCertificateTypeIsKeptAsRsaSha256()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates =
|
|
[
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
SubjectName = "CN=Test"
|
|
// CertificateType deliberately not set
|
|
}
|
|
],
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
};
|
|
|
|
Assert.That(configuration.ApplicationCertificates, Has.Count.EqualTo(1));
|
|
Assert.That(
|
|
configuration.ApplicationCertificates[0].CertificateType,
|
|
Is.EqualTo(ObjectTypeIds.RsaSha256ApplicationCertificateType));
|
|
Assert.That(
|
|
configuration.SupportedSecurityPolicies.ToArray(),
|
|
Contains.Item(SecurityPolicies.Basic256Sha256));
|
|
|
|
configuration.Validate(telemetry);
|
|
}
|
|
|
|
[Test]
|
|
public void UnsupportedApplicationCertificateTypeIsRemovedAndReportedByValidate()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates =
|
|
[
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
SubjectName = "CN=Test",
|
|
CertificateType = ObjectTypeIds.EccCurve25519ApplicationCertificateType
|
|
}
|
|
],
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
};
|
|
|
|
Assert.That(configuration.ApplicationCertificates, Is.Empty);
|
|
|
|
ServiceResultException sre = Assert.Throws<ServiceResultException>(
|
|
() => configuration.Validate(telemetry));
|
|
|
|
Assert.That(sre.Code, Is.EqualTo(StatusCodes.BadConfigurationError));
|
|
Assert.That(sre.Message, Does.Contain("CertificateType is not supported"));
|
|
Assert.That(
|
|
sre.Message,
|
|
Does.Contain(ObjectTypeIds.EccCurve25519ApplicationCertificateType.ToString()));
|
|
}
|
|
|
|
[Test]
|
|
public void SupportedApplicationCertificateSurvivesAnUnsupportedSibling()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates =
|
|
[
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
SubjectName = "CN=Test",
|
|
CertificateType = ObjectTypeIds.EccCurve25519ApplicationCertificateType
|
|
},
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
SubjectName = "CN=Test"
|
|
}
|
|
],
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
};
|
|
|
|
Assert.That(configuration.ApplicationCertificates, Has.Count.EqualTo(1));
|
|
Assert.That(
|
|
configuration.ApplicationCertificates[0].CertificateType,
|
|
Is.EqualTo(ObjectTypeIds.RsaSha256ApplicationCertificateType));
|
|
|
|
// the unsupported sibling is only logged, it must not fail validation
|
|
configuration.Validate(telemetry);
|
|
}
|
|
|
|
[Test]
|
|
public void EmptyApplicationCertificatesStillReportsTheClassicError()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates = [],
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
};
|
|
|
|
ServiceResultException sre = Assert.Throws<ServiceResultException>(
|
|
() => configuration.Validate(telemetry));
|
|
|
|
Assert.That(sre.Code, Is.EqualTo(StatusCodes.BadConfigurationError));
|
|
Assert.That(sre.Message, Does.Contain("ApplicationCertificate must be specified."));
|
|
}
|
|
|
|
[Test]
|
|
public void ClearingApplicationCertificatesRebuildsSupportedSecurityPolicies()
|
|
{
|
|
var configuration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates =
|
|
[
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
SubjectName = "CN=Test",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
}
|
|
]
|
|
};
|
|
|
|
Assert.That(
|
|
configuration.SupportedSecurityPolicies.ToArray(),
|
|
Contains.Item(SecurityPolicies.Basic256Sha256));
|
|
|
|
configuration.ApplicationCertificates = [];
|
|
|
|
Assert.That(configuration.ApplicationCertificates, Is.Empty);
|
|
Assert.That(
|
|
configuration.SupportedSecurityPolicies.ToArray(),
|
|
Is.EqualTo(new[] { SecurityPolicies.None }));
|
|
}
|
|
|
|
[Test]
|
|
public void LoadingConfigurationWithApplicationCertificateShouldMarkItDeprecated()
|
|
{
|
|
string file = Path.Combine(TestContext.CurrentContext.WorkDirectory, "testlegacyconfig.xml");
|
|
|
|
using var stream = new FileStream(file, FileMode.Open, FileAccess.Read);
|
|
ApplicationConfiguration reloadedConfiguration = DecodeApplicationConfiguration(stream);
|
|
|
|
Assert.That(
|
|
reloadedConfiguration.SecurityConfiguration.IsDeprecatedConfiguration,
|
|
Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void LoadingConfigurationWithApplicationCertificateAndApplicationCertificatesShouldNotMarkItDeprecated()
|
|
{
|
|
string file = Path.Combine(TestContext.CurrentContext.WorkDirectory, "testhybridconfig.xml");
|
|
|
|
using var stream = new FileStream(file, FileMode.Open, FileAccess.Read);
|
|
ApplicationConfiguration reloadedConfiguration = DecodeApplicationConfiguration(stream);
|
|
|
|
Assert.That(
|
|
reloadedConfiguration.SecurityConfiguration.IsDeprecatedConfiguration,
|
|
Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public async Task FindApplicationCertificateUsesAbstractApplicationCertificateAsFallbackAsync()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
using Certificate certificate = CertificateFactory
|
|
.CreateCertificate("CN=Abstract Application Certificate")
|
|
.CreateForRSA();
|
|
var certificateIdentifier = new CertificateIdentifier
|
|
{
|
|
RawData = certificate.RawData,
|
|
CertificateType = ObjectTypeIds.ApplicationCertificateType
|
|
};
|
|
var securityConfiguration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates = [certificateIdentifier]
|
|
};
|
|
|
|
using Certificate result = (await securityConfiguration.FindApplicationCertificateAsync(
|
|
SecurityPolicies.Basic256Sha256,
|
|
privateKey: false,
|
|
telemetry: telemetry).ConfigureAwait(false))!;
|
|
|
|
Assert.That(result, Is.Not.Null);
|
|
Assert.That(result.Thumbprint, Is.EqualTo(certificate.Thumbprint));
|
|
Assert.That(
|
|
certificateIdentifier.CertificateType,
|
|
Is.EqualTo(ObjectTypeIds.ApplicationCertificateType));
|
|
}
|
|
|
|
[Test]
|
|
public void SavingConfigurationShouldNotMarkItDeprecated()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var securityConfiguration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates =
|
|
[
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
}
|
|
],
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
};
|
|
|
|
var configuration = new ApplicationConfiguration(telemetry)
|
|
{
|
|
ApplicationName = "DeprecatedConfigurationTest",
|
|
ApplicationUri = "urn:localhost:DeprecatedConfigurationTest",
|
|
ApplicationType = ApplicationType.Server,
|
|
SecurityConfiguration = securityConfiguration
|
|
};
|
|
|
|
string xml = EncodeApplicationConfiguration(configuration);
|
|
|
|
using var readStream = new MemoryStream(Encoding.UTF8.GetBytes(xml));
|
|
ApplicationConfiguration reloadedConfiguration = DecodeApplicationConfiguration(readStream);
|
|
|
|
Assert.That(
|
|
reloadedConfiguration.SecurityConfiguration.IsDeprecatedConfiguration,
|
|
Is.False,
|
|
"Deserializing a configuration that uses ApplicationCertificates should not mark it deprecated via the legacy ApplicationCertificate setter.");
|
|
}
|
|
|
|
[Test]
|
|
public void DeprecatedConfigurationRoundTripsWithLegacyElement()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new ApplicationConfiguration(telemetry)
|
|
{
|
|
ApplicationName = "DeprecatedConfigurationTest",
|
|
ApplicationUri = "urn:localhost:DeprecatedConfigurationTest",
|
|
ApplicationType = ApplicationType.Server,
|
|
SecurityConfiguration = new SecurityConfiguration
|
|
{
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
};
|
|
|
|
configuration.SecurityConfiguration.ApplicationCertificate = new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
};
|
|
|
|
string xml = EncodeApplicationConfiguration(configuration);
|
|
|
|
var document = XDocument.Parse(xml);
|
|
using var readStream = new MemoryStream(Encoding.UTF8.GetBytes(xml));
|
|
ApplicationConfiguration roundTripped = DecodeApplicationConfiguration(readStream);
|
|
|
|
Assert.That(roundTripped, Is.Not.Null);
|
|
Assert.That(configuration.SecurityConfiguration.IsDeprecatedConfiguration, Is.True);
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificate", Namespaces.OpcUaConfig)).Any(),
|
|
Is.True,
|
|
"Legacy ApplicationCertificate element should be present for deprecated configurations.");
|
|
}
|
|
|
|
[Test]
|
|
public void ModernConfigurationOmitsLegacyElement()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new ApplicationConfiguration(telemetry)
|
|
{
|
|
ApplicationName = "ModernConfigurationTest",
|
|
ApplicationUri = "urn:localhost:ModernConfigurationTest",
|
|
ApplicationType = ApplicationType.Server,
|
|
SecurityConfiguration = new SecurityConfiguration
|
|
{
|
|
ApplicationCertificates =
|
|
[
|
|
new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
}
|
|
],
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
};
|
|
|
|
string xml = EncodeApplicationConfiguration(configuration);
|
|
|
|
var document = XDocument.Parse(xml);
|
|
using var readStream = new MemoryStream(Encoding.UTF8.GetBytes(xml));
|
|
ApplicationConfiguration roundTripped = DecodeApplicationConfiguration(readStream);
|
|
|
|
Assert.That(roundTripped, Is.Not.Null);
|
|
Assert.That(configuration.SecurityConfiguration.IsDeprecatedConfiguration, Is.False);
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificate", Namespaces.OpcUaConfig)).Any(),
|
|
Is.False,
|
|
"Modern configurations should not emit the legacy ApplicationCertificate element.");
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificates", Namespaces.OpcUaConfig)).Any(),
|
|
Is.True,
|
|
"Modern configurations should emit the ApplicationCertificates element.");
|
|
}
|
|
|
|
[Test]
|
|
public void DeprecatedConfigurationAlsoEmitsApplicationCertificatesElement()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var configuration = new ApplicationConfiguration(telemetry)
|
|
{
|
|
ApplicationName = "DeprecatedNoListConfig",
|
|
ApplicationUri = "urn:localhost:DeprecatedNoListConfig",
|
|
ApplicationType = ApplicationType.Server,
|
|
SecurityConfiguration = new SecurityConfiguration
|
|
{
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
};
|
|
|
|
configuration.SecurityConfiguration.ApplicationCertificate = new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
};
|
|
|
|
string xml = EncodeApplicationConfiguration(configuration);
|
|
|
|
var document = XDocument.Parse(xml);
|
|
|
|
Assert.That(configuration.SecurityConfiguration.IsDeprecatedConfiguration, Is.True);
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificate", Namespaces.OpcUaConfig)).Any(),
|
|
Is.True,
|
|
"Legacy ApplicationCertificate element should be present for deprecated configurations.");
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificates", Namespaces.OpcUaConfig)).Any(),
|
|
Is.True,
|
|
"The IEncodeable encoder always emits ApplicationCertificates when the collection is populated.");
|
|
}
|
|
|
|
[Test]
|
|
public void HybridConfigurationPrefersModernElementOnSave()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
|
|
var legacyCert = new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
};
|
|
|
|
var modernCert = new CertificateIdentifier
|
|
{
|
|
StoreType = CertificateStoreType.Directory,
|
|
StorePath = "pki/own-modern",
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType
|
|
};
|
|
|
|
var configuration = new ApplicationConfiguration(telemetry)
|
|
{
|
|
ApplicationName = "HybridConfiguration",
|
|
ApplicationUri = "urn:localhost:HybridConfiguration",
|
|
ApplicationType = ApplicationType.Server,
|
|
SecurityConfiguration = new SecurityConfiguration
|
|
{
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
};
|
|
|
|
// First set legacy to mark deprecated, then set the modern collection.
|
|
configuration.SecurityConfiguration.ApplicationCertificate = legacyCert;
|
|
configuration.SecurityConfiguration.ApplicationCertificates = [modernCert];
|
|
|
|
string xml = EncodeApplicationConfiguration(configuration);
|
|
|
|
var document = XDocument.Parse(xml);
|
|
using var readStream = new MemoryStream(Encoding.UTF8.GetBytes(xml));
|
|
ApplicationConfiguration roundTripped = DecodeApplicationConfiguration(readStream);
|
|
|
|
Assert.That(configuration.SecurityConfiguration.IsDeprecatedConfiguration, Is.False);
|
|
Assert.That(roundTripped.SecurityConfiguration.IsDeprecatedConfiguration, Is.False);
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificate", Namespaces.OpcUaConfig)).Any(),
|
|
Is.False,
|
|
"Hybrid configurations should serialize as modern and omit the legacy element.");
|
|
Assert.That(
|
|
document.Descendants(XName.Get("ApplicationCertificates", Namespaces.OpcUaConfig)).Any(),
|
|
Is.True,
|
|
"Hybrid configurations should serialize the modern ApplicationCertificates element.");
|
|
Assert.That(roundTripped.SecurityConfiguration.ApplicationCertificates, Has.Count.EqualTo(1));
|
|
}
|
|
|
|
private static IEnumerable<TestCaseData> GetInvalidConfigurations()
|
|
{
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] }
|
|
}
|
|
).SetName("NoStores");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = string.Empty },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("InvalidTrustedStore");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList
|
|
{
|
|
StorePath = string.Empty
|
|
}
|
|
}
|
|
).SetName("InvalidIssuerStore");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedHttpsCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("OnlyTrustedHttps");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
HttpsIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("OnlyIssuerHttps");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
HttpsIssuerCertificates = new CertificateTrustList { StorePath = string.Empty },
|
|
TrustedHttpsCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("InvalidHttpsIssuer");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
HttpsIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedHttpsCertificates = new CertificateTrustList { StorePath = string.Empty }
|
|
}
|
|
).SetName("InvalidHttpsTrusted");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedUserCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("OnlyTrustedUser");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
UserIssuerCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("OnlyIssuerUser");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
UserIssuerCertificates = new CertificateTrustList { StorePath = string.Empty },
|
|
TrustedUserCertificates = new CertificateTrustList { StorePath = "Test" }
|
|
}
|
|
).SetName("InvalidUserIssuer");
|
|
|
|
yield return new TestCaseData(
|
|
new SecurityConfiguration
|
|
{
|
|
ApplicationCertificate = new CertificateIdentifier { RawData = [] },
|
|
TrustedPeerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
UserIssuerCertificates = new CertificateTrustList { StorePath = "Test" },
|
|
TrustedUserCertificates = new CertificateTrustList { StorePath = string.Empty }
|
|
}
|
|
).SetName("InvalidUserTrusted");
|
|
}
|
|
|
|
private static IServiceMessageContext CreateMessageContext()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
using IDisposable scope = AmbientMessageContext.SetScopedContext(telemetry);
|
|
return AmbientMessageContext.CurrentContext
|
|
?? ServiceMessageContext.CreateEmpty(telemetry);
|
|
}
|
|
|
|
private static ApplicationConfiguration DecodeApplicationConfiguration(Stream stream)
|
|
{
|
|
IServiceMessageContext ctx = CreateMessageContext();
|
|
var parser = new XmlParser(typeof(ApplicationConfiguration), stream, ctx);
|
|
var config = new ApplicationConfiguration();
|
|
config.Decode(parser);
|
|
return config;
|
|
}
|
|
|
|
private static string EncodeApplicationConfiguration(
|
|
ApplicationConfiguration configuration)
|
|
{
|
|
IServiceMessageContext ctx = CreateMessageContext();
|
|
using var stream = new MemoryStream();
|
|
XmlWriterSettings settings = Utils.DefaultXmlWriterSettings();
|
|
settings.Encoding = new UTF8Encoding(false);
|
|
using (var writer = XmlWriter.Create(stream, settings))
|
|
{
|
|
var encoder = new XmlEncoder(
|
|
typeof(ApplicationConfiguration), writer, ctx);
|
|
configuration.Encode(encoder);
|
|
encoder.Close();
|
|
}
|
|
|
|
return Encoding.UTF8.GetString(stream.ToArray());
|
|
}
|
|
}
|
|
}
|