mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-18 14:43:08 +08:00
Marc Schier
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.
350 lines
14 KiB
C#
350 lines
14 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.IO;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Core.TestFramework;
|
|
|
|
namespace Opc.Ua.Core.Encoders.Tests
|
|
{
|
|
/// <summary>
|
|
/// Tests for the IEncodeable classes.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("EncodeableTypes")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
[Parallelizable]
|
|
public class EncodeableTypesTests : EncoderCommon
|
|
{
|
|
[DatapointSource]
|
|
public Type[] TypeArray =
|
|
[
|
|
.. typeof(BaseObjectState).Assembly
|
|
.GetExportedTypes()
|
|
.Where(IsEncodeableType)
|
|
];
|
|
|
|
/// <summary>
|
|
/// Verify encode and decode of an encodeable type.
|
|
/// </summary>
|
|
[Theory]
|
|
[Category("EncodeableTypes")]
|
|
public void ActivateEncodeableType(
|
|
[ValueSource(
|
|
nameof(EncodingTypesJsonBinaryXmlAndJsonCompact))] EncodingTypeGroup encoderTypeGroup,
|
|
MemoryStreamType memoryStreamType,
|
|
Type systemType)
|
|
{
|
|
EncodingType encoderType = encoderTypeGroup.EncoderType;
|
|
JsonEncodingType jsonEncodingType = encoderTypeGroup.JsonEncodingType;
|
|
bool useXmlParser = encoderTypeGroup.UseXmlParser;
|
|
var testObject = CreateDefaultEncodeableType(systemType) as IEncodeable;
|
|
Assert.That(testObject, Is.Not.Null);
|
|
|
|
if (testObject.BinaryEncodingId.IsNull)
|
|
{
|
|
return;
|
|
}
|
|
|
|
Assert.That(testObject.BinaryEncodingId.IsNull, Is.False);
|
|
Assert.That(testObject.TypeId.IsNull, Is.False);
|
|
Assert.That(testObject.XmlEncodingId.IsNull, Is.False);
|
|
Assert.That(testObject.BinaryEncodingId, Is.Not.EqualTo(testObject.TypeId));
|
|
Assert.That(testObject.XmlEncodingId, Is.Not.EqualTo(testObject.TypeId));
|
|
Assert.That(testObject.XmlEncodingId, Is.Not.EqualTo(testObject.BinaryEncodingId));
|
|
EncodeDecode(
|
|
encoderType,
|
|
jsonEncodingType,
|
|
useXmlParser,
|
|
BuiltInType.ExtensionObject,
|
|
memoryStreamType,
|
|
new ExtensionObject(testObject));
|
|
}
|
|
|
|
[Theory]
|
|
[Category("EncodeableTypes")]
|
|
public void ActivateEncodeableTypeArray(
|
|
[ValueSource(
|
|
nameof(EncodingTypesJsonBinaryXmlAndJsonCompact))] EncodingTypeGroup encoderTypeGroup,
|
|
MemoryStreamType memoryStreamType,
|
|
Type systemType)
|
|
{
|
|
EncodingType encoderType = encoderTypeGroup.EncoderType;
|
|
JsonEncodingType jsonEncodingType = encoderTypeGroup.JsonEncodingType;
|
|
bool useXmlParser = encoderTypeGroup.UseXmlParser;
|
|
int arrayLength = DataGenerator.GetRandomByte();
|
|
var array = new ExtensionObject[arrayLength];
|
|
ExpandedNodeId dataTypeId = NodeId.Null;
|
|
for (int i = 0; i < array.Length; i++)
|
|
{
|
|
var testObject = CreateDefaultEncodeableType(systemType) as IEncodeable;
|
|
array[i] = new ExtensionObject(testObject);
|
|
if (dataTypeId.IsNull)
|
|
{
|
|
dataTypeId = testObject.TypeId;
|
|
}
|
|
}
|
|
var expected = Variant.From(array);
|
|
const string objectName = "Array";
|
|
|
|
byte[] buffer;
|
|
using (MemoryStream encoderStream = CreateEncoderMemoryStream(memoryStreamType))
|
|
{
|
|
using (
|
|
IEncoder encoder = CreateEncoder(
|
|
encoderType,
|
|
Context,
|
|
encoderStream,
|
|
systemType,
|
|
jsonEncodingType))
|
|
{
|
|
encoder.PushNamespace("urn:This:is:another:namespace");
|
|
encoder.WriteVariantValue(objectName, expected);
|
|
encoder.PopNamespace();
|
|
}
|
|
buffer = encoderStream.ToArray();
|
|
}
|
|
|
|
switch (encoderType)
|
|
{
|
|
case EncodingType.Json:
|
|
PrettifyAndValidateJson(Encoding.UTF8.GetString(buffer));
|
|
break;
|
|
case EncodingType.Xml:
|
|
string xml = Encoding.UTF8.GetString(buffer);
|
|
Assert.That(
|
|
xml.Contains(
|
|
"<Array xmlns=\"urn:This:is:another:namespace\">",
|
|
StringComparison.Ordinal),
|
|
Is.True);
|
|
break;
|
|
case EncodingType.Binary:
|
|
break;
|
|
default:
|
|
Assert.Fail($"Encoder type {encoderType} not supported.");
|
|
break;
|
|
}
|
|
|
|
Variant result;
|
|
using (var decoderStream = new MemoryStream(buffer))
|
|
using (IDecoder decoder = CreateDecoder(
|
|
encoderType,
|
|
useXmlParser,
|
|
Context,
|
|
decoderStream,
|
|
systemType))
|
|
{
|
|
decoder.PushNamespace("urn:This:is:another:namespace");
|
|
result = decoder.ReadVariantValue(objectName, expected.TypeInfo);
|
|
decoder.PopNamespace();
|
|
}
|
|
|
|
TestContext.Out.WriteLine("Result:");
|
|
TestContext.Out.WriteLine(result);
|
|
|
|
string encodeInfo =
|
|
$"Encoder: {encoderType} Type: Array of {systemType}. Expected is different from result.";
|
|
Assert.That(result, Is.EqualTo(expected), encodeInfo);
|
|
}
|
|
|
|
[Theory]
|
|
[Category("EncodeableTypes")]
|
|
public void ActivateEncodeableTypeMatrix(
|
|
[ValueSource(
|
|
nameof(EncodingTypesJsonBinaryXmlAndJsonCompact))] EncodingTypeGroup encoderTypeGroup,
|
|
MemoryStreamType memoryStreamType,
|
|
Type systemType)
|
|
{
|
|
EncodingType encoderType = encoderTypeGroup.EncoderType;
|
|
JsonEncodingType jsonEncodingType = encoderTypeGroup.JsonEncodingType;
|
|
bool useXmlParser = encoderTypeGroup.UseXmlParser;
|
|
int matrixDimension = RandomSource.NextInt32(2) + 2;
|
|
int[] dimensions = new int[matrixDimension];
|
|
SetMatrixDimensions(dimensions);
|
|
int elementsCount = ElementsFromDimension(dimensions);
|
|
var array = new ExtensionObject[elementsCount];
|
|
|
|
ExpandedNodeId dataTypeId = NodeId.Null;
|
|
for (int i = 0; i < array.Length; i++)
|
|
{
|
|
var testObject = CreateDefaultEncodeableType(systemType) as IEncodeable;
|
|
array[i] = new ExtensionObject(testObject);
|
|
if (dataTypeId.IsNull)
|
|
{
|
|
dataTypeId = testObject.TypeId;
|
|
}
|
|
}
|
|
|
|
var expected = Variant.From(array);
|
|
const string objectName = "Matrix";
|
|
|
|
byte[] buffer;
|
|
using (MemoryStream encoderStream = CreateEncoderMemoryStream(memoryStreamType))
|
|
{
|
|
using (
|
|
IEncoder encoder = CreateEncoder(
|
|
encoderType,
|
|
Context,
|
|
encoderStream,
|
|
systemType,
|
|
jsonEncodingType))
|
|
{
|
|
encoder.WriteVariantValue(objectName, expected);
|
|
}
|
|
buffer = encoderStream.ToArray();
|
|
}
|
|
|
|
if (encoderType == EncodingType.Json)
|
|
{
|
|
PrettifyAndValidateJson(Encoding.UTF8.GetString(buffer));
|
|
}
|
|
|
|
Variant result;
|
|
using (var decoderStream = new MemoryStream(buffer))
|
|
using (IDecoder decoder = CreateDecoder(
|
|
encoderType,
|
|
useXmlParser,
|
|
Context,
|
|
decoderStream,
|
|
systemType))
|
|
{
|
|
result = decoder.ReadVariantValue(objectName, expected.TypeInfo);
|
|
}
|
|
|
|
TestContext.Out.WriteLine("Result:");
|
|
TestContext.Out.WriteLine(result);
|
|
|
|
Assert.That(
|
|
result,
|
|
Is.EqualTo(expected),
|
|
$"Encoder: {encoderType} Type: Matrix of {systemType}. Expected is different from result.");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Create an instance of an encodeable type with default values.
|
|
/// </summary>
|
|
/// <param name="systemType">The type to create</param>
|
|
private static object CreateDefaultEncodeableType(Type systemType)
|
|
{
|
|
object instance = Activator.CreateInstance(systemType);
|
|
SetDefaultEncodeableType(instance);
|
|
return instance;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Set encodeable type properties recursively
|
|
/// to expected default values.
|
|
/// </summary>
|
|
/// <exception cref="ServiceResultException"></exception>
|
|
private static void SetDefaultEncodeableType(object typeInstance)
|
|
{
|
|
foreach (System.Reflection.PropertyInfo property in typeInstance.GetType()
|
|
.GetProperties())
|
|
{
|
|
if (property.CanWrite)
|
|
{
|
|
var typeInfo = TypeInfo.Construct(property.PropertyType);
|
|
switch (typeInfo.BuiltInType)
|
|
{
|
|
case BuiltInType.ExtensionObject:
|
|
object propertyObject = property.GetValue(typeInstance);
|
|
if (propertyObject == null &&
|
|
property.PropertyType.IsAssignableFrom(typeof(ExtensionObject)))
|
|
{
|
|
property.SetValue(typeInstance, ExtensionObject.Null);
|
|
}
|
|
else if (propertyObject is not null and IEncodeable)
|
|
{
|
|
SetDefaultEncodeableType(propertyObject);
|
|
}
|
|
break;
|
|
case BuiltInType.Null:
|
|
break;
|
|
case BuiltInType.DataValue:
|
|
if (property.GetValue(typeInstance) == null)
|
|
{
|
|
property.SetValue(typeInstance, new DataValue());
|
|
}
|
|
break;
|
|
case BuiltInType.NodeId:
|
|
if (property.GetValue(typeInstance) == null)
|
|
{
|
|
property.SetValue(typeInstance, NodeId.Null);
|
|
}
|
|
break;
|
|
case BuiltInType.ExpandedNodeId:
|
|
if (property.GetValue(typeInstance) == null)
|
|
{
|
|
property.SetValue(typeInstance, ExpandedNodeId.Null);
|
|
}
|
|
break;
|
|
case BuiltInType.DiagnosticInfo:
|
|
if (property.GetValue(typeInstance) == null)
|
|
{
|
|
if (typeInfo.ValueRank == ValueRanks.Scalar)
|
|
{
|
|
property.SetValue(typeInstance, new DiagnosticInfo());
|
|
}
|
|
else
|
|
{
|
|
property.SetValue(typeInstance, Array.Empty<DiagnosticInfo>());
|
|
}
|
|
}
|
|
break;
|
|
case BuiltInType.Enumeration:
|
|
if (typeInfo.ValueRank == ValueRanks.Scalar)
|
|
{
|
|
foreach (object ii in Enum.GetValues(property.PropertyType))
|
|
{
|
|
property.SetValue(typeInstance, ii);
|
|
break;
|
|
}
|
|
}
|
|
break;
|
|
case >= BuiltInType.Null and <= BuiltInType.Enumeration:
|
|
if (typeInfo.ValueRank == ValueRanks.Scalar)
|
|
{
|
|
object value = TypeInfo.GetDefaultValue(typeInfo.BuiltInType);
|
|
property.SetValue(typeInstance, value);
|
|
}
|
|
break;
|
|
default:
|
|
throw ServiceResultException.Unexpected(
|
|
$"Unexpected BuiltInType {typeInfo.BuiltInType}");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|