Compare commits
2 Commits
phase-6-2-
...
phase-6-2-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3b8280f08a | ||
| 70f3ec0092 |
@@ -0,0 +1,117 @@
|
|||||||
|
using Microsoft.EntityFrameworkCore;
|
||||||
|
using ZB.MOM.WW.OtOpcUa.Configuration;
|
||||||
|
using ZB.MOM.WW.OtOpcUa.Configuration.Entities;
|
||||||
|
using ZB.MOM.WW.OtOpcUa.Configuration.Enums;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.OtOpcUa.Admin.Services;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Draft-aware write surface over <see cref="NodeAcl"/>. Replaces direct
|
||||||
|
/// <see cref="NodeAclService"/> CRUD for Admin UI grant authoring; the raw service stays
|
||||||
|
/// as the read / delete surface. Enforces the invariants listed in Phase 6.2 Stream D.2:
|
||||||
|
/// scope-uniqueness per (LdapGroup, ScopeKind, ScopeId, GenerationId), grant shape
|
||||||
|
/// consistency, and no empty permission masks.
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// <para>Per decision #129 grants are additive — <see cref="NodePermissions.None"/> is
|
||||||
|
/// rejected at write time. Explicit Deny is v2.1 and is not representable in the current
|
||||||
|
/// <c>NodeAcl</c> row; attempts to express it (e.g. empty permission set) surface as
|
||||||
|
/// <see cref="InvalidNodeAclGrantException"/>.</para>
|
||||||
|
///
|
||||||
|
/// <para>Draft scope: writes always target an unpublished (Draft-state) generation id.
|
||||||
|
/// Once a generation publishes, its rows are frozen.</para>
|
||||||
|
/// </remarks>
|
||||||
|
public sealed class ValidatedNodeAclAuthoringService(OtOpcUaConfigDbContext db)
|
||||||
|
{
|
||||||
|
/// <summary>Add a new grant row to the given draft generation.</summary>
|
||||||
|
public async Task<NodeAcl> GrantAsync(
|
||||||
|
long draftGenerationId,
|
||||||
|
string clusterId,
|
||||||
|
string ldapGroup,
|
||||||
|
NodeAclScopeKind scopeKind,
|
||||||
|
string? scopeId,
|
||||||
|
NodePermissions permissions,
|
||||||
|
string? notes,
|
||||||
|
CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
ArgumentException.ThrowIfNullOrWhiteSpace(clusterId);
|
||||||
|
ArgumentException.ThrowIfNullOrWhiteSpace(ldapGroup);
|
||||||
|
|
||||||
|
ValidateGrantShape(scopeKind, scopeId, permissions);
|
||||||
|
await EnsureNoDuplicate(draftGenerationId, clusterId, ldapGroup, scopeKind, scopeId, cancellationToken).ConfigureAwait(false);
|
||||||
|
|
||||||
|
var row = new NodeAcl
|
||||||
|
{
|
||||||
|
GenerationId = draftGenerationId,
|
||||||
|
NodeAclId = $"acl-{Guid.NewGuid():N}"[..20],
|
||||||
|
ClusterId = clusterId,
|
||||||
|
LdapGroup = ldapGroup,
|
||||||
|
ScopeKind = scopeKind,
|
||||||
|
ScopeId = scopeId,
|
||||||
|
PermissionFlags = permissions,
|
||||||
|
Notes = notes,
|
||||||
|
};
|
||||||
|
db.NodeAcls.Add(row);
|
||||||
|
await db.SaveChangesAsync(cancellationToken).ConfigureAwait(false);
|
||||||
|
return row;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Replace an existing grant's permission set in place. Validates the new shape;
|
||||||
|
/// rejects attempts to blank-out to None (that's a Revoke via <see cref="NodeAclService"/>).
|
||||||
|
/// </summary>
|
||||||
|
public async Task<NodeAcl> UpdatePermissionsAsync(
|
||||||
|
Guid nodeAclRowId,
|
||||||
|
NodePermissions newPermissions,
|
||||||
|
string? notes,
|
||||||
|
CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
if (newPermissions == NodePermissions.None)
|
||||||
|
throw new InvalidNodeAclGrantException(
|
||||||
|
"Permission set cannot be None — revoke the row instead of writing an empty grant.");
|
||||||
|
|
||||||
|
var row = await db.NodeAcls.FirstOrDefaultAsync(a => a.NodeAclRowId == nodeAclRowId, cancellationToken).ConfigureAwait(false)
|
||||||
|
?? throw new InvalidNodeAclGrantException($"NodeAcl row {nodeAclRowId} not found.");
|
||||||
|
|
||||||
|
row.PermissionFlags = newPermissions;
|
||||||
|
if (notes is not null) row.Notes = notes;
|
||||||
|
await db.SaveChangesAsync(cancellationToken).ConfigureAwait(false);
|
||||||
|
return row;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void ValidateGrantShape(NodeAclScopeKind scopeKind, string? scopeId, NodePermissions permissions)
|
||||||
|
{
|
||||||
|
if (permissions == NodePermissions.None)
|
||||||
|
throw new InvalidNodeAclGrantException(
|
||||||
|
"Permission set cannot be None — grants must carry at least one flag (decision #129, additive only).");
|
||||||
|
|
||||||
|
if (scopeKind == NodeAclScopeKind.Cluster && !string.IsNullOrEmpty(scopeId))
|
||||||
|
throw new InvalidNodeAclGrantException(
|
||||||
|
"Cluster-scope grants must have null ScopeId. ScopeId only applies to sub-cluster scopes.");
|
||||||
|
|
||||||
|
if (scopeKind != NodeAclScopeKind.Cluster && string.IsNullOrEmpty(scopeId))
|
||||||
|
throw new InvalidNodeAclGrantException(
|
||||||
|
$"ScopeKind={scopeKind} requires a populated ScopeId.");
|
||||||
|
}
|
||||||
|
|
||||||
|
private async Task EnsureNoDuplicate(
|
||||||
|
long generationId, string clusterId, string ldapGroup, NodeAclScopeKind scopeKind, string? scopeId,
|
||||||
|
CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
var exists = await db.NodeAcls.AsNoTracking()
|
||||||
|
.AnyAsync(a => a.GenerationId == generationId
|
||||||
|
&& a.ClusterId == clusterId
|
||||||
|
&& a.LdapGroup == ldapGroup
|
||||||
|
&& a.ScopeKind == scopeKind
|
||||||
|
&& a.ScopeId == scopeId,
|
||||||
|
cancellationToken).ConfigureAwait(false);
|
||||||
|
|
||||||
|
if (exists)
|
||||||
|
throw new InvalidNodeAclGrantException(
|
||||||
|
$"A grant for (LdapGroup={ldapGroup}, ScopeKind={scopeKind}, ScopeId={scopeId}) already exists in generation {generationId}. " +
|
||||||
|
"Update the existing row's permissions instead of inserting a duplicate.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Thrown when a <see cref="NodeAcl"/> grant authoring request violates an invariant.</summary>
|
||||||
|
public sealed class InvalidNodeAclGrantException(string message) : Exception(message);
|
||||||
@@ -0,0 +1,146 @@
|
|||||||
|
using Microsoft.EntityFrameworkCore;
|
||||||
|
using Shouldly;
|
||||||
|
using Xunit;
|
||||||
|
using ZB.MOM.WW.OtOpcUa.Admin.Services;
|
||||||
|
using ZB.MOM.WW.OtOpcUa.Configuration;
|
||||||
|
using ZB.MOM.WW.OtOpcUa.Configuration.Enums;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.OtOpcUa.Admin.Tests;
|
||||||
|
|
||||||
|
[Trait("Category", "Unit")]
|
||||||
|
public sealed class ValidatedNodeAclAuthoringServiceTests : IDisposable
|
||||||
|
{
|
||||||
|
private readonly OtOpcUaConfigDbContext _db;
|
||||||
|
|
||||||
|
public ValidatedNodeAclAuthoringServiceTests()
|
||||||
|
{
|
||||||
|
var options = new DbContextOptionsBuilder<OtOpcUaConfigDbContext>()
|
||||||
|
.UseInMemoryDatabase($"val-nodeacl-{Guid.NewGuid():N}")
|
||||||
|
.Options;
|
||||||
|
_db = new OtOpcUaConfigDbContext(options);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void Dispose() => _db.Dispose();
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_Rejects_NonePermissions()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
|
||||||
|
await Should.ThrowAsync<InvalidNodeAclGrantException>(() => svc.GrantAsync(
|
||||||
|
draftGenerationId: 1, clusterId: "c1", ldapGroup: "cn=ops",
|
||||||
|
scopeKind: NodeAclScopeKind.Cluster, scopeId: null,
|
||||||
|
permissions: NodePermissions.None, notes: null, CancellationToken.None));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_Rejects_ClusterScope_With_ScopeId()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
|
||||||
|
await Should.ThrowAsync<InvalidNodeAclGrantException>(() => svc.GrantAsync(
|
||||||
|
1, "c1", "cn=ops",
|
||||||
|
NodeAclScopeKind.Cluster, scopeId: "not-null-wrong",
|
||||||
|
NodePermissions.Read, null, CancellationToken.None));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_Rejects_SubClusterScope_Without_ScopeId()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
|
||||||
|
await Should.ThrowAsync<InvalidNodeAclGrantException>(() => svc.GrantAsync(
|
||||||
|
1, "c1", "cn=ops",
|
||||||
|
NodeAclScopeKind.Equipment, scopeId: null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_Succeeds_When_Valid()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
|
||||||
|
var row = await svc.GrantAsync(
|
||||||
|
1, "c1", "cn=ops",
|
||||||
|
NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read | NodePermissions.Browse, "fleet reader", CancellationToken.None);
|
||||||
|
|
||||||
|
row.LdapGroup.ShouldBe("cn=ops");
|
||||||
|
row.PermissionFlags.ShouldBe(NodePermissions.Read | NodePermissions.Browse);
|
||||||
|
row.NodeAclId.ShouldNotBeNullOrWhiteSpace();
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_Rejects_DuplicateScopeGroup_Pair()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
await svc.GrantAsync(1, "c1", "cn=ops", NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None);
|
||||||
|
|
||||||
|
await Should.ThrowAsync<InvalidNodeAclGrantException>(() => svc.GrantAsync(
|
||||||
|
1, "c1", "cn=ops", NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.WriteOperate, null, CancellationToken.None));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_SameGroup_DifferentScope_IsAllowed()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
await svc.GrantAsync(1, "c1", "cn=ops", NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None);
|
||||||
|
|
||||||
|
var tagRow = await svc.GrantAsync(1, "c1", "cn=ops",
|
||||||
|
NodeAclScopeKind.Tag, scopeId: "tag-xyz",
|
||||||
|
NodePermissions.WriteOperate, null, CancellationToken.None);
|
||||||
|
|
||||||
|
tagRow.ScopeKind.ShouldBe(NodeAclScopeKind.Tag);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Grant_SameGroupScope_DifferentDraft_IsAllowed()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
await svc.GrantAsync(1, "c1", "cn=ops", NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None);
|
||||||
|
|
||||||
|
var draft2Row = await svc.GrantAsync(2, "c1", "cn=ops",
|
||||||
|
NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None);
|
||||||
|
|
||||||
|
draft2Row.GenerationId.ShouldBe(2);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task UpdatePermissions_Rejects_None()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
var row = await svc.GrantAsync(1, "c1", "cn=ops", NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None);
|
||||||
|
|
||||||
|
await Should.ThrowAsync<InvalidNodeAclGrantException>(
|
||||||
|
() => svc.UpdatePermissionsAsync(row.NodeAclRowId, NodePermissions.None, null, CancellationToken.None));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task UpdatePermissions_RoundTrips_NewFlags()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
var row = await svc.GrantAsync(1, "c1", "cn=ops", NodeAclScopeKind.Cluster, null,
|
||||||
|
NodePermissions.Read, null, CancellationToken.None);
|
||||||
|
|
||||||
|
var updated = await svc.UpdatePermissionsAsync(row.NodeAclRowId,
|
||||||
|
NodePermissions.Read | NodePermissions.WriteOperate, "bumped", CancellationToken.None);
|
||||||
|
|
||||||
|
updated.PermissionFlags.ShouldBe(NodePermissions.Read | NodePermissions.WriteOperate);
|
||||||
|
updated.Notes.ShouldBe("bumped");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task UpdatePermissions_MissingRow_Throws()
|
||||||
|
{
|
||||||
|
var svc = new ValidatedNodeAclAuthoringService(_db);
|
||||||
|
|
||||||
|
await Should.ThrowAsync<InvalidNodeAclGrantException>(
|
||||||
|
() => svc.UpdatePermissionsAsync(Guid.NewGuid(), NodePermissions.Read, null, CancellationToken.None));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -22,6 +22,7 @@
|
|||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<ProjectReference Include="..\..\src\ZB.MOM.WW.OtOpcUa.Admin\ZB.MOM.WW.OtOpcUa.Admin.csproj"/>
|
<ProjectReference Include="..\..\src\ZB.MOM.WW.OtOpcUa.Admin\ZB.MOM.WW.OtOpcUa.Admin.csproj"/>
|
||||||
<PackageReference Include="Microsoft.Data.SqlClient" Version="6.1.1"/>
|
<PackageReference Include="Microsoft.Data.SqlClient" Version="6.1.1"/>
|
||||||
|
<PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="10.0.0"/>
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
|||||||
Reference in New Issue
Block a user