Marc Schier 2b4b0677d4 Validate issuer/CA certificate KeyUsage (keyCertSign, cRLSign) (#3947)
## Summary

Fixes a certificate-validation compliance gap: the stack did not verify
that **CA/issuer certificates** in a chain assert the KeyUsage required
for a CA.

Per **OPC 10000-6 §6.2.4, Table 52 (Issuer Certificate)**, a CA
certificate must carry a KeyUsage extension asserting `keyCertSign` and
`cRLSign`, and **OPC 10000-4 §6.1.3, Table 100 ("Certificate Usage")**
requires validators to check issuer usage and report
`Bad_CertificateIssuerUseNotAllowed`.

The validator only checked the **leaf** certificate's KeyUsage and
delegated all issuer/CA usage to .NET `X509Chain`. Per RFC 5280
§4.2.1.3, `X509Chain` does **not** reject a CA whose KeyUsage extension
is *absent* (absence implies no usage restriction), so a
root/intermediate CA with no KeyUsage — exactly the scenario reported in
#3944 — was accepted by two .NET peers while strict third-party OPC UA
stacks reject the same chain with `BadCertificateInvalid`.

## Changes

- `CertificateValidationHelpers.HasRequiredIssuerKeyUsage(Certificate)`
— returns whether both `keyCertSign` and `cRLSign` are asserted (absent
KeyUsage → `None` → fails).
- `CertificateValidationCore.InternalValidateAsync` — after the leaf
KeyUsage check, verifies every resolved issuer/CA certificate in the
chain and appends a **suppressible**
`Bad_CertificateIssuerUseNotAllowed` when the required bits are missing.
Existing deployments that must interoperate with a non-compliant CA can
suppress it via the validation callback.
- **Two coupled defects fixed in `CheckChainStatus`** (surfaced while
testing the `NotValidForUsage` path):
1. A `FormatException` — `ServiceResult.Create` was given a
named-placeholder format string (`{Status}: {Information}`) where
positional `{0}: {1}` is required; this crashed validation whenever
`X509Chain` reported `NotValidForUsage`.
2. An inverted `isIssuer` status-code ternary (issuer↔leaf codes were
swapped, contrary to Part 4 Table 100).
- `Docs/Certificates.md` — new "CA (issuer) KeyUsage validation"
subsection.

Every new check/helper carries an in-code citation to the governing spec
sections.

## Testing

- New tests in `CertificateValidatorTest.cs`: a deterministic helper
unit test (absent / partial / compliant KeyUsage) plus integration tests
for reject / suppress / accept.
- Full `CertificateValidator` fixture green on **net10.0** and
**net48**, no regressions.

## Compatibility

- Long-standing behaviour present in both `master` (2.0) and `master378`
(1.5.378) — **not** a 2.0 regression. The 1.5.378 backport is submitted
separately.
- No public API change; the new error is suppressible, preserving
backward compatibility.

Relates to #3944
2026-07-04 11:35:37 +02:00
2020-05-15 19:41:55 +02:00
2021-07-26 10:06:51 +03:00

OPC UA .NET Standard Stack

Release NuGet Downloads Build Tests Coverage

🆕 This is version 2.0 of the OPC UA .NET Standard Stack (current master).

Looking for the supported 1.x release? It lives on the master378 branch (last release: 1.5.378). All new feature work happens here on master; master378 continues to receive security and critical-bug fixes for the 1.x line.

The official OPC Foundation reference implementation of OPC UA for .NET — a certified, cross-platform stack with client, server, PubSub, GDS, complex types, and source-generated tooling. Used in production across industrial control, manufacturing, energy, and IoT systems.

📦 What it is

  • A full-stack OPC UA implementation — Core / Client / Server / PubSub / GDS / LDS / Complex Types / Device Integration libraries built on .NET, with UA-TCP and HTTPS transports.
  • Cross-platform — runs on .NET 10, .NET 9, .NET 8 (LTS), .NET Framework 4.8, and .NET Standard 2.1; ships Native-AOT-friendly assemblies.
  • Certified for compliance — the reference server has been certified through an OPC Foundation Certification Test Lab and is continuously verified against the latest Compliance Test Tool (CTT).
  • Companion-spec coverage — 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), OPC 10100-1 (WoT Connectivity).
  • Modern developer surface — first-class Microsoft.Extensions.DependencyInjection hosting (services.AddOpcUa()), fluent server + client builders, source-generated NodeManagers and DataTypes, and an MCP server so LLMs / Copilot can drive an OPC UA client.

For the full feature breakdown see OPC UA Profiles and Facets and the What's New in 2.0 tour.

🚀 Getting started

You need the .NET 10 SDK to build the repo. From the repository root:

dotnet restore UA.slnx
dotnet build UA.slnx

For the supported target frameworks and platform notes see Platform Support. The official NuGet packages are published to nuget.org under the OPCFoundation.NetStandard prefix — the meta package OPCFoundation.NetStandard.Opc.Ua pulls in everything, or pick the split OPCFoundation.NetStandard.Opc.Ua.Core / .Client / .Server / .Bindings.Https packages directly. Preview builds for every successful master build are available in the Azure DevOps opcua-preview feed.

Sample applications

Each sample has its own README.md with build and run instructions.

Reference applications

  • Console Reference Server — the certified reference server (with Quickstarts, CTT, and Mono configs). Also ships as a Docker container.
  • Console Reference Client — cross-platform reference client demonstrating sessions, subscriptions, browsing, and method calls.
  • Console LDS Server — a standalone Local Discovery Server built on Opc.Ua.Lds.Server.
  • MCP Server — Model Context Protocol server that exposes OPC UA client operations as MCP tools, so an LLM / Copilot can browse, read, write, subscribe, and call methods on any OPC UA server.

PubSub samples

  • Console Reference PubSub Client — one executable with publisher, subscriber, and external (external-server adapter) modes across the supported transport profiles.

Minimal / Device-Integration samples

More sample projects are maintained in the companion OPC UA .NET Samples repository.

🔧 Migrating from 1.5.378 to 2.0

The 2.0 release introduces breaking API changes, and comes with a full prescriptive migration guide that links to per-area documentation covering telemetry, packages, source generation, types, encoders, node states, identity, certificates, configuration, sessions / subscriptions, alarms / model change, and TimeProvider.

Most of the mechanical migration work is automated:

  • OPCFoundation.NetStandard.Opc.Ua.MigrationAnalyzer NuGet — install it in your project to get analyzer warnings (UA0001–UA0022)
    • one-click code fixes for the patterns in the guide. Setup steps are in the package's NugetREADME.md.
  • Migration agent skill — the opcua-v20-migration skill walks Copilot / Claude / any coding agent through installing the NuGet, running dotnet format analyzers to apply auto-fixes, and handling the small residual manual patterns. The skill knows which sub-doc to load for each symptom so it stays context-efficient.

If you are still on 1.x and not ready to upgrade, stay on the master378 branch — it continues to receive security and critical-bug fixes.

🤝 Contributing and license

Community contributions are welcome. Fork the repository, make your changes on a branch, and open a pull request; see CONTRIBUTING.md for the contribution workflow.

Contributors must sign the OPC Foundation Contributor License Agreement (CLA). The CLA "I AGREE" gate is presented automatically on your first PR.

The project is licensed under the OPC Foundation MIT License. Report security vulnerabilities via the process documented in SECURITY.md.

📚 Further reading

S
Description
OPC Unified Architecture .NET Standard
Readme
296 MiB
Languages
C# 99.4%
PowerShell 0.2%