mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-18 22:55:08 +08:00
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.
115 lines
5.3 KiB
C#
115 lines
5.3 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.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Server.TestFramework;
|
|
using Opc.Ua.Tests;
|
|
using Quickstarts.ReferenceServer;
|
|
|
|
namespace Opc.Ua.Server.Tests
|
|
{
|
|
[TestFixture]
|
|
[Category("CoreNodeManager")]
|
|
[Parallelizable]
|
|
public class CoreNodeManagerTests
|
|
{
|
|
[Test]
|
|
public async Task ImportNodes_IsInternal_UpdatesDiagnosticsAsync()
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
var fixture = new ServerFixture<StandardServer>(t => new ReferenceServer(t));
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
|
|
// Create a CoreNodeManager2
|
|
var config = new ApplicationConfiguration
|
|
{
|
|
ServerConfiguration = new ServerConfiguration
|
|
{
|
|
MaxNotificationQueueSize = 100,
|
|
MaxDurableNotificationQueueSize = 100
|
|
}
|
|
};
|
|
using var nodeManager = new CoreNodeManager(server.CurrentInstance, config);
|
|
await nodeManager.CreateAddressSpaceAsync(new Dictionary<NodeId, IList<IReference>>()).ConfigureAwait(false);
|
|
|
|
// Create a node in Namespace 0 that also exists in DiagnosticsNodeManager (e.g. Server Object)
|
|
// Note: We need a node that exists in DiagnosticsNodeManager. StandardServer populates it with BaseNodes.
|
|
// Let's use ObjectIds.Server.
|
|
var serverNode = new BaseObjectState(null)
|
|
{
|
|
NodeId = ObjectIds.Server,
|
|
BrowseName = new QualifiedName(BrowseNames.Server, 0),
|
|
DisplayName = new LocalizedText("Server")
|
|
};
|
|
|
|
// Add a reference that we want to check
|
|
var targetNodeId = new NodeId(1234, 1); // Some random target
|
|
serverNode.AddReference(ReferenceTypeIds.HasComponent, false, targetNodeId);
|
|
|
|
// Act - isInternal = false
|
|
await nodeManager.ImportNodesAsync(server.CurrentInstance.DefaultSystemContext, [serverNode], false).ConfigureAwait(false);
|
|
|
|
// Assert
|
|
// Check if DiagnosticsNodeManager has the reference
|
|
NodeState diagNode = server.CurrentInstance.DiagnosticsNodeManager.FindPredefinedNode<NodeState>(ObjectIds.Server);
|
|
Assert.That(diagNode, Is.Not.Null, "Diagnostics node should exist");
|
|
Assert.That(diagNode.ReferenceExists(ReferenceTypeIds.HasComponent, false, targetNodeId), Is.True, "Reference should be added to diagnostics");
|
|
|
|
// Cleanup reference to verify isInternal = true
|
|
diagNode.RemoveReference(ReferenceTypeIds.HasComponent, false, targetNodeId);
|
|
Assert.That(diagNode.ReferenceExists(ReferenceTypeIds.HasComponent, false, targetNodeId), Is.False, "Reference should be removed");
|
|
|
|
// Act - isInternal = true
|
|
var serverNode2 = new BaseObjectState(null)
|
|
{
|
|
NodeId = ObjectIds.Server,
|
|
BrowseName = new QualifiedName(BrowseNames.Server, 0),
|
|
DisplayName = new LocalizedText("Server")
|
|
};
|
|
serverNode2.AddReference(ReferenceTypeIds.HasComponent, false, targetNodeId);
|
|
|
|
await nodeManager.ImportNodesAsync(server.CurrentInstance.DefaultSystemContext, [serverNode2], true).ConfigureAwait(false);
|
|
|
|
// Assert
|
|
Assert.That(diagNode.ReferenceExists(ReferenceTypeIds.HasComponent, false, targetNodeId), Is.False,
|
|
"Reference should NOT be added to diagnostics when isInternal=true");
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
}
|
|
}
|