Joseph Doherty
b9bdfee189
STRUCTURAL (links-report.md): - Repointed missing src/.../Security/Ldap/LdapAuthService.cs -> the real OtOpcUaLdapAuthService.cs (Ldap/OtOpcUaLdapAuthService.cs implements ILdapAuthService). Class was reorganized as a wrapper over shared ZB.MOM.WW.Auth.Ldap. check_links now clean for docs/security.md. CODE-REALITY — transport profiles (OpcUaApplicationHost.cs:15-23,59-64,374-409): - Only THREE profiles exist: None, Basic256Sha256Sign, Basic256Sha256SignAndEncrypt (NO hyphens, NO underscores). Removed the four fabricated Aes128/Aes256 rows. Config binds by enum-member name; hyphenated form does NOT bind. Documented this + the empty-list fallback to None. - Config section is OpcUa (not OpcUaServer); key is the LIST EnabledSecurityProfiles (not singular SecurityProfile). Program.cs:120 binds 'OpcUa'; Certificates.razor:80 reads OpcUa:PkiStoreRoot. - No SecurityProfileResolver class exists — stated so explicitly. CODE-REALITY — LDAP (LdapOptions.cs:21, OtOpcUaLdapAuthService.cs): - Section is Security:Ldap (LdapOptions.SectionName), not OpcUaServer:Ldap. - Authenticator is OtOpcUaLdapAuthService (wrapper) + LdapOpcUaUserAuthenticator (IOpcUaUserAuthenticator.AuthenticateUserNameAsync), not bespoke LdapUserAuthenticator/IUserAuthenticator. - UseTls bool -> Transport enum (Ldaps/StartTls/None); AllowInsecureLdap -> AllowInsecure. Added Enabled master switch + DevStubMode. - Group->role mapping is downstream via IGroupRoleMapper<string> (OtOpcUaGroupRoleMapper), NOT in the auth service. ILdapGroupsBearer and DenyAllUserAuthenticator do not exist (fallback is NullOpcUaUserAuthenticator). - GroupToRole values corrected to canonical roles (Viewer/Designer/ Administrator/Operator). CODE-REALITY — ACL trie (TriePermissionEvaluator.cs, PermissionTrieCache.cs, NodeScope.cs, NodePermissions.cs): - NodePermissions backing type is int (not uint); lives in Configuration/Enums. - Authorize(UserAuthorizationState, OpcUaOperation, NodeScope) returns AuthorizationDecision. - Evaluator is strictly fail-CLOSED. Removed the fabricated 'fail-open-during-transition' + Authorization:StrictMode key (no StrictMode anywhere in source). - Cache: generation-sealed Install/Invalidate/Prune. AclChangeNotifier does NOT exist — removed. - Added the SystemPlatform (Galaxy) scope hierarchy variant. CODE-REALITY — control plane (AdminRole.cs, ServiceCollectionExtensions.cs: 113-131): - AdminRole members are Viewer/Designer/Administrator (Task 1.7 rename from ConfigViewer/ConfigEditor/FleetAdmin). DriverOperator/FleetAdmin are POLICY names; DriverOperator requires roles Operator|Administrator. CODE-REALITY — analyzer (UnwrappedCapabilityCallAnalyzer.cs:99-103, AnalyzerReleases.Shipped.md): - Confirmed category OtOpcUa.Resilience + severity Warning (already correct). Corrected 'Five tests' (suite has 26 cases) and AlarmSurfaceInvoker wrapper-home wording. OTHER FIXES: - v2 header: removed false AddJwtBearer/IPostConfigureOptions<JwtBearerOptions> claim — auth is Cookie-only; JWT is mint-only via /auth/token for external consumers (JwtTokenService.cs:25-48). - Certificates.razor is a read-only viewer; removed fabricated CertTrustService/CertTrustOptions promote claim. - Audit: writer is AuditWriterActor (not AuditLogService); softened the unverifiable server-side 'AUDIT:' Serilog-prefix claim.
OtOpcUa documentation
Two tiers of documentation live here:
- Current reference at the top level (
docs/*.md) — describes what's shipped today. Start here for operator + integrator reference. - Implementation history + design notes at
docs/v2/*.md— the authoritative plan + decision log the current reference is built from. Start here when you need the why behind an architectural choice, or when a top-level doc says "see plan.md § X".
The project was originally called LmxOpcUa (a single-driver Galaxy/MXAccess OPC UA server) and has since become OtOpcUa, a multi-driver OPC UA server platform. Any lingering LmxOpcUa-string in a path you see in docs is a deliberate residual (executable name lmxopcua-cli, client PKI folder {LocalAppData}/LmxOpcUaClient/) — fixing those requires migration shims + is tracked as follow-ups.
Platform overview
v2 (2026-05-26): the separate
OtOpcUa.Server+OtOpcUa.Adminservices fused into a single role-gatedOtOpcUa.Hostbinary, joined by an Akka.NET cluster. See v2 design for the architectural decision.
- Core owns shared abstractions (driver capability contracts, scripting, virtual tags, alarm historian).
- Drivers plug in via capability interfaces in
ZB.MOM.WW.OtOpcUa.Core.Abstractions:IDriver,IReadable,IWritable,ITagDiscovery,ISubscribable,IHostConnectivityProbe,IAlarmSource,IHistoryProvider,IPerCallHostResolver. Each driver opts into whichever it supports. - Host (
src/Server/ZB.MOM.WW.OtOpcUa.Host) is the single fused binary (.NET 10, AnyCPU).OTOPCUA_ROLESenv decides what to mount:admin(Blazor + control-plane singletons),driver(OPC UA endpoint + per-node actors), or both. See ServiceHosting.md. - Cluster + ControlPlane + Runtime + AdminUI + Security sit between Core and Host. The cluster glues per-node actors into one logical fleet; the control-plane singletons (deploy coordinator, audit writer, redundancy state) live on the admin role-leader. See Redundancy.md.
- The Galaxy driver still reaches MXAccess via gRPC to a separately-installed mxaccessgw sidecar (sibling repo).
Where to find what
Architecture + data-path reference
| Doc | Covers |
|---|---|
| OpcUaServer.md | Top-level server architecture — Core, driver dispatch, Config DB, generations |
| AddressSpace.md | GenericDriverNodeManager + ITagDiscovery + IAddressSpaceBuilder |
| ReadWriteOperations.md | OPC UA Read/Write → CapabilityInvoker → IReadable/IWritable |
| Subscriptions.md | Monitored items → ISubscribable + per-driver subscription refcount (v1 archive) |
| AlarmTracking.md | IAlarmSource + AlarmSurfaceInvoker + OPC UA alarm conditions (v1 archive) |
| DataTypeMapping.md | Per-driver DriverAttributeInfo → OPC UA variable types (v1 archive — live mapping is in src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DataTypeMap.cs) |
| IncrementalSync.md | Address-space rebuild on redeploy + sp_ComputeGenerationDiff |
| HistoricalDataAccess.md | IHistoryProvider as a per-driver optional capability (v1 archive) |
| VirtualTags.md | Core.Scripting + Core.VirtualTags — Roslyn script sandbox, engine, dispatch alongside driver tags |
| ScriptedAlarms.md | Core.ScriptedAlarms — script-predicate IAlarmSource + Part 9 state machine |
Two Core subsystems are shipped without a dedicated top-level doc; see the section in the linked doc:
| Project | See |
|---|---|
Core.AlarmHistorian |
AlarmTracking.md § Alarm historian sink (v1 archive) |
Analyzers (Roslyn OTOPCUA0001) |
security.md § OTOPCUA0001 Analyzer |
Drivers
| Doc | Covers |
|---|---|
| drivers/README.md | Index of the eight shipped drivers + capability matrix |
| drivers/Galaxy.md | Galaxy driver — in-process gRPC client to the mxaccessgw sidecar |
| v1/drivers/Galaxy-Repository.md | Galaxy-specific discovery via the ZB SQL database (v1 archive — the gateway owns this path now) |
For Modbus / S7 / AB CIP / AB Legacy / TwinCAT / FOCAS / OPC UA Client specifics, see v2/driver-specs.md.
Operational
| Doc | Covers |
|---|---|
| Configuration.md | appsettings bootstrap + Config DB + Admin UI draft/publish (v1 archive — OTOPCUA_GALAXY_* env vars now live in mxaccessgw config) |
| security.md | Transport security profiles, LDAP auth, ACL trie, role grants, OTOPCUA0001 analyzer |
| Redundancy.md | RedundancyCoordinator, ServiceLevelCalculator, apply-lease, Prometheus metrics |
| Reservations.md | Fleet-wide ZTag / SAPID external-ID reservations — publish-time claim, release flow |
| ServiceHosting.md | Single fused OtOpcUa.Host binary install/uninstall with OTOPCUA_ROLES gating, plus the optional OtOpcUaWonderwareHistorian sidecar |
| StatusDashboard.md | Pointer — superseded by v2/admin-ui.md |
Client tooling
| Doc | Covers |
|---|---|
| Client.CLI.md | otopcua-cli — OPC UA command-line client |
| Client.UI.md | Avalonia desktop client |
| DriverClis.md | Driver test-client CLIs — index + shared commands |
| Driver.Modbus.Cli.md | otopcua-modbus-cli — Modbus-TCP |
| Driver.AbCip.Cli.md | otopcua-abcip-cli — ControlLogix / CompactLogix / Micro800 / GuardLogix |
| Driver.AbLegacy.Cli.md | otopcua-ablegacy-cli — SLC / MicroLogix / PLC-5 (PCCC) |
| Driver.S7.Cli.md | otopcua-s7-cli — Siemens S7-300 / S7-400 / S7-1200 / S7-1500 |
| Driver.TwinCAT.Cli.md | otopcua-twincat-cli — Beckhoff TwinCAT 2/3 ADS |
| Driver.FOCAS.Cli.md | otopcua-focas-cli — Fanuc FOCAS/2 CNC |
Requirements
| Doc | Covers |
|---|---|
| reqs/HighLevelReqs.md | HLRs — numbered system-level requirements |
| reqs/OpcUaServerReqs.md | OPC UA server-layer reqs |
| v1/reqs/ServiceHostReqs.md | Per-process hosting reqs (v1 archive — only OtOpcUa server hosting remains in scope post-PR-7.2) |
| reqs/ClientRequirements.md | Client CLI + UI reqs |
| v1/reqs/GalaxyRepositoryReqs.md | Galaxy-scoped repository reqs (v1 archive — owned by mxaccessgw today) |
| v1/reqs/MxAccessClientReqs.md | Galaxy-scoped MXAccess reqs (v1 archive — owned by mxaccessgw today) |
| reqs/StatusDashboardReqs.md | Pointer — superseded by Admin UI |
Implementation history (docs/v2/)
Design decisions + phase plans + execution notes. Load-bearing cross-references from the top-level docs:
- v2/plan.md — authoritative v2 vision doc + numbered decision log (referenced as "decision #N" elsewhere)
- v2/admin-ui.md — Admin UI spec
- v2/acl-design.md — data-plane ACL + permission-trie design (Phase 6.2)
- v2/config-db-schema.md — Config DB schema reference
- v2/driver-specs.md — per-driver addressing + quirks for every shipped protocol
- v2/dev-environment.md — dev-box bootstrap
- v2/test-data-sources.md — integration-test simulator matrix (includes the pinned libplctag
ab_serverversion for AB CIP tests) - v2/multi-host-dispatch.md — per-PLC circuit breakers (Phase 6.1 decision #144)
- v2/v2-release-readiness.md — release-readiness tracker
- v2/phase-7-status.md — Phase 7 reconciliation: what shipped vs. the plan, and the five remaining gaps
- v2/implementation/phase--.md — per-phase execution plans with exit-gate evidence
v1 archive
The v1 in-process MXAccess architecture (Galaxy.Host + Galaxy.Proxy + Galaxy.Shared, .NET 4.8 x86 COM, the OtOpcUaGalaxyHost Windows service) was retired in PR 7.2 (2026-04-30, commit ae7106d). Docs that described that shape are kept under v1/ as historical record — see v1/README.md for the index.