mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-24 02:58:36 +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.
181 lines
7.3 KiB
C#
181 lines
7.3 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2026 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.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
|
|
namespace Opc.Ua.Server.Tests.Identity
|
|
{
|
|
[TestFixture]
|
|
[Category("Identity")]
|
|
[Category("KeyCredential")]
|
|
public class InMemoryKeyCredentialStoreTests
|
|
{
|
|
private const string CredentialId = "credential-store-1";
|
|
private static readonly byte[] s_secret = [1, 2, 3, 4, 5];
|
|
private static readonly string[] s_orderedIds = ["aaa", "bbb", "ccc"];
|
|
|
|
[Test]
|
|
public async Task GetAsyncReturnsNullForUnknownCredentialId()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
|
|
Server.KeyCredential result = await store.GetAsync("unknown", CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(result, Is.Null);
|
|
}
|
|
|
|
[Test]
|
|
public async Task UpdateAsyncStoresSecretAndExpirationAndSubject()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
var expiration = new DateTime(2030, 1, 1, 0, 0, 0, DateTimeKind.Utc);
|
|
string[] scopes = ["ua.read", "ua.write"];
|
|
|
|
await store.UpdateAsync(
|
|
CredentialId,
|
|
new Server.KeyCredential(s_secret, expiration, subject: null, scopes: scopes),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
Server.KeyCredential stored = await store.GetAsync(CredentialId, CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(stored, Is.Not.Null);
|
|
Assert.That(stored.Secret, Is.EqualTo(s_secret));
|
|
Assert.That(stored.Expiration, Is.EqualTo(expiration));
|
|
Assert.That(stored.Subject, Is.Empty);
|
|
Assert.That(stored.Scopes, Is.EqualTo(scopes));
|
|
}
|
|
|
|
[Test]
|
|
public async Task UpdateAsyncReplacesExistingCredentialMetadataAndSecret()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
await store.UpdateAsync(
|
|
CredentialId,
|
|
new Server.KeyCredential(s_secret, DateTime.UtcNow.AddMinutes(1)),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
byte[] replacement = [9, 9, 9];
|
|
DateTime newExpiration = DateTime.UtcNow.AddHours(1);
|
|
await store.UpdateAsync(
|
|
CredentialId,
|
|
new Server.KeyCredential(replacement, newExpiration),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
Server.KeyCredential stored = await store.GetAsync(CredentialId, CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(stored.Secret, Is.EqualTo(replacement));
|
|
Assert.That(stored.Expiration, Is.EqualTo(newExpiration));
|
|
}
|
|
|
|
[Test]
|
|
public async Task DeleteAsyncRemovesCredential()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
await store.UpdateAsync(
|
|
CredentialId,
|
|
new Server.KeyCredential(s_secret, DateTime.UtcNow.AddMinutes(1)),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
await store.DeleteAsync(CredentialId, CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Server.KeyCredential after = await store.GetAsync(CredentialId, CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
Assert.That(after, Is.Null);
|
|
|
|
IReadOnlyList<string> list = await store.ListAsync(CancellationToken.None).ConfigureAwait(false);
|
|
Assert.That(list, Is.Empty);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ListAsyncReturnsCredentialIdsInOrdinalOrder()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
await store.UpdateAsync(
|
|
"ccc",
|
|
new Server.KeyCredential(s_secret, DateTime.UtcNow.AddHours(1)),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
await store.UpdateAsync(
|
|
"aaa",
|
|
new Server.KeyCredential(s_secret, DateTime.UtcNow.AddHours(1)),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
await store.UpdateAsync(
|
|
"bbb",
|
|
new Server.KeyCredential(s_secret, DateTime.UtcNow.AddHours(1)),
|
|
CancellationToken.None)
|
|
.ConfigureAwait(false);
|
|
|
|
IReadOnlyList<string> ids = await store.ListAsync(CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Assert.That(ids, Is.EqualTo(s_orderedIds));
|
|
}
|
|
|
|
[Test]
|
|
public void GetAsyncRejectsEmptyCredentialId()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
ArgumentException ex = Assert.ThrowsAsync<ArgumentException>(
|
|
async () => await store.GetAsync(string.Empty, CancellationToken.None).ConfigureAwait(false));
|
|
Assert.That(ex.ParamName, Is.EqualTo("credentialId"));
|
|
}
|
|
|
|
[Test]
|
|
public void UpdateAsyncRejectsNullCredential()
|
|
{
|
|
using var store = new InMemoryKeyCredentialStore();
|
|
ArgumentNullException ex = Assert.ThrowsAsync<ArgumentNullException>(
|
|
async () => await store.UpdateAsync(CredentialId, null, CancellationToken.None).ConfigureAwait(false));
|
|
Assert.That(ex.ParamName, Is.EqualTo("credential"));
|
|
}
|
|
|
|
[Test]
|
|
public void OperationsAfterDisposeThrowObjectDisposedException()
|
|
{
|
|
var store = new InMemoryKeyCredentialStore();
|
|
store.Dispose();
|
|
|
|
Assert.ThrowsAsync<ObjectDisposedException>(
|
|
async () => await store.GetAsync(CredentialId, CancellationToken.None).ConfigureAwait(false));
|
|
}
|
|
}
|
|
}
|