mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-24 19:13:02 +08:00
## Proposed changes Fixes #4857. The stack's log messages wrote network addresses (endpoint, discovery and reverse connect URLs, host names, IP addresses, ports), application and user identities, file paths and exception texts as plain parameters. Applications had no reliable way to keep them out of general-purpose logs. This PR replaces the stack's own redaction mechanism with the standard .NET [data classification and redaction](https://learn.microsoft.com/dotnet/core/extensions/data-redaction) packages. Each sensitive `[LoggerMessage]` parameter is classified. The application decides per classification what reaches its logs: erase it, replace it with an HMAC token so entries stay correlatable, or pass it through. ### Taxonomy `Opc.Ua.Redaction.OpcUaDataClassifications` defines the `OpcUa` taxonomy and one attribute per classification: | Classification | Used for | Parameters | |---|---|---| | `[NetworkAddress]` | URLs, host and domain names, IP/MAC addresses, end points, ports | 120 | | `[ApplicationIdentity]` | certificates, subject, issuer, thumbprint, ApplicationUri | 103 | | `[FilePath]` | file, directory and certificate store paths | 67 | | `[SensitiveText]` | exception or remote-supplied text passed as a parameter | 55 | | `[UserIdentity]` | user names, token subjects | 7 | Correlation ids (`ChannelId`, `SessionId`, ...), status codes and NodeIds stay unclassified. ### Pipeline and defaults - Opc.Ua.Core now references `Microsoft.Extensions.Telemetry(.Abstractions)` 10.11.0, so every project above Core uses the `Microsoft.Gen.Logging` generator. Opc.Ua.Client already did, through Http.Resilience. The packages ship net462 and netstandard2.0 builds, so net48 is supported. - **A plain `ILoggerFactory` logs `(null)` in place of classified values.** Classified values are only written by the redaction-aware logger. - The new `ILoggingBuilder.EnableOpcUaRedaction()` turns that logger on. It is `EnableRedaction()` with the discriminator off; otherwise every unredacted value gets `:ParamName` appended. `AddOpcUa().AddLogging(...)` and `DefaultTelemetry.Create(...)` call it, as do the samples, so they log the same information as before until redactors are registered. - `services.AddOpcUa()` alone does not change the host's logging. Generic-host apps call `builder.Logging.EnableOpcUaRedaction()`. This is documented as a behavior-breaking change in `docs/migrate/2.0.x/telemetry.md`. ### Obsolete API `Redact`, `RedactionWrapper<T>`, `IRedactionStrategy`, `RedactionStrategies` and `SimpleRedactionStrategy` are `[Obsolete]`. They still work, but the stack no longer uses them. ### Not classified - The `Exception` passed to a log call. Applications can drop exception messages with `LoggerEnrichmentOptions.IncludeExceptionMessage`. - Exception and `ServiceResult` message texts. - `ServiceResult`/`StatusCode` parameters and logged data values. - The few log calls whose level is decided at run time. - `Opc.Ua.Vision.OpenUsd`, which references only Opc.Ua.Types and cannot see the attributes. ### Generator behavior differences These are visible to log consumers and to tests: - `IFormattable` values such as `NodeId` are stored in the structured state as invariant strings, not as objects. - The generated log state is a thread-local object that is cleared after the call. - Classified values are pooled redactor objects, valid only during the `Log` call. Tests that inspected log state after the fact now capture it during the call. The shared `RecordingLoggerProvider` snapshots classified values. ## Related Issues - Fixes #4857 ## Types of changes - [ ] Bugfix (non-breaking change which fixes an issue) - [x] Enhancement (non-breaking change which adds functionality) - [ ] Test enhancement (non-breaking change to increase test coverage) - [x] Breaking change (fix or feature that would cause existing functionality to not work as expected; plain logger factories drop classified values) - [x] Documentation Update (if none of the other choices apply) ## Checklist - [x] I have read the CONTRIBUTING doc. - [x] I have signed the CLA. - [x] I ran tests locally with my changes, all passed. - [x] I fixed all failing tests in the CI pipelines. - [x] I fixed all introduced issues with CodeQL and LGTM. - [x] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added necessary documentation (if appropriate). - [ ] Any dependent changes have been merged and published in downstream modules. ## Further comments New tests: - `LogClassificationCoverageTests` (Tools.Tests) scans all 104 stack assemblies and fails if an address, identity or path parameter of a `[LoggerMessage]` method is unclassified. - `DataClassificationLoggingTests` (Core.Tests) pins erasing and HMAC redaction, pass-through, the plain-factory drop, and both stack defaults. Local results on net10.0: | Suite | Passed | Failed | |---|---|---| | Core.Tests | 6,489 | 0 | | Client.Tests | 3,231 | 0 | | Tools.Tests | 7,210 | 0 | | PubSub.Tests | 1,536 | 0 | | Core.Diagnostics.Tests | 571 | 0 | | Configuration.Tests | 241 | 0 | - **Server.Tests:** the full run predates the final test fixes and had 12 failures. All 12 were in the fixtures fixed afterwards, which now pass: RoleStateBinding (45/45) and the FileDirectory and compatibility-logging fixtures (74/74 in total). The full Core.Tests and Server.Tests runs were not repeated after those fixes. - **Builds:** `UA.slnx` builds with 0 errors for net10.0 and net48, and the whitespace check passes. - **NativeAOT:** not confirmed locally, because the machine has no C++ linker. A trimmed publish of `Opc.Ua.Aot.Tests` reported no trim or AOT warnings from the stack, the new packages or the generated logging code; its only errors come from the TUnit test framework (`FSharp.Core` not found). The `aot-test` CI job has to confirm the native build. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
190 lines
8.5 KiB
C#
190 lines
8.5 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.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Hosting;
|
|
using Microsoft.Extensions.Logging;
|
|
using Opc.Ua;
|
|
using Opc.Ua.Client;
|
|
using Opc.Ua.MachineTool.Client;
|
|
using TypedClient = Opc.Ua.MachineTool.Client.MachineToolClient;
|
|
|
|
namespace MachineToolSample.Client
|
|
{
|
|
/// <summary>
|
|
/// Runs one bounded, passive-by-default workflow through a managed session and the typed client factory.
|
|
/// </summary>
|
|
internal static class Program
|
|
{
|
|
/// <summary>
|
|
/// Validates local consent before allocating resources and reports cancellation separately.
|
|
/// </summary>
|
|
private static async Task<int> Main(string[] args)
|
|
{
|
|
if (Array.IndexOf(args, "--help") >= 0 || Array.IndexOf(args, "-h") >= 0)
|
|
{
|
|
ClientOptions.PrintHelp();
|
|
return 0;
|
|
}
|
|
using var cancelled = new CancellationTokenSource();
|
|
void Cancel(object? _, ConsoleCancelEventArgs eventArgs)
|
|
{
|
|
eventArgs.Cancel = true;
|
|
cancelled.Cancel();
|
|
}
|
|
Console.CancelKeyPress += Cancel;
|
|
try
|
|
{
|
|
ClientOptions options = ClientOptions.Parse(ArrayOf.Wrapped(args));
|
|
if (options.CancelAfterMilliseconds.HasValue)
|
|
{
|
|
cancelled.CancelAfter(options.CancelAfterMilliseconds.Value);
|
|
}
|
|
await RunAsync(options, cancelled.Token).ConfigureAwait(false);
|
|
return 0;
|
|
}
|
|
catch (OperationCanceledException) when (cancelled.IsCancellationRequested)
|
|
{
|
|
Console.WriteLine("CANCELLED: local request cancelled; no implicit AbortOperation or command retry.");
|
|
return 2;
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
await Console.Error.WriteLineAsync(exception.ToString()).ConfigureAwait(false);
|
|
return 1;
|
|
}
|
|
finally
|
|
{
|
|
Console.CancelKeyPress -= Cancel;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Keeps secure endpoint selection and certificate validation, and releases all owned sessions on every path.
|
|
/// </summary>
|
|
private static async Task RunAsync(ClientOptions options, CancellationToken cancellationToken)
|
|
{
|
|
TimeProvider clock = TimeProvider.System;
|
|
using CancellationTokenSource deadline =
|
|
TimeProviderExtensions.CreateCancellationTokenSource(clock, TimeSpan.FromSeconds(90));
|
|
using var linked = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, deadline.Token);
|
|
CancellationToken ct = linked.Token;
|
|
HostApplicationBuilder builder = Host.CreateApplicationBuilder();
|
|
builder.Logging.ClearProviders();
|
|
builder.Logging.EnableOpcUaRedaction();
|
|
builder.Logging.AddConsole();
|
|
builder.Logging.SetMinimumLevel(LogLevel.Warning);
|
|
builder.Logging.AddFilter("MachineToolSample", LogLevel.Information);
|
|
builder.Services.AddSingleton(clock);
|
|
builder.Services.AddOpcUa()
|
|
.AddClient(client =>
|
|
{
|
|
client.ApplicationName = "MachineToolClient";
|
|
client.ApplicationUri = "urn:localhost:OPCFoundation:MachineToolClient";
|
|
client.ProductUri = "uri:opcfoundation.org:MachineToolClient";
|
|
client.PkiRoot = options.PkiRoot;
|
|
client.AutoAcceptUntrustedCertificates = options.DemoTrust;
|
|
client.Session = new ManagedSessionOptions
|
|
{
|
|
SessionName = "MachineToolClient",
|
|
SessionTimeout = TimeSpan.FromSeconds(30),
|
|
CheckDomain = true,
|
|
TimeProvider = clock
|
|
};
|
|
})
|
|
.AddDiscoveryAndConnect(discovery =>
|
|
{
|
|
discovery.DiscoveryUrl = options.Endpoint;
|
|
discovery.SecurityMode = MessageSecurityMode.SignAndEncrypt;
|
|
discovery.SecurityPolicyUri = SecurityPolicies.Basic256Sha256;
|
|
})
|
|
.AddMachineToolClient();
|
|
IHost host = builder.Build();
|
|
await using (((IAsyncDisposable)host).ConfigureAwait(false))
|
|
{
|
|
ILogger logger = host.Services.GetRequiredService<ITelemetryContext>().CreateLogger<ClientOptions>();
|
|
if (options.DemoTrust)
|
|
{
|
|
logger.LocalDemoTrust();
|
|
}
|
|
try
|
|
{
|
|
await host.StartAsync(ct).ConfigureAwait(false);
|
|
TypedClient client = await host.Services.GetRequiredService<MachineToolClientFactory>()
|
|
.CreateAsync(ct).ConfigureAwait(false);
|
|
ManagedSession session = client.Session as ManagedSession ??
|
|
throw new InvalidOperationException("The configured factory did not return a managed session.");
|
|
try
|
|
{
|
|
await DemoReader.RunAsync(client, options, ct).ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
try
|
|
{
|
|
using CancellationTokenSource close =
|
|
TimeProviderExtensions.CreateCancellationTokenSource(clock, TimeSpan.FromSeconds(10));
|
|
await session.CloseAsync(close.Token).ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
await client.DisposeAsync().ConfigureAwait(false);
|
|
await session.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
Console.WriteLine($"SESSION_CLOSED connected={session.Connected} disposed={session.Disposed}");
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
using CancellationTokenSource cleanup =
|
|
TimeProviderExtensions.CreateCancellationTokenSource(clock, TimeSpan.FromSeconds(20));
|
|
await host.StopAsync(cleanup.Token).ConfigureAwait(false);
|
|
}
|
|
}
|
|
Console.WriteLine("CLIENT_COMPLETE: observations, session and application host disposed.");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Source-generated client policy diagnostics.
|
|
/// </summary>
|
|
internal static partial class ProgramLog
|
|
{
|
|
/// <summary>
|
|
/// Makes the loopback-only trust exception visible without changing message-security selection.
|
|
/// </summary>
|
|
[LoggerMessage(EventId = MachineToolClientEventIds.Program, Level = LogLevel.Warning,
|
|
Message = "LOCAL SIMULATION ONLY: unknown server certificates accepted; SignAndEncrypt still required.")]
|
|
public static partial void LocalDemoTrust(this ILogger logger);
|
|
}
|
|
}
|