Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.AuditLog.Tests/Redaction/SafeDefaultAuditRedactorTests.cs
T
Joseph Doherty 5aaf9e2923 fix(audit): ScadaBridge C2 review — over-redact scrubs all sensitive free-text fields + outer-catch never-leak test + marker alignment
I1 (security): OverRedact() in ScadaBridgeAuditRedactor now suppresses ErrorDetail,
ErrorMessage, and Extra (in addition to RequestSummary/ResponseSummary) to the
over-redacted marker in BOTH code paths (Deserialize+with path and the fallback
new-AuditDetails path). SafeDefaultAuditRedactor catch block aligned to match.

M3 (test): OuterCatch_OptionsThrows_NeverLeaks_AllSensitiveFieldsOverRedacted forces
the outer try/catch → OverRedact path via a ThrowingMonitor that throws from
CurrentValue (the first statement in the try block). Asserts (a) Apply does not
throw, and (b) all five sensitive free-text fields are suppressed to the
over-redacted marker with PayloadTruncated=true.

M1 (consistency): SafeDefaultAuditRedactor now uses AuditRedactionPrimitives
constants (RedactedMarker for line-format header values, OverRedactedEventMarker
for the catch block), eliminating the divergent [REDACTED]/[redacted by ...]
strings. AuditRedactionPrimitives gains OverRedactedEventMarker = RedactorErrorMarker.
SafeDefaultAuditRedactorTests updated from [REDACTED] → <redacted>.

M2 (comment): Added one-line note in TruncateField explaining why the char-count
(result.Length != value.Length) truncation check is sufficient given TruncateUtf8
only ever shortens.
2026-06-02 11:12:18 -04:00

123 lines
4.0 KiB
C#

using ZB.MOM.WW.Audit;
using ZB.MOM.WW.ScadaBridge.AuditLog.Redaction;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Redaction;
/// <summary>
/// ScadaBridge audit re-architecture stage C2 (Task 2.5) tests for
/// <see cref="SafeDefaultAuditRedactor"/> — the canonical-record analogue of
/// <see cref="ZB.MOM.WW.ScadaBridge.AuditLog.Payload.SafeDefaultAuditPayloadFilter"/>.
/// Header-only scrub of the always-sensitive default headers inside
/// <c>DetailsJson</c>'s RequestSummary / ResponseSummary; never throws, never
/// performs body / SQL / truncation work.
/// </summary>
public class SafeDefaultAuditRedactorTests
{
private static AuditEvent EventWith(string? request = null, string? response = null)
{
var details = new AuditDetails
{
RequestSummary = request,
ResponseSummary = response,
};
return new AuditEvent
{
EventId = Guid.NewGuid(),
OccurredAtUtc = DateTimeOffset.UtcNow,
Actor = "tester",
Action = "ApiOutbound.ApiCall",
Outcome = AuditOutcome.Success,
DetailsJson = AuditDetailsCodec.Serialize(details),
};
}
private static AuditDetails Details(AuditEvent evt) =>
AuditDetailsCodec.Deserialize(evt.DetailsJson);
[Fact]
public void Redacts_DefaultSensitiveHeaders_InRequestSummary()
{
var evt = EventWith(request: "Authorization: Bearer secret-token\nContent-Type: application/json");
var result = SafeDefaultAuditRedactor.Instance.Apply(evt);
var d = Details(result);
Assert.Contains("Authorization: <redacted>", d.RequestSummary!);
Assert.DoesNotContain("secret-token", d.RequestSummary!);
Assert.Contains("Content-Type: application/json", d.RequestSummary!);
}
[Fact]
public void Redacts_DefaultSensitiveHeaders_InResponseSummary()
{
var evt = EventWith(response: "Set-Cookie: sessionid=abc123\nX-Other: ok");
var result = SafeDefaultAuditRedactor.Instance.Apply(evt);
var d = Details(result);
Assert.Contains("Set-Cookie: <redacted>", d.ResponseSummary!);
Assert.DoesNotContain("abc123", d.ResponseSummary!);
Assert.Contains("X-Other: ok", d.ResponseSummary!);
}
[Fact]
public void CaseInsensitive_HeaderName_Redacted()
{
var evt = EventWith(request: "authorization: Bearer x-y-z");
var result = SafeDefaultAuditRedactor.Instance.Apply(evt);
Assert.Contains("<redacted>", Details(result).RequestSummary!);
Assert.DoesNotContain("x-y-z", Details(result).RequestSummary!);
}
[Fact]
public void NonSensitiveHeader_Preserved()
{
var evt = EventWith(request: "X-Request-Id: abc-123\nAccept: application/json");
var result = SafeDefaultAuditRedactor.Instance.Apply(evt);
var d = Details(result);
Assert.Contains("X-Request-Id: abc-123", d.RequestSummary!);
Assert.Contains("Accept: application/json", d.RequestSummary!);
}
[Fact]
public void NullDetails_FastPath_ReturnsSameInstance()
{
var evt = new AuditEvent
{
EventId = Guid.NewGuid(),
OccurredAtUtc = DateTimeOffset.UtcNow,
Actor = "tester",
Action = "ApiOutbound.ApiCall",
Outcome = AuditOutcome.Success,
DetailsJson = null,
};
var result = SafeDefaultAuditRedactor.Instance.Apply(evt);
Assert.Same(evt, result);
}
[Fact]
public void MalformedDetailsJson_NeverThrows()
{
var evt = new AuditEvent
{
EventId = Guid.NewGuid(),
OccurredAtUtc = DateTimeOffset.UtcNow,
Actor = "tester",
Action = "ApiOutbound.ApiCall",
Outcome = AuditOutcome.Success,
DetailsJson = "{not valid json]",
};
var ex = Record.Exception(() => SafeDefaultAuditRedactor.Instance.Apply(evt));
Assert.Null(ex);
}
}