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.
223 lines
10 KiB
C#
223 lines
10 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;
|
|
|
|
namespace Opc.Ua.InformationModel.Tests
|
|
{
|
|
/// <summary>
|
|
/// compliance tests for Attribute Write StatusCode & TimeStamp.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Conformance")]
|
|
[Category("AttributeServices")]
|
|
public class AttributeWriteStatuscodeTimestampTests : TestFixture
|
|
{
|
|
[Description("Write to a single valid Node a VTQ by passing the Value and Quality only. */")]
|
|
[Test]
|
|
public async Task WriteValueWithStatusCodeOnlySucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to a single valid Node a VTQ by passing the Value, Quality and sourceTimestamp. */")]
|
|
[Test]
|
|
public async Task WriteValueWithStatusCodeAndSourceTimestampSucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to a single valid Node a VTQ by passing the Value, Quality, sourceTimestamp and serverTimestamp. */")]
|
|
[Test]
|
|
public async Task WriteValueWithStatusCodeAndBothTimestampsSucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to a single valid Node a Value and SourceTimestamp. */")]
|
|
[Test]
|
|
public async Task WriteValueWithSourceTimestampOnlySucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to a single valid Node a Value only. Do not specify a StatusCode or any Timestamps.*/")]
|
|
[Test]
|
|
public async Task WriteValueWithoutStatusCodeOrTimestampsSucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42))
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to the value attribute a Value, a TimestampServer and TimestampSource, but do not specify a StatusCode. */")]
|
|
[Test]
|
|
public async Task WriteValueWithBothTimestampsAndNoStatusCodeSucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to the Value attribute a Value, StatusCode and TimestampSource, but do not specify a TimestampServer. */")]
|
|
[Test]
|
|
public async Task WriteValueWithStatusCodeAndSourceTimestampNoServerSucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Write to a single valid Node a Value and ServerTimestamp only. Expect Good or Bad_WriteNotSupported. */")]
|
|
[Test]
|
|
public async Task WriteValueWithServerTimestampOnlySucceedsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Create one monitored item. call Publish(). Write a status code to the Value attribute (don�t change the value of the Value attribute). call Publish(). Write the existing value and")]
|
|
[Test]
|
|
public async Task WriteStatusCodeAndValueWithMonitoredItemPublishesNotificationsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("Create one monitored item with a filter of StatusValueTimestamp.")]
|
|
[Test]
|
|
public async Task WriteVqtWithStatusValueTimestampFilterPublishesNotificationsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
|
|
[Description("CreateMonitoredItems: filter=VQT; no deadband. Write a VQT. Call Publish. */")]
|
|
[Test]
|
|
public async Task WriteVqtWithVqtFilterPublishesNotificationsAsync()
|
|
{
|
|
ArrayOf<WriteValue> wv = new WriteValue[]
|
|
{
|
|
new() {
|
|
NodeId = ToNodeId(Constants.ScalarStaticInt32),
|
|
AttributeId = Attributes.Value,
|
|
Value = new DataValue(new Variant(42), StatusCodes.Good, DateTime.UtcNow, DateTime.UtcNow)
|
|
}
|
|
}.ToArrayOf();
|
|
WriteResponse response = await Session.WriteAsync(null, wv, CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
}
|
|
}
|
|
}
|