Joseph Doherty
544a6ddb77
Resolves the 35 findings from the 2026-06-01 baseline (commit 26ba1c7),
test-first for every behavioral change. +51 tests (331 -> 382 passing, 0 failed).
- Telemetry-001 (HIGH): RedactionEnricher now honours property removal, so a
redactor that drops a key actually scrubs the secret from the event.
- Auth: LDAP validator ValidateOnStart; API-key verify no longer fails on a
best-effort MarkUsed write or a corrupt scopes column (fail-closed); LDAP cert
validation hook; KeyPrefix persistence aligned; README algorithm corrected.
- Health: Akka checks return Degraded (not throw) when the cluster isn't up yet;
GrpcDependencyHealthCheck catch-all; null 'description' rendered; composite
endpoint builder; XML docs shipped.
- Audit: CompositeAuditWriter no longer re-throws OperationCanceledException;
TruncatingAuditRedactor over-redact scrubs Target + safe negative max; options
record; XML docs shipped.
- Configuration: TryAddEnumerable idempotent registration; consistent port
quoting; strict invariant port parsing; XML docs + README packaged.
- Theme: mobile toggle is now CSS-only (no Bootstrap JS); token/CSS hygiene;
XML docs on the public parameter surface.
Shared-contract/spec docs updated where the code was the source of truth
(observability service.instance.id, MapZbMetrics, redactor reach). All changes
additive/back-compatible at v0.1.0. code-reviews bookkeeping follows separately.
ZB.MOM.WW.Audit
Canonical audit event model, best-effort writer seam, and redactor seam for the ZB.MOM.WW SCADA family (OtOpcUa, MxAccessGateway, ScadaBridge). This is a library, not a service — it is linked directly into the consuming application at build time. Transport and storage remain per-project; only the shared record + seams live here.
Packages
| Package | Description | Key Dependencies |
|---|---|---|
ZB.MOM.WW.Audit |
Canonical AuditEvent record, AuditOutcome enum, IAuditWriter + IAuditRedactor seams, shipped helpers (NullAuditRedactor, TruncatingAuditRedactor, NoOpAuditWriter, CompositeAuditWriter, RedactingAuditWriter), and AddZbAudit DI extension. |
Microsoft.Extensions.DependencyInjection.Abstractions |
Consumer Matrix
| Consumer | ZB.MOM.WW.Audit |
|---|---|
| OtOpcUa | yes (adoption deferred) |
| MxAccessGateway | yes (adoption deferred) |
| ScadaBridge | yes (adoption deferred — "align, don't replace") |
Adoption is tracked in components/audit/GAPS.md in the outer scadaproj workspace. Each app brings its own transport (Akka broadcast / SQLite append / SQL ingest) and domain vocabulary (channels / kinds / event-types) — those stay per-project. The shared library provides the canonical record and the two seams that decouple "what to audit" from "how to store it".
Auth alignment
AuditEvent.Actor is a string today. At adoption time it SHOULD be set to the ZB.MOM.WW.Auth principal identifier — this is the "audit closes the loop on Auth" hinge described in the spec. No compile-time dependency on ZB.MOM.WW.Auth is introduced here; the alignment is by convention.
Versioning
The single package is versioned from Directory.Build.props. The current release is 0.1.0. A single version bump in Directory.Build.props bumps the package.
Building and packing
# From ZB.MOM.WW.Audit/
dotnet build ZB.MOM.WW.Audit.slnx
dotnet test ZB.MOM.WW.Audit.slnx
# Produce the NuGet package into ./artifacts/
./build/pack.sh
Design documentation
Full design docs live in the components/audit folder of the SCADA project workspace:
~/Desktop/scadaproj-audit/components/audit/spec/SPEC.md— overall audit specification~/Desktop/scadaproj-audit/components/audit/spec/EVENT-MODEL.md— field-by-field event model + per-project mapping table~/Desktop/scadaproj-audit/components/audit/shared-contract/ZB.MOM.WW.Audit.md— public API contract (on paper)~/Desktop/scadaproj-audit/components/audit/GAPS.md— adoption backlog