Joseph Doherty
544a6ddb77
Resolves the 35 findings from the 2026-06-01 baseline (commit 26ba1c7),
test-first for every behavioral change. +51 tests (331 -> 382 passing, 0 failed).
- Telemetry-001 (HIGH): RedactionEnricher now honours property removal, so a
redactor that drops a key actually scrubs the secret from the event.
- Auth: LDAP validator ValidateOnStart; API-key verify no longer fails on a
best-effort MarkUsed write or a corrupt scopes column (fail-closed); LDAP cert
validation hook; KeyPrefix persistence aligned; README algorithm corrected.
- Health: Akka checks return Degraded (not throw) when the cluster isn't up yet;
GrpcDependencyHealthCheck catch-all; null 'description' rendered; composite
endpoint builder; XML docs shipped.
- Audit: CompositeAuditWriter no longer re-throws OperationCanceledException;
TruncatingAuditRedactor over-redact scrubs Target + safe negative max; options
record; XML docs shipped.
- Configuration: TryAddEnumerable idempotent registration; consistent port
quoting; strict invariant port parsing; XML docs + README packaged.
- Theme: mobile toggle is now CSS-only (no Bootstrap JS); token/CSS hygiene;
XML docs on the public parameter surface.
Shared-contract/spec docs updated where the code was the source of truth
(observability service.instance.id, MapZbMetrics, redactor reach). All changes
additive/back-compatible at v0.1.0. code-reviews bookkeeping follows separately.
52 lines
2.1 KiB
C#
52 lines
2.1 KiB
C#
using System.Text.Json;
|
|
|
|
namespace ZB.MOM.WW.Auth.ApiKeys.Sqlite;
|
|
|
|
/// <summary>
|
|
/// Serializes API-key scope sets to a canonical JSON array. Scopes are sorted with
|
|
/// <see cref="StringComparer.Ordinal"/> so that equal sets always produce identical
|
|
/// column text, regardless of insertion order.
|
|
/// </summary>
|
|
public static class ScopeSerializer
|
|
{
|
|
/// <summary>Serializes scopes to an ordinal-sorted JSON array.</summary>
|
|
/// <param name="scopes">The scopes to serialize.</param>
|
|
/// <returns>A JSON array string with elements sorted ordinally.</returns>
|
|
public static string Serialize(IReadOnlySet<string> scopes)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(scopes);
|
|
return JsonSerializer.Serialize(scopes.Order(StringComparer.Ordinal));
|
|
}
|
|
|
|
/// <summary>Deserializes scopes from a JSON array string.</summary>
|
|
/// <param name="value">The JSON string to deserialize; may be null or empty.</param>
|
|
/// <returns>
|
|
/// An ordinal-compared set of scopes; empty when the input is null/blank. A malformed or
|
|
/// non-array column (operator tampering, a partial write, a format change, or a buggy writer)
|
|
/// fails closed to an EMPTY set rather than throwing, so a single poisoned row degrades to a
|
|
/// zero-scope identity on the auth path instead of an unhandled <see cref="JsonException"/>.
|
|
/// </returns>
|
|
public static IReadOnlySet<string> Deserialize(string? value)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(value))
|
|
{
|
|
return new HashSet<string>(StringComparer.Ordinal);
|
|
}
|
|
|
|
string[]? scopes;
|
|
try
|
|
{
|
|
scopes = JsonSerializer.Deserialize<string[]>(value);
|
|
}
|
|
catch (JsonException)
|
|
{
|
|
// Fail closed: a corrupt scopes column yields no scopes rather than an exception on the
|
|
// verification hot path. The verifier's "only exception path is cancellation" contract
|
|
// is preserved, and a key with an unreadable scope set is left with zero authority.
|
|
return new HashSet<string>(StringComparer.Ordinal);
|
|
}
|
|
|
|
return new HashSet<string>(scopes ?? [], StringComparer.Ordinal);
|
|
}
|
|
}
|