# Description Completes the OPC UA Part 11 Historical Access work requested by #4387 and the historian framework integration requested by #4400. The conformance/evidence catalog covers all 37 released UACore 1.05 Historical Access profiles: 15 Server facets and 22 Client facets, together with the standard aggregate functions and their conformance units. Server facets are advertised only when the resolved providers expose their required interfaces and capabilities. ## Server and provider support - Completes raw, modified, at-time, processed, annotation, structured, and event history. - Dispatches best-effort, bulk, and transactional updates with aligned statuses, old values, diagnostics, and rollback state. - Supports mixed history-update detail types and batched structured/annotation operations. - Uses composite identities and exclusive cursors for same-timestamp structured, modified, and event values. - Captures live data and events, installs historical configuration objects, and emits typed audit payloads. - Derives aggregate monitoring filters from per-node historian capabilities and rejects unsupported processed aggregates before provider dispatch. - Supports tri-state `Historizing`: set, clear, or preserve provider-owned state. ## Client support - Exposes modified values together with `ModificationInfo`. - Adds event-history reads and event insert/replace/update/delete operations. - Adds structured and annotation batching with strict response validation. - Shares continuation handling and release-on-abandon across read families. - Accepts inherited standard event fields rooted at event subtypes. ## Review hardening - Registers DI-selected historians before node-manager reconciliation and capability publication, while preserving provider ownership. - Uses committed Raft read barriers for linearizable `TryGetAsync` and `ScanAsync`. - Keeps claimed continuation state immutable until a fresh successor is saved, restoring the original after transient failures. - Uses exact-incarnation compare-and-delete so delayed cleanup cannot remove a restored same-ID continuation. - Cleans up indeterminate initial and replacement saves, and propagates shutdown cancellation through cleanup resolution. - Preserves legacy continuation envelopes/cursors and distinct annotation parent/property identities. - Deletes every structured entry at a requested timestamp and uses the complete modified-history ordering tuple. - Shares native/fallback at-time and AnnotationCount calculations, including reverse endpoints and cross-framework fractional intervals. - Primes modified aggregate items before buffered live delivery and deduplicates history/live overlap using provider-specific identities. - Keeps committed Modify results successful while reporting priming failures through the monitored item's notification queue. - Keeps protected-notification state live-only for queues larger than one. Queue size one retains the newest notification without pinning errors or transferring priority during resizing. Durable restore retains ordinary definitions, last values/errors, and raw queues without recreating priority. - Isolates aggregate calculation, modification preparation, and historical/live handoff in `AggregationFilterHandler`, retaining existing provider/factory wiring and supported past-start behavior. The larger-queue protection policy is unchanged pending the open review discussion. - Uses one `IMonitoringFilter` owner for protocol filters or the aggregation handler, eliminating parallel effective-filter storage and retaining the current definition during preparation. The original client filter stays distinct. - Integrates current master, retaining custom monitored-item creation decisions and per-node history callbacks. ## Redundant-server alignment and samples - Adds a protected shared historian with immutable segments, manifest CAS publication, writer fencing, and restart recovery. - Persists portable continuation state before exposing it to clients and transfers ownership during mirrored-session takeover. - Rejects eventual-consistency and active/active multi-writer historian configurations rather than silently degrading. - ReferenceServer and ConsoleReferenceClient demonstrate discovery, paging, raw/modified/at-time/processed reads, annotation/structured CRUD, event capture, and event CRUD. - RedundantServer and RedundantClient demonstrate active/passive history, continuation recovery after replica termination, and post-promotion writes. - Updates Historical Access, High Availability, profile, migration, and sample documentation. ## Compatibility - New 2.0 collection boundaries use `ArrayOf<T>` and public byte payloads use `ByteString`. - Removes the legacy public virtual `SamplingGroupManager.CreateMonitoredItem` / `ModifyMonitoredItem` entry points and protected creation factory, as agreed in review. Migration guidance points to the monitored-item manager and construction-decision APIs. - Retains established persisted formats and current write layouts. Retired interim notification-state formats (sample v2 / shared v4) are rejected, as agreed in review. - Keeps the historian integration compatible with .NET Framework and NativeAOT. ## Validation ### Latest CI source repair `73c619435` forwards the existing cancellation token at both predefined-node creation calls in the PR-added History event fixture. The merged lifecycle overload exposed these two CA2016 errors, which blocked History jobs, the solution build matrix, and CodeQL on GitHub and Azure. The exact compiler failure was reproduced locally; the repaired fixture passes 4/4 integration cases on net10.0 and 4/4 on net48 with clean scoped diagnostics. No assertions, tests, coverage thresholds, or CI configuration were weakened. The repaired History jobs on Linux/macOS and all four Azure solution builds now pass. The Windows all-TFM GitHub job instead lost its hosted runner's connection; no build log was recoverable, and GitHub recorded a runner-loss annotation rather than a compiler/test diagnostic. One unchanged retry was requested. Remaining checks are monitored with `gh pr checks --watch --fail-fast --interval 30`; CI is not yet reported as green. ### Latest base integration `bd52e5fea` merges upstream `master` at `da7412c42`. The lifecycle conflict retains upstream's shared cancellation-aware registration helper and the historian behavior. The hosted-historian fixture forwards its existing token to the new lifecycle overload. GDS project renames and all three AOT test hosts are retained, with their project references resolving after the merge. | Integrated scope | net10.0 | net48 | | --- | --- | --- | | Server lifecycle, fluent authoring/import, historian, monitored-item and hosting regressions | 732 passed | 732 passed | | NodeState lifecycle regressions | 216 passed | 216 passed | | Automatically merged Raft client fixtures | 28 passed | 28 passed | No selected tests failed or were skipped. The manually resolved files pass scoped formatting/analyzer checks. One CA1861 warning remains in the incoming `NodeSetImportIntegrationTests.cs`; that file is byte-identical to upstream master and was not rewritten or suppressed during integration. ### Latest feedback follow-up `102954eaa` replaces split filter references with the shared `IMonitoringFilter` contract implemented by protocol filters and `AggregationFilterHandler`. Targeted server regressions pass **103/103 on net10.0 and 103/103 on net48**; scoped formatting/analyzers are clean, and the updated XML-documentation inventory has zero gaps across 188 non-generated PR C# files. `93c5b5db8` renames `AggregationFilterHandler`, makes it the owner of the server-revised aggregate filter while preserving the original client filter, and removes the retired interim notification-state readers. Server regressions pass **101/101** and shared-store regressions **64/64**, on both net10.0 and net48, with no failures or skips. Runtime-file formatting/analyzers are clean. `5ccf45630` completes the public/internal XML-documentation sweep. The Roslyn inventory finds zero undocumented eligible declarations across all 186 non-generated PR C# files; the 110-file documentation slice changes only XML comments and spacing. `f17765475` applies the three requested Markdown edits. ### Earlier feedback follow-ups `a53950737` removes single-slot notification pinning and extracts aggregate implementation from MonitoredItem. Targeted sampling, aggregate modification, history/live handoff, queue/lifecycle, restore, and serialization cases pass **101/101 on net10.0 and 101/101 on net48**, without failures or skips. Scoped formatting/analyzers are clean; the focused review found no significant issues. The final formatted monitored-item fixtures also pass 45/45 on net48. The preceding `b21555568` removes the legacy sampling API bridge and durable notification-priority state. Its targeted Server cases passed 97/97 and shared subscription-store cases passed 64/64 on each framework. The broader evidence below remains pinned to its original tested commit, not attributed to these follow-ups. ### Earlier integrated-implementation validation Validated implementation commit: **`3efae597f`**. The following commit, `f6dbefb1c`, only adds two explanatory comment lines for the final standards review; it changes no executable code. | Scope | net10.0 | net48 | | --- | --- | --- | | Server | 5,187 passed; 56 skipped | Affected surface: 2,160 passed; 1 reproduced baseline failure; 56 skipped | | Client | 2,202 passed; 2 skipped | 2,204 passed; 5 skipped | | History integration | 519 passed; 21 skipped | 519 passed; 21 skipped | | Redundancy server | 641 passed | 641 passed | | Redundancy client | 124 passed | 124 passed | | Core shared-store regression suite | 23 passed | 23 passed | All six affected samples passed non-incremental Release/net10.0 builds with zero warnings and errors: ConsoleReferenceClient, ConsoleReferenceServer, RedundantServer, RedundantClient, MinimalBoilerServer, and PumpDeviceIntegrationServer. The published self-contained win-x64 NativeAOT executable is 116,924,928 bytes and has no CLR header or managed runtime dependency. Direct execution passed **HistoryAotTests 3/3** and **RaftAotTests 2/2**. Final standards and specification reviews found no confirmed outstanding high/medium functional gaps or hard standards violations. The remaining constructor-purpose clarification is addressed in `f6dbefb1c`. ### Reproduced baseline exceptions The net48 hosted-startup timeout also reproduces in a pristine worktree at the previous PR head, `24cf1416d`, in `RegisterPostStartRegistriesWiresHistorianAndAliasStoresOnPlainServerAsync`, with the same subsequent certificate-leak assertion. The corresponding renamed case fails before startup in the reviewed branch as well. This is reported separately from the net48 affected-surface results, not counted as a passing full Server suite. The net48 matrix selected the historian, aggregate, monitored-item, fluent, and continuation surfaces and excluded the Hosting namespace. `DurableDataValueQueueVerifyReferenceBatchingAsync` failed at item 1000 in the net48 affected-surface run and passed its single isolated rerun. The same failure at the same assertion reproduces on pristine `849e16acc`; the test, sample queue, queue factory, and batch persistor are unchanged. The original failure remains in the table rather than being erased by the rerun. ### CI source repairs - `4be7eb8f7` keeps diagnostics/configuration managers out of distributed address-space replication. Those managers inherit the source interface, but their live server state and redundancy metadata must remain replica-local. The ownership regression passes on net10.0 and net48, and all nine redundancy sample CI tests pass locally. - `d17f467b3` completes the sample startup repair: core managers are also replica-local; the startup banner no longer advertises readiness before initialization; the producer starts after distributed services; and native Raft startup no longer forces disruptive extra elections. The full sample suite passed 9/9, with initialized `RedundancySupport=Hot`, and focused Raft/address-space regressions passed 8/8 and 3/3. - `81b0b72be` moves the unchanged distributed-historian NativeAOT scenario into a smaller, always-run companion executable to bound Apple's linker input. All 137 AOT tests remain present; the moved test and helpers are unchanged. GitHub and Azure publish/run both native executables, with separate result directories where they share a job. The companion passed actual Windows NativeAOT execution. Linux and Intel macOS CI passed both executables, but this split alone did not fix ARM64 macOS linking. The remaining historian graph is rooted by ReferenceServer startup, not just the relocated test. No test exclusion or speculative linker setting was added to conceal it. - `8a5842913` isolates the independent MCP test graph into an always-run native host. The existing MCP source and assembly leak hooks are linked unchanged, and evaluated compiler inputs prove exactly one owner for every test source: 133 main + 3 MCP + 1 historian = 137 declarations. All three hosts run on every AOT platform. The main Windows native object is 9.35% smaller; both changed publishes had zero diagnostics. MCP passed 3/3; the identical main executable passed 133/133 on one unfiltered followup after two initial endpoint-discovery connection failures, which remain recorded in the local evidence. - The previous Intel macOS job successfully published and executed its native tests, then failed on artifact-upload DNS (`ENOTFOUND`). No upload gate, shared environment setting, or cache configuration was disabled. The first repair round also encountered the unrelated `MetricsAreEmittedForChannelLifetimeAsync` timing failure on macOS Core. Neither that test nor channel-manager code is changed by this PR, and its assertions remain intact. It passed unchanged on the final repair head. On `d17f467b3`, the Linux and macOS redundancy sample jobs pass; the remaining failure was ARM64 Apple's `too many large addends` assertion. The verified upstream relocation-anchor fix (dotnet/runtime#124721, backport dotnet/runtime#132171) is not present in the shipping ILCompiler 10.0.11. An experimental multi-module probe failed and was rejected, not added to CI. On `8a5842913`, [`aot-macos-latest`](https://github.com/OPCFoundation/UA-.NETStandard/actions/runs/34102158680/job/101678934057) successfully publishes and executes all three native hosts on ARM64: 136 main runtime cases, 1 historian case, and 3 MCP cases, with no skips. The previous Apple linker blocker is resolved. Linux NativeAOT also passes. No assertion, test, shared environment setting, cache, or required gate was weakened. The same CI run reports a separate macOS Sessions teardown failure: all 662 executed tests pass, but the global leak assertion detects one undisposed certificate. The MCP partition changes no runtime, Sessions, or test-fixture code. A single unchanged diagnostic rerun is queued once GitHub permits rerunning that job; the failure is not suppressed or counted as green. Other CI checks are still pending. ## Related issues - Fixes #4387 - Fixes #4400 ## Checklist - [ ] I have signed the CLA and read the contributing guide. - [x] I have added regression tests and directly related documentation. - [x] I have retained working reference and redundant-server sample wiring. - [x] Final validation and review evidence is complete, including the baseline exceptions above. - [ ] All required CI checks pass; the fail-fast rerun for `73c619435` is pending. --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9dbd9527-d818-47a0-984c-fbb1472d3d6b
32 KiB
OPC UA Profiles and Facets Support
This document describes which OPC UA Profiles and Facets are implemented in the OPC UA .NET Standard Stack, and where in the codebase / documentation each one lives.
Overview
The OPC UA .NET Standard Stack is a reference implementation that targets OPC UA specification version 1.05.07. The stack has been certified for compliance through an OPC Foundation Certification Test Lab and is continuously tested for compliance using the latest Compliance Test Tool (CTT).
Version 2.0 substantially extends companion-spec coverage over the previous 1.5.378 version. The stack now ships full server- and client-side support for: Part 9 (Alarms & Conditions), Part 11 (Historical Access) + Part 13 (Aggregates), Part 16 (State Machines), Part 17 (Alias Names), Part 18 (Role Management), Part 20 (File Transfer), Part 100 (Device Integration / Software Update), OPC 10100-1 (WoT Connectivity), OPC 40001-1 (Industrial Automation), OPC 40010-1 (Robotics), and the Local Discovery Server. See What's New in 2.0 for the broader change narrative.
The canonical list of all OPC UA profile and facet URIs is maintained by the
OPC Foundation at https://profiles.opcfoundation.org/. Where this document
hyperlinks a URI, that URI is the same string the reference server
advertises in ServerProfileArray; URIs not yet present in a shipping
config are referred to by name and the reader should consult the OPC
Foundation registry for the canonical URI form.
Server Profiles
The reference server (samples/Reference/ConsoleReferenceServer) advertises the
following profiles in its ServerProfileArray:
Core Server Profiles
- Standard UA Server Profile (2017) — The core OPC UA Server profile that includes:
- Basic server capabilities
- Discovery services
- Session management
- Subscription management
- MonitoredItem services
- View services (Browse, BrowseNext, TranslateBrowsePathsToNodeIds)
- Attribute services (Read, Write, HistoryRead, HistoryUpdate)
- Query services
Functional Facets
-
Data Access Server Facet — Variables, data types, and data-change notifications.
-
Method Server Facet — Method calls on objects in the address space.
-
Reverse Connect Facet — Server-initiated connections to a client (see Reverse Connect documentation).
-
Client Redundancy Facet — Subscription transfer between sessions/servers; see Transfer Subscriptions.
-
Historical Access (15 released 2022 Server facets) — the ReferenceServer capability-gates and advertises:
- Raw Data
- Modified Data
- AtTime
- Aggregate
- Annotation
- Structured Data
- Raw Data Insert
- Raw Data Replace
- Raw Data Update
- Raw Data Delete
- Event Read
- Event Insert
- Event Replace
- Event Update
- Event Delete
See Historical Access and Aggregates.
Local Discovery Server (LDS) Profile
The Opc.Ua.Lds.Server library plus the ConsoleLdsServer reference
application implement the Local Discovery Server. The LDS application
advertises the Local Discovery Server 2017 Facet
(see samples/Lds/ConsoleLdsServer/Lds.Server.Config.xml).
Additional facets supported by the implementation (beyond the default advertised set)
Beyond the seven facets advertised by default in the reference server's
ServerProfileArray, the master branch implements the following facets in
the SDK. They can be enabled per-application by registering the
corresponding NodeManager and, where applicable, adding the matching URI to
ServerProfileArray (consult https://profiles.opcfoundation.org/ for the
canonical URI string before claiming a facet):
- Alarms and Conditions (Part 9) — Full server-side implementation
with latched / silenced / out-of-service alarms, alarm groups, a
suppression engine, and rate metrics. The reference server's
AlarmNodeManagerexposes a working sample. See Alarms and Conditions. - State Machine (Part 16) —
StateMachineBuilderand theFluentFiniteStateMachineStateextensibility insrc/Opc.Ua.Server/StateMachines/. The reference server'sBoilerStateMachineStateis an end-to-end sample. See State Machines. - File Access (Part 20) — Server-side
FileSystemNodeManager+IFileSystemProviderinsrc/Opc.Ua.Server/FileSystem/. The reference server enables it via theEnableFileSystemNodeManageroption. The matching System.IO-style client lives inFileSystemClient. - Node Management (Part 4 service set) —
INodeManagementAsyncNodeManageropt-in plus a per-NodeManagerAllowNodeManagementgate forAddNodes/DeleteNodes/AddReferences/DeleteReferences. See Node Management. - Alias Names (Part 17) —
AliasNameStoreand the optionalAliasNameNodeManagerforAliasNameCategory/FindAlias/FindAliasVerbose/AddAliasesToCategory/DeleteAliasesFromCategory/LastChange. The reference server wires the standard Aliases and Topics nodes viaConfigureAliasNameStore. See Alias Names. - WoT Connectivity (OPC 10100-1) —
Opc.Ua.WotCon/Opc.Ua.WotCon.Server/Opc.Ua.WotCon.Clientlibrary trio for surfacing OPC UA servers as Web-of-Things Thing Descriptions. See WoT Connectivity. - Device Integration (Part 100) —
Opc.Ua.Di/Opc.Ua.Di.Server/Opc.Ua.Di.Clientlibrary trio, including the lock service and the software-update package store. See Device Integration and Software Update. - Relative Spatial Location and Global Positioning (Parts 210 and 211) —
Opc.Ua.Positioning/Opc.Ua.Positioning.Server/Opc.Ua.Positioning.Clientimplement the released RSL and GPOS models, including RSL spatial lists and model changes plus the GPOS GlobalPosition, GlobalLocation, and Zones conformance units. See Positioning. - Robotics (OPC 40010-1) over Industrial Automation (OPC 40001-1) —
Opc.Ua.Robotics/Opc.Ua.Robotics.Server/Opc.Ua.Robotics.Clientlibrary trio implementing the released Robotics 1.02 model over IA and Device Integration, with validated fluent topology builders for motion device systems, controllers, motion devices, axes, power trains, motors, gears, drives, safety states, and task controls. See Robotics. - Role Management (Part 18) — Server-side role administration plus a
pluggable identity-provider model for anonymous,
username, X.509, and token-issuer flows. The server automatically
assigns the OPC UA Part 3 §4.9
TrustedApplicationrole; see also Role-Based User Management. - Auditing — The server raises audit events for security-relevant
service calls (channel/secure-channel/session/activate/cancel). The
audit and redaction APIs are provided by
Opc.Ua.Server. - Model Change Tracking — Server-side
ModelChangeAggregatorwith auto-emittedGeneralModelChangeEventfromCustomNodeManager; client-side per-nodeINodeCache.InvalidateNode. See Model Change Tracking. - Durable Subscriptions — Subscriptions that persist across reconnects. See Durable Subscriptions.
- Complex Types — Custom structures and enumerations; see Complex Types.
- Async server NodeManagers — TAP-based
AsyncCustomNodeManageris the recommended base for new NodeManagers, and every NodeManager shipped with the stack has migrated to it. See Async Server Support. - Server redundancy (Part 4 §6.6) —
AddServerRedundancy(...)publishes theServer.ServerRedundancyobject, drivesServer.ServiceLevel, and supports everyRedundancySupportmode (None / Cold / Warm / Hot / HotAndMirrored / Transparent). Non-transparent modes advertise theNTRSdiscovery capability and return the peer set fromFindServers;RequestServerStateChangesupports administrator-driven Maintenance / NoData failover. Opt-in distributed high availability — address-space, session, and subscription mirroring over an in-package CRDT (eventual) or Raft (strong) shared store, plus a Kubernetes deployment — is provided by theOpc.Ua.Redundancy,.Server,.Client, and.Kubernetespackages. See High Availability.
Client Profiles
The client (Opc.Ua.Client) supports the standard UA Client functionality
through two coexisting paths:
- Classic
Session— the lowest-level OPC UA session primitive, paired withSessionReconnectHandlerfor caller-driven reconnect. ManagedSession— recommended for new code. Encapsulates the connection state machine, reconnect policy, and pluggable subscription engine behind a fluent builder. See Sessions, Reconnection, and Subscription Engines.
Client-side feature coverage:
- Subscriptions and monitored items — Both the classic publish
engine and the V2 subscription engine (
ISubscriptionManager/DefaultSubscriptionEngine) are supported and selectable per session. The V2 surface includes a declarative + imperativeSetTriggeringAPI with N:M support and automatic replay on recreate / reconnect, plus anIStreamingSubscription(IAsyncEnumerable-based) facade for state-machine waits and short-lived monitoring (ManagedSession.DefaultStreaming,TakeUntilAsync/WithTimeoutAsynchelpers). See Subscriptions and Monitored Items. - Transfer Subscriptions — Subscription transfer between servers;
see Transfer Subscriptions. An opt-in
SubscriptionRecoveryPolicylets the client tolerateGood_SubscriptionTransferrednotifications from the server. - Reverse Connect — Client can accept connections initiated by the server; see Reverse Connect.
- Model Change Tracking — Client-side per-node cache invalidation driven by server-emitted model-change events; see Model Change Tracking.
- File System Operations — Async,
System.IO-style client over OPC UA file methods; see FileSystemClient. - Alarms and Conditions — Typed
AlarmClientevent records, fluentAlarmEventFilterBuilder, andIAsyncEnumerablealarm streaming viaAlarmStreamExtensions; see Alarms and Conditions. - Historical Access —
HistoryClient(session.Historian()) for raw, modified (includingModificationInfo), at-time, processed (aggregate), annotation, and event history reads / updates; see Historical Access. - State Machines — Streaming and read helpers
(
GetCurrentFiniteStateAsync,ObserveFiniteTransitionsAsync,WaitForStateAsync) on the source-generated*TypeClientproxies; see State Machines. - NodeSet Export — Extract a server's address space to NodeSet2 XML; see NodeSet Export.
- Source-generated typed proxies —
*TypeClientproxies for ObjectTypes inside loaded models give strongly-typed method-call signatures; see Source-Generated NodeManagers. - Complex types — Decode and consume server-defined structures and enumerations on the client; see Complex Types.
Transport Profiles
The stack implements the following transport profiles:
Client and server transports
-
UA TCP Transport (
opc.tcp://) — Primary OPC UA binary transport over TCP.- Full UA Secure Conversation (UASC)
- Binary encoding
- Reverse-connect capability
-
HTTPS Binary Transport (
opc.https://andhttps://) — OPC UA binary protocol over HTTPS with TLS. -
HTTPS JSON Transport (
opc.https://andhttps://) - OPC UA JSON (compact / reversible) over HTTPS (OPC UA Part 6 §7.4.5)- Compact JSON encoding (
application/opcua+uajson) - TLS/SSL encryption only — no UA SecureChannel layer
- Restricted to
MessageSecurityMode.None; transport security is provided exclusively by TLS
- Compact JSON encoding (
-
WebSocket Secure (UA Binary) (
opc.wss://andwss://) - UA Binary + UASC over secure WebSockets (OPC UA Part 6 §7.5.2, sub-protocolopcua+uacp)- Same UASC SecureChannel pipeline as
opc.tcpcarried over WebSocket binary frames (one frame per MessageChunk) - Supports all security modes (None / Sign / SignAndEncrypt)
- TLS/SSL encryption at the WebSocket layer
- Same UASC SecureChannel pipeline as
-
WebSocket Secure (JSON) (
opc.wss://andwss://) - OPC UA JSON over secure WebSockets (Part 6 §7.5.2, sub-protocolopcua+uajson)- Compact JSON encoding per WebSocket text frame
- TLS/SSL encryption only — no UA SecureChannel layer
- Restricted to
MessageSecurityMode.None
-
HTTPS OpenAPI (
opc.https://andhttps://) - OPC UA OpenAPI Mapping (Part 6 §G.3) — official OPC Foundation profile/2338, URIhttp://opcfoundation.org/UA-Profile/Transport/https-uajson-openapi- Path-routed REST surface:
POST /<service>(e.g./read,/browse,/createsubscription) - Body is the bare
<Service>Request/<Service>Response— no{UaTypeId, UaBody}envelope at the HTTPS layer - Compact (default, mandatory per §5.4.9) and Verbose JSON flavours selected via the
application/json; encoding=compact|verbosemedia-type parameter - TLS/SSL encryption only — no UA SecureChannel layer
- Restricted to
MessageSecurityMode.None - Authentication via Anonymous, Bearer JWT, HTTP Basic, or Mutual TLS (see WebApi.md)
- Server-side discovery emission:
HttpsServiceHostemits this sub-profile as a discovery-only twin alongside eachSecurityMode.NoneHTTPS-binary endpoint, so discovery-driven clients can find the OpenAPI endpoint without hard-coding the URL. - Shipped as part of the
OPCFoundation.NetStandard.Opc.Ua.Bindings.Httpspackage (net8+ only) - Surfaced via
Profiles.HttpsOpenApiTransport
- Path-routed REST surface:
-
WSS OpenAPI (
opc.wss://andwss://) - OPC UA OpenAPI Mapping over secure WebSockets (Part 6 §7.5.2, sub-protocolopcua+openapi/opcua+openapi+<accesstoken>) — official OPC Foundation profile/2339, URIhttp://opcfoundation.org/UA-Profile/Transport/wss-uajson-openapi- Same on-wire
{TypeId, Body}OPC UA JSON envelope asopcua+uajson, multiplexed over WebSocket text frames; distinguished by the negotiated sub-protocol and the advertised TransportProfileUri - Bearer-token variant negotiates the access token in the sub-protocol name (no
Authorizationheader — required for browser fetch compatibility); the server extracts the token from the sub-protocol name and feeds it through the standardISessionlessIdentityProviderpipeline - Server-side discovery emission: the WSS factories emit this sub-profile as a discovery-only twin alongside each
SecurityMode.NoneWSS binary endpoint, mirroring the HTTPS OpenAPI emission. - Client surface:
src/Opc.Ua.Client/WebApi/WebApiWssTransportChannel.cs; fluent shortcutManagedSessionBuilder.UseWssOpenApiEndpoint(url); DI registration viaservices.AddWebApiTransportChannel()(registers both HTTPS and WSS WebApi channel factories). - Surfaced via
Profiles.WssOpenApiTransport
- Same on-wire
PubSub transports
The PubSub library supports the following PubSub transport
facets (URIs surfaced by Profiles.PubSub*Transport constants in
src/Opc.Ua.Core/Security/Constants/SecurityConstants.cs). Facet
machinery and conformance unit semantics are defined by
Part 7 §4.3.
- PubSub UDP UADP — UDP transport with UADP message encoding.
- PubSub Ethernet UADP — Ethernet (Layer 2) transport with UADP message encoding (see PubSub transports).
- PubSub MQTT UADP — MQTT transport with UADP message encoding.
- PubSub MQTT JSON — MQTT transport with JSON message encoding.
- Datagram-v2 connection profile —
DatagramConnectionTransport2DataType(Part 14 §6.4.1.4) is honoured for UDP transports. TheDiscoveryAnnounceRate,DiscoveryMaxMessageSize, andQosCategoryfields drive discovery cadence and the IP DSCP TOS byte. - PubSub SKS pull / push —
Part 14 §8.5.1
/ §8.5.2: the
AddPubSubSecurityKeyServiceClientextension implements the pull client (callsGetSecurityKeyson a remote SKS), andAddPubSubSecurityKeyServiceServerhosts the in-memory SKS withGet/SetSecurityKeysandAddSecurityGroupmethods bound on the address space. - AES-128-CTR / AES-256-CTR with HMAC-SHA-256 —
Part 14 §8.4.3
message security. Profiles registered as
PubSubAes128CtrPolicy/PubSubAes256CtrPolicy; conformance to NIST SP 800-38A F.5.1 / F.5.5 is asserted by the test suite. - Anonymous certificate-based MQTT auth — the MQTT transport
exposes the
MqttClientAuthenticationOptionswith the certificate-based variant from Part 14 §6.4.2.2.4.
PubSub additionally supports certificate-based MQTT authentication and
considers WriterGroups in MQTT keep-alive calculations.
All transport profiles defined in OPC UA Part 6 §7.4 (HTTPS) and §7.5
(WebSockets) are supported, including the opcua+openapi and
opcua+openapi+<accesstoken> WebSocket sub-protocols (Part 6 §7.5.2
Table 81).
Security Profiles
The stack supports the following security profiles for secure
communication. The canonical set is defined in
src/Opc.Ua.Core/Security/Constants/SecurityPolicies.cs.
RSA-based security policies
- Basic256Sha256
- 256-bit AES encryption
- RSA-OAEP for key encryption
- HMAC-SHA256 for message authentication
- Minimum key size: 2048 bits
- Aes128_Sha256_RsaOaep
- 128-bit AES encryption
- RSA-OAEP for key encryption
- HMAC-SHA256 for message authentication
- Aes256_Sha256_RsaPss
- 256-bit AES encryption
- RSA-PSS signatures
- HMAC-SHA256 for message authentication
ECC-based security policies
ECC support is documented in detail in ECC Profiles.
Traditional ECC curves
- ECC_nistP256 — NIST P-256 with SHA-256
- ECC_nistP384 — NIST P-384 with SHA-384
- ECC_brainpoolP256r1 — Brainpool P-256r1 with SHA-256
- ECC_brainpoolP384r1 — Brainpool P-384r1 with SHA-384
Modern ECC curves (v2.0)
- ECC_curve25519 — Curve25519 with ChaCha20-Poly1305
- ECC_curve25519_AesGcm — Curve25519 with AES-GCM
- ECC_curve448 — Curve448 with ChaCha20-Poly1305
- ECC_curve448_AesGcm — Curve448 with AES-GCM
AES-GCM and ChaCha20-Poly1305 variants (v2.0)
Modern AEAD cipher alternatives for traditional ECC curves:
- ECC_nistP256_AesGcm, ECC_nistP256_ChaChaPoly
- ECC_nistP384_AesGcm, ECC_nistP384_ChaChaPoly
- ECC_brainpoolP256r1_AesGcm, ECC_brainpoolP256r1_ChaChaPoly
- ECC_brainpoolP384r1_AesGcm, ECC_brainpoolP384r1_ChaChaPoly
RSA Diffie-Hellman (v2.0)
- RSA_DH_AesGcm — RSA Diffie-Hellman key agreement with AES-GCM
- RSA_DH_ChaChaPoly — RSA Diffie-Hellman key agreement with ChaCha20-Poly1305
Platform requirements for ECC. ECC support is available on .NET
Framework 4.8, .NET Standard 2.1, and .NET 5.0 or later. Modern curves
(Curve25519, Curve448) and AEAD ciphers (AES-GCM, ChaCha20-Poly1305)
require .NET 8.0 or later (AesGcm.IsSupported /
ChaCha20Poly1305.IsSupported guard the runtime registration). Not all
curves are supported by every OS platform and .NET implementation.
Deprecated security policies
The following security policies are deprecated but still supported for backward compatibility:
- Basic256 — uses SHA-1
- Basic128Rsa15 — uses SHA-1 and RSA-PKCS#1 v1.5
Note. SHA-1 signed certificates are rejected by default
(RejectSHA1SignedCertificates configuration option). These deprecated
policies should only be enabled for compatibility with legacy systems.
Security policy None
- None — No security.
- For testing or isolated networks only.
- Not recommended for production environments.
User Authentication
The stack supports the following user authentication mechanisms:
- Anonymous — No user authentication.
- Username / Password — User credentials encrypted using the active security policy.
- X.509 Certificate — User authentication via X.509 certificates.
- Issued Token — Includes JSON Web Tokens (JWT) and other
IssuerEndpointUrl-driven flows (OAuth2 / OIDC / Entra). The
Identity Providers pluggable model
(
IClientIdentityProvider,IUserTokenAuthenticator,IAccessTokenProvider,ITokenIssuer,IIdentityClaims) is the recommended way to wire these in.
Certificate Types
The stack supports the following certificate types for application authentication:
RSA certificates
- RsaSha256ApplicationCertificateType — RSA with SHA-256 signatures
- Default minimum key size: 2048 bits
- Recommended for production use
ECC certificates
- EccNistP256ApplicationCertificateType
- EccNistP384ApplicationCertificateType
- EccBrainpoolP256r1ApplicationCertificateType
- EccBrainpoolP384r1ApplicationCertificateType
The RejectSHA1SignedCertificates configuration option (on by default)
prevents SHA-1 signed certificates from being accepted. See
Certificates and Certificate Manager
for storage, ref-counted lifetime, and the segregated-interface design.
Global Discovery Server (GDS)
The stack ships a Global Discovery Server implementation that is full OPC UA Part 12 compliance, including:
- Application registration and discovery.
- Pull and Push certificate-management models, including pushing to arbitrary certificate groups and custom certificate groups on the GDS itself.
- Sub-CA revocation without auto-creating an empty CRL.
- Support for both RSA and ECC certificate types and CRLs.
- AuthorizationService (OPC 10000-12 §9) —
OAuth2-style
StartRequestToken/FinishRequestTokenissuance with a pluggableIAccessTokenProvider/ITokenIssuer. - KeyCredentialService (OPC 10000-12 §8) —
Credential issuance for non-OPC UA services such as MQTT brokers and
REST APIs, backed by
IKeyCredentialRequestStore/ISecretStore.
See the GDS Developer Guide for the full feature breakdown and
hosting integration. The Local Discovery Server is a separate library
(Opc.Ua.Lds.Server) and reference application (ConsoleLdsServer) that
advertises the
Local Discovery Server 2017
facet.
Message Encoding
The stack supports the following message encoding formats:
- UA Binary — OPC UA binary encoding (primary for UA-TCP and HTTPS).
- UA XML — OPC UA XML encoding (for configuration import / export and PubSub Dataset XML).
- UA JSON — OPC UA JSON encoding for PubSub MQTT.
- UADP — UA Data Protocol for PubSub.
The 2.0 release ships a new JSON decoder / encoder, array / matrix
abstractions, and a first-class ByteString type. See the
2.0 migration guide — Encoders and Complex Types
for the encoder/decoder migration details and
Complex Types for client-side decode of
server-defined types.
Specification Compliance
- OPC UA Specification: Version 1.05.07.
- Certification: The reference server has been certified for compliance through an OPC Foundation Certification Test Lab.
- Testing: All releases are verified for compliance using the latest Compliance Test Tool (CTT).
- Redundancy (Part 4 §6.6): Server and client redundancy are implemented
(opt-in) —
RedundancySupport,Server.ServiceLevel, non-transparent (ServerUriArray/RedundantServerArray) and transparent (CurrentServerId) modes,RequestServerStateChange, and client-side transparent failover viaManagedSession.WithServerRedundancy(); see High Availability.
Configuration
Server profile configuration
Server profiles are configured in the server configuration file using the
ServerProfileArray element. The reference server's default array is:
<ServerConfiguration>
<!-- see https://profiles.opcfoundation.org/ for the canonical list of profile and facet URIs -->
<ServerProfileArray>
<ua:String>http://opcfoundation.org/UA-Profile/Server/StandardUA2017</ua:String>
<ua:String>http://opcfoundation.org/UA-Profile/Server/DataAccess</ua:String>
<ua:String>http://opcfoundation.org/UA-Profile/Server/Methods</ua:String>
<ua:String>http://opcfoundation.org/UA-Profile/Server/ReverseConnect</ua:String>
<ua:String>http://opcfoundation.org/UA-Profile/Server/ClientRedundancy</ua:String>
</ServerProfileArray>
</ServerConfiguration>
To advertise additional facets (Historical Access, Aggregates, Alarms &
Conditions, File Access, Auditing, NodeManagement, State Machine, etc.)
look up the canonical URI for the facet on
https://profiles.opcfoundation.org/ and add it to ServerProfileArray.
Only advertise a facet that the application genuinely implements — the
Compliance Test Tool will exercise every claimed facet. Bringing the
reference-server and CTT configs in line with the facets the stack
actually implements is tracked in
#3875.
Security policy configuration
Security policies are configured in the SecurityPolicies section:
<SecurityPolicies>
<ServerSecurityPolicy>
<SecurityMode>SignAndEncrypt_3</SecurityMode>
<SecurityPolicyUri>http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256</SecurityPolicyUri>
</ServerSecurityPolicy>
<ServerSecurityPolicy>
<SecurityMode>SignAndEncrypt_3</SecurityMode>
<SecurityPolicyUri>http://opcfoundation.org/UA/SecurityPolicy#Aes128_Sha256_RsaOaep</SecurityPolicyUri>
</ServerSecurityPolicy>
<!-- ECC security policies -->
<ServerSecurityPolicy>
<SecurityMode>SignAndEncrypt_3</SecurityMode>
<SecurityPolicyUri>http://opcfoundation.org/UA/SecurityPolicy#ECC_nistP256</SecurityPolicyUri>
</ServerSecurityPolicy>
</SecurityPolicies>
See the reference server configuration file
for a complete example, or the
CTT configuration file
for the variant selected by --ctt.
Related Documentation
- What's New in 2.0 — Narrative tour of the 1.5.378 → 2.0 changes, grouped by theme and layer.
- Migration Guide — Prescriptive, per-API migration reference.
- Subscriptions and Monitored Items —
V2
ISubscriptionManager, declarative + imperativeSetTriggering(N:M, replay on recreate / reconnect), andIStreamingSubscription. - Async Server Support — TAP-based
AsyncCustomNodeManagerand theIAsyncNodeManagerfamily. - Dependency Injection —
services.AddOpcUa()and theIOpcUaBuilderhosting surface. - Native AOT — AOT publishing, AOT-clean source generators, and the AOT test matrix.
Core and companion spec related documentation
- Alarms and Conditions (Part 9)
- Historical Access (Part 11)
- Aggregates (Part 13)
- State Machines (Part 16)
- Alias Names (Part 17)
- Role-Based User Management (Part 18)
- Identity Providers
- Authorization Service (Part 12 §9)
- Key Credential Service (Part 12 §8)
- GDS Developer Guide (Part 12 full compliance)
- File System Client (Part 20)
- Device Integration (Part 100)
- Relative Spatial Location and Global Positioning (Parts 210 and 211)
- Robotics (OPC 40010-1 over OPC 40001-1)
- Software Update
- WoT Connectivity (OPC 10100-1)
- Node Management (Part 4)
References
- OPC Foundation Profile Reporting — canonical profile and facet URI registry.
- OPC UA Specification — online reference for the OPC 10000 series.
- OPC UA Compliance Test Tool (CTT) — official conformance test tool.