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

116 lines
4.5 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.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Client.TestFramework;
using Opc.Ua.Identity;
namespace Opc.Ua.Client.Tests.Identity
{
[TestFixture]
[Category("Session")]
[Category("Identity")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
public sealed class UpdateIdentityAsyncTests : ClientTestFramework
{
public UpdateIdentityAsyncTests()
: base(Utils.UriSchemeOpcTcp)
{
m_secretStore = new InMemorySecretStore();
m_secretRegistry = new SecretRegistry(m_secretStore);
SingleSession = false;
}
[OneTimeSetUp]
public override Task OneTimeSetUpAsync()
{
SingleSession = false;
return base.OneTimeSetUpAsync();
}
[OneTimeTearDown]
public override Task OneTimeTearDownAsync()
{
return base.OneTimeTearDownAsync();
}
[Test]
public async Task UpdateIdentityAsyncSwitchesUserNameIdentity()
{
Endpoints = await ClientFixture.GetEndpointsAsync(ServerUrl).ConfigureAwait(false);
ConfiguredEndpoint endpoint = await ClientFixture
.GetEndpointAsync(ServerUrl, SecurityPolicies.Basic256Sha256, Endpoints)
.ConfigureAwait(false);
var userIdentity = new UserIdentity("user1", "password"u8);
UserTokenPolicy identityPolicy = endpoint.Description.FindUserTokenPolicy(
userIdentity.TokenType,
userIdentity.IssuedTokenType,
endpoint.Description.SecurityPolicyUri);
if (identityPolicy == null)
{
Assert.Ignore("The test server endpoint does not advertise UserName tokens.");
}
using ISession session = await ClientFixture
.ConnectAsync(endpoint, userIdentity)
.ConfigureAwait(false);
var rawSession = (Session)session;
SecretIdentifier passwordId = await CreatePasswordAsync("password1"u8.ToArray())
.ConfigureAwait(false);
var provider = new UserNamePasswordIdentityProvider(
"user2",
m_secretRegistry,
passwordId);
await rawSession.UpdateIdentityAsync(provider).ConfigureAwait(false);
Assert.That(session.Identity.DisplayName, Is.EqualTo("user2"));
ServerStatusDataType status = await session
.ReadValueAsync<ServerStatusDataType>(VariableIds.Server_ServerStatus)
.ConfigureAwait(false);
Assert.That(status, Is.Not.Null);
}
private async Task<SecretIdentifier> CreatePasswordAsync(byte[] password)
{
var id = new SecretIdentifier(
"password-" + m_secretCounter++,
InMemorySecretStore.DefaultStoreType);
await m_secretStore.SetAsync(id, password).ConfigureAwait(false);
return id;
}
private readonly InMemorySecretStore m_secretStore;
private readonly SecretRegistry m_secretRegistry;
private int m_secretCounter;
}
}