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

182 lines
6.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;
using System.Security.Cryptography;
using System.Text;
using NUnit.Framework;
using Opc.Ua.Identity;
namespace Opc.Ua.Core.Tests.Security.Identity
{
/// <summary>
/// Tests for <see cref="IssuerVerificationKey"/> signature verification
/// across the JWS algorithms required by Part 6 §6.5.2 (RS256, ES256).
/// </summary>
[TestFixture]
[Category("Identity")]
[Parallelizable]
[SetCulture("en-us")]
[SetUICulture("en-us")]
public class IssuerVerificationKeyTests
{
[Test]
public void CtorRejectsNullKey()
{
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
() => new IssuerVerificationKey("kid", null!, "RS256"))!;
Assert.That(ex.ParamName, Is.EqualTo("key"));
}
[Test]
public void CtorRejectsEmptyAlgorithm()
{
using var rsa = RSA.Create(2048);
ArgumentException ex = Assert.Throws<ArgumentException>(
() => new IssuerVerificationKey("kid", rsa, string.Empty))!;
Assert.That(ex.ParamName, Is.EqualTo("algorithm"));
}
[Test]
public void CtorRejectsUnsupportedKeyType()
{
// ECDiffieHellman is an AsymmetricAlgorithm but is neither RSA
// nor ECDsa, so it should be rejected.
using var ecdh = ECDiffieHellman.Create();
ArgumentException ex = Assert.Throws<ArgumentException>(
() => new IssuerVerificationKey("kid", ecdh, "RS256"))!;
Assert.That(ex.ParamName, Is.EqualTo("key"));
}
[Test]
public void VerifyRs256SignatureAcceptsValidSignature()
{
using var rsa = RSA.Create(2048);
byte[] data = Encoding.UTF8.GetBytes("eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhbGljZSJ9");
byte[] sig = rsa.SignData(
data,
HashAlgorithmName.SHA256,
RSASignaturePadding.Pkcs1);
using var key = new IssuerVerificationKey("kid-1", rsa, "RS256");
Assert.That(key.VerifySignature(data, sig), Is.True);
}
[Test]
public void VerifyRs256SignatureRejectsTamperedData()
{
using var rsa = RSA.Create(2048);
byte[] data = Encoding.UTF8.GetBytes("original payload");
byte[] sig = rsa.SignData(
data,
HashAlgorithmName.SHA256,
RSASignaturePadding.Pkcs1);
byte[] tampered = Encoding.UTF8.GetBytes("tampered payload");
using var key = new IssuerVerificationKey("kid-1", rsa, "RS256");
Assert.That(key.VerifySignature(tampered, sig), Is.False);
}
[Test]
public void VerifyPs256SignatureAcceptsValidSignature()
{
using var rsa = RSA.Create(2048);
byte[] data = Encoding.UTF8.GetBytes("payload");
byte[] sig = rsa.SignData(
data,
HashAlgorithmName.SHA256,
RSASignaturePadding.Pss);
using var key = new IssuerVerificationKey("kid-1", rsa, "PS256");
Assert.That(key.VerifySignature(data, sig), Is.True);
}
[Test]
public void VerifyEs256SignatureAcceptsValidSignature()
{
using var ec = ECDsa.Create(ECCurve.NamedCurves.nistP256);
byte[] data = Encoding.UTF8.GetBytes("payload");
byte[] sig = ec.SignData(data, HashAlgorithmName.SHA256);
using var key = new IssuerVerificationKey("kid-1", ec, "ES256");
Assert.That(key.VerifySignature(data, sig), Is.True);
}
[Test]
public void VerifyAfterDisposeThrows()
{
using var rsa = RSA.Create(2048);
var key = new IssuerVerificationKey("kid-1", rsa, "RS256");
key.Dispose();
Assert.That(
() => key.VerifySignature([1], [1]),
Throws.TypeOf<ObjectDisposedException>());
}
[Test]
public void VerifyRejectsNullSigningInput()
{
using var rsa = RSA.Create(2048);
using var key = new IssuerVerificationKey("kid-1", rsa, "RS256");
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
() => key.VerifySignature(null!, [0]))!;
Assert.That(ex.ParamName, Is.EqualTo("signingInput"));
}
[Test]
public void VerifyRejectsNullSignature()
{
using var rsa = RSA.Create(2048);
using var key = new IssuerVerificationKey("kid-1", rsa, "RS256");
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
() => key.VerifySignature([0], null!))!;
Assert.That(ex.ParamName, Is.EqualTo("signature"));
}
[Test]
public void VerifyUnsupportedAlgorithmThrows()
{
using var rsa = RSA.Create(2048);
using var key = new IssuerVerificationKey("kid-1", rsa, "HS256");
Assert.That(
() => key.VerifySignature([0], [0]),
Throws.TypeOf<NotSupportedException>());
}
}
}