mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-28 14:09:56 +08:00
## Summary Fixes the findings of a bug audit of `Opc.Ua.Server`, `Opc.Ua.Gds.Server` and `Opc.Ua.Gds.Client`. Rebased on master after #4516. What went in: - **Audit:** 93 findings, each checked against the OPC UA specification. - **Code review of those fixes:** 35 further findings. - **Spec grounding of every fix commit:** 18 conformance gaps, now closed. Commits are one per finding, named `Fix <ID>`, `Fix review <ID>` or `Fix spec gap <name>`. The IDs refer to the audit report (S = Server areas, G1 = GDS server, G2 = GDS client). Validation: - Each finding was traced in code and checked against OPC 10000 (parts 3, 4, 5, 9, 11, 12, 13, 18, 20). - Every fix commit was checked against the spec text again afterwards: 0 non-conformant, remaining gaps fixed. - Regression tests were added for most fixes. - Suites run on net10.0 before the rebase: Server, GDS, History, Configuration, Features, Core.Security, DI, Redundancy, LDS, InformationModel, PubSub.Server, Client, Sessions and the three Subscriptions suites, all green. The same suites on the rebased branch are still running; results will be posted as a comment. ## Behaviour and user-facing changes ### Secure defaults - **`Historize()` / `HistorianBuilder`** grant HistoryRead only. History writes need an explicit `historyAccessLevel: HistoryRead | HistoryWrite`. - **File-system mount:** - Anonymous sessions can no longer create, delete, move or open files for writing (`Bad_UserAccessDenied`). - UserWritable and UserExecutable now reflect the user. - `AllowAnonymousWrite` restores the old behaviour; the ReferenceServer sample turns it on. - **Default PKI root** for the hosted server, hosted GDS, hosted LDS and `OpcUaApplicationConfigurationProvider`: - Moved from the shared temp directory to `{LocalApplicationData}/OPC Foundation/{ApplicationName}/pki`, and startup fails if no per-user directory exists. - When certificate stores of an earlier version still exist under temp, a warning names both paths. Existing deployments that relied on the default get a new application certificate (and the hosted GDS a new CA) unless `PkiRoot` is set to the old path. - **GDS:** - `GdsServerOptions.AutoApprove` defaults to `false`. - The default KeyCredential store grants no roles unless `AuthorizeRoles` allows them. - Certificate requests (StartSigningRequest, StartNewKeyPairRequest, FinishRequest) need an encrypted channel. - **Hosted server anonymous logins:** - Anonymous is rejected (`Bad_IdentityTokenRejected`) when the default authenticator options disable it. - A custom `AddIdentityAuthenticator<T>()` on its own no longer disables anonymous. - With anonymous disabled and no configured token policies, the endpoint advertises the authenticators' token types instead of Anonymous. - **Runtime-added roles:** their properties and methods need SecurityAdmin over an encrypted channel, like the well-known roles. - **Disabled users:** users disabled through Part 18 UserManagement can no longer log in through `RegisterDefaultAuthenticators(IUserDatabase)`. ### GDS server (Part 12) - **Certificate requests:** - FinishRequest / ReadRequest with another application's RequestId returns `Bad_InvalidArgument`. - Every Start*Request returns a new RequestId. - A CSR without the ApplicationUri is rejected (`Bad_CertificateUriInvalid`). - An abstract or unsupported certificate type is rejected at Start (`Bad_InvalidArgument`). - **Private-key password:** no longer persisted in the JSON applications database. A password saved by an earlier version is read into memory once and dropped on the next save. - **CheckRevocationStatus:** validates offline against the GDS's own trust lists and CRLs. It returns Good for good GDS-issued certificates and `Bad_CertificateInvalid` for input that is not a certificate. - **Certificate-group trust lists:** - Writes need CertificateAuthorityAdmin; SecurityAdmin and application admins are read-only. - Writes are validated with the Part 4 certificate validation. - **AuthorizationService:** - The legacy RequestAccessToken applies `AccessControl` and issues the token for the session identity. - StartRequestToken passes the session identity to every identity-aware provider. - Unknown ResourceIds return `Bad_NotFound`. - Expired token requests and refresh tokens are pruned, with at most 10 000 pending requests (`Bad_TooManyOperations`). - **KeyCredential:** requests with PublicKey + SecurityPolicyUri are rejected with `Bad_SecurityPolicyRejected` (secret encryption is not implemented); a PublicKey without SecurityPolicyUri is rejected with `Bad_InvalidArgument`. - **Audit events:** access-token audit events no longer contain the password or token data. - **RegisterTickets / UnregisterTickets:** need the RegistrarAdmin role when called from a session. - **Managed application nodes:** moved from namespace 0 to their own namespace (`ManagedApplicationsNamespaceUri`); the NodeId is the ApplicationUri, and the mandatory child properties exist. - **Hosted GDS:** - New `GdsServerOptions.CertificateGroups` (`GdsCertificateGroupOptions`), bindable from configuration. - The mandatory DefaultApplicationGroup is always present. - The default CA subject uses the resolved application name. - **JSON applications database:** - A corrupt file throws instead of being silently replaced by an empty database. - Saves are atomic and write in place on bind mounts; on net8+ builds they also follow symlinks and keep the Unix file mode. - Issued certificates and trust-list links survive a reload. ### GDS client - **Trust-list download:** - Reads until an empty chunk (Part 20 short reads). - A size-limit rejection of the final end-of-file read, as sent by released servers, counts as end of file. - **Default certificate group:** a null group means DefaultApplicationGroup, and vendor groups in other namespaces are no longer mistaken for well-known groups. - **Status codes and errors:** - Missing directory proxies report `Bad_ServerNotConnected`. - Short or wrongly typed method outputs throw `BadUnexpectedError` / `BadTypeMismatch`. - **GdsAccessTokenProvider:** no longer caches a failed client task, and one caller's cancellation no longer fails other callers. ### Trust lists, push and ConfigurationFile (Part 12 / Part 20) - **AddCertificate:** - `IsTrustedCertificate=false` returns `Bad_CertificateInvalid`. - Added certificates are validated (Part 4), and a certificate revoked by a current CRL returns `Bad_CertificateRevoked`. - **CloseAndUpdate:** validates the uploaded list against its own certificates and CRLs, not the stores it replaces. Validation failures are no longer recorded in the server's Rejected store. - **RemoveCertificate:** removing a trusted or issuer CA that other certificates still need returns `Bad_CertificateChainIncomplete`. - **Handles:** - Several read handles may be open at once. - Any open while a write handle exists returns `Bad_NotReadable` / `Bad_NotWritable`. - A write open while any handle is open returns `Bad_NotWritable`. - Handles of closed sessions are released. - Idle handles close after ActivityTimeout (default 60 s). - **Status codes:** - Read clamps to the remaining bytes and no longer enforces the size limit. - Oversized Write / AddCertificate returns `Bad_RequestTooLarge`. - Unsupported open modes return `Bad_NotSupported`. - **ConfigurationFile.CloseAndUpdate:** - Empty Targets return `Bad_InvalidArgument`. - The ConfigurationUpdatedAuditEvent is raised with the configuration owner as source. - With the new `IApplicationConfigurationFileTargetProvider`, providers receive the Targets, a bad target returns Uncertain with per-target results, and session-interrupting updates are applied after RestartDelayTime. - **Default namespace permissions:** namespaces registered after the first permission lookup now get their NamespaceMetadata default RolePermissions and AccessRestrictions (no stale negative cache). ### Sessions, identity and roles (Part 18) - **Session timeouts:** a failure closing one timed-out session no longer stops the session-timeout monitor. - **ChangePassword:** an empty old password returns `Bad_IdentityTokenInvalid`. - **Removing or disabling a user:** closes only that user's UserName-token sessions. - **Role configuration changes:** roles granted by an `ImpersonateUser` mapping are kept. - **X509Subject rules:** a certificate subject value containing a quote never matches an X509Subject rule. - **`ImpersonateUser` callback:** no longer runs under the global session lock. - **Session diagnostics:** LocaleIds are kept as the client sent them, while null LocaleIds are ignored for translation. ### Subscriptions and monitored items (Part 4) - **Acknowledgements:** a failing acknowledgement returns a per-entry Bad status instead of failing the whole Publish. - **`DiscardedMessageCount`:** counts messages dropped from the retransmission queue and unsent overflow messages. - **Durable subscriptions:** transferring a restored anonymous subscription works (no NullReferenceException). - **Transferred subscriptions:** sampling and permission checks use the item's current owner session. - **Access denied:** a monitored item whose user may no longer read the attribute gets a `Bad_UserAccessDenied` notification instead of going silent. Non-Value attributes need Browse permission (RolePermissions needs ReadRolePermissions), and User* attributes are evaluated per subscriber. - **ModifyMonitoredItems:** a SamplingInterval of -1 uses the subscription's publishing interval. - **AggregateFilter priming:** needs HistoryRead / ReadHistory permission and is bounded (100 000 values, bounded page size). - **Resource leak:** event monitored items no longer leak a consumer task per create/delete cycle. ### Node management services (Part 3 / Part 4) - **Reference types:** AddNodes, AddReferences, DeleteReferences and Browse reject ids that are not ReferenceTypes with `Bad_ReferenceTypeIdInvalid`. AddNodes, AddReferences and DeleteReferences also reject abstract ReferenceTypes; Browse still accepts them (e.g. `HierarchicalReferences` with includeSubtypes). - **Concurrent AddNodes:** duplicate BrowseNames under one parent get `Bad_BrowseNameDuplicated`. - **TranslateBrowsePathsToNodeIds:** - Requires Browse permission on intermediate nodes and final targets (RolePermissions and AccessRestrictions). - A long RelativePath no longer rejects the whole request. - **SemanticChangeEvent:** - Raised once per actual change of a semantic property, whether or not it is monitored. - Also raised for properties with the SemanticChange access-level bit. - Reports the owning node's TypeDefinition as AffectedType. - **Localized diagnostics:** operation-level text is translated when OperationLocalizedText is requested. ### History and aggregates (Part 11 / Part 13) - **DeleteRawModified:** an unspecified or reversed range returns `Bad_InvalidTimestampArgument`, and StartTime == EndTime deletes the value at StartTime for every provider. - **ReadAtTime fallback:** reads only the values around each requested time. A time whose bound is not found within the search limit returns `Bad_BoundNotSupported` instead of failing the request. - **ReadProcessed:** a ProcessingInterval shorter than one tick returns `Bad_AggregateInvalidInputs`. - **Delta / DeltaBounds:** widen to the next larger signed type when the result does not fit the source type (e.g. a decreasing unsigned counter, or an Int16 overflow). - **Range / Range2:** return the source data type. ### Alarms and fluent API (Part 9) - **Suppression:** an alarm stays suppressed while any suppression group is active, and re-evaluation without a state change does not move TransitionTime. - **`MonitorVariable(variable)`:** sets SourceNode, SourceName and InputNode to the variable and makes it a ConditionSource (HasCondition to the alarm, HasEventSource from the object). - **Fluent input/output arguments:** InputArguments / OutputArguments added through the fluent API to a registered method are readable. - **Root notifiers:** a failed root-notifier registration no longer leaves an orphaned event worker. - **State-machine handlers:** exceptions are logged at Error. ### File system (Part 20) - **Delete / MoveOrCopy:** - Only act on direct children of the directory. - A NodeId whose kind does not match the entry returns `Bad_NotFound` (a file NodeId can no longer delete a directory). - Copying a directory into its own subtree returns `Bad_InvalidArgument`. - **Locking:** - An open file, or a directory containing one, cannot be deleted or moved (`Bad_InvalidState`). - The check is atomic with opens. - While a Delete or Move runs, read opens get `Bad_NotReadable` and write opens `Bad_InvalidState`. - **Open:** - Reserved mode bits or EraseExisting without Write return `Bad_InvalidArgument`. - Read+Write returns `Bad_NotSupported`. - Read while a writer is open returns `Bad_NotReadable`. - **Client `FileSystemErrors`:** maps `Bad_NotReadable` to `IOException`. - **RuntimeNodeSet:** well-formed NodeSets with a stray `Model` element, or two models in one file where one requires the other, now load. ### Server core, hosting and lifecycle - **`SessionEstablishmentQueueLimit` > 0:** CreateSession/ActivateSession now queue for a permit. The permit is acquired before the request is registered, and a waiting handshake releases its worker through the request-parking policy. - **Node manager lifecycle:** - Add, reload and remove no longer wait for parked Publish requests. - A Migrate reload racing with CreateMonitoredItems no longer blocks later lifecycle operations. - Late items on retired or removed managers get `Bad_NodeIdUnknown`. - **HistoryUpdate:** a batch mixing data and event details is bounded by both limits. - **Server stop/start:** stopping the server disposes the configuration watcher and certificate subscription; starting recreates them. - **Monitored-item queue factory:** a factory supplied by the caller or the DI container is no longer disposed by the server. - **Audit events:** each certificate validation error raises its own AuditCertificate event. A failed OpenSecureChannel without a service result is audited as failed. ## New public API (additive) - `IQueuedSessionEstablishmentLimiter` - `StandardServer.OwnsMonitoredItemQueueFactory` (protected virtual) - `DefaultPkiRoot.Get` (Opc.Ua.Configuration) - `TrustList.SetCertificateValidation` - `NamespaceMetadataRegistry.Invalidate` - `IApplicationConfigurationFileTargetProvider` and `ApplicationConfigurationUpdatePlan` - `GdsServerOptions.CertificateGroups` / `GdsCertificateGroupOptions` - `InMemoryKeyCredentialRequestStore.AuthorizeRoles` - `DefaultManagedApplicationsNodeManager.ManagedApplicationsNamespaceUri` - `AuthorizationServiceManager.RequestAccessTokenAsync(..., IUserIdentity?, ...)` - `AllowAnonymousWrite` on the file-system node manager and its factory - `IFileSystemHost.TryBeginMutation` / `EndMutation`, replacing `HasOpenHandles` ## Not fixed / known limitations - **KeyCredential:** secret encryption with the client's PublicKey (requests needing it are rejected). - **CSR SAN restriction:** restricting subject / SAN values copied from a CSR (CA policy). - **Ticket signatures:** ticket signature verification (needs a trusted-signer configuration). - **FileType Read+Write open:** needs a read/write stream contract in `IFileSystemProvider`. - **Custom `IUserDatabase` implementations:** the disabled-user check still scans all users per login. The built-in stores do a single lookup. - **64-bit Delta precision:** limited by the calculator's double arithmetic. ## Tests with changed expectations Existing tests were updated where they asserted the old behaviour: - File-system status codes - Trust-list handle eviction - `DiscardedMessageCount` - Localized diagnostics bits - Delta on unsigned sources - SourceNode of fluent alarms - ReferenceServer transfer permission test (now expects `Bad_UserAccessDenied` notifications) - `UserDeactivationShutdownReviewTests` (the revoked session is a UserName login) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
633 lines
27 KiB
C#
633 lines
27 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
#nullable enable
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Server.UserDatabase;
|
|
using Opc.Ua.Tests;
|
|
using UserManagementImpl = Opc.Ua.Server.UserManagement.UserManagement;
|
|
|
|
namespace Opc.Ua.Server.Tests
|
|
{
|
|
/// <summary>
|
|
/// Unit tests for <see cref="UserManagement.UserManagement"/>
|
|
/// covering OPC UA Part 18 §5 compliance: spec result codes, password
|
|
/// validation, self-modify rejection, MustChangePassword bit handling,
|
|
/// and the UserDeactivated event.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Roles")]
|
|
[Parallelizable]
|
|
public class UserManagementTests
|
|
{
|
|
private static readonly string[] s_defaultUserNames = ["alice", "bob"];
|
|
|
|
private static UserManagementImpl CreateManager()
|
|
{
|
|
return new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 });
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_HappyPath_Succeeds()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
ServiceResult result = um.AddUser("alice", "secret", UserConfigurationMask.None, "Tester");
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
|
|
IReadOnlyList<UserManagementDataType> users = um.SnapshotUsers();
|
|
Assert.That(users, Has.Count.EqualTo(1));
|
|
Assert.That(users[0].UserName, Is.EqualTo("alice"));
|
|
Assert.That(users[0].Description, Is.EqualTo("Tester"));
|
|
}
|
|
|
|
[Test]
|
|
public void SnapshotUsers_StartsWithAllDatabaseUsers()
|
|
{
|
|
var database = new LinqUserDatabase();
|
|
Assert.That(database.CreateUser("alice", "secret"u8, [Role.AuthenticatedUser]), Is.True);
|
|
Assert.That(database.CreateUser("bob", "secret2"u8, [Role.AuthenticatedUser]), Is.True);
|
|
|
|
using var um = new UserManagementImpl(database, passwordLength: new Range { Low = 4, High = 64 });
|
|
|
|
IReadOnlyList<UserManagementDataType> users = um.SnapshotUsers();
|
|
Assert.That(users.Select(u => u.UserName), Is.EquivalentTo(s_defaultUserNames));
|
|
Assert.That(users.All(u => u.UserConfiguration == (uint)UserConfigurationMask.None), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void SnapshotUsers_StartsWithAllCustomDatabaseUsers()
|
|
{
|
|
var database = new TestUserDatabase(
|
|
[
|
|
new UserManagementDataType
|
|
{
|
|
UserName = "alice",
|
|
UserConfiguration = (uint)UserConfigurationMask.MustChangePassword,
|
|
Description = "Alice Description"
|
|
},
|
|
new UserManagementDataType
|
|
{
|
|
UserName = "bob",
|
|
UserConfiguration = (uint)UserConfigurationMask.Disabled,
|
|
Description = "Bob Description"
|
|
}
|
|
]);
|
|
|
|
using var um = new UserManagementImpl(database, passwordLength: new Range { Low = 4, High = 64 });
|
|
|
|
IReadOnlyList<UserManagementDataType> users = um.SnapshotUsers();
|
|
UserManagementDataType alice = users.Single(u => u.UserName == "alice");
|
|
UserManagementDataType bob = users.Single(u => u.UserName == "bob");
|
|
Assert.That(users.Select(u => u.UserName), Is.EquivalentTo(s_defaultUserNames));
|
|
Assert.That(alice.UserConfiguration, Is.EqualTo((uint)UserConfigurationMask.MustChangePassword));
|
|
Assert.That(alice.Description, Is.EqualTo("Alice Description"));
|
|
Assert.That(bob.UserConfiguration, Is.EqualTo((uint)UserConfigurationMask.Disabled));
|
|
Assert.That(bob.Description, Is.EqualTo("Bob Description"));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_DuplicateUserName_ReturnsBadAlreadyExists()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult duplicate = um.AddUser("alice", "secret2", UserConfigurationMask.None, string.Empty);
|
|
Assert.That(duplicate.StatusCode, Is.EqualTo(StatusCodes.BadAlreadyExists));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_PasswordTooShort_ReturnsBadOutOfRange()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
ServiceResult result = um.AddUser("alice", "ab", UserConfigurationMask.None, string.Empty);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_PasswordTooLong_ReturnsBadOutOfRange()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
ServiceResult result = um.AddUser("alice", new string('a', 200),
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_MustChangePasswordPlusNoChangeByUser_ReturnsBadConfigurationError()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
ServiceResult result = um.AddUser("alice", "secret",
|
|
UserConfigurationMask.MustChangePassword | UserConfigurationMask.NoChangeByUser,
|
|
string.Empty);
|
|
Assert.That(result.StatusCode,
|
|
Is.EqualTo(StatusCodes.BadConfigurationError));
|
|
}
|
|
|
|
[Test]
|
|
public void RemoveUser_NonExistent_ReturnsBadNotFound()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
ServiceResult result = um.RemoveUser("ghost", callingUserName: null);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadNotFound));
|
|
}
|
|
|
|
[Test]
|
|
public void RemoveUser_SelfReference_ReturnsBadInvalidSelfReference()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult result = um.RemoveUser("alice", callingUserName: "alice");
|
|
Assert.That(result.StatusCode,
|
|
Is.EqualTo(StatusCodes.BadInvalidSelfReference));
|
|
}
|
|
|
|
[Test]
|
|
public void ModifyUser_DisableSelfReference_ReturnsBadInvalidSelfReference()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult result = um.ModifyUser(
|
|
"alice",
|
|
modifyPassword: false,
|
|
password: string.Empty,
|
|
modifyUserConfiguration: true,
|
|
userConfiguration: UserConfigurationMask.Disabled,
|
|
modifyDescription: false,
|
|
description: string.Empty,
|
|
callingUserName: "alice");
|
|
Assert.That(result.StatusCode,
|
|
Is.EqualTo(StatusCodes.BadInvalidSelfReference));
|
|
}
|
|
|
|
[Test]
|
|
public void ModifyUser_DisableOther_RaisesUserDeactivatedEvent()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
|
|
string? deactivated = null;
|
|
um.UserDeactivated += (_, e) => deactivated = e.UserName;
|
|
|
|
ServiceResult result = um.ModifyUser(
|
|
"alice",
|
|
modifyPassword: false,
|
|
password: string.Empty,
|
|
modifyUserConfiguration: true,
|
|
userConfiguration: UserConfigurationMask.Disabled,
|
|
modifyDescription: false,
|
|
description: string.Empty,
|
|
callingUserName: "admin");
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
Assert.That(deactivated, Is.EqualTo("alice"));
|
|
Assert.That(um.IsUserActive("alice"), Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void RemoveUser_RaisesUserDeactivatedEvent()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
|
|
string? deactivated = null;
|
|
um.UserDeactivated += (_, e) => deactivated = e.UserName;
|
|
|
|
ServiceResult result = um.RemoveUser("alice", callingUserName: "admin");
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
Assert.That(deactivated, Is.EqualTo("alice"));
|
|
}
|
|
|
|
[Test]
|
|
public void RemoveUser_NoDeleteFlag_ReturnsBadNotSupported()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.SupportDisableUser |
|
|
PasswordOptionsMask.SupportDisableDeleteForUser |
|
|
PasswordOptionsMask.SupportInitialPasswordChange);
|
|
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.NoDelete, string.Empty)), Is.True);
|
|
ServiceResult result = um.RemoveUser("alice", callingUserName: "admin");
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadNotSupported));
|
|
}
|
|
|
|
[Test]
|
|
public void ModifyUser_AdminPasswordReset_PreservesUserRoles()
|
|
{
|
|
// Regression for the password-reset path that previously dropped
|
|
// the user's roles by calling CreateUser with []. The fix
|
|
// snapshots roles via IUserDatabase.GetUserRoles before delete
|
|
// and re-applies them on recreate.
|
|
var db = new LinqUserDatabase();
|
|
db.CreateUser("alice", "secret"u8, [Role.SecurityAdmin, Role.AuthenticatedUser]);
|
|
|
|
using var um = new UserManagementImpl(
|
|
db, passwordLength: new Range { Low = 4, High = 64 });
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("bob", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
// Bob exists in the manager metadata as well as in the db (added
|
|
// by AddUser); now layer in admin-assigned roles directly on the
|
|
// db (typical pattern for integrators).
|
|
db.DeleteUser("bob");
|
|
db.CreateUser("bob", "secret"u8, [Role.Engineer]);
|
|
|
|
ServiceResult result = um.ModifyUser(
|
|
"bob",
|
|
modifyPassword: true,
|
|
password: "newsecret",
|
|
modifyUserConfiguration: false,
|
|
userConfiguration: UserConfigurationMask.None,
|
|
modifyDescription: false,
|
|
description: string.Empty,
|
|
callingUserName: "admin");
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
|
|
// The Engineer role assignment must have survived the reset.
|
|
ICollection<Role> rolesAfter = db.GetUserRoles("bob");
|
|
Assert.That(rolesAfter, Has.Member(Role.Engineer),
|
|
"Admin password reset should preserve previously assigned roles.");
|
|
Assert.That(db.CheckCredentials("bob", "newsecret"u8), Is.True,
|
|
"New password must be active after the reset.");
|
|
}
|
|
|
|
[Test]
|
|
public void ChangePassword_HappyPath_Succeeds()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "oldpass", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult result = um.ChangePassword("alice", "oldpass", "newpass");
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void JsonDatabasePersistsUserConfigurationAndDescriptionAcrossReload()
|
|
{
|
|
string fileName = Path.Combine(
|
|
Path.GetTempPath(),
|
|
"opcua-user-metadata-" + Guid.NewGuid().ToString("N") + ".json");
|
|
try
|
|
{
|
|
using (var initial = new UserManagementImpl(
|
|
new JsonUserDatabase(fileName),
|
|
passwordLength: new Range { Low = 4, High = 64 }))
|
|
{
|
|
ServiceResult result = initial.AddUser(
|
|
"alice",
|
|
"secret",
|
|
UserConfigurationMask.Disabled | UserConfigurationMask.MustChangePassword,
|
|
"Disabled until verified");
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
}
|
|
|
|
IUserDatabase loadedDatabase = JsonUserDatabase.Load(
|
|
fileName,
|
|
NUnitTelemetryContext.Create());
|
|
using var reloaded = new UserManagementImpl(
|
|
loadedDatabase,
|
|
passwordLength: new Range { Low = 4, High = 64 });
|
|
|
|
UserManagementDataType alice = reloaded.SnapshotUsers()
|
|
.Single(user => user.UserName == "alice");
|
|
Assert.That(
|
|
(UserConfigurationMask)alice.UserConfiguration,
|
|
Is.EqualTo(UserConfigurationMask.Disabled | UserConfigurationMask.MustChangePassword));
|
|
Assert.That(alice.Description, Is.EqualTo("Disabled until verified"));
|
|
}
|
|
finally
|
|
{
|
|
if (File.Exists(fileName))
|
|
{
|
|
File.Delete(fileName);
|
|
}
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public void ChangePassword_SameAsOld_ReturnsBadAlreadyExists()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult result = um.ChangePassword("alice", "secret", "secret");
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadAlreadyExists));
|
|
}
|
|
|
|
[Test]
|
|
public void ChangePassword_WrongOldPassword_ReturnsBadIdentityTokenInvalid()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult result = um.ChangePassword("alice", "wrong", "newpass");
|
|
Assert.That(result.StatusCode,
|
|
Is.EqualTo(StatusCodes.BadIdentityTokenInvalid));
|
|
}
|
|
|
|
[TestCase("")]
|
|
[TestCase(null)]
|
|
public void ChangePassword_EmptyOldPassword_ReturnsBadIdentityTokenInvalid(string? oldPassword)
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(
|
|
um.AddUser("alice", "secret", UserConfigurationMask.None, string.Empty)), Is.True);
|
|
ServiceResult result = um.ChangePassword("alice", oldPassword!, "newpass");
|
|
Assert.That(result.StatusCode,
|
|
Is.EqualTo(StatusCodes.BadIdentityTokenInvalid));
|
|
}
|
|
|
|
[Test]
|
|
public void ChangePassword_ClearsMustChangePasswordBit()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(um.AddUser("alice", "secret",
|
|
UserConfigurationMask.MustChangePassword, string.Empty)), Is.True);
|
|
Assert.That(um.MustChangePassword("alice"), Is.True);
|
|
|
|
Assert.That(ServiceResult.IsGood(um.ChangePassword("alice", "secret", "newpass")), Is.True);
|
|
Assert.That(um.MustChangePassword("alice"), Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void ChangePassword_NoChangeByUser_ReturnsBadNotSupported()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.SupportDisableUser |
|
|
PasswordOptionsMask.SupportNoChangeForUser |
|
|
PasswordOptionsMask.SupportInitialPasswordChange);
|
|
|
|
Assert.That(ServiceResult.IsGood(um.AddUser("alice", "secret",
|
|
UserConfigurationMask.NoChangeByUser, string.Empty)), Is.True);
|
|
ServiceResult result = um.ChangePassword("alice", "secret", "newpass");
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadNotSupported));
|
|
}
|
|
|
|
[Test]
|
|
public void IsUserActive_DisabledUser_ReturnsFalse()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(um.AddUser("alice", "secret",
|
|
UserConfigurationMask.Disabled, string.Empty)), Is.True);
|
|
Assert.That(um.IsUserActive("alice"), Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void IsUserActive_ActiveUser_ReturnsTrue()
|
|
{
|
|
using UserManagementImpl um = CreateManager();
|
|
Assert.That(ServiceResult.IsGood(um.AddUser("alice", "secret",
|
|
UserConfigurationMask.None, string.Empty)), Is.True);
|
|
Assert.That(um.IsUserActive("alice"), Is.True);
|
|
}
|
|
|
|
// ----------------------------------------------------------------
|
|
// Gap 11: Password length exact boundaries
|
|
// ----------------------------------------------------------------
|
|
|
|
[TestCase(3, ExpectedResult = false, TestName = "Password just below min length is rejected")]
|
|
[TestCase(4, ExpectedResult = true, TestName = "Password exactly at min length is accepted")]
|
|
[TestCase(5, ExpectedResult = true, TestName = "Password just above min length is accepted")]
|
|
public bool AddUser_PasswordLengthAtLowerBoundary_RespectsRange(int length)
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 });
|
|
ServiceResult result = um.AddUser("alice", new string('a', length),
|
|
UserConfigurationMask.None, string.Empty);
|
|
return ServiceResult.IsGood(result);
|
|
}
|
|
|
|
[TestCase(63, ExpectedResult = true, TestName = "Password just below max length is accepted")]
|
|
[TestCase(64, ExpectedResult = true, TestName = "Password exactly at max length is accepted")]
|
|
[TestCase(65, ExpectedResult = false, TestName = "Password just above max length is rejected")]
|
|
public bool AddUser_PasswordLengthAtUpperBoundary_RespectsRange(int length)
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 });
|
|
ServiceResult result = um.AddUser("alice", new string('a', length),
|
|
UserConfigurationMask.None, string.Empty);
|
|
return ServiceResult.IsGood(result);
|
|
}
|
|
|
|
// ----------------------------------------------------------------
|
|
// Gap 10: Password complexity (Upper / Lower / Digit / Special)
|
|
// ----------------------------------------------------------------
|
|
|
|
[Test]
|
|
public void AddUser_RequiresUpperCase_PasswordWithoutUpper_ReturnsBadOutOfRange()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresUpperCaseCharacters);
|
|
ServiceResult result = um.AddUser("alice", "alllower1!",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresUpperCase_PasswordWithUpper_Succeeds()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresUpperCaseCharacters);
|
|
ServiceResult result = um.AddUser("alice", "HasUpper",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresLowerCase_PasswordWithoutLower_ReturnsBadOutOfRange()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresLowerCaseCharacters);
|
|
ServiceResult result = um.AddUser("alice", "ALLUPPER1!",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresLowerCase_PasswordWithLower_Succeeds()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresLowerCaseCharacters);
|
|
ServiceResult result = um.AddUser("alice", "haslower",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresDigit_PasswordWithoutDigit_ReturnsBadOutOfRange()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresDigitCharacters);
|
|
ServiceResult result = um.AddUser("alice", "NoDigits",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresDigit_PasswordWithDigit_Succeeds()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresDigitCharacters);
|
|
ServiceResult result = um.AddUser("alice", "HasDigit1",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresSpecial_PasswordWithoutSpecial_ReturnsBadOutOfRange()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresSpecialCharacters);
|
|
ServiceResult result = um.AddUser("alice", "OnlyAlphaNumeric1",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
}
|
|
|
|
[Test]
|
|
public void AddUser_RequiresSpecial_PasswordWithSpecial_Succeeds()
|
|
{
|
|
using var um = new UserManagementImpl(
|
|
new LinqUserDatabase(),
|
|
passwordLength: new Range { Low = 4, High = 64 },
|
|
passwordOptions: PasswordOptionsMask.RequiresSpecialCharacters);
|
|
ServiceResult result = um.AddUser("alice", "Has!Special",
|
|
UserConfigurationMask.None, string.Empty);
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
}
|
|
|
|
private sealed class TestUserDatabase : IUserDatabase
|
|
{
|
|
private readonly IReadOnlyList<UserManagementDataType> m_users;
|
|
|
|
public TestUserDatabase(IReadOnlyList<UserManagementDataType> users)
|
|
{
|
|
m_users = users;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool CreateUser(string userName, ReadOnlySpan<byte> password, ICollection<Role> roles)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool DeleteUser(string userName)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool CheckCredentials(string userName, ReadOnlySpan<byte> password)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public ICollection<Role> GetUserRoles(string userName)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public IReadOnlyList<UserManagementDataType> GetUsers()
|
|
{
|
|
return m_users;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool ChangePassword(
|
|
string userName,
|
|
ReadOnlySpan<byte> oldPassword,
|
|
ReadOnlySpan<byte> newPassword)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool CreateUser(
|
|
string userName,
|
|
ReadOnlySpan<byte> password,
|
|
ArrayOf<Role> roles,
|
|
UserConfigurationMask userConfiguration,
|
|
string description)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool ResetPassword(
|
|
string userName,
|
|
ReadOnlySpan<byte> newPassword,
|
|
UserConfigurationMask userConfiguration,
|
|
string description)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool UpdateUserMetadata(
|
|
string userName,
|
|
UserConfigurationMask userConfiguration,
|
|
string description)
|
|
{
|
|
throw new NotSupportedException();
|
|
}
|
|
}
|
|
}
|
|
}
|