Files
UA-.NETStandard/tests/Opc.Ua.Gds.Tests/ApplicationsNodeManagerKeyCredentialTests.cs
romanett a0d569d756 Fix Server and GDS audit findings, review findings and spec-conformance gaps (#4571)
## 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>
2026-09-29 07:26:05 +02:00

758 lines
31 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2026 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/
* ======================================================================*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Moq;
using NUnit.Framework;
using Opc.Ua.Gds.Server;
using Opc.Ua.Gds.Server.Database.Linq;
using Opc.Ua.Server;
namespace Opc.Ua.Gds.Tests
{
[TestFixture]
[Category("KeyCredential")]
[Category("ApplicationsNodeManagerCoverage")]
[NonParallelizable]
public sealed class ApplicationsNodeManagerKeyCredentialTests : GdsTestFixture
{
private const string OwnerApplicationUri =
"urn:opcfoundation.org:tests:test:app:KeyCredentialOwner";
private const string OtherApplicationUri =
"urn:opcfoundation.org:tests:test:app:KeyCredentialOther";
private static readonly byte[] s_passwordBytes = Encoding.UTF8.GetBytes("password");
private TestableApplicationsNodeManager m_nodeManager = null!;
private KeyCredentialServiceState m_service = null!;
private LinqApplicationsDatabase m_database = null!;
private NodeId m_ownerApplicationId;
private NodeId m_otherApplicationId;
[OneTimeSetUp]
public async Task KeyCredentialSetUpAsync()
{
m_database = new LinqApplicationsDatabase();
m_nodeManager = new TestableApplicationsNodeManager(
ReferenceServer.CurrentInstance,
ServerFixture.Config,
m_database,
Mock.Of<ICertificateGroup>());
m_database.NamespaceIndex = m_nodeManager.ApplicationsNamespaceIndex;
ApplicationRecordDataType owner = CreateTestApplicationRecord("KeyCredentialOwner");
ApplicationRecordDataType other = CreateTestApplicationRecord("KeyCredentialOther");
m_ownerApplicationId = m_database.RegisterApplication(owner);
m_otherApplicationId = m_database.RegisterApplication(other);
m_service = await m_nodeManager.CreateKeyCredentialServiceAsync().ConfigureAwait(false);
}
[OneTimeTearDown]
public void KeyCredentialTearDown()
{
m_nodeManager?.Dispose();
}
[SetUp]
public void ResetStore()
{
m_nodeManager.KeyCredentialRequestStore = new InMemoryKeyCredentialRequestStore();
}
[Test]
public void KeyCredentialMethodsExposeApplicationPrivilegePermissions()
{
Assert.That(m_service.StartRequest!.OnReadRolePermissions, Is.Not.Null);
Assert.That(m_service.StartRequest.OnReadUserRolePermissions, Is.Not.Null);
Assert.That(m_service.FinishRequest!.OnReadRolePermissions, Is.Not.Null);
Assert.That(m_service.FinishRequest.OnReadUserRolePermissions, Is.Not.Null);
Assert.That(m_service.Revoke, Is.Not.Null);
Assert.That(m_service.Revoke!.OnReadRolePermissions, Is.Not.Null);
Assert.That(m_service.Revoke.OnReadUserRolePermissions, Is.Not.Null);
}
[Test]
public async Task KeyCredentialAdminCanCompleteLifecycleAsync()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 1);
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult finished =
await FinishRequestAsync(context, requestId, cancelRequest: false)
.ConfigureAwait(false);
KeyCredentialRevokeMethodStateResult revoked =
await RevokeAsync(context, finished.CredentialId).ConfigureAwait(false);
Assert.Multiple(() =>
{
Assert.That(requestId.IsNull, Is.False);
Assert.That(ServiceResult.IsGood(finished.ServiceResult), Is.True);
Assert.That(finished.CredentialId, Is.Not.Empty);
Assert.That(finished.CredentialSecret.IsEmpty, Is.False);
Assert.That(ServiceResult.IsGood(revoked.ServiceResult), Is.True);
});
}
[Test]
public async Task ApplicationSelfAdminCanCompleteOwnApplicationLifecycleAsync()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(
GdsRole.ApplicationSelfAdmin,
applicationId: m_ownerApplicationId),
certificateMarker: 2);
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult finished =
await FinishRequestAsync(context, requestId, cancelRequest: false)
.ConfigureAwait(false);
KeyCredentialRevokeMethodStateResult revoked =
await RevokeAsync(context, finished.CredentialId).ConfigureAwait(false);
Assert.That(ServiceResult.IsGood(finished.ServiceResult), Is.True);
Assert.That(ServiceResult.IsGood(revoked.ServiceResult), Is.True);
}
[Test]
public async Task ApplicationSelfAdminCannotManageAnotherApplicationAsync()
{
ISystemContext adminContext = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 3);
NodeId requestId = await StartRequestAsync(adminContext, OtherApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult finished =
await FinishRequestAsync(adminContext, requestId, cancelRequest: false)
.ConfigureAwait(false);
ISystemContext selfAdminContext = CreateContext(
CreateRoleIdentity(
GdsRole.ApplicationSelfAdmin,
applicationId: m_ownerApplicationId),
certificateMarker: 3);
AssertBadUserAccessDenied(
async () => await StartRequestAsync(selfAdminContext, OtherApplicationUri)
.ConfigureAwait(false));
AssertBadUserAccessDenied(
async () => await FinishRequestAsync(
selfAdminContext,
requestId,
cancelRequest: false).ConfigureAwait(false));
AssertBadUserAccessDenied(
async () => await RevokeAsync(selfAdminContext, finished.CredentialId)
.ConfigureAwait(false));
}
[Test]
public async Task ApplicationAdminCanCompleteManagedApplicationLifecycleAsync()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(
GdsRole.ApplicationAdmin,
administeredApplicationIds: [m_ownerApplicationId]),
certificateMarker: 4);
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult finished =
await FinishRequestAsync(context, requestId, cancelRequest: false)
.ConfigureAwait(false);
KeyCredentialRevokeMethodStateResult revoked =
await RevokeAsync(context, finished.CredentialId).ConfigureAwait(false);
Assert.That(ServiceResult.IsGood(finished.ServiceResult), Is.True);
Assert.That(ServiceResult.IsGood(revoked.ServiceResult), Is.True);
}
[Test]
public async Task ApplicationAdminCannotManageUnmanagedApplicationAsync()
{
ISystemContext adminContext = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 5);
NodeId requestId = await StartRequestAsync(adminContext, OtherApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult finished =
await FinishRequestAsync(adminContext, requestId, cancelRequest: false)
.ConfigureAwait(false);
ISystemContext applicationAdminContext = CreateContext(
CreateRoleIdentity(
GdsRole.ApplicationAdmin,
administeredApplicationIds: [m_ownerApplicationId]),
certificateMarker: 5);
AssertBadUserAccessDenied(
async () => await StartRequestAsync(
applicationAdminContext,
OtherApplicationUri).ConfigureAwait(false));
AssertBadUserAccessDenied(
async () => await FinishRequestAsync(
applicationAdminContext,
requestId,
cancelRequest: false).ConfigureAwait(false));
AssertBadUserAccessDenied(
async () => await RevokeAsync(
applicationAdminContext,
finished.CredentialId).ConfigureAwait(false));
}
[Test]
public async Task FinishRequestWithDifferentInitiatingCertificateFailsAsync()
{
ISystemContext startContext = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 6);
NodeId requestId = await StartRequestAsync(startContext, OwnerApplicationUri)
.ConfigureAwait(false);
ISystemContext finishContext = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 7);
Assert.That(
async () => await FinishRequestAsync(
finishContext,
requestId,
cancelRequest: false).ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityChecksFailed));
}
[Test]
public async Task CancelRequestReturnsGoodWithoutCredentialMaterialAsync()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 8);
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult result =
await FinishRequestAsync(context, requestId, cancelRequest: true)
.ConfigureAwait(false);
Assert.Multiple(() =>
{
Assert.That(ServiceResult.IsGood(result.ServiceResult), Is.True);
Assert.That(result.CredentialId, Is.Null.Or.Empty);
Assert.That(result.CredentialSecret.IsEmpty, Is.True);
});
}
[Test]
public async Task PendingRequestReturnsBadRequestNotCompleteAsync()
{
m_nodeManager.KeyCredentialRequestStore =
new StateKeyCredentialRequestStore(
m_ownerApplicationId,
KeyCredentialRequestState.New);
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 9);
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult result =
await FinishRequestAsync(context, requestId, cancelRequest: false)
.ConfigureAwait(false);
Assert.That(
result.ServiceResult.StatusCode,
Is.EqualTo(StatusCodes.BadRequestNotComplete));
Assert.That(result.CredentialSecret.IsEmpty, Is.True);
}
[Test]
public async Task RejectedRequestReturnsBadRequestNotAllowedAsync()
{
m_nodeManager.KeyCredentialRequestStore =
new StateKeyCredentialRequestStore(
m_ownerApplicationId,
KeyCredentialRequestState.Rejected);
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 13);
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult result =
await FinishRequestAsync(context, requestId, cancelRequest: false)
.ConfigureAwait(false);
Assert.That(
result.ServiceResult.StatusCode,
Is.EqualTo(StatusCodes.BadRequestNotAllowed));
Assert.That(result.CredentialSecret.IsEmpty, Is.True);
}
[Test]
public void UnknownApplicationFailureIsAuditedAndRethrown()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 10);
Assert.That(
async () => await StartRequestAsync(context, "urn:test:unknown")
.ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadNotFound));
}
[Test]
public void UnknownCredentialFailureIsAuditedAndRethrown()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 11);
Assert.That(
async () => await RevokeAsync(context, "unknown-credential")
.ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadInvalidArgument));
}
[Test]
public void StoreWithoutApplicationOwnershipIsRejected()
{
m_nodeManager.KeyCredentialRequestStore = new LegacyKeyCredentialRequestStore();
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 12);
Assert.That(
async () => await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityChecksFailed));
}
/// <summary>
/// OPC 10000-12 §8.5.5 / §8.5.6: a SecurityPolicyUri requires a PublicKey,
/// and a secret that is not encrypted reports no SecurityPolicyUri.
/// </summary>
[Test]
public async Task KeyCredentialSecurityPolicyRequiresPublicKeyAsync()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 15);
Assert.That(
async () => await m_service.StartRequest!.OnCallAsync!(
context,
m_service.StartRequest,
m_service.NodeId,
OwnerApplicationUri,
default,
SecurityPolicies.Basic256Sha256,
default,
CancellationToken.None).ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadInvalidArgument));
NodeId requestId = await StartRequestAsync(context, OwnerApplicationUri)
.ConfigureAwait(false);
KeyCredentialFinishRequestMethodStateResult finished =
await FinishRequestAsync(context, requestId, cancelRequest: false)
.ConfigureAwait(false);
Assert.That(finished.SecurityPolicyUri, Is.Null.Or.Empty);
}
/// <summary>
/// OPC 10000-12 §8.5.5: a PublicKey requires a SecurityPolicyUri, and a
/// request for an encrypted secret is rejected with
/// Bad_SecurityPolicyRejected instead of returning the secret in plain text.
/// </summary>
[Test]
public void KeyCredentialPublicKeyRequestIsRejected()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.KeyCredentialAdmin),
certificateMarker: 16);
Assert.That(
async () => await m_service.StartRequest!.OnCallAsync!(
context,
m_service.StartRequest,
m_service.NodeId,
OwnerApplicationUri,
ByteString.From([1, 2, 3]),
null!,
default,
CancellationToken.None).ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadInvalidArgument));
Assert.That(
async () => await m_service.StartRequest!.OnCallAsync!(
context,
m_service.StartRequest,
m_service.NodeId,
OwnerApplicationUri,
ByteString.From([1, 2, 3]),
SecurityPolicies.Basic256Sha256,
default,
CancellationToken.None).ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityPolicyRejected));
}
/// <summary>
/// OPC 10000-12 §7.9.3 - §7.9.5: the certificate request methods shall
/// be called from an encrypted SecureChannel.
/// </summary>
[Test]
public void CertificateRequestMethodsRequireEncryptedChannel()
{
ISystemContext context = CreateContext(
CreateRoleIdentity(GdsRole.CertificateAuthorityAdmin),
certificateMarker: 14,
MessageSecurityMode.Sign);
var method = new MethodState(null);
NodeId requestId = default;
Assert.That(
() => m_nodeManager.OnStartNewKeyPairRequest(
context, method, default, m_ownerApplicationId, default, default,
"CN=Owner", default, "PFX", "password", ref requestId),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityModeInsufficient));
Assert.That(
async () => await m_nodeManager.OnStartSigningRequestAsync(
context, method, default, m_ownerApplicationId, default, default,
ByteString.From([1, 2, 3]), CancellationToken.None).ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityModeInsufficient));
Assert.That(
async () => await m_nodeManager.OnFinishRequestAsync(
context, method, default, m_ownerApplicationId, new NodeId(Guid.NewGuid()),
CancellationToken.None).ConfigureAwait(false),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityModeInsufficient));
}
private async Task<NodeId> StartRequestAsync(
ISystemContext context,
string applicationUri)
{
KeyCredentialStartRequestMethodStateResult result =
await m_service.StartRequest!.OnCallAsync!(
context,
m_service.StartRequest,
m_service.NodeId,
applicationUri,
default,
null!,
default,
CancellationToken.None).ConfigureAwait(false);
Assert.That(ServiceResult.IsGood(result.ServiceResult), Is.True);
return result.RequestId;
}
private ValueTask<KeyCredentialFinishRequestMethodStateResult> FinishRequestAsync(
ISystemContext context,
NodeId requestId,
bool cancelRequest)
{
return m_service.FinishRequest!.OnCallAsync!(
context,
m_service.FinishRequest,
m_service.NodeId,
requestId,
cancelRequest,
CancellationToken.None);
}
private ValueTask<KeyCredentialRevokeMethodStateResult> RevokeAsync(
ISystemContext context,
string credentialId)
{
return m_service.Revoke!.OnCallAsync!(
context,
m_service.Revoke,
m_service.NodeId,
credentialId,
CancellationToken.None);
}
private ServerSystemContext CreateContext(
IUserIdentity identity,
byte certificateMarker,
MessageSecurityMode securityMode = MessageSecurityMode.SignAndEncrypt)
{
var endpoint = new EndpointDescription
{
SecurityMode = securityMode,
SecurityPolicyUri = SecurityPolicies.Basic256Sha256
};
var channelContext = new SecureChannelContext(
$"key-credential-{certificateMarker}",
endpoint,
RequestEncoding.Binary,
[certificateMarker, 1, 2, 3]);
var operationContext = new OperationContext(
new RequestHeader(),
channelContext,
RequestType.Call,
RequestLifetime.None,
identity);
return ReferenceServer.CurrentInstance.DefaultSystemContext.Copy(operationContext);
}
private GdsRoleBasedIdentity CreateRoleIdentity(
Role role,
NodeId applicationId = default,
IEnumerable<NodeId>? administeredApplicationIds = null)
{
return new GdsRoleBasedIdentity(
new UserIdentity(role.Name, s_passwordBytes),
[role],
applicationId,
administeredApplicationIds,
ReferenceServer.CurrentInstance.NamespaceUris);
}
private static void AssertBadUserAccessDenied(Func<Task> action)
{
Assert.That(
action,
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadUserAccessDenied));
}
private sealed class TestableApplicationsNodeManager : ApplicationsNodeManager
{
public TestableApplicationsNodeManager(
IServerInternal server,
ApplicationConfiguration configuration,
LinqApplicationsDatabase database,
ICertificateGroup certificateGroup)
: base(
server,
configuration,
database,
database,
certificateGroup,
autoApprove: true)
{
}
public async ValueTask<KeyCredentialServiceState> CreateKeyCredentialServiceAsync()
{
// The service is a node of the companion model's
// KeyCredentialManagement folder, so it is named in the
// manager's own namespace rather than in the one the GDS
// mints application records into.
ushort namespaceIndex = NamespaceIndex;
var service = new KeyCredentialServiceState(null);
service.Create(
SystemContext,
new NodeId("KeyCredentialManagement/Test", namespaceIndex),
new QualifiedName("Test", namespaceIndex),
new LocalizedText("Test"),
false);
service.AddRevoke(SystemContext);
// A host adds its own service objects to the model's empty
// KeyCredentialManagement folder and wires each one, the
// same call the GDS makes for the nodes it owns.
await ConfigureKeyCredentialServiceAsync(service).ConfigureAwait(false);
await AddPredefinedNodeAsync(SystemContext, service).ConfigureAwait(false);
return service;
}
}
private sealed class StateKeyCredentialRequestStore :
IApplicationOwnedKeyCredentialRequestStore
{
private readonly NodeId m_applicationId;
private readonly KeyCredentialRequestState m_state;
private readonly NodeId m_requestId = new(1);
public StateKeyCredentialRequestStore(
NodeId applicationId,
KeyCredentialRequestState state)
{
m_applicationId = applicationId;
m_state = state;
}
public ValueTask<NodeId> StartRequestAsync(
string applicationUri,
ByteString publicKey,
string? securityPolicyUri,
ArrayOf<NodeId> requestedRoles,
CancellationToken cancellationToken = default)
{
return new ValueTask<NodeId>(m_requestId);
}
public ValueTask<NodeId> StartBoundRequestAsync(
string applicationUri,
ByteString publicKey,
string? securityPolicyUri,
ArrayOf<NodeId> requestedRoles,
ByteString clientCertificateFingerprint,
CancellationToken cancellationToken = default)
{
return new ValueTask<NodeId>(m_requestId);
}
public ValueTask<NodeId> StartOwnedBoundRequestAsync(
string applicationUri,
NodeId applicationId,
ByteString publicKey,
string? securityPolicyUri,
ArrayOf<NodeId> requestedRoles,
ByteString clientCertificateFingerprint,
CancellationToken cancellationToken = default)
{
return new ValueTask<NodeId>(m_requestId);
}
public ValueTask<FinishKeyCredentialRequestResult> FinishRequestAsync(
NodeId requestId,
bool cancelRequest,
CancellationToken cancellationToken = default)
{
return new ValueTask<FinishKeyCredentialRequestResult>(
new FinishKeyCredentialRequestResult
{
State = m_state
});
}
public ValueTask<FinishKeyCredentialRequestResult> FinishBoundRequestAsync(
NodeId requestId,
bool cancelRequest,
ByteString clientCertificateFingerprint,
CancellationToken cancellationToken = default)
{
return FinishRequestAsync(requestId, cancelRequest, cancellationToken);
}
public ValueTask<NodeId> GetRequestApplicationIdAsync(
NodeId requestId,
CancellationToken cancellationToken = default)
{
return new ValueTask<NodeId>(m_applicationId);
}
public ValueTask<FinishKeyCredentialRequestResult> FinishOwnedBoundRequestAsync(
NodeId requestId,
bool cancelRequest,
NodeId applicationId,
ByteString clientCertificateFingerprint,
CancellationToken cancellationToken = default)
{
return FinishRequestAsync(requestId, cancelRequest, cancellationToken);
}
public ValueTask<NodeId> GetCredentialApplicationIdAsync(
string credentialId,
CancellationToken cancellationToken = default)
{
return new ValueTask<NodeId>(m_applicationId);
}
public ValueTask RevokeAsync(
string credentialId,
CancellationToken cancellationToken = default)
{
return default;
}
public ValueTask RevokeOwnedAsync(
string credentialId,
NodeId applicationId,
CancellationToken cancellationToken = default)
{
return default;
}
}
private sealed class LegacyKeyCredentialRequestStore : IKeyCredentialRequestStore
{
public ValueTask<NodeId> StartRequestAsync(
string applicationUri,
ByteString publicKey,
string? securityPolicyUri,
ArrayOf<NodeId> requestedRoles,
CancellationToken cancellationToken = default)
{
return new ValueTask<NodeId>(new NodeId(1));
}
public ValueTask<FinishKeyCredentialRequestResult> FinishRequestAsync(
NodeId requestId,
bool cancelRequest,
CancellationToken cancellationToken = default)
{
return new ValueTask<FinishKeyCredentialRequestResult>(
new FinishKeyCredentialRequestResult
{
State = KeyCredentialRequestState.Completed
});
}
public ValueTask RevokeAsync(
string credentialId,
CancellationToken cancellationToken = default)
{
return default;
}
}
}
}