using Grpc.Core; using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Extensions.Options; using Shouldly; using Xunit; using ZB.MOM.WW.OtOpcUa.Cluster; using ZB.MOM.WW.OtOpcUa.Host.Configuration; namespace ZB.MOM.WW.OtOpcUa.Host.Tests.Configuration; /// /// Per-cluster mesh Phase 5 — the telemetry stream endpoint's inbound gate. Wiring this /// interceptor into the AddGrpc pipeline + Kestrel is a separate, later task; this test /// covers only the interceptor's own authorization behavior. /// /// /// Same contract as / , /// scoped to /telemetry.v1.TelemetryStreamService/ — fail-closed on an unconfigured key, /// constant-time comparison, gated on every handler shape so scoping holds regardless of RPC shape. /// public sealed class TelemetryStreamAuthInterceptorTests { private const string SubscribeMethod = "/telemetry.v1.TelemetryStreamService/Subscribe"; private const string OtherMethod = "/deployment_artifact.v1.DeploymentArtifactService/Fetch"; private static TelemetryStreamAuthInterceptor CreateInterceptor(string? apiKey) => new( Options.Create(new TelemetryOptions { ApiKey = apiKey ?? string.Empty }), NullLogger.Instance); private static ServerCallContext CreateContext(string method, string? authorizationHeader) { var headers = new Metadata(); if (authorizationHeader is not null) headers.Add("authorization", authorizationHeader); return new FakeServerCallContext(method, headers); } /// Invokes the interceptor's server-streaming path (how Subscribe actually runs). private static Task Invoke(TelemetryStreamAuthInterceptor interceptor, ServerCallContext context) => interceptor.ServerStreamingServerHandler( "request", responseStream: null!, context, (_, _, _) => Task.CompletedTask); [Fact] public async Task NonTelemetryMethod_PassesThrough_EvenWithNoKeyConfigured() { // The interceptor shares the AddGrpc pipeline with other gRPC services, so it sees every // call. It must be scoped strictly to the telemetry service. var interceptor = CreateInterceptor(apiKey: null); var context = CreateContext(OtherMethod, authorizationHeader: null); await Invoke(interceptor, context); // no throw } [Fact] public async Task SubscribeMethod_WithNoKeyConfigured_IsDenied_EvenWithABearerToken() { // Fail-closed. "No key configured" is the DEFAULT — treating it as "no auth required" would // expose live telemetry on exactly the shape most nodes ship with. A token must not help. var interceptor = CreateInterceptor(apiKey: null); var context = CreateContext(SubscribeMethod, "Bearer anything-at-all"); var ex = await Should.ThrowAsync(() => Invoke(interceptor, context)); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task SubscribeMethod_WithNoBearerToken_IsDenied() { var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, authorizationHeader: null); var ex = await Should.ThrowAsync(() => Invoke(interceptor, context)); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task SubscribeMethod_WithMalformedAuthorizationHeader_IsDenied() { // No "Bearer " prefix at all — must be treated the same as a missing header. var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "the-shared-key"); var ex = await Should.ThrowAsync(() => Invoke(interceptor, context)); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task SubscribeMethod_WithWrongBearerToken_IsDenied() { var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "Bearer the-wrong-key"); var ex = await Should.ThrowAsync(() => Invoke(interceptor, context)); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task SubscribeMethod_WithCorrectBearerToken_PassesThrough() { var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "Bearer the-shared-key"); await Invoke(interceptor, context); // no throw } [Fact] public async Task SubscribeMethod_TokenComparison_IsNotAPrefixMatch() { // A prefix/StartsWith comparison would accept a truncated key and make the secret // recoverable one character at a time. var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "Bearer the-shared-ke"); var ex = await Should.ThrowAsync(() => Invoke(interceptor, context)); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task UnaryPath_IsAlsoGated() { // Subscribe is server-streaming today, but gating only that path would leave any future // unary method on the same service open. Gate every handler shape. var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "Bearer the-wrong-key"); var ex = await Should.ThrowAsync(() => interceptor.UnaryServerHandler( "request", context, (_, _) => Task.FromResult("ok"))); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task ClientStreamingPath_IsAlsoGated() { var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "Bearer the-wrong-key"); var ex = await Should.ThrowAsync(() => interceptor.ClientStreamingServerHandler( requestStream: null!, context, (_, _) => Task.FromResult("ok"))); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public async Task DuplexStreamingPath_IsAlsoGated() { var interceptor = CreateInterceptor("the-shared-key"); var context = CreateContext(SubscribeMethod, "Bearer the-wrong-key"); var ex = await Should.ThrowAsync(() => interceptor.DuplexStreamingServerHandler( requestStream: null!, responseStream: null!, context, (_, _, _) => Task.CompletedTask)); ex.StatusCode.ShouldBe(StatusCode.PermissionDenied); } [Fact] public void HasExactlyOnePublicConstructor() { // Grpc.AspNetCore silently stops invoking an interceptor with more than one public ctor — // this pins the shape so a well-meaning overload doesn't quietly disable auth in production. var publicCtors = typeof(TelemetryStreamAuthInterceptor).GetConstructors(); publicCtors.Length.ShouldBe(1); } /// /// Minimal carrying just a method name and request headers — /// the only two things the interceptor reads. Hand-rolled because /// Grpc.Core.Testing.TestServerCallContext ships only in the retired native package. /// private sealed class FakeServerCallContext(string method, Metadata requestHeaders) : ServerCallContext { protected override string MethodCore => method; protected override string HostCore => "localhost"; protected override string PeerCore => "ipv4:127.0.0.1:12345"; protected override DateTime DeadlineCore => DateTime.UtcNow.AddMinutes(1); protected override Metadata RequestHeadersCore => requestHeaders; protected override CancellationToken CancellationTokenCore => CancellationToken.None; protected override Metadata ResponseTrailersCore { get; } = []; protected override Status StatusCore { get; set; } protected override WriteOptions? WriteOptionsCore { get; set; } protected override AuthContext AuthContextCore { get; } = new(null, new Dictionary>()); protected override ContextPropagationToken CreatePropagationTokenCore( ContextPropagationOptions? options) => throw new NotSupportedException(); protected override Task WriteResponseHeadersAsyncCore(Metadata responseHeaders) => Task.CompletedTask; } }