Files
UA-.NETStandard/samples/Vision/MachineVisionClient/Program.cs
f6b27025a6 Classify sensitive log parameters with Microsoft.Extensions.Compliance data classification (#4864)
## 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>
2026-10-21 09:47:07 +00:00

166 lines
8.6 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.IO;
using System.Text;
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.Client.StateMachines;
using Opc.Ua.Vision.Client;
using Opc.Ua.Vision.MachineVision;
HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Logging.EnableOpcUaRedaction();
string url = builder.Configuration["endpoint"] ?? "opc.tcp://localhost:62550/MachineVision";
string? insecureOption = builder.Configuration["insecure"];
bool insecure = false;
if (insecureOption != null && !bool.TryParse(insecureOption, out insecure))
{
throw new ArgumentException("--insecure requires true or false.", nameof(args));
}
ITelemetryContext telemetry = DefaultTelemetry.Create(logging => logging.SetMinimumLevel(LogLevel.Warning));
using var cancellation = new CancellationTokenSource(TimeSpan.FromSeconds(60));
CancellationToken ct = cancellation.Token;
EndpointDescription? selected = null;
using (DiscoveryClient discovery = await DiscoveryClient.CreateAsync(new Uri(url), telemetry, ct: ct)
.ConfigureAwait(false))
{
GetEndpointsResponse endpoints = await discovery.GetEndpointsAsync(null, url, [], [], ct).ConfigureAwait(false);
foreach (EndpointDescription endpoint in endpoints.Endpoints)
{
if (endpoint.SecurityMode == MessageSecurityMode.SignAndEncrypt &&
endpoint.SecurityPolicyUri == SecurityPolicies.Basic256Sha256)
{
selected = endpoint;
break;
}
}
}
if (selected == null)
{
throw new InvalidOperationException("The demonstrator requires a Basic256Sha256 SignAndEncrypt endpoint.");
}
builder.Services.AddOpcUa().AddClient(options =>
{
options.ApplicationName = "MachineVisionClient";
options.ApplicationUri = "urn:localhost:OPCFoundation:MachineVisionClient";
options.PkiRoot = builder.Configuration["pki"] ?? Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
"OPCFoundation", "MachineVisionClient", "pki");
options.AutoAcceptUntrustedCertificates = insecure;
options.Session = new ManagedSessionOptions
{
Endpoint = new ConfiguredEndpoint(null, selected, null),
SessionName = "MachineVisionClient"
};
}).AddVisionClient();
using IHost host = builder.Build();
VisionClient vision = await host.Services.GetRequiredService<Func<CancellationToken, Task<VisionClient>>>()(ct)
.ConfigureAwait(false);
if (vision.Session is not ManagedSession session)
{
throw new InvalidOperationException("The client factory did not provide a managed session.");
}
await using (session.ConfigureAwait(false))
{
MachineVisionClient client = vision.MachineVision();
await foreach (VisionNodeEntry entry in client.EnumerateSystemsAsync(cancellationToken: ct).ConfigureAwait(false))
{
Console.WriteLine($"System {entry.BrowseName}: {entry.NodeId}");
MachineVisionSystemClient system = client.System(entry.NodeId);
VisionStateMachineTypeClient control = await system.ControlAsync(ct).ConfigureAwait(false);
FiniteStateSnapshot state = await control.GetCurrentFiniteStateAsync(ct).ConfigureAwait(false);
if (state.CurrentState.Text == "Preoperational")
{
MachineVisionSystemClient.ThrowIfDomainError(
await control.SelectModeAutomaticAsync(ct).ConfigureAwait(false),
"SelectModeAutomatic");
}
using var recipeContent = new MemoryStream(Encoding.UTF8.GetBytes("deterministic-inspection-recipe"));
RecipeIdInternalDataType recipe = await system.UploadRecipeAsync(
new RecipeIdExternalDataType { Id = "sample-recipe" },
new ProductIdDataType { Id = "sample-product" }, recipeContent, ct).ConfigureAwait(false);
RecipeManagementTypeClient recipes = await system.RecipesAsync(ct).ConfigureAwait(false);
var prepared = await recipes.PrepareRecipeAsync(new RecipeIdExternalDataType(), recipe, ct)
.ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(prepared.error, "PrepareRecipe");
VisionAutomaticModeStateMachineTypeClient automatic = await system.AutomaticAsync(ct).ConfigureAwait(false);
var started = await automatic.StartSingleJobAsync(
new MeasIdDataType { Id = "sample-measurement" }, new PartIdDataType(),
new RecipeIdExternalDataType { Id = "sample-recipe" },
new ProductIdDataType { Id = "sample-product" }, [], ct).ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(started.error, "StartSingleJob");
await automatic.WaitForStateAsync(
session.DefaultStreaming,
NodeId.Create(VisionAutomaticModeStateMachineTypeIds.StateIds.Ready,
Opc.Ua.Vision.MachineVision.Namespaces.MachineVision, session.NamespaceUris),
TimeSpan.FromSeconds(15), ct: ct).ConfigureAwait(false);
ResultManagementTypeClient results = await system.ResultsAsync(ct).ConfigureAwait(false);
var page = await results.GetResultListFilteredAsync(
0, new MeasIdDataType(), new PartIdDataType(), new RecipeIdExternalDataType(),
new RecipeIdInternalDataType(), new ConfigurationIdDataType(), new ConfigurationIdDataType(),
new ProductIdDataType(), started.jobId, 10, 0, 0, ct).ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(page.error, "GetResultListFiltered");
foreach (ResultDataType result in page.resultList)
{
Console.WriteLine(
$"Result {result.ResultId.Id}: state={result.ResultState}, simulated={result.IsSimulated}");
}
MachineVisionSystemClient.ThrowIfDomainError(
await results.ReleaseResultHandleAsync(page.resultHandle, ct).ConfigureAwait(false), "ReleaseResultHandle");
ArrayOf<NodeId> pipelines = await vision.DiscoverPipelinesAsync(ct).ConfigureAwait(false);
if (!pipelines.IsEmpty)
{
string sharedId = await vision.Pipeline(pipelines[0]).RunInferenceAsync(cancellationToken: ct)
.ConfigureAwait(false);
var shared = await results.GetResultByIdAsync(new ResultIdDataType { Id = sharedId }, 0, ct)
.ConfigureAwait(false);
MachineVisionSystemClient.ThrowIfDomainError(shared.error, "GetResultById");
Console.WriteLine($"Draft and released models share result {shared.result.ResultId.Id}.");
MachineVisionSystemClient.ThrowIfDomainError(
await results.ReleaseResultHandleAsync(shared.resultHandle, ct).ConfigureAwait(false),
"ReleaseResultHandle");
}
}
await foreach (VisionNodeEntry asset in client.EnumerateAssetsAsync(cancellationToken: ct).ConfigureAwait(false))
{
MachineVisionAssetSnapshot snapshot = await client.ReadAssetAsync(asset.NodeId, cancellationToken: ct)
.ConfigureAwait(false);
Console.WriteLine($"Asset {asset.BrowseName}: {snapshot.Values.Count} values, complete={snapshot.IsComplete}");
}
await session.DefaultStreaming.DisposeAsync().ConfigureAwait(false);
await session.CloseAsync(ct).ConfigureAwait(false);
}