Files
scadaproj/ZB.MOM.WW.Secrets/tests/ZB.MOM.WW.Secrets.Ui.Tests/RevealButtonTests.cs
T

308 lines
14 KiB
C#

using Bunit;
using Bunit.TestDoubles;
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Authorization;
using Microsoft.AspNetCore.Components.Web;
using System.Security.Claims;
using Microsoft.Extensions.DependencyInjection;
using ZB.MOM.WW.Audit;
using ZB.MOM.WW.Secrets.Abstractions;
using ZB.MOM.WW.Secrets.Ui.Components;
using ZB.MOM.WW.Secrets.Ui.Tests.Fakes;
namespace ZB.MOM.WW.Secrets.Ui.Tests;
public class RevealButtonTests : BunitContext
{
public RevealButtonTests() => RevealInterop.Setup(JSInterop);
private const string PlainValue = "the-plaintext-value-42";
private (RecordingSecretStore Store, CapturingAuditWriter Audit, FakeCipher Cipher) RegisterServices()
{
var store = new RecordingSecretStore();
var audit = new CapturingAuditWriter();
var cipher = new FakeCipher();
Services.AddSingleton<ISecretStore>(store);
Services.AddSingleton<IAuditWriter>(audit);
Services.AddSingleton<ISecretCipher>(cipher);
return (store, audit, cipher);
}
private static StoredSecret Row(SecretName name, string plaintext)
=> new FakeCipher().Encrypt(name, plaintext, SecretContentType.Text) with
{
Revision = 1,
CreatedUtc = DateTimeOffset.UnixEpoch,
UpdatedUtc = DateTimeOffset.UnixEpoch,
};
[Fact]
public void RevealButton_ShowsValueOnClick_AndAudits()
{
var (store, audit, _) = RegisterServices();
var name = new SecretName("api/token");
store.Seed(Row(name, PlainValue));
var auth = this.AddAuthorization();
auth.SetAuthorized("carol");
auth.SetPolicies(SecretsAuthorization.RevealPolicy);
var cut = Render<RevealButton>(p => p.Add(c => c.Name, name));
// The value is NOT present before the reveal click.
Assert.DoesNotContain(PlainValue, cut.Markup);
Assert.Empty(audit.Events);
cut.Find("button.reveal-secret").Click();
// After the click the plaintext is shown and a Success reveal audit is recorded.
Assert.Contains(PlainValue, cut.Markup);
Assert.Single(audit.Events);
AuditEvent evt = audit.Events[0];
Assert.Equal("secret.reveal", evt.Action);
Assert.Equal(AuditOutcome.Success, evt.Outcome);
Assert.Equal("Secrets", evt.Category);
Assert.Equal("api/token", evt.Target);
Assert.Equal("carol", evt.Actor);
AssertNoValueLeak(evt);
}
[Fact]
public void RevealButton_MissingSecret_AuditsFailure()
{
var (_, audit, _) = RegisterServices();
var name = new SecretName("api/missing");
var auth = this.AddAuthorization();
auth.SetAuthorized("carol");
auth.SetPolicies(SecretsAuthorization.RevealPolicy);
var cut = Render<RevealButton>(p => p.Add(c => c.Name, name));
cut.Find("button.reveal-secret").Click();
// No value shown; a Failure reveal audit recorded.
Assert.DoesNotContain(PlainValue, cut.Markup);
Assert.Single(audit.Events);
AuditEvent evt = audit.Events[0];
Assert.Equal("secret.reveal", evt.Action);
Assert.Equal(AuditOutcome.Failure, evt.Outcome);
Assert.Equal("api/missing", evt.Target);
}
[Fact]
public void RevealButton_DecryptFault_AuditsFailure_ShowsError_NoValue()
{
var (store, audit, cipher) = RegisterServices();
var name = new SecretName("api/token");
store.Seed(Row(name, PlainValue));
cipher.FailDecrypt = true;
var auth = this.AddAuthorization();
auth.SetAuthorized("carol");
auth.SetPolicies(SecretsAuthorization.RevealPolicy);
var cut = Render<RevealButton>(p => p.Add(c => c.Name, name));
// The click must not throw into the Blazor event pipeline.
cut.Find("button.reveal-secret").Click();
// No value shown, an error surfaced, and a Failure reveal audit recorded (no value leak).
Assert.DoesNotContain(PlainValue, cut.Markup);
Assert.NotEmpty(cut.FindAll("[data-testid=reveal-error]"));
Assert.Single(audit.Events);
AuditEvent evt = audit.Events[0];
Assert.Equal("secret.reveal", evt.Action);
Assert.Equal(AuditOutcome.Failure, evt.Outcome);
Assert.Equal("api/token", evt.Target);
Assert.Equal("carol", evt.Actor);
AssertNoValueLeak(evt);
}
[Fact]
public void RevealOutcome_IsNonSensitiveAndHideClearsTheValueWithStableControlIdentity()
{
var (store, _, _) = RegisterServices();
AuthorizeReveal();
var name = new SecretName("app/a");
store.Seed(Row(name, PlainValue));
var cut = Render<RevealButton>(p => p.Add(x => x.Name, name));
string? controlId = cut.Find("[data-testid=reveal-button]").Id;
Assert.False(string.IsNullOrWhiteSpace(controlId));
Assert.Equal("", cut.Find("[data-testid=reveal-status][role=status]").TextContent);
cut.Find("[data-testid=reveal-button]").Click();
Assert.Equal(PlainValue, cut.Find("[data-testid=revealed-value]").TextContent);
var status = cut.Find("[data-testid=reveal-status][role=status]");
Assert.Contains("Value revealed", status.TextContent);
Assert.DoesNotContain(PlainValue, status.TextContent);
Assert.DoesNotContain(PlainValue, cut.Find("[data-testid=hide-button]").GetAttribute("aria-label"));
Assert.Equal(controlId, cut.Find("[data-testid=hide-button]").Id);
cut.Find("[data-testid=hide-button]").Click();
Assert.Empty(cut.FindAll("[data-testid=revealed-value]"));
Assert.DoesNotContain(PlainValue, cut.Markup);
Assert.Contains("hidden", cut.Find("[data-testid=reveal-status]").TextContent);
Assert.Equal(controlId, cut.Find("[data-testid=reveal-button]").Id);
}
[Fact]
public void ChangingRevealTarget_ClearsEarlierPlaintextAndOutcome()
{
var (store, audit, _) = RegisterServices();
AuthorizeReveal();
var a = new SecretName("app/a"); var b = new SecretName("app/b");
store.Seed(Row(a, "synthetic-a-value")); store.Seed(Row(b, "synthetic-b-value"));
var cut = Render<RevealButton>(p => p.Add(x => x.Name, a));
cut.Find("[data-testid=reveal-button]").Click();
Assert.Contains("synthetic-a-value", cut.Markup);
cut.Render(p => p.Add(x => x.Name, b));
Assert.DoesNotContain("synthetic-a-value", cut.Markup);
Assert.Equal("", cut.Find("[data-testid=reveal-status]").TextContent);
Assert.Equal("Reveal app/b", cut.Find("[data-testid=reveal-button]").GetAttribute("aria-label"));
cut.Find("[data-testid=reveal-button]").Click();
Assert.Equal("synthetic-b-value", cut.Find("[data-testid=revealed-value]").TextContent);
Assert.Equal(new[] { a.Value, b.Value }, audit.Events.Select(x => x.Target));
}
[Fact]
public async Task SupersededRevealRead_IsCancelledAndCannotDiscloseUnderTheNewTarget()
{
var (store, audit, _) = RegisterServices(); AuthorizeReveal();
var a = new SecretName("app/a"); var b = new SecretName("app/b");
var entered = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
var release = new TaskCompletionSource<StoredSecret?>(TaskCreationOptions.RunContinuationsAsynchronously);
CancellationToken aToken = default;
store.GetOverride = (name, ct) =>
{
if (name == b) return Task.FromResult<StoredSecret?>(Row(b, "synthetic-b-value"));
aToken = ct; entered.TrySetResult(); return release.Task;
};
var cut = Render<RevealButton>(p => p.Add(x => x.Name, a));
var pending = cut.Find("[data-testid=reveal-button]").ClickAsync(new MouseEventArgs());
await entered.Task;
try
{
cut.Render(p => p.Add(x => x.Name, b));
Assert.True(aToken.IsCancellationRequested);
cut.Find("[data-testid=reveal-button]").Click();
}
finally { release.TrySetResult(Row(a, "synthetic-a-value")); await pending; }
Assert.DoesNotContain("synthetic-a-value", cut.Markup);
Assert.Equal("synthetic-b-value", cut.Find("[data-testid=revealed-value]").TextContent);
Assert.Equal(b.Value, Assert.Single(audit.Events).Target);
}
[Fact]
public async Task PendingAuthorization_DisablesDuplicateRevealBeforeTheRead()
{
var (store, audit, _) = RegisterServices(); AuthorizeReveal();
var name = new SecretName("app/a"); store.Seed(Row(name, PlainValue));
var auth = new TaskCompletionSource<AuthenticationState>(TaskCreationOptions.RunContinuationsAsynchronously);
RenderFragment child = builder =>
{
builder.OpenComponent<RevealButton>(0);
builder.AddAttribute(1, nameof(RevealButton.Name), (object)name);
builder.CloseComponent();
};
var cut = Render<CascadingValue<Task<AuthenticationState>>>(p => p.Add(x => x.Value, auth.Task).AddChildContent(child));
var first = cut.Find("[data-testid=reveal-button]").ClickAsync(new MouseEventArgs());
var second = cut.Find("[data-testid=reveal-button]").ClickAsync(new MouseEventArgs());
try
{
Assert.True(cut.Find("[data-testid=reveal-button]").HasAttribute("disabled"));
Assert.Empty(store.Gets);
}
finally
{
auth.TrySetResult(new AuthenticationState(new ClaimsPrincipal(new ClaimsIdentity([new Claim(ClaimTypes.Name, "reviewer")], "fixture"))));
await Task.WhenAll(first, second);
}
Assert.Single(store.Gets);
Assert.Single(audit.Events);
}
[Fact]
public async Task AuditCompletesAfterTargetChange_NeverPublishesOldPlaintext()
{
var (store, _, _) = RegisterServices(); AuthorizeReveal();
var audit = new DeferredRevealAudit(); Services.AddSingleton<IAuditWriter>(audit);
var a = new SecretName("app/a"); var b = new SecretName("app/b");
store.Seed(Row(a, "synthetic-a-value"));
var cut = Render<RevealButton>(p => p.Add(x => x.Name, a));
var pending = cut.Find("[data-testid=reveal-button]").ClickAsync(new MouseEventArgs());
await audit.Entered.Task;
try { cut.Render(p => p.Add(x => x.Name, b)); }
finally { audit.Release.TrySetResult(); await pending; }
Assert.Equal(a.Value, Assert.Single(audit.Events).Target);
Assert.DoesNotContain("synthetic-a-value", cut.Markup);
Assert.Empty(cut.FindAll("[data-testid=revealed-value]"));
Assert.Equal("", cut.Find("[data-testid=reveal-status]").TextContent);
}
[Fact]
public async Task RemovedReveal_CancelsAndDoesNotResolveDisposedScopeAfterRead()
{
var (store, audit, _) = RegisterServices(); AuthorizeReveal();
var provider = new RevealScopeGuard(Services);
var entered = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
var release = new TaskCompletionSource<StoredSecret?>(TaskCreationOptions.RunContinuationsAsynchronously);
CancellationToken token = default;
store.GetOverride = (_, ct) => { token = ct; entered.TrySetResult(); return release.Task; };
var name = new SecretName("app/a");
RenderFragment child = builder => { builder.OpenComponent<RevealButton>(0); builder.AddAttribute(1, nameof(RevealButton.Name), (object)name); builder.CloseComponent(); };
var cut = Render<CascadingValue<bool>>(p => p.Add(x => x.Value, true).AddChildContent(child));
typeof(RevealButton).GetProperty("Services", System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.NonPublic)!
.SetValue(cut.FindComponent<RevealButton>().Instance, provider);
var pending = cut.Find("[data-testid=reveal-button]").ClickAsync(new MouseEventArgs());
await entered.Task;
Assert.True(provider.Resolutions > 0);
int resolutions = provider.Resolutions;
cut.Render(p => p.Add(x => x.Value, true).AddChildContent((RenderFragment)(_ => { })));
Assert.True(token.IsCancellationRequested);
provider.Reject = true;
release.SetResult(Row(name, PlainValue));
await pending;
Assert.Equal(resolutions, provider.Resolutions);
Assert.Empty(audit.Events);
Assert.DoesNotContain(PlainValue, cut.Markup);
}
private void AuthorizeReveal()
{
var auth = this.AddAuthorization(); auth.SetAuthorized("reviewer");
auth.SetPolicies(SecretsAuthorization.RevealPolicy);
}
private sealed class DeferredRevealAudit : IAuditWriter
{
public TaskCompletionSource Entered { get; } = new(TaskCreationOptions.RunContinuationsAsynchronously);
public TaskCompletionSource Release { get; } = new(TaskCreationOptions.RunContinuationsAsynchronously);
public List<AuditEvent> Events { get; } = [];
public async Task WriteAsync(AuditEvent evt, CancellationToken ct = default)
{ Entered.TrySetResult(); await Release.Task; Events.Add(evt); }
}
private sealed class RevealScopeGuard(IServiceProvider inner) : IServiceProvider
{
public bool Reject { get; set; }
public int Resolutions { get; private set; }
public object? GetService(Type type)
{
++Resolutions;
if (Reject) throw new ObjectDisposedException("synthetic circuit scope");
return inner.GetService(type);
}
}
private static void AssertNoValueLeak(AuditEvent evt)
{
foreach (string? field in new[] { evt.Action, evt.Actor, evt.Category, evt.Target, evt.DetailsJson, evt.ToString() })
{
if (field is not null)
{
Assert.DoesNotContain(PlainValue, field, StringComparison.Ordinal);
}
}
}
}