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
OPC UA server (.NET 10 AnyCPU) that exposes a fleet of industrial drivers as a single OPC UA address space. Drivers ship in-process for AVEVA System Platform Galaxy (via the sibling mxaccessgw repo), Modbus TCP, Siemens S7, Allen-Bradley CIP (ControlLogix / CompactLogix), Allen-Bradley Legacy (SLC 500 / MicroLogix), Beckhoff TwinCAT (ADS), FANUC FOCAS, and OPC UA Client (gateway).
A cross-platform client stack (.NET 10) — shared library, CLI, and Avalonia desktop app — connects to any OPC UA server.
Architecture
OPC UA Clients (CLI, Desktop UI, 3rd-party)
|
v
+-------------------------------------+
| OtOpcUa.Server (.NET 10 AnyCPU) |
| address space + capability fan-out|
+-------------------------------------+
| | | | | | | |
Galaxy Modbus S7 AbCip AbLeg TwinCAT FOCAS OpcUaClient
|
v
mxaccessgw (sibling repo, gRPC)
|
v
MXAccess COM (x86 worker, on AVEVA box)
Galaxy is the only driver with an external runtime: it speaks gRPC to a separately installed mxaccessgw server (sibling repo at c:\Users\dohertj2\Desktop\mxaccessgw\) which owns the MXAccess COM apartment and the x86/STA bitness constraint server-side. Everything in this repo is platform-agnostic .NET 10.
Prerequisites
- .NET 10 SDK (server, drivers, clients all target .NET 10)
- SQL Server reachable for the central config DB
- For Galaxy specifically: a running
mxaccessgwdeployment — see docs/v2/Galaxy.ParityRig.md - For Wonderware Historian read-back: optional
OtOpcUaWonderwareHistoriansidecar — see docs/ServiceHosting.md
Quick Start
dotnet restore ZB.MOM.WW.OtOpcUa.slnx
dotnet build ZB.MOM.WW.OtOpcUa.slnx
dotnet test ZB.MOM.WW.OtOpcUa.slnx
# Run the server in dev (foreground)
dotnet run --project src/Server/ZB.MOM.WW.OtOpcUa.Server
The server starts on opc.tcp://localhost:4840 with the None security profile. Configure Security.Profiles in src/Server/ZB.MOM.WW.OtOpcUa.Server/appsettings.json to enable Basic256Sha256-Sign or Basic256Sha256-SignAndEncrypt. See docs/security.md.
Install as Windows Services
Production deployment is driven by scripts/install/Install-Services.ps1, which registers the OtOpcUa server service (and optionally the OtOpcUaWonderwareHistorian sidecar) under a chosen service account. Galaxy support requires a separately installed mxaccessgw — neither this repo nor the install script provisions it.
.\scripts\install\Install-Services.ps1 `
-InstallRoot 'C:\Program Files\OtOpcUa' `
-ServiceAccount 'DOMAIN\svc-otopcua'
Add -InstallWonderwareHistorian for the historian sidecar. See the script header and docs/ServiceHosting.md for full options.
Client CLI
dotnet run --project src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI -- connect -u opc.tcp://localhost:4840
dotnet run --project src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI -- browse -u opc.tcp://localhost:4840 -r -d 3
dotnet run --project src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI -- read -u opc.tcp://localhost:4840 -n "ns=2;s=SomeNode"
dotnet run --project src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI -- write -u opc.tcp://localhost:4840 -n "ns=2;s=SomeNode" -v 42
dotnet run --project src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI -- subscribe -u opc.tcp://localhost:4840 -n "ns=2;s=SomeNode" -i 500
See docs/Client.CLI.md and docs/Client.UI.md.
Documentation
Architecture deep-dives
| Topic | Doc |
|---|---|
| OPC UA server composition, namespace fan-out, Polly invoker | docs/OpcUaServer.md |
| Address space layout | docs/AddressSpace.md |
| Read / Write dispatch (driver vs virtual vs scripted-alarm) | docs/ReadWriteOperations.md |
| Incremental sync (driver-backend rediscovery + config publishes) | docs/IncrementalSync.md |
| Service hosting (Server + Admin + optional historian sidecar) | docs/ServiceHosting.md |
| Security (transport, LDAP, certificates) | docs/security.md |
| Redundancy | docs/Redundancy.md |
| Status dashboard | docs/StatusDashboard.md |
Drivers
| Topic | Doc |
|---|---|
| Driver specs (per-driver capability surface, config, addressing) | docs/v2/driver-specs.md |
| Galaxy driver | docs/drivers/Galaxy.md |
| Modbus / S7 / AbCip / AbLegacy / TwinCAT / FOCAS / OpcUaClient | docs/drivers/ |
| Galaxy parity rig (mxaccessgw setup) | docs/v2/Galaxy.ParityRig.md |
| Galaxy performance + tracing | docs/v2/Galaxy.Performance.md |
Clients
| Topic | Doc |
|---|---|
| Client CLI | docs/Client.CLI.md |
| Client UI (Avalonia desktop) | docs/Client.UI.md |
v1 archive
The original v1 in-process MXAccess docs (Galaxy.Host topology, Configuration env vars, AlarmTracking, DataTypeMapping, HistoricalDataAccess, Subscriptions, etc.) are preserved under docs/v1/ — historical reference only. PR 7.2 retired the v1 architecture on 2026-04-30; current state is documented in the sections above.
License
Internal use only.