Files
UA-.NETStandard/tests/Opc.Ua.Gds.Tests/AuthorizationHelperTests.cs
romanettandClaude Opus 5.5 9b034f8291 Enable nullable reference types centrally; migrate all unset and annotations-only projects (#4700)
# 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>
2026-10-08 08:48:13 +02:00

799 lines
32 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/
* ======================================================================*/
using System.Collections.Generic;
using System.Security.Cryptography;
using System.Text;
using NUnit.Framework;
using Opc.Ua.Gds.Server;
using Opc.Ua.Server;
using Opc.Ua.Tests;
namespace Opc.Ua.Gds.Tests
{
[TestFixture]
[Category("Authorization")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
[Parallelizable]
public class AuthorizationHelperTests
{
private static readonly byte[] s_passwordBytes = Encoding.UTF8.GetBytes("password");
private NamespaceTable m_namespaceTable;
private ITelemetryContext m_telemetry;
[SetUp]
public void SetUp()
{
m_telemetry = NUnitTelemetryContext.Create();
m_namespaceTable = new NamespaceTable();
// Ensure the GDS namespace is registered so that GDS-namespace
// role NodeIds (e.g. WellKnownRole_DiscoveryAdmin) resolve to a
// unique NodeId rather than colliding on NodeId.Null with the
// namespace-less ApplicationSelfAdmin/ApplicationAdmin
// privileges.
m_namespaceTable.Append(Namespaces.OpcUaGds);
}
[Test]
public void HasAuthorizationWithNullContextDoesNotThrow()
{
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(null!, AuthorizationHelper.DiscoveryAdmin));
}
[Test]
public void HasAuthorizationThrowsWhenUserLacksRequiredRole()
{
var identity = new UserIdentity("user", s_passwordBytes);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdmin));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationSucceedsWhenUserHasDiscoveryAdminRole()
{
var innerIdentity = new UserIdentity("admin", s_passwordBytes);
var roles = new List<Role> { GdsRole.DiscoveryAdmin };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdmin));
}
[Test]
public void HasAuthorizationSucceedsWithSelfAdminForOwnApplication()
{
var appId = new NodeId(99);
var innerIdentity = new UserIdentity("appuser", s_passwordBytes);
var roles = new List<Role> { Role.AuthenticatedUser };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, appId, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrSelfAdmin,
appId));
}
/// <summary>
/// OPC 10000-12 §7.2 Table 20: ApplicationSelfAdmin only reads the
/// shared group trust list; writing needs CertificateAuthorityAdmin.
/// </summary>
[Test]
public void HasTrustListWriteAccessRequiresCertificateAuthorityAdmin()
{
var selfAdmin = new GdsRoleBasedIdentity(
new UserIdentity("appuser", s_passwordBytes),
new List<Role> { Role.AuthenticatedUser },
new NodeId(99),
m_namespaceTable);
var selfAdminContext = new SessionSystemContext(m_telemetry)
{
UserIdentity = selfAdmin,
NamespaceUris = m_namespaceTable
};
var caAdmin = new GdsRoleBasedIdentity(
new UserIdentity("admin", s_passwordBytes),
new List<Role> { GdsRole.CertificateAuthorityAdmin },
m_namespaceTable);
var caAdminContext = new SessionSystemContext(m_telemetry)
{
UserIdentity = caAdmin,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasTrustListWriteAccess(selfAdminContext));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
Assert.DoesNotThrow(() => AuthorizationHelper.HasTrustListWriteAccess(caAdminContext));
}
/// <summary>
/// OPC 10000-12 §7.2 Table 19 / §7.8.2.5: SecurityAdmin is a
/// PushManagement Role and does not grant write access to a
/// CertificateManager (PullManagement) group trust list.
/// </summary>
[Test]
public void HasTrustListWriteAccessRejectsSecurityAdmin()
{
var securityAdmin = new GdsRoleBasedIdentity(
new UserIdentity("secadmin", s_passwordBytes),
new List<Role> { Role.SecurityAdmin },
m_namespaceTable);
var securityAdminContext = new SessionSystemContext(m_telemetry)
{
UserIdentity = securityAdmin,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasTrustListWriteAccess(securityAdminContext));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationThrowsWithSelfAdminForDifferentApplication()
{
var ownAppId = new NodeId(99);
var otherAppId = new NodeId(100);
var innerIdentity = new UserIdentity("appuser", s_passwordBytes);
var roles = new List<Role> { Role.AuthenticatedUser };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, ownAppId, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrSelfAdmin,
otherAppId));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationThrowsWithSelfAdminAndNullApplicationId()
{
var appId = new NodeId(99);
var innerIdentity = new UserIdentity("appuser", s_passwordBytes);
var roles = new List<Role> { Role.AuthenticatedUser };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, appId, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrSelfAdmin,
NodeId.Null));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationThrowsForAnonymousUser()
{
var identity = new UserIdentity();
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.CertificateAuthorityAdmin));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationSucceedsWithCertificateAuthorityAdminRole()
{
var innerIdentity = new UserIdentity("caadmin", s_passwordBytes);
var roles = new List<Role> { GdsRole.CertificateAuthorityAdmin };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.CertificateAuthorityAdmin));
}
[Test]
public void HasAuthorizationSucceedsWithKeyCredentialAdminRole()
{
var innerIdentity = new UserIdentity("keyadmin", s_passwordBytes);
var roles = new List<Role> { GdsRole.KeyCredentialAdmin };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.KeyCredentialAdmin));
}
[Test]
public void KeyCredentialAuthorizationAllowsSelfAdminOnlyForOwnApplication()
{
var ownAppId = new NodeId(99);
var otherAppId = new NodeId(100);
var identity = new GdsRoleBasedIdentity(
new UserIdentity("appuser", s_passwordBytes),
[GdsRole.ApplicationSelfAdmin],
ownAppId,
m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.KeyCredentialAdminOrSelfAdminOrAppAdmin,
ownAppId));
Assert.That(
() => AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.KeyCredentialAdminOrSelfAdminOrAppAdmin,
otherAppId),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void KeyCredentialAuthorizationAllowsApplicationAdminOnlyForManagedApplication()
{
var managedAppId = new NodeId(11);
var unmanagedAppId = new NodeId(12);
var identity = new GdsRoleBasedIdentity(
new UserIdentity("agent", s_passwordBytes),
[GdsRole.ApplicationAdmin],
NodeId.Null,
[managedAppId],
m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.KeyCredentialAdminOrSelfAdminOrAppAdmin,
managedAppId));
Assert.That(
() => AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.KeyCredentialAdminOrSelfAdminOrAppAdmin,
unmanagedAppId),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthenticatedSecureChannelThrowsForNonSystemContext()
{
var context = new SessionSystemContext(m_telemetry)
{
NamespaceUris = m_namespaceTable
};
Assert.That(
() => AuthorizationHelper.HasAuthenticatedSecureChannel(context),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityModeInsufficient));
}
[Test]
public void HasAuthenticatedSecureChannelThrowsForNullContext()
{
Assert.That(
() => AuthorizationHelper.HasAuthenticatedSecureChannel(null!),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityModeInsufficient));
}
[Test]
public void HasAuthenticatedSecureChannelThrowsForNonSecureChannel()
{
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.None
};
var channelContext = new SecureChannelContext(
"test-channel", endpoint, RequestEncoding.Binary);
var requestHeader = new RequestHeader();
var operationContext = new OperationContext(
requestHeader, channelContext, RequestType.Read, RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthenticatedSecureChannel(context));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadSecurityModeInsufficient));
}
[Test]
public void HasAuthenticatedSecureChannelDoesNotThrowForSign()
{
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.Sign
};
var channelContext = new SecureChannelContext(
"test-channel", endpoint, RequestEncoding.Binary);
var operationContext = new OperationContext(
new RequestHeader(), channelContext, RequestType.Read, RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthenticatedSecureChannel(context));
}
[Test]
public void HasAuthenticatedSecureChannelWithRequireEncryptionThrowsForSign()
{
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.Sign
};
var channelContext = new SecureChannelContext(
"test-channel", endpoint, RequestEncoding.Binary);
var operationContext = new OperationContext(
new RequestHeader(), channelContext, RequestType.Read, RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthenticatedSecureChannel(context, requireEncryption: true));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadSecurityModeInsufficient));
}
[Test]
public void HasAuthenticatedSecureChannelDoesNotThrowForSignAndEncrypt()
{
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.SignAndEncrypt
};
var channelContext = new SecureChannelContext(
"test-channel", endpoint, RequestEncoding.Binary);
var requestHeader = new RequestHeader();
var operationContext = new OperationContext(
requestHeader, channelContext, RequestType.Read, RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthenticatedSecureChannel(context));
}
[Test]
public void GetClientCertificateFingerprintReturnsSha256()
{
byte[] clientCertificate = [1, 2, 3, 4, 5];
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.SignAndEncrypt
};
var channelContext = new SecureChannelContext(
"test-channel",
endpoint,
RequestEncoding.Binary,
clientCertificate);
var operationContext = new OperationContext(
new RequestHeader(),
channelContext,
RequestType.Call,
RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
#if NET6_0_OR_GREATER
byte[] expected = SHA256.HashData(clientCertificate);
#else
byte[] expected;
using (var sha256 = SHA256.Create())
{
expected = sha256.ComputeHash(clientCertificate);
}
#endif
ByteString fingerprint = AuthorizationHelper.GetClientCertificateFingerprint(context);
Assert.That(fingerprint.ToArray(), Is.EqualTo(expected));
}
[Test]
public void GetClientCertificateFingerprintThrowsWhenCertificateIsMissing()
{
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.SignAndEncrypt
};
var channelContext = new SecureChannelContext(
"test-channel",
endpoint,
RequestEncoding.Binary);
var operationContext = new OperationContext(
new RequestHeader(),
channelContext,
RequestType.Call,
RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
Assert.That(
() => AuthorizationHelper.GetClientCertificateFingerprint(context),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityChecksFailed));
}
[Test]
public void GetClientCertificateFingerprintThrowsWhenCertificateIsEmpty()
{
var endpoint = new EndpointDescription
{
SecurityMode = MessageSecurityMode.SignAndEncrypt
};
var channelContext = new SecureChannelContext(
"test-channel",
endpoint,
RequestEncoding.Binary,
[]);
var operationContext = new OperationContext(
new RequestHeader(),
channelContext,
RequestType.Call,
RequestLifetime.None);
var context = new SystemContext(operationContext, m_telemetry)
{
NamespaceUris = m_namespaceTable
};
Assert.That(
() => AuthorizationHelper.GetClientCertificateFingerprint(context),
Throws.TypeOf<ServiceResultException>()
.With.Property(nameof(ServiceResultException.StatusCode))
.EqualTo(StatusCodes.BadSecurityChecksFailed));
}
[Test]
public void StaticRoleListsAreCorrectlyPopulated()
{
Assert.That(AuthorizationHelper.AuthenticatedUser, Has.Count.EqualTo(1));
Assert.That(AuthorizationHelper.AuthenticatedUser[0], Is.EqualTo(Role.AuthenticatedUser));
Assert.That(AuthorizationHelper.DiscoveryAdmin, Has.Count.EqualTo(1));
Assert.That(AuthorizationHelper.DiscoveryAdmin[0], Is.EqualTo(GdsRole.DiscoveryAdmin));
Assert.That(AuthorizationHelper.KeyCredentialAdmin, Has.Count.EqualTo(1));
Assert.That(AuthorizationHelper.KeyCredentialAdmin[0],
Is.EqualTo(GdsRole.KeyCredentialAdmin));
Assert.That(
AuthorizationHelper.KeyCredentialAdminOrSelfAdminOrAppAdmin,
Is.EquivalentTo(
[
GdsRole.KeyCredentialAdmin,
GdsRole.ApplicationSelfAdmin,
GdsRole.ApplicationAdmin
]));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdmin, Has.Count.EqualTo(2));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdmin,
Does.Contain(GdsRole.DiscoveryAdmin));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdmin,
Does.Contain(GdsRole.ApplicationSelfAdmin));
Assert.That(AuthorizationHelper.AuthenticatedUserOrSelfAdmin, Has.Count.EqualTo(2));
Assert.That(AuthorizationHelper.AuthenticatedUserOrSelfAdmin,
Does.Contain(Role.AuthenticatedUser));
Assert.That(AuthorizationHelper.AuthenticatedUserOrSelfAdmin,
Does.Contain(GdsRole.ApplicationSelfAdmin));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdmin, Has.Count.EqualTo(2));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdmin,
Does.Contain(GdsRole.CertificateAuthorityAdmin));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdmin,
Does.Contain(GdsRole.ApplicationSelfAdmin));
Assert.That(AuthorizationHelper.CertificateAuthorityAdmin, Has.Count.EqualTo(1));
Assert.That(AuthorizationHelper.CertificateAuthorityAdmin[0],
Is.EqualTo(GdsRole.CertificateAuthorityAdmin));
}
[Test]
public void HasAuthorizationSucceedsWithAuthenticatedUserRole()
{
var innerIdentity = new UserIdentity("user", s_passwordBytes);
var roles = new List<Role> { Role.AuthenticatedUser };
var identity = new RoleBasedIdentity(innerIdentity, roles, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.AuthenticatedUser));
}
[Test]
public void HasAuthorizationThrowsWhenNonSelfAdminIdentityAccessesSelfAdminOnlyList()
{
var innerIdentity = new UserIdentity("user", s_passwordBytes);
var roles = new List<Role> { Role.Observer };
var identity = new RoleBasedIdentity(innerIdentity, roles, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.CertificateAuthorityAdminOrSelfAdmin,
new NodeId(42)));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationWithCertAuthorityAdminOrSelfAdminSucceedsForCaAdmin()
{
var innerIdentity = new UserIdentity("caadmin", s_passwordBytes);
var roles = new List<Role> { GdsRole.CertificateAuthorityAdmin };
var identity = new GdsRoleBasedIdentity(innerIdentity, roles, m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.CertificateAuthorityAdminOrSelfAdmin,
new NodeId(42)));
}
[Test]
public void HasAuthorizationWithApplicationAdminSucceedsForAdministeredApp()
{
var managedApp1 = new NodeId(11);
var managedApp2 = new NodeId(12);
var innerIdentity = new UserIdentity("agent", s_passwordBytes);
var identity = new GdsRoleBasedIdentity(
innerIdentity,
[GdsRole.ApplicationAdmin],
NodeId.Null,
[managedApp1, managedApp2],
m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrSelfAdminOrAppAdmin,
managedApp2));
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.CertificateAuthorityAdminOrSelfAdminOrAppAdmin,
managedApp1));
}
[Test]
public void HasAuthorizationWithApplicationAdminThrowsForUnmanagedApp()
{
var managedApp = new NodeId(11);
var unmanagedApp = new NodeId(99);
var innerIdentity = new UserIdentity("agent", s_passwordBytes);
var identity = new GdsRoleBasedIdentity(
innerIdentity,
[GdsRole.ApplicationAdmin],
NodeId.Null,
[managedApp],
m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrSelfAdminOrAppAdmin,
unmanagedApp));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void HasAuthorizationWithApplicationAdminSucceedsForRegisterApplication()
{
var managedApp = new NodeId(11);
var innerIdentity = new UserIdentity("agent", s_passwordBytes);
var identity = new GdsRoleBasedIdentity(
innerIdentity,
[GdsRole.ApplicationAdmin],
NodeId.Null,
[managedApp],
m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
// RegisterApplication has no existing applicationId; the
// ApplicationAdmin privilege alone is sufficient.
Assert.DoesNotThrow(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrAppAdmin));
}
[Test]
public void HasAuthorizationWithApplicationAdminThrowsWithEmptyAdministeredList()
{
var innerIdentity = new UserIdentity("agent", s_passwordBytes);
var identity = new GdsRoleBasedIdentity(
innerIdentity,
[GdsRole.ApplicationAdmin],
NodeId.Null,
administeredApplicationIds: null,
m_namespaceTable);
var context = new SessionSystemContext(m_telemetry)
{
UserIdentity = identity,
NamespaceUris = m_namespaceTable
};
// Without any administered apps the privilege is inert.
ServiceResultException ex = Assert.Throws<ServiceResultException>(() =>
AuthorizationHelper.HasAuthorization(
context,
AuthorizationHelper.DiscoveryAdminOrAppAdmin));
Assert.That(ex.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
}
[Test]
public void NewRoleListsAreCorrectlyPopulated()
{
Assert.That(AuthorizationHelper.DiscoveryAdminOrAppAdmin, Has.Count.EqualTo(2));
Assert.That(AuthorizationHelper.DiscoveryAdminOrAppAdmin,
Does.Contain(GdsRole.DiscoveryAdmin));
Assert.That(AuthorizationHelper.DiscoveryAdminOrAppAdmin,
Does.Contain(GdsRole.ApplicationAdmin));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdminOrAppAdmin, Has.Count.EqualTo(3));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdminOrAppAdmin,
Does.Contain(GdsRole.DiscoveryAdmin));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdminOrAppAdmin,
Does.Contain(GdsRole.ApplicationSelfAdmin));
Assert.That(AuthorizationHelper.DiscoveryAdminOrSelfAdminOrAppAdmin,
Does.Contain(GdsRole.ApplicationAdmin));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdminOrAppAdmin,
Has.Count.EqualTo(3));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdminOrAppAdmin,
Does.Contain(GdsRole.CertificateAuthorityAdmin));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdminOrAppAdmin,
Does.Contain(GdsRole.ApplicationSelfAdmin));
Assert.That(AuthorizationHelper.CertificateAuthorityAdminOrSelfAdminOrAppAdmin,
Does.Contain(GdsRole.ApplicationAdmin));
}
}
}