feat(mgmt): secured-write submit/reject/list handlers + Operator/Verifier gating (T14b)
This commit is contained in:
@@ -0,0 +1,83 @@
|
||||
namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
|
||||
// ============================================================================
|
||||
// Two-person ("secured") write commands (M7 OPC UA / MxGateway UX, Task T14b).
|
||||
//
|
||||
// An Operator SUBMITS a pending secured write against an MxGateway data
|
||||
// connection; a distinct Verifier later APPROVES (executes — Task C3) or
|
||||
// REJECTS it. Separation of duties is enforced at the handler: a write may not
|
||||
// be verified by the same principal that submitted it. ListSecuredWrites is a
|
||||
// read-only query (any authenticated user). Role gating lives in
|
||||
// ManagementActor.GetRequiredRole (Operator for submit; Verifier for
|
||||
// reject/approve).
|
||||
// ============================================================================
|
||||
|
||||
/// <summary>
|
||||
/// Operator request to submit a pending secured write. The target connection
|
||||
/// must exist within the site and use the MxGateway protocol; the value is
|
||||
/// captured as <paramref name="ValueJson"/> interpreted per <paramref name="ValueType"/>.
|
||||
/// Returns the newly-created <see cref="SecuredWriteDto"/>.
|
||||
/// </summary>
|
||||
/// <param name="SiteId">Site identifier the write targets.</param>
|
||||
/// <param name="ConnectionName">Data connection name within the site.</param>
|
||||
/// <param name="TagPath">Fully-qualified tag path the value is written to.</param>
|
||||
/// <param name="ValueJson">JSON-serialised value to write.</param>
|
||||
/// <param name="ValueType">Target data type name (e.g. <c>Boolean</c>, <c>Double</c>).</param>
|
||||
/// <param name="Comment">Optional free-text comment supplied by the operator.</param>
|
||||
public record SubmitSecuredWriteCommand(
|
||||
string SiteId,
|
||||
string ConnectionName,
|
||||
string TagPath,
|
||||
string ValueJson,
|
||||
string ValueType,
|
||||
string? Comment);
|
||||
|
||||
/// <summary>
|
||||
/// Verifier request to approve (and execute — handled by Task C3) a pending
|
||||
/// secured write. Declared here so the secured-write contract is complete; the
|
||||
/// approve→execute relay handler and dispatch arm are implemented in C3.
|
||||
/// </summary>
|
||||
/// <param name="Id">Identity of the pending secured write.</param>
|
||||
/// <param name="Comment">Optional free-text comment supplied by the verifier.</param>
|
||||
public record ApproveSecuredWriteCommand(long Id, string? Comment);
|
||||
|
||||
/// <summary>
|
||||
/// Verifier request to reject a pending secured write. The write must still be
|
||||
/// <c>Pending</c>, and the verifier must differ from the submitting operator
|
||||
/// (separation of duties). Returns the updated <see cref="SecuredWriteDto"/>.
|
||||
/// </summary>
|
||||
/// <param name="Id">Identity of the pending secured write.</param>
|
||||
/// <param name="Comment">Optional free-text comment supplied by the verifier.</param>
|
||||
public record RejectSecuredWriteCommand(long Id, string? Comment);
|
||||
|
||||
/// <summary>
|
||||
/// Read-only query for secured writes, optionally filtered by status and site.
|
||||
/// A <c>null</c> filter matches every row.
|
||||
/// </summary>
|
||||
/// <param name="Status">Status filter; <c>null</c> matches every status.</param>
|
||||
/// <param name="SiteId">Site id filter; <c>null</c> matches every site.</param>
|
||||
public record ListSecuredWritesCommand(string? Status, string? SiteId);
|
||||
|
||||
/// <summary>
|
||||
/// Result projection of a single pending secured write row, mirroring the
|
||||
/// <c>PendingSecuredWrite</c> entity shape.
|
||||
/// </summary>
|
||||
public record SecuredWriteDto(
|
||||
long Id,
|
||||
string SiteId,
|
||||
string ConnectionName,
|
||||
string TagPath,
|
||||
string ValueJson,
|
||||
string ValueType,
|
||||
string Status,
|
||||
string OperatorUser,
|
||||
string? OperatorComment,
|
||||
DateTime SubmittedAtUtc,
|
||||
string? VerifierUser,
|
||||
string? VerifierComment,
|
||||
DateTime? DecidedAtUtc,
|
||||
DateTime? ExecutedAtUtc,
|
||||
string? ExecutionError);
|
||||
|
||||
/// <summary>Result wrapper for <see cref="ListSecuredWritesCommand"/>.</summary>
|
||||
public record SecuredWriteListResult(IReadOnlyList<SecuredWriteDto> Items);
|
||||
@@ -11,6 +11,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.Instances;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Scripts;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Templates;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Notifications;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.SecuredWrites;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Security;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
||||
@@ -216,6 +217,15 @@ public class ManagementActor : ReceiveActor
|
||||
or RetryParkedMessageCommand or DiscardParkedMessageCommand
|
||||
or DebugSnapshotCommand => Roles.Deployer,
|
||||
|
||||
// Two-person secured write (M7 / T14b). Submit is an Operator action;
|
||||
// approve/reject are Verifier actions. Separation of duties (a write may
|
||||
// not be verified by its submitter) is enforced inside the handler — the
|
||||
// role gate only ensures the caller holds the right coarse role.
|
||||
SubmitSecuredWriteCommand => Roles.Operator,
|
||||
RejectSecuredWriteCommand or ApproveSecuredWriteCommand => Roles.Verifier,
|
||||
// ListSecuredWritesCommand is read-only -> falls through to "any
|
||||
// authenticated user" below, like the other list/query commands.
|
||||
|
||||
// Read-only queries -- any authenticated user
|
||||
_ => null
|
||||
};
|
||||
@@ -368,6 +378,13 @@ public class ManagementActor : ReceiveActor
|
||||
DiscardParkedMessageCommand cmd => await HandleDiscardParkedMessage(sp, cmd, user),
|
||||
DebugSnapshotCommand cmd => await HandleDebugSnapshot(sp, cmd, user),
|
||||
|
||||
// Secured writes (M7 / T14b). Approve (execute) is intentionally NOT
|
||||
// dispatched here — the approve->execute relay is Task C3; it would
|
||||
// 'NotSupported' at runtime until then.
|
||||
SubmitSecuredWriteCommand cmd => await HandleSubmitSecuredWrite(sp, cmd, user),
|
||||
RejectSecuredWriteCommand cmd => await HandleRejectSecuredWrite(sp, cmd, user),
|
||||
ListSecuredWritesCommand cmd => await HandleListSecuredWrites(sp, cmd),
|
||||
|
||||
// Transport (#24) bundle operations
|
||||
ExportBundleCommand cmd => await HandleExportBundle(sp, cmd, user.Username),
|
||||
PreviewBundleCommand cmd => await HandlePreviewBundle(sp, cmd),
|
||||
@@ -860,6 +877,91 @@ public class ManagementActor : ReceiveActor
|
||||
return await commService.DiscardParkedMessageAsync(cmd.SiteIdentifier, request);
|
||||
}
|
||||
|
||||
// ========================================================================
|
||||
// Secured-write handlers (M7 / T14b)
|
||||
//
|
||||
// Two-person workflow: an Operator submits a pending write against an
|
||||
// MxGateway data connection; a distinct Verifier approves (Task C3) or
|
||||
// rejects it. The role gate (GetRequiredRole) only verifies the coarse role;
|
||||
// the separation-of-duties rule (a write may not be verified by its
|
||||
// submitter) is enforced here.
|
||||
// ========================================================================
|
||||
|
||||
private static SecuredWriteDto ToSecuredWriteDto(PendingSecuredWrite e) => new(
|
||||
e.Id, e.SiteId, e.ConnectionName, e.TagPath, e.ValueJson, e.ValueType,
|
||||
e.Status, e.OperatorUser, e.OperatorComment, e.SubmittedAtUtc,
|
||||
e.VerifierUser, e.VerifierComment, e.DecidedAtUtc, e.ExecutedAtUtc, e.ExecutionError);
|
||||
|
||||
private static async Task<object?> HandleSubmitSecuredWrite(
|
||||
IServiceProvider sp, SubmitSecuredWriteCommand cmd, AuthenticatedUser user)
|
||||
{
|
||||
var siteRepo = sp.GetRequiredService<ISiteRepository>();
|
||||
var site = await siteRepo.GetSiteByIdentifierAsync(cmd.SiteId)
|
||||
?? throw new ManagementCommandException($"Site '{cmd.SiteId}' not found.");
|
||||
|
||||
var connections = await siteRepo.GetDataConnectionsBySiteIdAsync(site.Id);
|
||||
var conn = connections.FirstOrDefault(c =>
|
||||
string.Equals(c.Name, cmd.ConnectionName, StringComparison.Ordinal))
|
||||
?? throw new ManagementCommandException(
|
||||
$"Data connection '{cmd.ConnectionName}' not found on site '{cmd.SiteId}'.");
|
||||
|
||||
// Secured writes only apply to MxGateway connections.
|
||||
if (!string.Equals(conn.Protocol, "MxGateway", StringComparison.OrdinalIgnoreCase))
|
||||
throw new ManagementCommandException(
|
||||
$"Secured writes require an MxGateway connection; '{cmd.ConnectionName}' uses protocol '{conn.Protocol}'.");
|
||||
|
||||
var entity = new PendingSecuredWrite
|
||||
{
|
||||
SiteId = cmd.SiteId,
|
||||
ConnectionName = cmd.ConnectionName,
|
||||
TagPath = cmd.TagPath,
|
||||
ValueJson = cmd.ValueJson,
|
||||
ValueType = cmd.ValueType,
|
||||
Status = "Pending",
|
||||
OperatorUser = user.Username,
|
||||
OperatorComment = cmd.Comment,
|
||||
SubmittedAtUtc = DateTime.UtcNow
|
||||
};
|
||||
|
||||
var repo = sp.GetRequiredService<ISecuredWriteRepository>();
|
||||
entity.Id = await repo.AddAsync(entity);
|
||||
return ToSecuredWriteDto(entity);
|
||||
}
|
||||
|
||||
private static async Task<object?> HandleRejectSecuredWrite(
|
||||
IServiceProvider sp, RejectSecuredWriteCommand cmd, AuthenticatedUser user)
|
||||
{
|
||||
var repo = sp.GetRequiredService<ISecuredWriteRepository>();
|
||||
var entity = await repo.GetAsync(cmd.Id)
|
||||
?? throw new ManagementCommandException($"Secured write {cmd.Id} not found.");
|
||||
|
||||
if (!string.Equals(entity.Status, "Pending", StringComparison.Ordinal))
|
||||
throw new ManagementCommandException(
|
||||
$"Secured write {cmd.Id} is '{entity.Status}', not Pending; it cannot be rejected.");
|
||||
|
||||
// Separation of duties: the verifier must differ from the submitter.
|
||||
if (string.Equals(entity.OperatorUser, user.Username, StringComparison.OrdinalIgnoreCase))
|
||||
throw new ManagementCommandException(
|
||||
"A secured write cannot be verified by its submitter.");
|
||||
|
||||
entity.Status = "Rejected";
|
||||
entity.VerifierUser = user.Username;
|
||||
entity.VerifierComment = cmd.Comment;
|
||||
entity.DecidedAtUtc = DateTime.UtcNow;
|
||||
|
||||
// UpdateAsync overwrites all columns -> pass the fully-populated entity.
|
||||
await repo.UpdateAsync(entity);
|
||||
return ToSecuredWriteDto(entity);
|
||||
}
|
||||
|
||||
private static async Task<object?> HandleListSecuredWrites(
|
||||
IServiceProvider sp, ListSecuredWritesCommand cmd)
|
||||
{
|
||||
var repo = sp.GetRequiredService<ISecuredWriteRepository>();
|
||||
var rows = await repo.QueryAsync(cmd.Status, cmd.SiteId, skip: 0, take: 200);
|
||||
return new SecuredWriteListResult(rows.Select(ToSecuredWriteDto).ToList());
|
||||
}
|
||||
|
||||
// ========================================================================
|
||||
// Site handlers
|
||||
// ========================================================================
|
||||
|
||||
Reference in New Issue
Block a user