mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-28 22:55:49 +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.
307 lines
15 KiB
C#
307 lines
15 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.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Extensions.Logging;
|
|
using Opc.Ua.Security.Certificates;
|
|
|
|
namespace Opc.Ua
|
|
{
|
|
/// <summary>
|
|
/// The security configuration for the application.
|
|
/// </summary>
|
|
public partial class SecurityConfiguration
|
|
{
|
|
/// <summary>
|
|
/// The security profiles which are supported for this configuration.
|
|
/// </summary>
|
|
public ArrayOf<string> SupportedSecurityPolicies { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Get the provider which is invoked when a password
|
|
/// for a private key is requested.
|
|
/// </summary>
|
|
public ICertificatePasswordProvider? CertificatePasswordProvider { get; set; }
|
|
|
|
/// <summary>
|
|
/// Adds a certificate as a trusted peer.
|
|
/// </summary>
|
|
public void AddTrustedPeer(byte[] certificate)
|
|
{
|
|
TrustedPeerCertificates.TrustedCertificates =
|
|
TrustedPeerCertificates.TrustedCertificates.AddItem(
|
|
new CertificateIdentifier { RawData = certificate });
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validates the security configuration.
|
|
/// </summary>
|
|
/// <exception cref="ServiceResultException"></exception>
|
|
public void Validate(ITelemetryContext telemetry)
|
|
{
|
|
if (m_applicationCertificates.IsNull || m_applicationCertificates.Count == 0)
|
|
{
|
|
throw ServiceResultException.ConfigurationError(
|
|
"ApplicationCertificate must be specified.");
|
|
}
|
|
// ensure mandatory stores are valid
|
|
ValidateStore(TrustedIssuerCertificates, nameof(TrustedIssuerCertificates), telemetry);
|
|
ValidateStore(TrustedPeerCertificates, nameof(TrustedPeerCertificates), telemetry);
|
|
|
|
//ensure optional stores are valid if specified
|
|
if (TrustedHttpsCertificates != null)
|
|
{
|
|
ValidateStore(TrustedHttpsCertificates, nameof(TrustedHttpsCertificates), telemetry);
|
|
}
|
|
if (HttpsIssuerCertificates != null)
|
|
{
|
|
ValidateStore(HttpsIssuerCertificates, nameof(HttpsIssuerCertificates), telemetry);
|
|
}
|
|
if (TrustedUserCertificates != null)
|
|
{
|
|
ValidateStore(TrustedUserCertificates, nameof(TrustedUserCertificates), telemetry);
|
|
}
|
|
if (UserIssuerCertificates != null)
|
|
{
|
|
ValidateStore(UserIssuerCertificates, nameof(UserIssuerCertificates), telemetry);
|
|
}
|
|
|
|
if ((TrustedHttpsCertificates != null && HttpsIssuerCertificates == null) ||
|
|
(HttpsIssuerCertificates != null && TrustedHttpsCertificates == null))
|
|
{
|
|
throw ServiceResultException.ConfigurationError(
|
|
"Either none or both of HttpsIssuerCertificates & TrustedHttpsCertificates stores must be specified.");
|
|
}
|
|
|
|
if ((TrustedUserCertificates != null && UserIssuerCertificates == null) ||
|
|
(UserIssuerCertificates != null && TrustedUserCertificates == null))
|
|
{
|
|
throw ServiceResultException.ConfigurationError(
|
|
"Either none or both of UserIssuerCertificates & TrustedUserCertificates stores must be specified.");
|
|
}
|
|
|
|
// replace subjectName DC=localhost with DC=hostname
|
|
foreach (CertificateIdentifier applicationCertificate in m_applicationCertificates)
|
|
{
|
|
applicationCertificate.SubjectName = Utils.ReplaceDCLocalhost(
|
|
applicationCertificate.SubjectName);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validate if the specified store can be opened
|
|
/// throws ServiceResultException
|
|
/// </summary>
|
|
/// <exception cref="ServiceResultException"></exception>
|
|
private static void ValidateStore(
|
|
CertificateTrustList? storeIdentifier,
|
|
string storeName,
|
|
ITelemetryContext telemetry)
|
|
{
|
|
if (string.IsNullOrEmpty(storeIdentifier?.StorePath))
|
|
{
|
|
throw ServiceResultException.ConfigurationError(
|
|
"{0} StorePath must be specified.", storeName);
|
|
}
|
|
try
|
|
{
|
|
ICertificateStore store = storeIdentifier!.OpenStore(telemetry) ??
|
|
throw ServiceResultException.ConfigurationError(
|
|
"Failed to open {0} store", storeName);
|
|
store.Close();
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
ILogger<SecurityConfiguration> logger = telemetry.CreateLogger<SecurityConfiguration>();
|
|
logger.LogError(ex, "Failed to open {StoreName} store", storeName);
|
|
throw ServiceResultException.ConfigurationError("{0} store is invalid.", storeName);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Find application certificate for a security policy.
|
|
/// </summary>
|
|
public async Task<Certificate?> FindApplicationCertificateAsync(
|
|
string securityPolicy,
|
|
bool privateKey,
|
|
ITelemetryContext telemetry,
|
|
CancellationToken ct = default)
|
|
{
|
|
foreach (NodeId certType in CertificateIdentifier.MapSecurityPolicyToCertificateTypes(
|
|
securityPolicy))
|
|
{
|
|
CertificateIdentifier? id = (ApplicationCertificates.ToArray() ?? []).FirstOrDefault(certId =>
|
|
certId.CertificateType == certType);
|
|
if (id == null)
|
|
{
|
|
if (certType == ObjectTypeIds.RsaSha256ApplicationCertificateType)
|
|
{
|
|
// undefined certificate type as RsaSha256
|
|
id = (ApplicationCertificates.ToArray() ?? []).FirstOrDefault(
|
|
certId => certId.CertificateType.IsNull);
|
|
}
|
|
else if (certType == ObjectTypeIds.ApplicationCertificateType)
|
|
{
|
|
// first certificate
|
|
id = (ApplicationCertificates.ToArray() ?? []).FirstOrDefault();
|
|
}
|
|
else if (certType == ObjectTypeIds.EccApplicationCertificateType)
|
|
{
|
|
// first Ecc certificate (matches by configured CertificateType
|
|
// since identifier no longer caches a Certificate to inspect).
|
|
id = (ApplicationCertificates.ToArray() ?? []).FirstOrDefault(certId =>
|
|
certId.CertificateType == ObjectTypeIds.EccNistP256ApplicationCertificateType ||
|
|
certId.CertificateType == ObjectTypeIds.EccNistP384ApplicationCertificateType ||
|
|
certId.CertificateType == ObjectTypeIds.EccBrainpoolP256r1ApplicationCertificateType ||
|
|
certId.CertificateType == ObjectTypeIds.EccBrainpoolP384r1ApplicationCertificateType ||
|
|
certId.CertificateType == ObjectTypeIds.EccCurve25519ApplicationCertificateType ||
|
|
certId.CertificateType == ObjectTypeIds.EccCurve448ApplicationCertificateType);
|
|
}
|
|
}
|
|
|
|
if (id != null)
|
|
{
|
|
if (privateKey)
|
|
{
|
|
return await CertificateIdentifierResolver
|
|
.LoadPrivateKeyAsync(
|
|
id,
|
|
CertificatePasswordProvider,
|
|
applicationUri: null,
|
|
telemetry,
|
|
ct)
|
|
.ConfigureAwait(false);
|
|
}
|
|
|
|
return await CertificateIdentifierResolver
|
|
.ResolveAsync(
|
|
id,
|
|
registry: null,
|
|
needPrivateKey: false,
|
|
applicationUri: null,
|
|
telemetry,
|
|
ct)
|
|
.ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Use the list of application certificates to build a list
|
|
/// of supported security policies.
|
|
/// </summary>
|
|
private ArrayOf<string> BuildSupportedSecurityPolicies()
|
|
{
|
|
var securityPolicies = new List<string> { SecurityPolicies.None };
|
|
foreach (CertificateIdentifier applicationCertificate in m_applicationCertificates)
|
|
{
|
|
if (applicationCertificate.CertificateType.IsNull)
|
|
{
|
|
securityPolicies.Add(SecurityPolicies.Basic256Sha256);
|
|
securityPolicies.Add(SecurityPolicies.Aes128_Sha256_RsaOaep);
|
|
securityPolicies.Add(SecurityPolicies.Aes256_Sha256_RsaPss);
|
|
securityPolicies.Add(SecurityPolicies.RSA_DH_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.RSA_DH_ChaChaPoly);
|
|
continue;
|
|
}
|
|
if (applicationCertificate.CertificateType.TryGetValue(out uint identifier))
|
|
{
|
|
switch (identifier)
|
|
{
|
|
case ObjectTypes.EccNistP256ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP256);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP256_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP256_ChaChaPoly);
|
|
break;
|
|
case ObjectTypes.EccNistP384ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP256);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP256_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP256_ChaChaPoly);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP384);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP384_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_nistP384_ChaChaPoly);
|
|
break;
|
|
case ObjectTypes.EccBrainpoolP256r1ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP256r1);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP256r1_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP256r1_ChaChaPoly);
|
|
break;
|
|
case ObjectTypes.EccBrainpoolP384r1ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP256r1);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP256r1_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP256r1_ChaChaPoly);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP384r1);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP384r1_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_brainpoolP384r1_ChaChaPoly);
|
|
break;
|
|
case ObjectTypes.EccCurve25519ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.ECC_curve25519);
|
|
securityPolicies.Add(SecurityPolicies.ECC_curve25519_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_curve25519_ChaChaPoly);
|
|
break;
|
|
case ObjectTypes.EccCurve448ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.ECC_curve448);
|
|
securityPolicies.Add(SecurityPolicies.ECC_curve448_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.ECC_curve448_ChaChaPoly);
|
|
break;
|
|
case ObjectTypes.RsaMinApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.Basic128Rsa15);
|
|
securityPolicies.Add(SecurityPolicies.Basic256);
|
|
break;
|
|
case ObjectTypes.ApplicationCertificateType:
|
|
case ObjectTypes.RsaSha256ApplicationCertificateType:
|
|
securityPolicies.Add(SecurityPolicies.Basic256Sha256);
|
|
securityPolicies.Add(SecurityPolicies.Aes128_Sha256_RsaOaep);
|
|
securityPolicies.Add(SecurityPolicies.Aes256_Sha256_RsaPss);
|
|
securityPolicies.Add(SecurityPolicies.RSA_DH_AesGcm);
|
|
securityPolicies.Add(SecurityPolicies.RSA_DH_ChaChaPoly);
|
|
goto case ObjectTypes.RsaMinApplicationCertificateType;
|
|
}
|
|
}
|
|
}
|
|
// filter based on platform support
|
|
var result = new List<string>();
|
|
foreach (string securityPolicyUri in securityPolicies.Distinct())
|
|
{
|
|
if (SecurityPolicies.GetDisplayName(securityPolicyUri) != null)
|
|
{
|
|
result.Add(securityPolicyUri);
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
}
|
|
}
|