Files
Marc Schier 0000513cde Pluggable user-identity provider model (#3807)
# Description

Introduces a pluggable user-identity provider model covering all OPC UA
Part 6 §6.5 mechanisms (Anonymous, UserName, X509, IssuedToken/JWT) on
both client and server, with full
`Microsoft.Extensions.DependencyInjection` integration, plus the Part 12
§9 `AuthorizationService` two-phase token-request flow **including
refresh-token rotation**, the Part 12 §8 KeyCredential Push model, and a
clean provider model for OPC 10000-12 §7.2 `ApplicationSelfAdmin`. The
work is split across phase-by-phase commits so it can be reviewed
independently; nothing here changes wire-level behaviour or forces
existing applications to migrate.

### Documentation

All under `Docs/`:

- `IdentityProviders.md` — full developer guide: three-layer model,
recipes, configuration reference, "what gets auto-wired" matrix, JWS
algorithm table, identity-augmenters section, **"Implementing your own
provider"** how-to subsections for Entra / OIDC / Windows / AspNetCore
(sibling files merged in per review feedback).
- `DependencyInjection.md` — `Identity` sections with `appsettings.json`
examples, identity-extension matrix, `WithAuthorizationService` +
`WithKeyCredentialPush` + `AddIdentityAugmenter` extensions documented.
- `RoleBasedUserManagement.md` — claim-criteria callout describing
`IIdentityClaims` probe surface.
- `AuthorizationService.md` — Architecture diagram +
`IAccessTokenProvider` conceptual narrative restored from master; modern
`StartRequestToken` / `FinishRequestToken` flow leads; refresh-token
recipe added.
- `KeyCredentialService.md` — Push model + Pull vs Push vs Bridge
decision matrix + Hybrid (Push + Pull) section; explicit experimental
warning for the bridge.
- `GDS.md` — KeyCredential Push, `StartRequestToken`,
`GdsApplicationSelfAdminProvider`, **shipped Refresh-token support with
rotation policy and audit semantics** all documented.
- `MigrationGuide.md` — User Identity Providers section listing
`[Obsolete]` markers + mechanical recipes; SelfAdmin migration via
`IIdentityAugmenter`; `EnableRefreshTokens` default note.
- `README.md` index entries.

## Checklist

- [x] I have signed the
[CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf)
and read the
[CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md)
doc.
- [x] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- [x] I have added all necessary documentation.
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings.
- [x] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed.
- [x] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [x] I have addressed **all** PR feedback received.
2026-06-02 01:14:54 +02:00

203 lines
8.4 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System.Threading;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Client.TestFramework;
namespace Opc.Ua.InformationModel.Tests
{
/// <summary>
/// compliance tests for Server Capabilities and Base Information conformance.
/// </summary>
[TestFixture]
[Category("Conformance")]
[Category("ServerCapabilities")]
public class ServerCapabilitiesTests : TestFixture
{
[Test]
public async Task ReadServerProfileArrayAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_ServerProfileArray).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.WrappedValue.TryGetValue(out ArrayOf<string> _), Is.True);
}
[Test]
public async Task ReadLocaleIdArrayAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_LocaleIdArray).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.WrappedValue.TryGetValue(out ArrayOf<string> _), Is.True);
}
[Test]
public async Task ReadMinSupportedSampleRateAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_MinSupportedSampleRate).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
double rate = result.WrappedValue.GetDouble();
Assert.That(rate, Is.GreaterThanOrEqualTo(0));
}
[Test]
public async Task ReadMaxBrowseContinuationPointsAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_MaxBrowseContinuationPoints).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
}
[Test]
public async Task ReadMaxQueryContinuationPointsAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_MaxQueryContinuationPoints).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
}
[Test]
public async Task ReadMaxHistoryContinuationPointsAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_MaxHistoryContinuationPoints).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
}
[Test]
public async Task ReadOperationLimitsMaxNodesPerReadAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_OperationLimits_MaxNodesPerRead).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
}
[Test]
public async Task ReadOperationLimitsMaxNodesPerWriteAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_OperationLimits_MaxNodesPerWrite).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
}
[Test]
public async Task ReadOperationLimitsMaxNodesPerBrowseAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerCapabilities_OperationLimits_MaxNodesPerBrowse).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
}
[Test]
public async Task ReadNamespaceArrayAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_NamespaceArray).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
string[] namespaces = result.GetValue<string[]>(default);
Assert.That(namespaces, Is.Not.Empty);
Assert.That(namespaces[0], Is.EqualTo(Namespaces.OpcUa));
}
[Test]
public async Task ReadServerArrayAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerArray).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
string[] serverArray = result.GetValue<string[]>(default);
Assert.That(serverArray, Is.Not.Empty);
}
[Test]
public async Task ReadServerStatusStateAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerStatus_State).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.GetValue<int>(default), Is.EqualTo((int)ServerState.Running));
}
[Test]
public async Task ReadServerStatusCurrentTimeAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerStatus_CurrentTime).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.WrappedValue.TryGetValue(out DateTimeUtc _), Is.True);
}
[Test]
public async Task ReadServerStatusStartTimeAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerStatus_StartTime).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.WrappedValue.TryGetValue(out DateTimeUtc _), Is.True);
}
[Test]
public async Task ReadBuildInfoProductNameAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerStatus_BuildInfo_ProductName).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.WrappedValue.TryGetValue(out string _), Is.True);
Assert.That(result.WrappedValue.GetString(), Is.Not.Empty);
}
[Test]
public async Task ReadBuildInfoSoftwareVersionAsync()
{
DataValue result = await ReadNodeValueAsync(
VariableIds.Server_ServerStatus_BuildInfo_SoftwareVersion).ConfigureAwait(false);
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
Assert.That(result.WrappedValue.TryGetValue(out string _), Is.True);
}
private async Task<DataValue> ReadNodeValueAsync(NodeId nodeId)
{
ReadResponse response = await Session.ReadAsync(
null, 0, TimestampsToReturn.Both,
new ReadValueId[]
{
new() { NodeId = nodeId, AttributeId = Attributes.Value }
}.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(response.Results.Count, Is.EqualTo(1));
return response.Results[0];
}
}
}