mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-22 09:37:12 +08:00
Marc Schier
0000513cde
# 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.
421 lines
15 KiB
C#
421 lines
15 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;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Client.TestFramework;
|
|
using ISession = Opc.Ua.Client.ISession;
|
|
|
|
namespace Opc.Ua.Core.Security.Tests
|
|
{
|
|
[TestFixture]
|
|
[Category("Conformance")]
|
|
[Category("SecurityRoleServerBase2")]
|
|
public class SecurityRoleServerBase2Tests : TestFixture
|
|
{
|
|
[Test]
|
|
public async Task Base2VerifyNamespacesObject001Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool foundNamespaceMetadata = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References)
|
|
{
|
|
if (rd.TypeDefinition.ToString().Contains("11616", StringComparison.Ordinal) ||
|
|
rd.BrowseName.Name.Contains("Namespace", StringComparison.Ordinal))
|
|
{
|
|
foundNamespaceMetadata = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
Assert.That(foundNamespaceMetadata, Is.True,
|
|
"Namespaces folder should contain " +
|
|
"NamespaceMetadataType instances.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2VerifyNamespaceMetadataInstance002Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
Assert.That(
|
|
response.Results[0].References.Count,
|
|
Is.GreaterThan(0),
|
|
"At least one NamespaceMetadata instance " +
|
|
"should exist.");
|
|
|
|
ReferenceDescription firstNs =
|
|
response.Results[0].References[0];
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
firstNs.NodeId, Session.NamespaceUris);
|
|
|
|
BrowseResponse nsChildren =
|
|
await BrowseForwardAsync(nsNodeId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(nsChildren.Results, Is.Not.Null);
|
|
Assert.That(nsChildren.Results.Count,
|
|
Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2DefaultRolePermissions004Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray())
|
|
{
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
NodeId propId = await FindChildAsync(
|
|
nsNodeId, "DefaultRolePermissions")
|
|
.ConfigureAwait(false);
|
|
if (!propId.IsNull)
|
|
{
|
|
DataValue dv = await ReadPropertyValueAsync(
|
|
propId).ConfigureAwait(false);
|
|
Assert.That(dv.StatusCode,
|
|
Is.EqualTo(StatusCodes.Good));
|
|
return;
|
|
}
|
|
}
|
|
|
|
Assert.Fail(
|
|
"No namespace exposes " +
|
|
"DefaultRolePermissions property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2DefaultUserRolePermissions005Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray())
|
|
{
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
NodeId propId = await FindChildAsync(
|
|
nsNodeId, "DefaultUserRolePermissions")
|
|
.ConfigureAwait(false);
|
|
if (!propId.IsNull)
|
|
{
|
|
DataValue dv = await ReadPropertyValueAsync(
|
|
propId).ConfigureAwait(false);
|
|
Assert.That(dv.StatusCode,
|
|
Is.EqualTo(StatusCodes.Good));
|
|
return;
|
|
}
|
|
}
|
|
|
|
Assert.Fail(
|
|
"No namespace exposes " +
|
|
"DefaultUserRolePermissions property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2DefaultAccessRestrictions006Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray())
|
|
{
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
NodeId propId = await FindChildAsync(
|
|
nsNodeId, "DefaultAccessRestrictions")
|
|
.ConfigureAwait(false);
|
|
if (!propId.IsNull)
|
|
{
|
|
DataValue dv = await ReadPropertyValueAsync(
|
|
propId).ConfigureAwait(false);
|
|
Assert.That(dv.StatusCode,
|
|
Is.EqualTo(StatusCodes.Good));
|
|
return;
|
|
}
|
|
}
|
|
|
|
Assert.Fail(
|
|
"No namespace exposes " +
|
|
"DefaultAccessRestrictions property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2FindRolePermissions007Async()
|
|
{
|
|
NodeId objectsId = ToNodeId(ObjectIds.ObjectsFolder);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(objectsId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool found = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray())
|
|
{
|
|
var childId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
DataValue dv = await ReadAttributeAsync(
|
|
childId, Attributes.RolePermissions)
|
|
.ConfigureAwait(false);
|
|
if (StatusCode.IsGood(dv.StatusCode) &&
|
|
dv.WrappedValue.TryGetValue(out ArrayOf<ExtensionObject> _))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found)
|
|
{
|
|
Assert.Ignore(
|
|
"No nodes with RolePermissions " +
|
|
"attribute found in Objects folder.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2FindUserRolePermissions008Async()
|
|
{
|
|
NodeId objectsId = ToNodeId(ObjectIds.ObjectsFolder);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(objectsId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool found = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray())
|
|
{
|
|
var childId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
DataValue dv = await ReadAttributeAsync(
|
|
childId,
|
|
Attributes.UserRolePermissions)
|
|
.ConfigureAwait(false);
|
|
if (StatusCode.IsGood(dv.StatusCode) &&
|
|
dv.WrappedValue.TryGetValue(out ArrayOf<ExtensionObject> _))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found)
|
|
{
|
|
Assert.Ignore(
|
|
"No nodes with UserRolePermissions " +
|
|
"attribute found in Objects folder.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2FindAccessRestrictions009Async()
|
|
{
|
|
NodeId objectsId = ToNodeId(ObjectIds.ObjectsFolder);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(objectsId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool found = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray())
|
|
{
|
|
var childId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
DataValue dv = await ReadAttributeAsync(
|
|
childId,
|
|
Attributes.AccessRestrictions)
|
|
.ConfigureAwait(false);
|
|
if (StatusCode.IsGood(dv.StatusCode) &&
|
|
dv.WrappedValue.TryGetValue(out ushort _))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found)
|
|
{
|
|
Assert.Ignore(
|
|
"No nodes with AccessRestrictions " +
|
|
"attribute found in Objects folder.");
|
|
}
|
|
}
|
|
|
|
private async Task<BrowseResponse> BrowseForwardAsync(
|
|
NodeId nodeId,
|
|
ISession session = null)
|
|
{
|
|
session ??= Session;
|
|
return await session.BrowseAsync(
|
|
null, null, 0,
|
|
new BrowseDescription[]
|
|
{
|
|
new() {
|
|
NodeId = nodeId,
|
|
BrowseDirection = BrowseDirection.Forward,
|
|
ReferenceTypeId =
|
|
ReferenceTypeIds.HierarchicalReferences,
|
|
IncludeSubtypes = true,
|
|
NodeClassMask = 0,
|
|
ResultMask = (uint)BrowseResultMask.All
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
|
|
private async Task<NodeId> FindChildAsync(
|
|
NodeId parentId,
|
|
string childName,
|
|
ISession session = null)
|
|
{
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(parentId, session)
|
|
.ConfigureAwait(false);
|
|
if (response?.Results == null ||
|
|
response.Results.Count == 0)
|
|
{
|
|
return NodeId.Null;
|
|
}
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References)
|
|
{
|
|
if (rd.BrowseName.Name == childName)
|
|
{
|
|
return ExpandedNodeId.ToNodeId(
|
|
rd.NodeId,
|
|
(session ?? Session).NamespaceUris);
|
|
}
|
|
}
|
|
|
|
return WellKnownRoleNodeIds.TryGetChild(parentId, childName);
|
|
}
|
|
|
|
private async Task<DataValue> ReadPropertyValueAsync(
|
|
NodeId nodeId,
|
|
ISession session = null)
|
|
{
|
|
session ??= Session;
|
|
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, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
return response.Results[0];
|
|
}
|
|
|
|
private async Task<DataValue> ReadAttributeAsync(
|
|
NodeId nodeId,
|
|
uint attributeId,
|
|
ISession session = null)
|
|
{
|
|
session ??= Session;
|
|
ReadResponse response = await session.ReadAsync(
|
|
null, 0, TimestampsToReturn.Both,
|
|
new ReadValueId[]
|
|
{
|
|
new() {
|
|
NodeId = nodeId,
|
|
AttributeId = attributeId
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
return response.Results[0];
|
|
}
|
|
}
|
|
}
|