mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-27 21:55:54 +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.
668 lines
29 KiB
C#
668 lines
29 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.Diagnostics.CodeAnalysis;
|
|
using Microsoft.Extensions.Configuration;
|
|
using Microsoft.Extensions.DependencyInjection.Extensions;
|
|
using Microsoft.Extensions.Hosting;
|
|
using Microsoft.Extensions.Logging;
|
|
using Opc.Ua;
|
|
using Opc.Ua.Gds.Server;
|
|
using Opc.Ua.Gds.Server.Database;
|
|
using Opc.Ua.Gds.Server.Hosting;
|
|
using Opc.Ua.Gds.Server.Identity;
|
|
using Opc.Ua.Identity;
|
|
using Opc.Ua.Server;
|
|
using Opc.Ua.Server.Hosting;
|
|
using Opc.Ua.Server.UserDatabase;
|
|
using ServerAccessTokenProvider = Opc.Ua.Gds.Server.IAccessTokenProvider;
|
|
|
|
namespace Microsoft.Extensions.DependencyInjection
|
|
{
|
|
/// <summary>
|
|
/// <see cref="IOpcUaBuilder"/> extensions provided by
|
|
/// <c>Opc.Ua.Gds.Server.Common</c>: register an OPC UA Global
|
|
/// Discovery Server hosted as an <see cref="IHostedService"/> so
|
|
/// the .NET Generic Host owns its lifetime, logging pipeline and
|
|
/// Ctrl+C / SIGTERM handling.
|
|
/// </summary>
|
|
public static class OpcUaGdsServerBuilderExtensions
|
|
{
|
|
/// <summary>
|
|
/// Default <see cref="IConfiguration"/> section name used by the
|
|
/// <see cref="AddGdsServer(IOpcUaBuilder, IConfiguration)"/>
|
|
/// overload.
|
|
/// </summary>
|
|
public const string DefaultConfigurationSection = "OpcUa:Gds:Server";
|
|
|
|
/// <summary>
|
|
/// Registers an OPC UA Global Discovery Server hosted as an
|
|
/// <see cref="IHostedService"/> and returns an
|
|
/// <see cref="IGdsServerBuilder"/> for chaining the pluggable
|
|
/// service registrations (applications database, certificate
|
|
/// stores, user database, optional token / key-credential /
|
|
/// managed application stores).
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// The hosted service builds an <see cref="ApplicationConfiguration"/>
|
|
/// from the supplied <see cref="GdsServerOptions"/>, attaches a
|
|
/// <see cref="GlobalDiscoveryServerConfiguration"/> extension,
|
|
/// ensures the application instance certificate is present, then
|
|
/// starts a <see cref="GlobalDiscoverySampleServer"/> subclass
|
|
/// that wires the resolved services into the
|
|
/// <see cref="ApplicationsNodeManager"/>.
|
|
/// </para>
|
|
/// <para>
|
|
/// Calling this method twice on the same
|
|
/// <see cref="IServiceCollection"/> throws
|
|
/// <see cref="InvalidOperationException"/>: at most one GDS
|
|
/// server may be registered per service collection. A GDS
|
|
/// server can coexist with a regular server registered via
|
|
/// <c>.AddServer(...)</c>.
|
|
/// </para>
|
|
/// </remarks>
|
|
/// <param name="builder">The OPC UA builder.</param>
|
|
/// <param name="configure">Required callback used to populate
|
|
/// <see cref="GdsServerOptions"/>.</param>
|
|
/// <returns>An <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="builder"/>
|
|
/// or <paramref name="configure"/> is <c>null</c>.</exception>
|
|
/// <exception cref="InvalidOperationException">A GDS server is
|
|
/// already registered.</exception>
|
|
public static IGdsServerBuilder AddGdsServer(
|
|
this IOpcUaBuilder builder,
|
|
Action<GdsServerOptions> configure)
|
|
{
|
|
if (builder is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(builder));
|
|
}
|
|
if (configure is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(configure));
|
|
}
|
|
|
|
EnsureFirstRegistration(builder.Services);
|
|
|
|
builder.Services.AddOptions<GdsServerOptions>().Configure(configure);
|
|
RegisterCommonServices(builder.Services);
|
|
|
|
return new GdsServerBuilder(builder.Services);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an OPC UA Global Discovery Server hosted as an
|
|
/// <see cref="IHostedService"/> with options bound from the
|
|
/// supplied <paramref name="configuration"/> section
|
|
/// <see cref="DefaultConfigurationSection"/>
|
|
/// (<c>OpcUa:Gds:Server</c>).
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// AOT-safe: bound by the .NET 8+ configuration binding source
|
|
/// generator (<c>EnableConfigurationBindingGenerator</c>).
|
|
/// </remarks>
|
|
/// <param name="builder">The OPC UA builder.</param>
|
|
/// <param name="configuration">Configuration root containing
|
|
/// the <c>OpcUa:Gds:Server</c> section.</param>
|
|
/// <exception cref="ArgumentNullException"><paramref name="builder"/>
|
|
/// or <paramref name="configuration"/> is <c>null</c>.</exception>
|
|
/// <exception cref="InvalidOperationException">A GDS server is
|
|
/// already registered.</exception>
|
|
public static IGdsServerBuilder AddGdsServer(
|
|
this IOpcUaBuilder builder,
|
|
IConfiguration configuration)
|
|
{
|
|
if (configuration is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(configuration));
|
|
}
|
|
return builder.AddGdsServer(configuration.GetSection(DefaultConfigurationSection));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an OPC UA Global Discovery Server hosted as an
|
|
/// <see cref="IHostedService"/> with options bound from the
|
|
/// supplied <paramref name="section"/>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// AOT-safe: bound by the .NET 8+ configuration binding source
|
|
/// generator (<c>EnableConfigurationBindingGenerator</c>).
|
|
/// </remarks>
|
|
/// <param name="builder">The OPC UA builder.</param>
|
|
/// <param name="section">Configuration section to bind.</param>
|
|
/// <exception cref="ArgumentNullException"><paramref name="builder"/>
|
|
/// or <paramref name="section"/> is <c>null</c>.</exception>
|
|
/// <exception cref="InvalidOperationException">A GDS server is
|
|
/// already registered.</exception>
|
|
public static IGdsServerBuilder AddGdsServer(
|
|
this IOpcUaBuilder builder,
|
|
IConfigurationSection section)
|
|
{
|
|
if (builder is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(builder));
|
|
}
|
|
if (section is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(section));
|
|
}
|
|
|
|
EnsureFirstRegistration(builder.Services);
|
|
|
|
builder.Services.AddOptions<GdsServerOptions>().Bind(section);
|
|
RegisterCommonServices(builder.Services);
|
|
|
|
return new GdsServerBuilder(builder.Services);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a GDS server-side identity authenticator and adds it to
|
|
/// the server registry on startup.
|
|
/// </summary>
|
|
/// <typeparam name="TAuth">The authenticator type.</typeparam>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddIdentityAuthenticator<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TAuth>(
|
|
this IGdsServerBuilder gdsBuilder)
|
|
where TAuth : class, IUserTokenAuthenticator
|
|
{
|
|
ToServerBuilder(gdsBuilder).AddIdentityAuthenticator<TAuth>(
|
|
);
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a GDS server-side identity augmenter and adds it to the
|
|
/// server registry on startup.
|
|
/// </summary>
|
|
/// <typeparam name="TAugmenter">The augmenter type.</typeparam>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddIdentityAugmenter<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TAugmenter>(
|
|
this IGdsServerBuilder gdsBuilder)
|
|
where TAugmenter : class, IIdentityAugmenter
|
|
{
|
|
ToServerBuilder(gdsBuilder).AddIdentityAugmenter<TAugmenter>(
|
|
);
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a GDS server-side identity augmenter factory and adds it
|
|
/// to the server registry on startup.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="factory">Factory that materialises the augmenter.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// or <paramref name="factory"/> is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddIdentityAugmenter(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
Func<IServiceProvider, IIdentityAugmenter> factory)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
if (factory is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(factory));
|
|
}
|
|
|
|
serverBuilder.AddIdentityAugmenter(factory);
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers the default GDS ApplicationSelfAdmin identity augmenter.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddGdsApplicationSelfAdminProvider(
|
|
this IGdsServerBuilder gdsBuilder)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
SuppressBuiltInGdsApplicationSelfAdminProvider(gdsBuilder.Services);
|
|
serverBuilder.AddIdentityAugmenter(
|
|
sp => new GdsApplicationSelfAdminProvider(
|
|
sp.GetRequiredService<IApplicationsDatabase>(),
|
|
sp.GetRequiredService<ILogger<GdsApplicationSelfAdminProvider>>()));
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers the built-in GDS identity authenticators that can be
|
|
/// resolved from DI and server state.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="configure">Callback used to populate
|
|
/// <see cref="GdsDefaultIdentityAuthenticatorOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// or <paramref name="configure"/> is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddDefaultIdentityAuthenticators(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
Action<GdsDefaultIdentityAuthenticatorOptions> configure)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
if (configure is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(configure));
|
|
}
|
|
|
|
var options = new GdsDefaultIdentityAuthenticatorOptions();
|
|
configure(options);
|
|
serverBuilder.AddDefaultIdentityAuthenticators(
|
|
serverOptions => CopyDefaultAuthenticatorOptions(serverOptions, options));
|
|
if (options.EnableGdsApplicationSelfAdminProvider)
|
|
{
|
|
AddGdsApplicationSelfAdminProvider(gdsBuilder);
|
|
}
|
|
else
|
|
{
|
|
SuppressBuiltInGdsApplicationSelfAdminProvider(gdsBuilder.Services);
|
|
}
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Configures the default role manager used by the hosted GDS server
|
|
/// using configuration binding.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="section">Configuration section bound to
|
|
/// <see cref="RoleConfigurationOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// or <paramref name="section"/> is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder ConfigureRoles(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
IConfiguration section)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
if (section is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(section));
|
|
}
|
|
|
|
serverBuilder.ConfigureRoles(section);
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers the default identity authenticators without the GDS ApplicationSelfAdmin identity augmenter.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder DisableGdsApplicationSelfAdminProvider(
|
|
this IGdsServerBuilder gdsBuilder)
|
|
{
|
|
return AddDefaultIdentityAuthenticators(
|
|
gdsBuilder,
|
|
options => options.EnableGdsApplicationSelfAdminProvider = false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers the built-in GDS identity authenticators with options
|
|
/// bound from a configuration section.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="section">Configuration section bound to
|
|
/// <see cref="GdsDefaultIdentityAuthenticatorOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// or <paramref name="section"/> is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddDefaultIdentityAuthenticators(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
IConfiguration section)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
if (section is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(section));
|
|
}
|
|
|
|
serverBuilder.AddDefaultIdentityAuthenticators(
|
|
section);
|
|
if (GetBoolean(
|
|
section,
|
|
nameof(GdsDefaultIdentityAuthenticatorOptions.EnableGdsApplicationSelfAdminProvider),
|
|
defaultValue: true))
|
|
{
|
|
AddGdsApplicationSelfAdminProvider(gdsBuilder);
|
|
}
|
|
else
|
|
{
|
|
SuppressBuiltInGdsApplicationSelfAdminProvider(gdsBuilder.Services);
|
|
}
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a trusted JWT issuer with the GDS server from code.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="configure">Callback used to populate
|
|
/// <see cref="JwtIssuerOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// or <paramref name="configure"/> is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddJwtIssuer(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
Action<JwtIssuerOptions> configure)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
if (configure is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(configure));
|
|
}
|
|
|
|
serverBuilder.AddJwtIssuer(configure);
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a trusted JWT issuer with the GDS server from a
|
|
/// configuration section.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="section">Configuration section bound to
|
|
/// <see cref="JwtIssuerOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="gdsBuilder"/>
|
|
/// or <paramref name="section"/> is <c>null</c>.</exception>
|
|
public static IGdsServerBuilder AddJwtIssuer(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
IConfiguration section)
|
|
{
|
|
IOpcUaServerBuilder serverBuilder = ToServerBuilder(gdsBuilder);
|
|
if (section is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(section));
|
|
}
|
|
|
|
serverBuilder.AddJwtIssuer(section);
|
|
return gdsBuilder;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Enables the default GDS AuthorizationService backed by an
|
|
/// ECDSA/RSA JWT issuer.
|
|
/// </summary>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="configure">Callback used to populate
|
|
/// <see cref="AuthorizationServiceOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
public static IGdsServerBuilder WithAuthorizationService(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
Action<AuthorizationServiceOptions> configure)
|
|
{
|
|
return WithAuthorizationService<CertificateJwtIssuer>(gdsBuilder, configure);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Enables the GDS AuthorizationService with a custom token issuer.
|
|
/// </summary>
|
|
/// <typeparam name="TIssuer">The issuer implementation.</typeparam>
|
|
/// <param name="gdsBuilder">The GDS server builder.</param>
|
|
/// <param name="configure">Callback used to populate
|
|
/// <see cref="AuthorizationServiceOptions"/>.</param>
|
|
/// <returns>The same <see cref="IGdsServerBuilder"/> for chaining.</returns>
|
|
public static IGdsServerBuilder WithAuthorizationService<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TIssuer>(
|
|
this IGdsServerBuilder gdsBuilder,
|
|
Action<AuthorizationServiceOptions> configure)
|
|
where TIssuer : class, ITokenIssuer
|
|
{
|
|
if (gdsBuilder is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(gdsBuilder));
|
|
}
|
|
if (configure is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(configure));
|
|
}
|
|
|
|
gdsBuilder.Services.AddOptions<AuthorizationServiceOptions>().Configure(configure);
|
|
gdsBuilder.Services.TryAddSingleton<TIssuer>();
|
|
gdsBuilder.Services.TryAddSingleton<ITokenIssuer>(sp => sp.GetRequiredService<TIssuer>());
|
|
gdsBuilder.Services.TryAddSingleton<InMemoryAccessTokenProvider>();
|
|
gdsBuilder.Services.TryAddSingleton<AuthorizationServiceManager>();
|
|
gdsBuilder.Services.TryAddSingleton<ServerAccessTokenProvider>(
|
|
sp => sp.GetRequiredService<AuthorizationServiceManager>());
|
|
return gdsBuilder;
|
|
}
|
|
|
|
private static ForwardingServerBuilder ToServerBuilder(IGdsServerBuilder gdsBuilder)
|
|
{
|
|
if (gdsBuilder is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(gdsBuilder));
|
|
}
|
|
|
|
return new ForwardingServerBuilder(gdsBuilder.Services);
|
|
}
|
|
|
|
private static void EnsureFirstRegistration(IServiceCollection services)
|
|
{
|
|
foreach (ServiceDescriptor d in services)
|
|
{
|
|
if (d.ServiceType == typeof(GdsServerRegistrationMarker))
|
|
{
|
|
throw new InvalidOperationException(
|
|
"AddGdsServer has already been called. At most one GDS server may be registered per service collection.");
|
|
}
|
|
}
|
|
services.AddSingleton<GdsServerRegistrationMarker>();
|
|
}
|
|
|
|
private static void RegisterCommonServices(IServiceCollection services)
|
|
{
|
|
// Ensure the shared ITelemetryContext and the default
|
|
// IApplicationInstanceFactory are registered (both
|
|
// idempotent: TryAddSingleton). Mirrors the
|
|
// OpcUaServerBuilderExtensions pattern so the GDS feature
|
|
// can be added independently of AddServer.
|
|
services.AddOpcUa().AddApplicationInstance();
|
|
services.AddOptions<GdsDefaultIdentityAuthenticatorOptions>();
|
|
|
|
services.AddHostedService<GdsServerHostedService>();
|
|
}
|
|
|
|
private static void SuppressBuiltInGdsApplicationSelfAdminProvider(IServiceCollection services)
|
|
{
|
|
services.PostConfigure<GdsDefaultIdentityAuthenticatorOptions>(
|
|
options => options.EnableGdsApplicationSelfAdminProvider = false);
|
|
}
|
|
|
|
private static void CopyDefaultAuthenticatorOptions(
|
|
DefaultAuthenticatorOptions target,
|
|
GdsDefaultIdentityAuthenticatorOptions source)
|
|
{
|
|
target.EnableAnonymous = source.EnableAnonymous;
|
|
target.EnableUserNamePassword = source.EnableUserNamePassword;
|
|
target.EnableX509 = source.EnableX509;
|
|
target.EnableJwt = source.EnableJwt;
|
|
target.UserDatabase = source.UserDatabase;
|
|
target.UserManagement = source.UserManagement;
|
|
target.UserCertificateTrustList = source.UserCertificateTrustList;
|
|
target.IssuerKeyResolver = source.IssuerKeyResolver;
|
|
target.ExpectedAudience = source.ExpectedAudience;
|
|
target.ClockSkewTolerance = source.ClockSkewTolerance;
|
|
}
|
|
|
|
private static bool GetBoolean(IConfiguration section, string key, bool defaultValue)
|
|
{
|
|
string? value = section[key];
|
|
return string.IsNullOrEmpty(value) ? defaultValue : bool.Parse(value);
|
|
}
|
|
|
|
private sealed class ForwardingServerBuilder : IOpcUaServerBuilder
|
|
{
|
|
public ForwardingServerBuilder(IServiceCollection services)
|
|
{
|
|
Services = services;
|
|
}
|
|
|
|
public IServiceCollection Services { get; }
|
|
|
|
public IOpcUaServerBuilder AddNodeManager<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TFactory>()
|
|
where TFactory : class, IAsyncNodeManagerFactory
|
|
{
|
|
Services.AddSingleton<TFactory>();
|
|
Services.AddSingleton(sp => new OpcUaServerNodeManagerRegistration(
|
|
sp.GetRequiredService<TFactory>()));
|
|
return this;
|
|
}
|
|
|
|
public IOpcUaServerBuilder AddSyncNodeManager<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] TFactory>()
|
|
where TFactory : class, INodeManagerFactory
|
|
{
|
|
Services.AddSingleton<TFactory>();
|
|
Services.AddSingleton(sp => new OpcUaServerNodeManagerRegistration(
|
|
sp.GetRequiredService<TFactory>()));
|
|
return this;
|
|
}
|
|
}
|
|
|
|
private sealed class GdsServerBuilder : IGdsServerBuilder
|
|
{
|
|
public GdsServerBuilder(IServiceCollection services)
|
|
{
|
|
Services = services;
|
|
}
|
|
|
|
public IServiceCollection Services { get; }
|
|
|
|
public IGdsServerBuilder AddApplicationsDatabase<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, IApplicationsDatabase
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<IApplicationsDatabase>(
|
|
sp => sp.GetRequiredService<T>());
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddApplicationsDatabase(
|
|
Func<IServiceProvider, IApplicationsDatabase> factory)
|
|
{
|
|
if (factory is null)
|
|
{
|
|
throw new ArgumentNullException(nameof(factory));
|
|
}
|
|
Services.AddSingleton(factory);
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddUserDatabase<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, IUserDatabase
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<IUserDatabase>(
|
|
sp => sp.GetRequiredService<T>());
|
|
|
|
// If T also implements IGdsUserDatabase, expose it via
|
|
// that interface too so consumers can resolve the
|
|
// GDS-specific membership API directly.
|
|
if (typeof(IGdsUserDatabase).IsAssignableFrom(typeof(T)))
|
|
{
|
|
Services.AddSingleton<IGdsUserDatabase>(
|
|
sp => (IGdsUserDatabase)sp.GetRequiredService<T>());
|
|
}
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddCertificateGroup<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, ICertificateGroup
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<ICertificateGroup>(
|
|
sp => sp.GetRequiredService<T>());
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddCertificateRequest<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, ICertificateRequest
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<ICertificateRequest>(
|
|
sp => sp.GetRequiredService<T>());
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddAccessTokenProvider<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, ServerAccessTokenProvider
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<ServerAccessTokenProvider>(
|
|
sp => sp.GetRequiredService<T>());
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddKeyCredentialRequestStore<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, IKeyCredentialRequestStore
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<IKeyCredentialRequestStore>(
|
|
sp => sp.GetRequiredService<T>());
|
|
return this;
|
|
}
|
|
|
|
public IGdsServerBuilder AddConfigurationDataStore<
|
|
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
|
|
where T : class, IConfigurationDataStore
|
|
{
|
|
Services.AddSingleton<T>();
|
|
Services.AddSingleton<IConfigurationDataStore>(
|
|
sp => sp.GetRequiredService<T>());
|
|
return this;
|
|
}
|
|
}
|
|
|
|
private sealed class GdsServerRegistrationMarker;
|
|
}
|
|
}
|