Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests/Secrets/DeployedSecretsMirrorRealStackTests.cs
T
Joseph Doherty 838fb4177b fix(site): DeployedSecretsMirror — ledger-owned rows recover past clock skew; real-cipher recovery test
Fix round 2 (review task-9-rereview-1.md), both Minors:

1. Clock skew. ApplyAndConfirmAsync now decides the tombstone-vs-out-of-band split by LEDGER
   OWNERSHIP (any mirrored_secrets entry for the name, at any revision), not merely by whether
   the local row happens to be a tombstone. A live local row this node already owns but whose
   ciphertext no longer matches the newly shipped revision (e.g. an earlier tombstone-recovery
   re-stamp landed ahead of a since-shipped central UpdatedUtc, under site/central clock skew)
   is now re-stamped and re-applied exactly like a tombstone, instead of being misreported as
   someone else's "newer local value" and left permanently un-converged. The out-of-band Failed
   message is now only ever produced for a name that is NOT in the ledger. New test:
   Reconcile_ClockSkewedRecoveredRow_StillConvergesOnNextCentralRevision (a skewed future
   re-stamp followed by a genuinely new central revision converges and re-invalidates the
   cache).
2. Real-cipher integration test. Added DeployedSecretsMirrorRealStackTests, running the mirror
   against the REAL ZB.MOM.WW.Secrets stack (SqliteSecretStore + AesGcmEnvelopeCipher +
   DefaultSecretResolver over a real temp-file SQLite database, plus a hand-written
   IMasterKeyProvider test double mirroring the library's own) instead of in-memory fakes:
   encrypt -> SecretArtifact -> apply -> delete (tombstone) -> re-add the same artifact -> the
   recovered row resolves to the original plaintext. Pins the "UpdatedUtc/Revision are not
   AEAD-bound" property against the real cipher rather than by source inspection alone.
   Test-only package reference: ZB.MOM.WW.Secrets (SiteRuntime itself still depends only on
   ZB.MOM.WW.Secrets.Abstractions).

Verify: dotnet test tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests --filter FullyQualifiedName~DeployedSecretsMirrorTests (25/25); full SiteRuntime.Tests suite 878/878.
2026-09-28 19:19:22 -04:00

160 lines
7.8 KiB
C#

using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
using ZB.MOM.WW.Audit;
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Artifacts;
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Persistence;
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Secrets;
using ZB.MOM.WW.ScadaBridge.TestSupport;
using ZB.MOM.WW.Secrets;
using ZB.MOM.WW.Secrets.Abstractions;
using ZB.MOM.WW.Secrets.Crypto;
using ZB.MOM.WW.Secrets.Sqlite;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Secrets;
/// <summary>
/// Task 9 fix round 2 (review <c>task-9-rereview-1.md</c> recommendation #2): runs
/// <see cref="DeployedSecretsMirror"/> against the REAL <c>ZB.MOM.WW.Secrets</c> stack —
/// <see cref="SqliteSecretStore"/> + <see cref="AesGcmEnvelopeCipher"/> +
/// <see cref="DefaultSecretResolver"/> over a real temp-file SQLite database — instead of the
/// in-memory fakes <see cref="DeployedSecretsMirrorTests"/> uses.
/// </summary>
/// <remarks>
/// <see cref="DeployedSecretsMirrorTests"/>'s fakes never actually decrypt anything, so the
/// class remarks' claim that a tombstone-recovery re-stamp (bumping <c>UpdatedUtc</c>/
/// <c>Revision</c> without touching ciphertext) cannot break decryption was previously proven
/// only by reading <c>AesGcmEnvelopeCipher</c>'s source (its AAD binds only
/// <see cref="SecretName.Value"/> and <see cref="StoredSecret.KekId"/>, never
/// <c>Revision</c>/<c>UpdatedUtc</c>). This test pins that property against the real cipher, so
/// a future library version that starts binding either field into the AEAD associated data
/// would fail here instead of only being caught by re-reading the source.
/// </remarks>
public sealed class DeployedSecretsMirrorRealStackTests : IAsyncLifetime, IDisposable
{
private readonly string _secretsDbPath =
Path.Combine(Path.GetTempPath(), $"zb-secrets-real-{Guid.NewGuid():N}.db");
private readonly TestLocalDb _localDb = TestLocalDb.CreateTemp("deployed-secrets-mirror-real");
private SqliteSecretStore _store = null!;
private AesGcmEnvelopeCipher _cipher = null!;
private DefaultSecretResolver _resolver = null!;
private SiteStorageService _storage = null!;
public async Task InitializeAsync()
{
var connectionFactory = new SecretsSqliteConnectionFactory(_secretsDbPath);
await new SqliteSecretsStoreMigrator(connectionFactory).MigrateAsync(CancellationToken.None);
_store = new SqliteSecretStore(connectionFactory);
var masterKey = new FakeMasterKeyProvider("kek-central");
_cipher = new AesGcmEnvelopeCipher(masterKey);
// DefaultSecretResolver implements BOTH ISecretResolver and ISecretCacheInvalidator (the
// real production shape — see SecretsServiceCollectionExtensions, which registers the
// same singleton instance behind both interfaces), so this test also exercises real
// cache invalidation, not a fake one.
_resolver = new DefaultSecretResolver(_store, _cipher, NoOpAuditWriter.Instance, TimeSpan.FromSeconds(30));
_storage = new SiteStorageService(_localDb.Db, NullLogger<SiteStorageService>.Instance);
await _storage.InitializeAsync();
}
public Task DisposeAsync() => Task.CompletedTask;
public void Dispose()
{
var path = _localDb.Path;
_localDb.Dispose();
TestLocalDb.DeleteFiles(path);
foreach (var suffix in new[] { "", "-wal", "-shm" })
{
try { File.Delete(_secretsDbPath + suffix); } catch { /* best effort */ }
}
}
[Fact]
public async Task RealStack_EncryptApplyDeleteReAdd_TheRecoveredRowResolvesToTheOriginalPlaintext()
{
const string plaintext = "s3cr3t-value";
// "Central" encrypts the secret under the fleet's shared KEK (the same KekId this
// node's own master key provider reports, mirroring a real shared-KEK fleet) and ships
// it as a SecretArtifact — the exact wire shape DeployedSecretsCollector produces.
var sealedSecret = _cipher.Encrypt(new SecretName("a"), plaintext, SecretContentType.Text);
// Deliberately far in the past so DeleteAsync's real-wall-clock tombstone stamp is
// guaranteed strictly newer, regardless of when this test runs — the point being
// tested is the RECOVERY, not a race against the tombstone.
var shippedUtc = new DateTimeOffset(2000, 1, 1, 0, 0, 0, TimeSpan.Zero);
var artifact = new SecretArtifact(
Name: "a",
ContentType: SecretContentType.Text.ToString(),
Ciphertext: sealedSecret.Ciphertext,
Nonce: sealedSecret.Nonce,
Tag: sealedSecret.Tag,
WrappedDek: sealedSecret.WrappedDek,
WrapNonce: sealedSecret.WrapNonce,
WrapTag: sealedSecret.WrapTag,
KekId: sealedSecret.KekId,
Revision: 1,
CreatedUtc: shippedUtc,
UpdatedUtc: shippedUtc);
var mirror = new DeployedSecretsMirror(
_storage,
_store,
_resolver,
_resolver, // the same singleton also serves ISecretCacheInvalidator
Options.Create(new SiteRuntimeOptions()),
NullLogger<DeployedSecretsMirror>.Instance,
TimeProvider.System);
// Apply — a fresh name, so this is a plain (non-recovery) apply.
await _storage.UpsertDeployedSecretsAsync([artifact], "d1");
var applyPass = await mirror.ReconcileAsync(CancellationToken.None);
Assert.Equal(["a"], applyPass.Applied);
Assert.Empty(applyPass.Failed);
Assert.Equal(plaintext, await _resolver.GetAsync(new SecretName("a"), CancellationToken.None));
// Delete — the site stops referencing it; the REAL store tombstones (does not
// hard-delete) at DateTimeOffset.UtcNow, which is far newer than the 2000-01-01 shipped
// stamp above.
await _storage.UpsertDeployedSecretsAsync([], "d2");
var removePass = await mirror.ReconcileAsync(CancellationToken.None);
Assert.Equal(["a"], removePass.Removed);
Assert.Null(await _resolver.GetAsync(new SecretName("a"), CancellationToken.None));
// Re-add the SAME (unchanged, still 2000-01-01-stamped) artifact. A naive
// ApplyReplicatedAsync call is a no-op against the newer tombstone — this forces the
// mirror's tombstone-recovery re-stamp path against the REAL store and REAL cipher.
await _storage.UpsertDeployedSecretsAsync([artifact], "d3");
var reAddPass = await mirror.ReconcileAsync(CancellationToken.None);
Assert.Equal(["a"], reAddPass.Applied);
Assert.Empty(reAddPass.Failed);
// The recovered row must decrypt to the ORIGINAL plaintext through the real
// AesGcmEnvelopeCipher, proving the bumped UpdatedUtc/Revision are not — and cannot
// silently become — bound into the AEAD associated data.
var resolved = await _resolver.GetAsync(new SecretName("a"), CancellationToken.None);
Assert.Equal(plaintext, resolved);
var recovered = await _store.GetAsync(new SecretName("a"), CancellationToken.None);
Assert.NotNull(recovered);
Assert.False(recovered!.IsDeleted);
Assert.True(recovered.UpdatedUtc > shippedUtc); // genuinely re-stamped, not a no-op
}
/// <summary>
/// A hand-written <see cref="IMasterKeyProvider"/> test double, mirroring the library's own
/// (test-internal, not shipped in the package) <c>FakeMasterKeyProvider</c>.
/// </summary>
private sealed class FakeMasterKeyProvider : IMasterKeyProvider
{
private readonly byte[] _key = System.Security.Cryptography.RandomNumberGenerator.GetBytes(32);
public FakeMasterKeyProvider(string kekId) => KekId = kekId;
public string KekId { get; }
public ReadOnlyMemory<byte> GetMasterKey() => _key;
}
}