feat(audit): MxGateway IAuditActorAccessor + dashboard audit Actor = operator principal (keyId→Target) (Phase 3)
Introduce IAuditActorAccessor seam + HttpAuditActorAccessor impl (reads ZbClaimTypes.Username
from IHttpContextAccessor; falls back to Identity.Name / ZbClaimTypes.Name; null when
unauthenticated). Register in DI via DashboardServiceCollectionExtensions.
Wire DashboardApiKeyManagementService: WriteDashboardAuditAsync now accepts the ClaimsPrincipal
user already in scope at each call site; ResolveOperatorActor extracts ZbClaimTypes.Username
(preferred) or Identity.Name. All four dashboard-* events now emit Actor = LDAP operator
username and Target = managed keyId, fixing the semantic gap where both fields held the keyId.
ConstraintEnforcer (gRPC / API-key actor) and CanonicalForwardingApiKeyAuditStore (CLI /
"system"/"cli" fallback) are unchanged.
Tests: DashboardApiKeyManagementServiceTests updated — CreateAuthorizedUser adds ZbClaimTypes.Username
("alice"), all dashboard-* audit assertions updated to Actor = "alice" / Target = "operator01";
new CreateAsync_AuthorizedUser_CanonicalAuditEventHasOperatorAsActorAndKeyIdAsTarget verifies the
canonical AuditEvent directly. New HttpAuditActorAccessorTests (4 cases: username claim, Identity.Name
fallback, unauthenticated → null, no context → null). ConstraintEnforcer tests still assert API-key/anonymous actor.
This commit is contained in:
@@ -66,7 +66,7 @@ public sealed class DashboardApiKeyManagementService(
|
||||
cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
await WriteDashboardAuditAsync(keyId, "dashboard-create-key", null, cancellationToken).ConfigureAwait(false);
|
||||
await WriteDashboardAuditAsync(user, keyId, "dashboard-create-key", null, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
return DashboardApiKeyManagementResult.Success(
|
||||
"API key created. Copy the key now; it will not be shown again.",
|
||||
@@ -108,6 +108,7 @@ public sealed class DashboardApiKeyManagementService(
|
||||
.ConfigureAwait(false);
|
||||
|
||||
await WriteDashboardAuditAsync(
|
||||
user,
|
||||
normalizedKeyId,
|
||||
"dashboard-revoke-key",
|
||||
result.Succeeded ? "revoked" : "not-found-or-already-revoked",
|
||||
@@ -150,6 +151,7 @@ public sealed class DashboardApiKeyManagementService(
|
||||
bool succeeded = rotated.Token is not null;
|
||||
|
||||
await WriteDashboardAuditAsync(
|
||||
user,
|
||||
normalizedKeyId,
|
||||
"dashboard-rotate-key",
|
||||
succeeded ? "rotated" : "not-found",
|
||||
@@ -194,6 +196,7 @@ public sealed class DashboardApiKeyManagementService(
|
||||
.ConfigureAwait(false);
|
||||
|
||||
await WriteDashboardAuditAsync(
|
||||
user,
|
||||
normalizedKeyId,
|
||||
"dashboard-delete-key",
|
||||
deleted ? "deleted" : "not-found-or-active",
|
||||
@@ -208,6 +211,35 @@ public sealed class DashboardApiKeyManagementService(
|
||||
private string? RemoteAddress() =>
|
||||
httpContextAccessor.HttpContext?.Connection.RemoteIpAddress?.ToString();
|
||||
|
||||
/// <summary>
|
||||
/// Resolves the operator's username from the authenticated dashboard principal.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The passed <paramref name="user"/> is preferred over the ambient HTTP context because it
|
||||
/// is already in scope at every call site (the callers gate on <see cref="CanManage"/> using
|
||||
/// it) and is unambiguous. Falls back to <see cref="IAuditActorAccessor.CurrentActor"/> for
|
||||
/// defensive coverage, then to <c>"unknown"</c> when neither is available.
|
||||
/// </remarks>
|
||||
private static string ResolveOperatorActor(ClaimsPrincipal user)
|
||||
{
|
||||
// ZbClaimTypes.Username = "zb:username" — the canonical LDAP login name.
|
||||
string? username = user.FindFirstValue(ZB.MOM.WW.Auth.AspNetCore.ZbClaimTypes.Username);
|
||||
if (!string.IsNullOrWhiteSpace(username))
|
||||
{
|
||||
return username;
|
||||
}
|
||||
|
||||
// Framework fallback: Identity.Name is driven by the nameClaimType on the ClaimsIdentity
|
||||
// (set to ZbClaimTypes.Name = ClaimTypes.Name by DashboardAuthenticator → display name).
|
||||
string? identityName = user.Identity?.Name;
|
||||
if (!string.IsNullOrWhiteSpace(identityName))
|
||||
{
|
||||
return identityName;
|
||||
}
|
||||
|
||||
return "unknown";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Emits the dashboard's own canonical <see cref="AuditEvent"/> for a <c>dashboard-*</c> op
|
||||
/// directly through the best-effort <see cref="IAuditWriter"/> (Task 2.3 #6). This is in
|
||||
@@ -215,7 +247,13 @@ public sealed class DashboardApiKeyManagementService(
|
||||
/// emits via the canonical-forwarding <c>IApiKeyAuditStore</c> adapter — the doubled-audit
|
||||
/// behaviour is preserved, both rows now land in the canonical <c>audit_event</c> store.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Phase 3 (Actor = operator principal): <c>Actor</c> is the LDAP operator who performed the
|
||||
/// action (resolved from the <paramref name="user"/> principal); <c>Target</c> is the managed
|
||||
/// API key id. This fixes the pre-Phase-3 semantic gap where both fields held the keyId.
|
||||
/// </remarks>
|
||||
private async Task WriteDashboardAuditAsync(
|
||||
ClaimsPrincipal user,
|
||||
string keyId,
|
||||
string action,
|
||||
string? detail,
|
||||
@@ -225,7 +263,7 @@ public sealed class DashboardApiKeyManagementService(
|
||||
{
|
||||
EventId = Guid.NewGuid(),
|
||||
OccurredAtUtc = DateTimeOffset.UtcNow,
|
||||
Actor = keyId,
|
||||
Actor = ResolveOperatorActor(user),
|
||||
Action = action,
|
||||
Outcome = AuditOutcome.Success,
|
||||
Category = CanonicalForwardingApiKeyAuditStore.ApiKeyCategory,
|
||||
|
||||
@@ -6,6 +6,7 @@ using Microsoft.Extensions.Options;
|
||||
using ZB.MOM.WW.Auth.Abstractions.Roles;
|
||||
using ZB.MOM.WW.Auth.AspNetCore;
|
||||
using ZB.MOM.WW.MxGateway.Server.Configuration;
|
||||
using ZB.MOM.WW.MxGateway.Server.Security.Audit;
|
||||
|
||||
namespace ZB.MOM.WW.MxGateway.Server.Dashboard;
|
||||
|
||||
@@ -47,6 +48,7 @@ public static class DashboardServiceCollectionExtensions
|
||||
services.AddHostedService<Hubs.DashboardSnapshotPublisher>();
|
||||
services.AddHostedService<Hubs.AlarmsHubPublisher>();
|
||||
services.AddHttpContextAccessor();
|
||||
services.AddSingleton<IAuditActorAccessor, HttpAuditActorAccessor>();
|
||||
services.AddAntiforgery();
|
||||
services.AddCascadingAuthenticationState();
|
||||
services.AddRazorComponents()
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
using System.Security.Claims;
|
||||
using ZB.MOM.WW.Auth.AspNetCore;
|
||||
|
||||
namespace ZB.MOM.WW.MxGateway.Server.Security.Audit;
|
||||
|
||||
/// <summary>
|
||||
/// HTTP-context-backed implementation of <see cref="IAuditActorAccessor"/> that reads the
|
||||
/// dashboard operator's identity from the current <see cref="IHttpContextAccessor"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Claim resolution order:
|
||||
/// <list type="number">
|
||||
/// <item><see cref="ZbClaimTypes.Username"/> ("zb:username") — the canonical LDAP login name.</item>
|
||||
/// <item><see cref="ClaimsPrincipal.Identity"/>.<see cref="System.Security.Principal.IIdentity.Name"/> — framework fallback (= <see cref="ZbClaimTypes.Name"/> = <see cref="ClaimTypes.Name"/> = display name).</item>
|
||||
/// <item><see cref="ZbClaimTypes.Name"/> — explicit fallback matching the claim emitted by <c>DashboardAuthenticator.CreatePrincipal</c>.</item>
|
||||
/// </list>
|
||||
/// Returns <see langword="null"/> when there is no HTTP context or the user is not authenticated.
|
||||
/// </remarks>
|
||||
public sealed class HttpAuditActorAccessor(IHttpContextAccessor httpContextAccessor) : IAuditActorAccessor
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public string? CurrentActor
|
||||
{
|
||||
get
|
||||
{
|
||||
ClaimsPrincipal? user = httpContextAccessor.HttpContext?.User;
|
||||
if (user?.Identity?.IsAuthenticated != true)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// Prefer the canonical login-username claim (set by DashboardAuthenticator).
|
||||
string? username = user.FindFirstValue(ZbClaimTypes.Username);
|
||||
if (!string.IsNullOrWhiteSpace(username))
|
||||
{
|
||||
return username;
|
||||
}
|
||||
|
||||
// Framework fallback: Identity.Name is driven by the ClaimsIdentity nameClaimType,
|
||||
// which DashboardAuthenticator sets to ZbClaimTypes.Name (= ClaimTypes.Name = display name).
|
||||
string? identityName = user.Identity?.Name;
|
||||
if (!string.IsNullOrWhiteSpace(identityName))
|
||||
{
|
||||
return identityName;
|
||||
}
|
||||
|
||||
// Final explicit fallback — ZbClaimTypes.Name claim value directly.
|
||||
return user.FindFirstValue(ZbClaimTypes.Name);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
namespace ZB.MOM.WW.MxGateway.Server.Security.Audit;
|
||||
|
||||
/// <summary>
|
||||
/// Returns the current actor name for use in audit events.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Implementations resolve the actor from the ambient request context. For the dashboard
|
||||
/// this is the authenticated LDAP operator; for non-HTTP contexts (gRPC, CLI) the caller
|
||||
/// provides the actor directly and this seam is not used.
|
||||
/// </remarks>
|
||||
public interface IAuditActorAccessor
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the current actor's username, or <see langword="null"/> when there is no
|
||||
/// authenticated principal in scope (e.g. an anonymous or unauthenticated request).
|
||||
/// </summary>
|
||||
string? CurrentActor { get; }
|
||||
}
|
||||
Reference in New Issue
Block a user