mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-21 17:16:16 +08:00
romanett
9b034f8291
# Description Nullable reference types are now enabled once, in `common.props`, and every project in the repository builds warning-clean with them. **Configuration** - `<Nullable>enable</Nullable>` lives in `common.props`. All per-project `<Nullable>` settings are removed: 178 project files (enable, annotations, and the `disable` in the three Aot test projects). - 419 per-file `#nullable enable`/`restore` directives and the 4 `#nullable disable` directives are removed. - Kept on purpose: - The 5 `<auto-generated>` schema files (`UANodeSet.cs`, `UA Type Dictionary.cs`, `OPCBinarySchema.cs`, `SecuredApplication.cs`, `PInvokeHelper.cs`) keep `#nullable enable`. The compiler ignores the project setting in generated code, so the directive is required there. - `tests/Opc.Ua.Interop.LegacyPeer` keeps `disable`. It builds against the 1.5.378 packages and does not import the repository props. - `docs/DeveloperGuide.md` and `.github/copilot-instructions.md` now describe the central setting. **Migration** (the 43 unset and 13 annotations-only projects, roughly 10k diagnostics) - **Production code: annotated at the declarations.** Covers `tools/Opc.Ua.SourceGeneration.Core`, `src/Opc.Ua.Lds.Server` and the LDS sample. - Members, parameters and returns are nullable where null actually flows. - Null-check helpers carry `[NotNullWhen]` (`IsNull`, `IsValidXmlName`, `IsMethodTypeDesign`). - `CoreUtils.Format`, `Utils.Format`, `ITemplateWriter.WriteLine` take `params object?[]`. `Template.AddReplacement` takes `string?` (rendering already skips null replacements). - `IRegisteredServerStore.RegisterAsync` returns `Task<RegistrationEntry?>`: it returns null when a registration is removed. - Dereferences backed by an invariant (for example, the validated model) use `!`, so runtime behaviour is unchanged. - **Behavioural changes in production code** (small, deliberate): - `NodeSetToModelDesign` throws `InvalidOperationException` when the file is not a NodeSet. Before, it threw a NullReferenceException on the next line. - `ModelDesignValidator` starts its lookup tables empty instead of null. A redundant `if (m_nodes == null) return;` guard is gone. - **Test code: minimal annotations.** - `?` on values that can be null, `!` where the test asserts non-null. - `= null!` for fixture members assigned in SetUp. - `TryGetStructure<T>(out T? x)` where the inferred `T?` broke the `IEncodeable` constraint. - A few redundant `== null` checks on structs (`NodeId`, `ArrayOf<T>`) folded into the adjacent `IsNull`/`Count` checks. **Notes for reviewers** - The diff is large (~1,500 files) but almost entirely mechanical: `?`, `!` and directive removal. The non-annotation changes are listed above. - Known follow-up, not done here: `IModelDesign.Namespaces/TargetNamespace/NamespaceUris` stay non-nullable even though the validator returns null before it loads a dictionary. Making them nullable would ripple through every generator call site. ## Related Issues - Fixes #4439 ## Checklist - [ ] I have signed the [CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf) and read the [CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md) doc. - [ ] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added all necessary documentation. - [x] I have verified that my changes do not introduce (new) build or analyzer warnings. - [ ] I ran **all** tests locally using the **UA.slnx** solution against at least .net **framework** and .net **10**, and all passed. - [ ] I fixed **all** failing and flaky tests in the CI pipelines and **all** CodeQL warnings. - [ ] I have addressed **all** PR feedback received. The "no new warnings" box covers net10.0 and net48: full non-incremental builds of `UA.slnx`, `tools/SourceGeneration.slnx`, `tools/MigrationAnalyzer.slnx` and the Aot test projects finished with 0 warnings and 0 errors under the repository's warnings-as-errors settings. net9.0 and net8.0 also had no nullable diagnostics, but they were not rebuilt after the final fixes. Tests have not been run locally yet. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
729 lines
28 KiB
C#
729 lines
28 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.Threading;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Gds.Server;
|
|
|
|
namespace Opc.Ua.Gds.Tests
|
|
{
|
|
/// <summary>
|
|
/// Unit tests for the in-memory KeyCredential request store and
|
|
/// the round-trip StartRequestAsync / FinishRequestAsync / RevokeAsync lifecycle.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("KeyCredential")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
[Parallelizable]
|
|
public class KeyCredentialRequestStoreTests
|
|
{
|
|
private InMemoryKeyCredentialRequestStore m_store = null!;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
m_store = new InMemoryKeyCredentialRequestStore();
|
|
}
|
|
|
|
[Test]
|
|
public async Task StartRequestReturnsNonNullIdAsync()
|
|
{
|
|
NodeId id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
ByteString.From(new byte[] { 1, 2, 3 }),
|
|
"http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256",
|
|
default).ConfigureAwait(false);
|
|
|
|
Assert.That(id.IsNull, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public async Task FinishRequestReturnsCredentialAsync()
|
|
{
|
|
NodeId id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
ByteString.From(new byte[] { 1, 2 }),
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult result = await m_store.FinishRequestAsync(
|
|
id,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
|
|
Assert.That(result.State, Is.EqualTo(KeyCredentialRequestState.Completed));
|
|
Assert.That(result.CredentialId, Is.Not.Null.And.Not.Empty);
|
|
Assert.That(result.CredentialSecret.IsEmpty, Is.False);
|
|
}
|
|
|
|
/// <summary>
|
|
/// OPC 10000-12 §8.5.5: roles the caller is not authorized to request
|
|
/// are ignored; without an authorization callback none are granted.
|
|
/// </summary>
|
|
[Test]
|
|
public async Task RequestedRolesAreOnlyGrantedWhenAuthorizedAsync()
|
|
{
|
|
NodeId securityAdmin = Ua.ObjectIds.WellKnownRole_SecurityAdmin;
|
|
NodeId observer = Ua.ObjectIds.WellKnownRole_Observer;
|
|
NodeId operatorRole = Ua.ObjectIds.WellKnownRole_Operator;
|
|
|
|
NodeId id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
new[] { securityAdmin }.ToArrayOf()).ConfigureAwait(false);
|
|
FinishKeyCredentialRequestResult result = await m_store.FinishRequestAsync(
|
|
id,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
Assert.That(result.GrantedRoles.IsEmpty, Is.True);
|
|
|
|
// the callback may only narrow the requested roles
|
|
m_store.AuthorizeRoles = (applicationUri, requested) => [observer, operatorRole];
|
|
id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
new[] { securityAdmin, observer }.ToArrayOf()).ConfigureAwait(false);
|
|
result = await m_store.FinishRequestAsync(
|
|
id,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
Assert.That(result.GrantedRoles.ToArray(), Is.EqualTo(new[] { observer }));
|
|
}
|
|
|
|
[Test]
|
|
public async Task BoundRequestFinishesWithInitiatingCertificateAsync()
|
|
{
|
|
ByteString fingerprint = CreateFingerprint(1);
|
|
NodeId id = await m_store.StartBoundRequestAsync(
|
|
"urn:test:app",
|
|
ByteString.From(new byte[] { 1, 2 }),
|
|
null,
|
|
default,
|
|
fingerprint).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult result = await m_store.FinishBoundRequestAsync(
|
|
id,
|
|
cancelRequest: false,
|
|
fingerprint).ConfigureAwait(false);
|
|
|
|
Assert.That(result.State, Is.EqualTo(KeyCredentialRequestState.Completed));
|
|
Assert.That(result.CredentialSecret.IsEmpty, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public async Task OwnedRequestPreservesApplicationOwnershipAsync()
|
|
{
|
|
var applicationId = new NodeId(42);
|
|
ByteString fingerprint = CreateFingerprint(1);
|
|
NodeId requestId = await m_store.StartOwnedBoundRequestAsync(
|
|
"urn:test:app",
|
|
applicationId,
|
|
default,
|
|
null,
|
|
default,
|
|
fingerprint).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
await m_store.GetRequestApplicationIdAsync(requestId).ConfigureAwait(false),
|
|
Is.EqualTo(applicationId));
|
|
|
|
FinishKeyCredentialRequestResult result = await m_store.FinishOwnedBoundRequestAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
applicationId,
|
|
fingerprint).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
await m_store
|
|
.GetCredentialApplicationIdAsync(result.CredentialId!)
|
|
.ConfigureAwait(false),
|
|
Is.EqualTo(applicationId));
|
|
Assert.That(
|
|
async () => await m_store
|
|
.RevokeOwnedAsync(result.CredentialId!, new NodeId(43))
|
|
.ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
Assert.That(
|
|
async () => await m_store
|
|
.RevokeOwnedAsync(result.CredentialId!, applicationId)
|
|
.ConfigureAwait(false),
|
|
Throws.Nothing);
|
|
}
|
|
|
|
[Test]
|
|
public async Task OwnedFinishRejectsDifferentApplicationAsync()
|
|
{
|
|
var applicationId = new NodeId(42);
|
|
ByteString fingerprint = CreateFingerprint(1);
|
|
NodeId requestId = await m_store.StartOwnedBoundRequestAsync(
|
|
"urn:test:app",
|
|
applicationId,
|
|
default,
|
|
null,
|
|
default,
|
|
fingerprint).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.FinishOwnedBoundRequestAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
new NodeId(43),
|
|
fingerprint).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task OwnershipLookupRejectsLegacyUnownedRecordAsync()
|
|
{
|
|
NodeId requestId = await m_store.StartBoundRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store
|
|
.GetRequestApplicationIdAsync(requestId)
|
|
.ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public void OwnershipLookupUsesConformantInvalidArgumentStatus()
|
|
{
|
|
Assert.That(
|
|
async () => await m_store
|
|
.GetRequestApplicationIdAsync(new NodeId(999))
|
|
.ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadInvalidArgument));
|
|
Assert.That(
|
|
async () => await m_store
|
|
.GetCredentialApplicationIdAsync("unknown-credential")
|
|
.ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadInvalidArgument));
|
|
}
|
|
|
|
[Test]
|
|
public async Task BoundRequestRejectsDifferentCertificateAsync()
|
|
{
|
|
NodeId id = await m_store.StartBoundRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.FinishBoundRequestAsync(
|
|
id,
|
|
cancelRequest: false,
|
|
CreateFingerprint(2)).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task LegacyFinishRejectsBoundRequestAsync()
|
|
{
|
|
NodeId id = await m_store.StartBoundRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.FinishRequestAsync(
|
|
id,
|
|
cancelRequest: false).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task BoundFinishRejectsLegacyUnboundRequestAsync()
|
|
{
|
|
NodeId id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.FinishBoundRequestAsync(
|
|
id,
|
|
cancelRequest: false,
|
|
CreateFingerprint(1)).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public void BindingCompatibilityRejectsLegacyStore()
|
|
{
|
|
IKeyCredentialRequestStore store = new LegacyKeyCredentialRequestStore();
|
|
|
|
Assert.That(
|
|
async () => await store.StartBoundRequestCompatAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1),
|
|
CancellationToken.None).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public void FinishBindingCompatibilityRejectsLegacyStore()
|
|
{
|
|
IKeyCredentialRequestStore store = new LegacyKeyCredentialRequestStore();
|
|
|
|
Assert.That(
|
|
async () => await store.FinishBoundRequestCompatAsync(
|
|
new NodeId(1),
|
|
cancelRequest: false,
|
|
CreateFingerprint(1),
|
|
CancellationToken.None).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task BindingCompatibilityDispatchesToBoundStoreAsync()
|
|
{
|
|
var boundStore = new RecordingBoundKeyCredentialRequestStore();
|
|
IKeyCredentialRequestStore store = boundStore;
|
|
ByteString fingerprint = CreateFingerprint(1);
|
|
|
|
NodeId requestId = await store.StartBoundRequestCompatAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
fingerprint,
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
FinishKeyCredentialRequestResult result =
|
|
await store.FinishBoundRequestCompatAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
fingerprint,
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(requestId, Is.EqualTo(new NodeId(2)));
|
|
Assert.That(result.State, Is.EqualTo(KeyCredentialRequestState.Completed));
|
|
Assert.That(boundStore.StartBoundCalled, Is.True);
|
|
Assert.That(boundStore.FinishBoundCalled, Is.True);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public void ConstructorWithNullSecretStoreThrows()
|
|
{
|
|
Assert.That(
|
|
() => new InMemoryKeyCredentialRequestStore(null!),
|
|
Throws.ArgumentNullException);
|
|
}
|
|
|
|
[Test]
|
|
public void StartOwnedBoundRequestWithNullApplicationIdThrows()
|
|
{
|
|
Assert.That(
|
|
async () => await m_store.StartOwnedBoundRequestAsync(
|
|
"urn:test:app",
|
|
NodeId.Null,
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[TestCase(0)]
|
|
[TestCase(31)]
|
|
[TestCase(33)]
|
|
public void StartBoundRequestWithInvalidFingerprintLengthThrows(int length)
|
|
{
|
|
Assert.That(
|
|
async () => await m_store.StartBoundRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
ByteString.From(new byte[length])).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task FinishBoundRequestWithInvalidFingerprintLengthThrowsAsync()
|
|
{
|
|
NodeId requestId = await m_store.StartBoundRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.FinishBoundRequestAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
ByteString.From(new byte[31])).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task OwnedOperationsWithNullApplicationIdThrowAsync()
|
|
{
|
|
NodeId requestId = await m_store.StartOwnedBoundRequestAsync(
|
|
"urn:test:app",
|
|
new NodeId(42),
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
FinishKeyCredentialRequestResult finished =
|
|
await m_store.FinishOwnedBoundRequestAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
new NodeId(42),
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.FinishOwnedBoundRequestAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
NodeId.Null,
|
|
CreateFingerprint(1)).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
Assert.That(
|
|
async () => await m_store.RevokeOwnedAsync(
|
|
finished.CredentialId!,
|
|
NodeId.Null).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
|
|
[Test]
|
|
public async Task OwnershipLookupsHonorCancellationAsync()
|
|
{
|
|
var applicationId = new NodeId(42);
|
|
NodeId requestId = await m_store.StartOwnedBoundRequestAsync(
|
|
"urn:test:app",
|
|
applicationId,
|
|
default,
|
|
null,
|
|
default,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
FinishKeyCredentialRequestResult finished =
|
|
await m_store.FinishOwnedBoundRequestAsync(
|
|
requestId,
|
|
cancelRequest: false,
|
|
applicationId,
|
|
CreateFingerprint(1)).ConfigureAwait(false);
|
|
using var cts = new CancellationTokenSource();
|
|
cts.Cancel();
|
|
|
|
Assert.That(
|
|
async () => await m_store.GetRequestApplicationIdAsync(
|
|
requestId,
|
|
cts.Token).ConfigureAwait(false),
|
|
Throws.InstanceOf<OperationCanceledException>());
|
|
Assert.That(
|
|
async () => await m_store.GetCredentialApplicationIdAsync(
|
|
finished.CredentialId!,
|
|
cts.Token).ConfigureAwait(false),
|
|
Throws.InstanceOf<OperationCanceledException>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task RepeatedFinishPreservesCompletedStateAndSecretAsync()
|
|
{
|
|
NodeId requestId = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
FinishKeyCredentialRequestResult first =
|
|
await m_store.FinishRequestAsync(
|
|
requestId,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult second =
|
|
await m_store.FinishRequestAsync(
|
|
requestId,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(second.State, Is.EqualTo(KeyCredentialRequestState.Completed));
|
|
Assert.That(second.CredentialId, Is.EqualTo(first.CredentialId));
|
|
Assert.That(second.CredentialSecret.ToArray(),
|
|
Is.EqualTo(first.CredentialSecret.ToArray()));
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task FinishAfterCancelDoesNotReturnPurgedSecretAsync()
|
|
{
|
|
NodeId requestId = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
await m_store.FinishRequestAsync(
|
|
requestId,
|
|
cancelRequest: true).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult result =
|
|
await m_store.FinishRequestAsync(
|
|
requestId,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
|
|
Assert.That(result.State, Is.EqualTo(KeyCredentialRequestState.Rejected));
|
|
Assert.That(result.CredentialSecret.IsEmpty, Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public async Task FinishAfterRevokeDoesNotReturnPurgedSecretAsync()
|
|
{
|
|
NodeId requestId = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
default,
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
FinishKeyCredentialRequestResult issued =
|
|
await m_store.FinishRequestAsync(
|
|
requestId,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
await m_store.RevokeAsync(issued.CredentialId!).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult result =
|
|
await m_store.FinishRequestAsync(
|
|
requestId,
|
|
cancelRequest: false).ConfigureAwait(false);
|
|
|
|
Assert.That(result.State, Is.EqualTo(KeyCredentialRequestState.Rejected));
|
|
Assert.That(result.CredentialSecret.IsEmpty, Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public async Task FinishRequestWithCancelRejectsRequestAsync()
|
|
{
|
|
NodeId id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
ByteString.From(new byte[] { 1 }),
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult result = await m_store.FinishRequestAsync(
|
|
id,
|
|
cancelRequest: true).ConfigureAwait(false);
|
|
|
|
Assert.That(result.State, Is.EqualTo(KeyCredentialRequestState.Rejected));
|
|
Assert.That(result.CredentialId, Is.Null);
|
|
}
|
|
|
|
[Test]
|
|
public void FinishRequestWithUnknownIdThrows()
|
|
{
|
|
Assert.That(
|
|
async () => await m_store.FinishRequestAsync(
|
|
new NodeId(999),
|
|
cancelRequest: false).ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadNotFound));
|
|
}
|
|
|
|
[Test]
|
|
public async Task RevokeMarksCredentialAsRejectedAsync()
|
|
{
|
|
NodeId id = await m_store.StartRequestAsync(
|
|
"urn:test:app",
|
|
ByteString.From(new byte[] { 1 }),
|
|
null,
|
|
default).ConfigureAwait(false);
|
|
|
|
FinishKeyCredentialRequestResult result = await m_store.FinishRequestAsync(
|
|
id, cancelRequest: false).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await m_store.RevokeAsync(result.CredentialId!).ConfigureAwait(false),
|
|
Throws.Nothing);
|
|
}
|
|
|
|
[Test]
|
|
public void RevokeUnknownCredentialReturnsBadInvalidArgument()
|
|
{
|
|
Assert.That(
|
|
async () => await m_store.RevokeAsync("unknown-credential").ConfigureAwait(false),
|
|
Throws.TypeOf<ServiceResultException>()
|
|
.With.Property(nameof(ServiceResultException.StatusCode))
|
|
.EqualTo(StatusCodes.BadInvalidArgument));
|
|
}
|
|
|
|
[Test]
|
|
public async Task MultipleRequestsGetUniqueIdsAsync()
|
|
{
|
|
NodeId id1 = await m_store.StartRequestAsync("urn:app1", default, null, default).ConfigureAwait(false);
|
|
NodeId id2 = await m_store.StartRequestAsync("urn:app2", default, null, default).ConfigureAwait(false);
|
|
|
|
Assert.That(id1, Is.Not.EqualTo(id2));
|
|
}
|
|
|
|
private static ByteString CreateFingerprint(byte value)
|
|
{
|
|
byte[] fingerprint = new byte[32];
|
|
fingerprint[0] = value;
|
|
return ByteString.From(fingerprint);
|
|
}
|
|
|
|
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;
|
|
}
|
|
}
|
|
|
|
private sealed class RecordingBoundKeyCredentialRequestStore :
|
|
IClientCertificateBoundKeyCredentialRequestStore
|
|
{
|
|
public bool StartBoundCalled { get; private set; }
|
|
public bool FinishBoundCalled { get; private set; }
|
|
|
|
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<NodeId> StartBoundRequestAsync(
|
|
string applicationUri,
|
|
ByteString publicKey,
|
|
string? securityPolicyUri,
|
|
ArrayOf<NodeId> requestedRoles,
|
|
ByteString clientCertificateFingerprint,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
StartBoundCalled = true;
|
|
return new ValueTask<NodeId>(new NodeId(2));
|
|
}
|
|
|
|
public ValueTask<FinishKeyCredentialRequestResult> FinishRequestAsync(
|
|
NodeId requestId,
|
|
bool cancelRequest,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
return new ValueTask<FinishKeyCredentialRequestResult>(
|
|
new FinishKeyCredentialRequestResult
|
|
{
|
|
State = KeyCredentialRequestState.Completed
|
|
});
|
|
}
|
|
|
|
public ValueTask<FinishKeyCredentialRequestResult> FinishBoundRequestAsync(
|
|
NodeId requestId,
|
|
bool cancelRequest,
|
|
ByteString clientCertificateFingerprint,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
FinishBoundCalled = true;
|
|
return FinishRequestAsync(requestId, cancelRequest, cancellationToken);
|
|
}
|
|
|
|
public ValueTask RevokeAsync(
|
|
string credentialId,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
return default;
|
|
}
|
|
}
|
|
}
|
|
}
|