feat(dcl): move the OPC UA client to OPC Foundation SDK 2.0.1 (#125)
OPCFoundation.NetStandard.Opc.Ua.Client and the test-only .Server move 1.5.378.182 -> 2.0.1, the version OtOpcUa master runs (lmxopcua#782; #799 and #801 closed). Transitive Core/Core.Types/Types/Configuration/ Security.Certificates resolve to 2.0.1. API breaks fixed in the DCL adapter: - Built-in types are immutable structs (Variant, DataValue, NodeId, LocalizedText, StatusCode, ArrayOf<T>). New OpcUaValueBoundary restores the SDK 1.5 CLR shapes for every read, subscription and alarm-event value (byte[], UTC DateTime with no-timestamp = MinValue, Guid, detached arrays) and builds write variants with SDK 1.5's new Variant(object) semantics (byte[] = ByteString scalar). - StatusCodes members are no longer constants: switches/patterns over them (verify-outcome mapping, connection-level classification, BadResourceUnavailable) match by value. - CertificateIdentifier no longer caches a certificate and the CertificateValidator/CertificateValidation event is gone: the configuration's CertificateManager owns trust lists and the loaded application certificate and is disposed with the session; auto-accept and the verify probe's capture-and-reject use AcceptError. - new UserIdentity(X509Certificate2) is gone: X509 user identities use X509IdentityTokenHandler with an on-demand PFX provider (still fails fast on a missing file/key). - DefaultSessionFactory takes the telemetry context; collections are ArrayOf<T>; EventFilter select clauses and ContentFilter operands are built immutably. UserName identity (lmxopcua#880): SDK 2's default handler sends a password over 64 bytes - every 65-character OtOpcUa API key - as an RsaEncryptedSecret that SDK 1.5 servers reject with BadIdentityTokenInvalid and SDK 2 servers accept only within a 5-minute clock window (#873). The DCL now always uses LegacyRsaUserNameIdentityTokenHandler (ported from OtOpcUa be28aa44), i.e. exactly what it sent on SDK 1.5, so it logs in to both server generations during a mixed rollout. Tests: the in-process secured test server is ported to SDK 2 and can admit an API key; new tests cover the handler (mutation-checked: 5 of 7 fail with the SDK default handler), the value boundary, and a 65-char key end to end over None/Sign/SignAndEncrypt with a wrong key reaching the key check (BadIdentityTokenRejected). Claude-Session: https://claude.ai/code/session_01GT67ACmpMR7b9LGRPLijMi
This commit is contained in:
@@ -69,20 +69,21 @@
|
|||||||
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
|
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
|
||||||
<PackageVersion Include="Microsoft.Playwright" Version="1.58.0" />
|
<PackageVersion Include="Microsoft.Playwright" Version="1.58.0" />
|
||||||
<PackageVersion Include="Moq" Version="4.20.72" />
|
<PackageVersion Include="Moq" Version="4.20.72" />
|
||||||
<!-- 13.0.4 is the floor OPCFoundation.NetStandard.Opc.Ua.Core 1.5.378.x demands; surfaced when
|
<!-- 13.0.4 was the floor OPCFoundation.NetStandard.Opc.Ua.Core 1.5.378.x demanded, surfaced when
|
||||||
CentralPackageTransitivePinningEnabled was turned on (Gitea #79). Also used by the
|
CentralPackageTransitivePinningEnabled was turned on (Gitea #79); SDK 2 dropped Newtonsoft from Core
|
||||||
Commons.Tests contract-lock tests;
|
(ScadaBridge#125). Still used by the Commons.Tests contract-lock tests that exercise the Akka default
|
||||||
used by Commons.Tests contract-lock tests that exercise the Akka default JSON serializer. -->
|
JSON serializer. -->
|
||||||
<PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
|
<PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
|
||||||
<PackageVersion Include="Novell.Directory.Ldap.NETStandard" Version="3.6.0" />
|
<PackageVersion Include="Novell.Directory.Ldap.NETStandard" Version="3.6.0" />
|
||||||
<PackageVersion Include="NSubstitute" Version="5.3.0" />
|
<PackageVersion Include="NSubstitute" Version="5.3.0" />
|
||||||
<!-- 1.5.378.182 = the last SDK 1.5 build OtOpcUa ran before its 2.0.1 move (ScadaBridge#125). The 2.0.x
|
<!-- 2.0.1 = the SDK OtOpcUa master runs (ScadaBridge#125, after lmxopcua#782/#799/#801 closed). The
|
||||||
move waits for lmxopcua#799 and #801. Since .156, issuer CA certs need the keyCertSign KeyUsage, and
|
transitive Core, Core.Types, Types, Configuration and Security.Certificates packages resolve to 2.0.1
|
||||||
this also applies to server certs the DCL trusts. -->
|
under transitive pinning. Issuer CA certs need the keyCertSign KeyUsage (since 1.5.378.156), and SDK 2
|
||||||
<PackageVersion Include="OPCFoundation.NetStandard.Opc.Ua.Client" Version="1.5.378.182" />
|
never accepts an incomplete chain or an empty subject/issuer DN, even with AutoAcceptUntrustedCerts. -->
|
||||||
|
<PackageVersion Include="OPCFoundation.NetStandard.Opc.Ua.Client" Version="2.0.1" />
|
||||||
<!-- Test-only: in-process secured server for the Gitea #121 Sign/SignAndEncrypt tests.
|
<!-- Test-only: in-process secured server for the Gitea #121 Sign/SignAndEncrypt tests.
|
||||||
Kept in lockstep with the client pin above. -->
|
Kept in lockstep with the client pin above. -->
|
||||||
<PackageVersion Include="OPCFoundation.NetStandard.Opc.Ua.Server" Version="1.5.378.182" />
|
<PackageVersion Include="OPCFoundation.NetStandard.Opc.Ua.Server" Version="2.0.1" />
|
||||||
<PackageVersion Include="OpenTelemetry.Api" Version="1.15.3" />
|
<PackageVersion Include="OpenTelemetry.Api" Version="1.15.3" />
|
||||||
<!-- Parquet audit archival + the parquet format of `audit export` (ScadaBridge#42). 6.1.0 is fully
|
<!-- Parquet audit archival + the parquet format of `audit export` (ScadaBridge#42). 6.1.0 is fully
|
||||||
managed (Snappier / ZstdSharp / K4os LZ4, no native IronCompress) and NuGetAudit-clean. -->
|
managed (Snappier / ZstdSharp / K4os LZ4, no native IronCompress) and NuGetAudit-clean. -->
|
||||||
|
|||||||
@@ -70,7 +70,10 @@ All protocols produce the same value tuple consumed by Instance Actors. Before t
|
|||||||
## Supported Protocols
|
## Supported Protocols
|
||||||
|
|
||||||
### OPC UA
|
### OPC UA
|
||||||
- Uses the **OPC Foundation .NET Standard Library** (`OPCFoundation.NetStandard.Opc.Ua.Client`).
|
- Uses the **OPC Foundation .NET Standard Library** (`OPCFoundation.NetStandard.Opc.Ua.Client`), **SDK 2.0.1** since ScadaBridge#125 (2026-11-12; the same version OtOpcUa runs). The port keeps the SDK 1.5 behaviour at the adapter boundary:
|
||||||
|
- **Values.** SDK 2's `Variant`/`DataValue` are immutable structs and its boxing returns SDK wrapper types; `OpcUaValueBoundary` converts every read, subscription and alarm-event value back to the SDK 1.5 CLR shapes (`byte[]` for ByteString, UTC `DateTime` with "no timestamp" as `DateTime.MinValue`, `Guid`, detached arrays), and builds write variants with SDK 1.5's `new Variant(object)` semantics (a `byte[]` is a ByteString scalar).
|
||||||
|
- **UserName identity.** Always sent in the legacy RSA password format (`LegacyRsaUserNameIdentityTokenHandler`, ported from OtOpcUa lmxopcua#880). SDK 2's own handler sends a password over 64 bytes — every 65-character OtOpcUa API key — as an `RsaEncryptedSecret`, which an SDK 1.5 server rejects with `BadIdentityTokenInvalid` and an SDK 2 server accepts only within a 5-minute clock window (lmxopcua#873). With the legacy format the DCL logs in to both server generations, as it did on SDK 1.5. X509 user identities resolve the PFX's private key on demand (`OpcUaUserIdentities`); a missing file or key still fails before any session is created.
|
||||||
|
- **Certificates.** The configuration's SDK-created `CertificateManager` owns the trust lists and the loaded application certificate, and is disposed with the session. `AutoAcceptUntrustedCerts` and the verify probe's capture-and-reject use the manager's `AcceptError` hook (the 1.5 `CertificateValidation` event is gone). SDK 2 makes two errors non-suppressible even with auto-accept on: an incomplete chain (install the issuing CA in the trusted or issuer store) and a certificate with an empty subject or issuer.
|
||||||
- Session-based connection with endpoint discovery, certificate handling, and configurable security modes. Endpoint discovery is **asynchronous** and bounded by the connection's `OperationTimeoutMs` (the discovery client is built from the connection's own `EndpointConfiguration`) and by the caller's cancellation; a cancelled discovery is never mistaken for "discovery unavailable". The `DataConnectionActor` starts every adapter `ConnectAsync` on the thread pool, so no adapter connect work — whatever runs before its first yielding await — can occupy the actor's dispatcher thread (review 2026-10-21; previously a synchronous discovery against a black-holed endpoint held the thread for the SDK's 120 s default on every reconnect tick).
|
- Session-based connection with endpoint discovery, certificate handling, and configurable security modes. Endpoint discovery is **asynchronous** and bounded by the connection's `OperationTimeoutMs` (the discovery client is built from the connection's own `EndpointConfiguration`) and by the caller's cancellation; a cancelled discovery is never mistaken for "discovery unavailable". The `DataConnectionActor` starts every adapter `ConnectAsync` on the thread pool, so no adapter connect work — whatever runs before its first yielding await — can occupy the actor's dispatcher thread (review 2026-10-21; previously a synchronous discovery against a black-holed endpoint held the thread for the SDK's 120 s default on every reconnect tick).
|
||||||
- Subscriptions via OPC UA Monitored Items with data change notifications (1000ms sampling, queue size 10, discard-oldest).
|
- Subscriptions via OPC UA Monitored Items with data change notifications (1000ms sampling, queue size 10, discard-oldest).
|
||||||
- Read/Write via OPC UA Read/Write services with StatusCode-based quality mapping.
|
- Read/Write via OPC UA Read/Write services with StatusCode-based quality mapping.
|
||||||
|
|||||||
@@ -1953,7 +1953,7 @@ public class DataConnectionActor : UntypedActor, IWithTimers
|
|||||||
or System.Net.Sockets.SocketException
|
or System.Net.Sockets.SocketException
|
||||||
or TimeoutException
|
or TimeoutException
|
||||||
or System.IO.IOException
|
or System.IO.IOException
|
||||||
|| (baseEx is Opc.Ua.ServiceResultException sre && IsConnectionLevelStatus(sre.StatusCode));
|
|| (baseEx is Opc.Ua.ServiceResultException sre && IsConnectionLevelStatus(sre.StatusCode.Code));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -1971,16 +1971,22 @@ public class DataConnectionActor : UntypedActor, IWithTimers
|
|||||||
/// as connection-level would put the connection into a reconnect loop over one bad tag path.
|
/// as connection-level would put the connection into a reconnect loop over one bad tag path.
|
||||||
/// </para>
|
/// </para>
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static bool IsConnectionLevelStatus(uint statusCode) => statusCode is
|
private static bool IsConnectionLevelStatus(uint statusCode) => ConnectionLevelStatusCodes.Contains(statusCode);
|
||||||
Opc.Ua.StatusCodes.BadSessionIdInvalid
|
|
||||||
or Opc.Ua.StatusCodes.BadSessionClosed
|
// SDK 2 (ScadaBridge#125): StatusCodes members are StatusCode structs, not constants, so the
|
||||||
or Opc.Ua.StatusCodes.BadSessionNotActivated
|
// set is built from their numeric codes rather than matched as constant patterns.
|
||||||
or Opc.Ua.StatusCodes.BadSecureChannelClosed
|
private static readonly HashSet<uint> ConnectionLevelStatusCodes =
|
||||||
or Opc.Ua.StatusCodes.BadSecureChannelIdInvalid
|
[
|
||||||
or Opc.Ua.StatusCodes.BadServerNotConnected
|
Opc.Ua.StatusCodes.BadSessionIdInvalid.Code,
|
||||||
or Opc.Ua.StatusCodes.BadConnectionClosed
|
Opc.Ua.StatusCodes.BadSessionClosed.Code,
|
||||||
or Opc.Ua.StatusCodes.BadCommunicationError
|
Opc.Ua.StatusCodes.BadSessionNotActivated.Code,
|
||||||
or Opc.Ua.StatusCodes.BadNotConnected;
|
Opc.Ua.StatusCodes.BadSecureChannelClosed.Code,
|
||||||
|
Opc.Ua.StatusCodes.BadSecureChannelIdInvalid.Code,
|
||||||
|
Opc.Ua.StatusCodes.BadServerNotConnected.Code,
|
||||||
|
Opc.Ua.StatusCodes.BadConnectionClosed.Code,
|
||||||
|
Opc.Ua.StatusCodes.BadCommunicationError.Code,
|
||||||
|
Opc.Ua.StatusCodes.BadNotConnected.Code,
|
||||||
|
];
|
||||||
|
|
||||||
private void HandleUnsubscribe(UnsubscribeTagsRequest request)
|
private void HandleUnsubscribe(UnsubscribeTagsRequest request)
|
||||||
{
|
{
|
||||||
|
|||||||
+144
@@ -0,0 +1,144 @@
|
|||||||
|
using Opc.Ua;
|
||||||
|
using Opc.Ua.Security.Certificates;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// UserName token handler that always encrypts the password in the legacy RSA format under an RSA security
|
||||||
|
/// policy, whatever the password's length (lmxopcua#880, ScadaBridge#125).
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// <para>
|
||||||
|
/// Ported verbatim from OtOpcUa (<c>Driver.OpcUaClient.Session</c>, lmxopcua <c>be28aa44</c>) when ScadaBridge
|
||||||
|
/// moved to SDK 2.0.1. Under SDK 1.5 the DCL always sent the legacy format, so this keeps its wire behaviour
|
||||||
|
/// unchanged in both directions of a mixed rollout: an SDK 1.5 OtOpcUa server still decrypts a 65-character API
|
||||||
|
/// key, and an SDK 2 server's <c>RsaEncryptedSecret</c> signing-time window (lmxopcua#873, 5 minutes) never
|
||||||
|
/// applies to a DCL login.
|
||||||
|
/// </para>
|
||||||
|
/// <para>
|
||||||
|
/// SDK 2.0.1's <see cref="UserNameIdentityTokenHandler"/> encrypts a password longer than 64 bytes (a private
|
||||||
|
/// <c>RsaEncryptedSecretPasswordThreshold</c> constant with no setting) as an <c>RsaEncryptedSecret</c>, with
|
||||||
|
/// <see cref="UserNameIdentityToken.EncryptionAlgorithm"/> left null. A 64-byte or shorter password is sent in
|
||||||
|
/// the legacy format: <c>RSA-OAEP(len ‖ password ‖ serverNonce)</c> under the server certificate, with the
|
||||||
|
/// algorithm URI set. An SDK 1.5.378 server decrypts only the legacy format under an RSA policy. A null
|
||||||
|
/// algorithm reaches its <c>SecurityPolicies.Decrypt</c> as "Unexpected encryption algorithm", so
|
||||||
|
/// <c>BadIdentityTokenInvalid</c> is returned before any credential check. Every production OtOpcUa API key
|
||||||
|
/// is 65 characters long (<c>otua_</c> + 16 hex + <c>_</c> + 43), so an SDK 2 client could not use one
|
||||||
|
/// against an SDK 1.5 server: QA, any rollback target, or an older third-party stack.
|
||||||
|
/// </para>
|
||||||
|
/// <para>
|
||||||
|
/// The legacy format needs no size limit, because the SDK frames the plaintext with a length and spreads it
|
||||||
|
/// over as many RSA blocks as it needs. An SDK 2 server accepts both formats. It uses the legacy decryptor
|
||||||
|
/// whenever the algorithm URI is set. This handler therefore sends what SDK 1.5 clients (ScadaBridge
|
||||||
|
/// included) always send, and what SDK 2 itself sends for every password up to 64 bytes. The crypto is the
|
||||||
|
/// same RSA-OAEP under the server certificate, bound to the server nonce. The only thing lost is
|
||||||
|
/// <c>RsaEncryptedSecret</c>'s block padding of the secret's length. Policy <c>None</c> and the ECC policies
|
||||||
|
/// are handed to the SDK handler unchanged, so this type never sends anything in a weaker form than the SDK
|
||||||
|
/// would.
|
||||||
|
/// </para>
|
||||||
|
/// </remarks>
|
||||||
|
internal sealed class LegacyRsaUserNameIdentityTokenHandler : IUserIdentityTokenHandler
|
||||||
|
{
|
||||||
|
private readonly UserNameIdentityTokenHandler _inner;
|
||||||
|
private readonly ISecurityPolicyRegistry _policies;
|
||||||
|
|
||||||
|
/// <summary>Create the handler for a user name and its plaintext password.</summary>
|
||||||
|
/// <param name="username">The user name.</param>
|
||||||
|
/// <param name="password">The password bytes (UTF-8 for an API key).</param>
|
||||||
|
/// <param name="securityPolicies">The policy registry, or null for <see cref="SecurityPolicies.Default"/>.</param>
|
||||||
|
public LegacyRsaUserNameIdentityTokenHandler(string username, ReadOnlySpan<byte> password,
|
||||||
|
ISecurityPolicyRegistry? securityPolicies = null)
|
||||||
|
: this(new UserNameIdentityTokenHandler(username, password, securityPolicies),
|
||||||
|
securityPolicies ?? SecurityPolicies.Default)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
private LegacyRsaUserNameIdentityTokenHandler(UserNameIdentityTokenHandler inner, ISecurityPolicyRegistry policies)
|
||||||
|
{
|
||||||
|
_inner = inner;
|
||||||
|
_policies = policies;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>The user name in the token.</summary>
|
||||||
|
public string UserName => _inner.UserName;
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public UserIdentityToken Token => _inner.Token;
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public string DisplayName => _inner.DisplayName;
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public UserTokenType TokenType => _inner.TokenType;
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public void UpdatePolicy(UserTokenPolicy userTokenPolicy) => _inner.UpdatePolicy(userTokenPolicy);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public ValueTask EncryptAsync(Certificate receiverCertificate, byte[] receiverNonce, string securityPolicyUri,
|
||||||
|
IServiceMessageContext context, Nonce? receiverEphemeralKey = null, Certificate? senderCertificate = null,
|
||||||
|
CertificateCollection? senderIssuerCertificates = null, bool doNotEncodeSenderCertificate = false,
|
||||||
|
CancellationToken ct = default)
|
||||||
|
{
|
||||||
|
var password = _inner.DecryptedPassword;
|
||||||
|
var policy = password is null || string.IsNullOrEmpty(securityPolicyUri)
|
||||||
|
? null
|
||||||
|
: _policies.GetInfo(securityPolicyUri);
|
||||||
|
|
||||||
|
// Only an RSA policy (no ephemeral key) with a receiver certificate is ours. None, ECC, an unknown policy
|
||||||
|
// and a missing certificate get the SDK's own handling, and its own errors.
|
||||||
|
if (policy is null || policy.Uri == SecurityPolicies.None
|
||||||
|
|| policy.EphemeralKeyAlgorithm != CertificateKeyAlgorithm.None || receiverCertificate is null)
|
||||||
|
{
|
||||||
|
return _inner.EncryptAsync(receiverCertificate!, receiverNonce, securityPolicyUri, context,
|
||||||
|
receiverEphemeralKey, senderCertificate, senderIssuerCertificates, doNotEncodeSenderCertificate, ct);
|
||||||
|
}
|
||||||
|
|
||||||
|
ct.ThrowIfCancellationRequested();
|
||||||
|
var token = (UserNameIdentityToken)_inner.Token;
|
||||||
|
var plaintext = Utils.Append(password, receiverNonce);
|
||||||
|
try
|
||||||
|
{
|
||||||
|
var encrypted = _policies.Encrypt(receiverCertificate, policy.Uri, plaintext);
|
||||||
|
token.Password = encrypted.Data.ToByteString();
|
||||||
|
token.EncryptionAlgorithm = encrypted.Algorithm;
|
||||||
|
}
|
||||||
|
finally
|
||||||
|
{
|
||||||
|
Array.Clear(plaintext);
|
||||||
|
}
|
||||||
|
|
||||||
|
return ValueTask.CompletedTask;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public ValueTask DecryptAsync(Certificate certificate, Nonce receiverNonce, string securityPolicyUri,
|
||||||
|
IServiceMessageContext context, Nonce? ephemeralKey = null, Certificate? senderCertificate = null,
|
||||||
|
CertificateCollection? senderIssuerCertificates = null, ICertificateValidatorEx? validator = null,
|
||||||
|
CancellationToken ct = default) =>
|
||||||
|
_inner.DecryptAsync(certificate, receiverNonce, securityPolicyUri, context, ephemeralKey, senderCertificate,
|
||||||
|
senderIssuerCertificates, validator, ct);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public ValueTask<SignatureData> SignAsync(byte[] dataToSign, string securityPolicyUri, CancellationToken ct = default) =>
|
||||||
|
_inner.SignAsync(dataToSign, securityPolicyUri, ct);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public ValueTask<bool> VerifyAsync(byte[] dataToVerify, SignatureData signatureData, string securityPolicyUri,
|
||||||
|
CancellationToken ct = default) =>
|
||||||
|
_inner.VerifyAsync(dataToVerify, signatureData, securityPolicyUri, ct);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
/// <remarks>The SDK session encrypts a <c>Copy()</c> of the handler, so the clone must keep this type.</remarks>
|
||||||
|
public object Clone() => new LegacyRsaUserNameIdentityTokenHandler((UserNameIdentityTokenHandler)_inner.Clone(), _policies);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public bool Equals(IUserIdentityTokenHandler? other) =>
|
||||||
|
other is LegacyRsaUserNameIdentityTokenHandler legacy ? _inner.Equals(legacy._inner) : _inner.Equals(other);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public override bool Equals(object? obj) => obj is IUserIdentityTokenHandler other && Equals(other);
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public override int GetHashCode() => StringComparer.Ordinal.GetHashCode(UserName ?? string.Empty);
|
||||||
|
}
|
||||||
+35
-19
@@ -43,7 +43,7 @@ public static class OpcUaApplicationIdentity
|
|||||||
|
|
||||||
// SDK telemetry for the non-obsolete ApplicationInstance ctor. SDK-internal logging is
|
// SDK telemetry for the non-obsolete ApplicationInstance ctor. SDK-internal logging is
|
||||||
// discarded; this class logs the outcome that matters (created vs reused) itself.
|
// discarded; this class logs the outcome that matters (created vs reused) itself.
|
||||||
private static readonly Lazy<ITelemetryContext> SdkTelemetry = new(() => DefaultTelemetry.Create(_ => { }));
|
internal static readonly Lazy<ITelemetryContext> SdkTelemetry = new(() => DefaultTelemetry.Create(_ => { }));
|
||||||
|
|
||||||
// One gate per own-store directory: two connections starting together against an empty
|
// One gate per own-store directory: two connections starting together against an empty
|
||||||
// store would otherwise BOTH generate a certificate, leaving two identities for one subject.
|
// store would otherwise BOTH generate a certificate, leaving two identities for one subject.
|
||||||
@@ -112,7 +112,10 @@ public static class OpcUaApplicationIdentity
|
|||||||
OpcUaGlobalOptions options, bool secured, bool autoAcceptUntrusted,
|
OpcUaGlobalOptions options, bool secured, bool autoAcceptUntrusted,
|
||||||
int sessionTimeoutMs, int operationTimeoutMs, ILogger logger, CancellationToken ct)
|
int sessionTimeoutMs, int operationTimeoutMs, ILogger logger, CancellationToken ct)
|
||||||
{
|
{
|
||||||
var appConfig = new ApplicationConfiguration
|
// SDK 2 (ScadaBridge#125): the configuration carries the telemetry context, and ValidateAsync
|
||||||
|
// creates the CertificateManager that owns the trust lists, the validator and (for a secured
|
||||||
|
// configuration) the loaded application certificate.
|
||||||
|
var appConfig = new ApplicationConfiguration(SdkTelemetry.Value)
|
||||||
{
|
{
|
||||||
ApplicationName = ResolveApplicationName(options),
|
ApplicationName = ResolveApplicationName(options),
|
||||||
ApplicationUri = ResolveApplicationUri(options),
|
ApplicationUri = ResolveApplicationUri(options),
|
||||||
@@ -158,9 +161,9 @@ public static class OpcUaApplicationIdentity
|
|||||||
operationTimeoutMs: 15_000, logger, ct).ConfigureAwait(false);
|
operationTimeoutMs: 15_000, logger, ct).ConfigureAwait(false);
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
var cert = appConfig.SecurityConfiguration.ApplicationCertificate.Certificate
|
using var entry = AcquireApplicationCertificate(appConfig)
|
||||||
?? throw new InvalidOperationException("OPC UA application certificate was not loaded.");
|
?? throw new InvalidOperationException("OPC UA application certificate was not loaded.");
|
||||||
return X509CertificateLoader.LoadCertificate(cert.RawData);
|
return X509CertificateLoader.LoadCertificate(entry.Certificate.RawData);
|
||||||
}
|
}
|
||||||
finally
|
finally
|
||||||
{
|
{
|
||||||
@@ -169,25 +172,34 @@ public static class OpcUaApplicationIdentity
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Disposes the private-key-bearing application certificate a configuration loaded. Call
|
/// Disposes the certificate manager a configuration created, which releases the
|
||||||
/// only once every session built from <paramref name="appConfig"/> is closed and disposed.
|
/// private-key-bearing application certificate it loaded. Call only once every session built
|
||||||
|
/// from <paramref name="appConfig"/> is closed and disposed.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// SDK 2 (ScadaBridge#125): <see cref="CertificateIdentifier"/> no longer caches a certificate.
|
||||||
|
/// The loaded identity and the trust-list stores belong to the configuration's
|
||||||
|
/// <see cref="ApplicationConfiguration.CertificateManager"/>, which <c>ValidateAsync</c> creates
|
||||||
|
/// and <see cref="ApplicationInstance"/> reuses, so disposing that manager releases everything.
|
||||||
|
/// </remarks>
|
||||||
/// <param name="appConfig">A configuration from <see cref="BuildClientConfigurationAsync"/>; null is a no-op.</param>
|
/// <param name="appConfig">A configuration from <see cref="BuildClientConfigurationAsync"/>; null is a no-op.</param>
|
||||||
internal static void ReleaseApplicationCertificate(ApplicationConfiguration? appConfig)
|
internal static void ReleaseApplicationCertificate(ApplicationConfiguration? appConfig)
|
||||||
{
|
{
|
||||||
var certificates = appConfig?.SecurityConfiguration?.ApplicationCertificates;
|
if (appConfig?.CertificateManager is not { } manager)
|
||||||
if (certificates is null)
|
|
||||||
return;
|
return;
|
||||||
foreach (var id in certificates)
|
appConfig.CertificateManager = null!;
|
||||||
{
|
(manager as IDisposable)?.Dispose();
|
||||||
var cert = id?.Certificate;
|
|
||||||
if (cert is null)
|
|
||||||
continue;
|
|
||||||
id!.Certificate = null;
|
|
||||||
cert.Dispose();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The configuration's RSA application certificate entry, or null when none is loaded. The
|
||||||
|
/// caller disposes the entry.
|
||||||
|
/// </summary>
|
||||||
|
private static Opc.Ua.Security.Certificates.CertificateEntry? AcquireApplicationCertificate(
|
||||||
|
ApplicationConfiguration appConfig) =>
|
||||||
|
appConfig.CertificateManager?.AcquireApplicationCertificateByType(
|
||||||
|
ObjectTypeIds.RsaSha256ApplicationCertificateType);
|
||||||
|
|
||||||
private static CertificateIdentifier NewOwnIdentifier(OpcUaGlobalOptions options) => new()
|
private static CertificateIdentifier NewOwnIdentifier(OpcUaGlobalOptions options) => new()
|
||||||
{
|
{
|
||||||
StoreType = CertificateStoreType.Directory,
|
StoreType = CertificateStoreType.Directory,
|
||||||
@@ -199,8 +211,11 @@ public static class OpcUaApplicationIdentity
|
|||||||
private static async Task EnsureLoadedAsync(
|
private static async Task EnsureLoadedAsync(
|
||||||
ApplicationConfiguration appConfig, OpcUaGlobalOptions options, ILogger logger, CancellationToken ct)
|
ApplicationConfiguration appConfig, OpcUaGlobalOptions options, ILogger logger, CancellationToken ct)
|
||||||
{
|
{
|
||||||
var id = appConfig.SecurityConfiguration.ApplicationCertificate;
|
var id = appConfig.SecurityConfiguration.ApplicationCertificate
|
||||||
var gate = ProvisionGates.GetOrAdd(Path.GetFullPath(id.StorePath), _ => new SemaphoreSlim(1, 1));
|
?? throw new InvalidOperationException("OPC UA application certificate identifier is not configured.");
|
||||||
|
var storePath = id.StorePath
|
||||||
|
?? throw new InvalidOperationException("OPC UA application certificate store path is not configured.");
|
||||||
|
var gate = ProvisionGates.GetOrAdd(Path.GetFullPath(storePath), _ => new SemaphoreSlim(1, 1));
|
||||||
await gate.WaitAsync(ct).ConfigureAwait(false);
|
await gate.WaitAsync(ct).ConfigureAwait(false);
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
@@ -226,7 +241,8 @@ public static class OpcUaApplicationIdentity
|
|||||||
$"ApplicationUri '{appConfig.ApplicationUri}': {ex.Message}", ex);
|
$"ApplicationUri '{appConfig.ApplicationUri}': {ex.Message}", ex);
|
||||||
}
|
}
|
||||||
|
|
||||||
var cert = id.Certificate;
|
using var entry = ok ? AcquireApplicationCertificate(appConfig) : null;
|
||||||
|
var cert = entry?.Certificate;
|
||||||
if (!ok || cert is null || !cert.HasPrivateKey)
|
if (!ok || cert is null || !cert.HasPrivateKey)
|
||||||
throw new InvalidOperationException(
|
throw new InvalidOperationException(
|
||||||
$"OPC UA application certificate '{id.SubjectName}' could not be loaded with its private key from '{id.StorePath}'.");
|
$"OPC UA application certificate '{id.SubjectName}' could not be loaded with its private key from '{id.StorePath}'.");
|
||||||
|
|||||||
@@ -482,7 +482,7 @@ public class OpcUaDataConnection
|
|||||||
/// connection fault, so it must not reach <c>RaiseDisconnected</c> or the connection-level
|
/// connection fault, so it must not reach <c>RaiseDisconnected</c> or the connection-level
|
||||||
/// status set the DataConnectionActor reconnects on.
|
/// status set the DataConnectionActor reconnects on.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
internal const uint BadResourceUnavailableCode = Opc.Ua.StatusCodes.BadResourceUnavailable;
|
internal static readonly uint BadResourceUnavailableCode = Opc.Ua.StatusCodes.BadResourceUnavailable.Code;
|
||||||
|
|
||||||
/// <summary>True when <paramref name="statusCode"/>'s code part is BadResourceUnavailable
|
/// <summary>True when <paramref name="statusCode"/>'s code part is BadResourceUnavailable
|
||||||
/// (the low 16 bits are info bits and do not change the meaning).</summary>
|
/// (the low 16 bits are info bits and do not change the meaning).</summary>
|
||||||
@@ -494,7 +494,7 @@ public class OpcUaDataConnection
|
|||||||
/// transient source-side condition from a configuration or security error.</summary>
|
/// transient source-side condition from a configuration or security error.</summary>
|
||||||
internal static string DescribeBadRead(uint statusCode)
|
internal static string DescribeBadRead(uint statusCode)
|
||||||
{
|
{
|
||||||
var name = Opc.Ua.StatusCodes.LookupSymbolicId(statusCode & 0xFFFF0000u);
|
var name = new Opc.Ua.StatusCode(statusCode & 0xFFFF0000u).SymbolicId;
|
||||||
var text = string.IsNullOrEmpty(name)
|
var text = string.IsNullOrEmpty(name)
|
||||||
? $"OPC UA read returned bad status: 0x{statusCode:X8}"
|
? $"OPC UA read returned bad status: 0x{statusCode:X8}"
|
||||||
: $"OPC UA read returned bad status: 0x{statusCode:X8} {name}";
|
: $"OPC UA read returned bad status: 0x{statusCode:X8} {name}";
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ public static class OpcUaNodeReference
|
|||||||
|
|
||||||
// Maps nsu= -> the live index; leaves an ns= reference's index untouched.
|
// Maps nsu= -> the live index; leaves an ns= reference's index untouched.
|
||||||
var nodeId = ExpandedNodeId.ToNodeId(expanded, namespaceUris);
|
var nodeId = ExpandedNodeId.ToNodeId(expanded, namespaceUris);
|
||||||
if (NodeId.IsNull(nodeId))
|
if (nodeId.IsNull)
|
||||||
{
|
{
|
||||||
throw new ArgumentException(
|
throw new ArgumentException(
|
||||||
$"'{reference}' names namespace URI '{expanded.NamespaceUri}', which this server " +
|
$"'{reference}' names namespace URI '{expanded.NamespaceUri}', which this server " +
|
||||||
@@ -95,14 +95,13 @@ public static class OpcUaNodeReference
|
|||||||
/// </returns>
|
/// </returns>
|
||||||
public static string ToDurable(ExpandedNodeId nodeId, NamespaceTable namespaceUris)
|
public static string ToDurable(ExpandedNodeId nodeId, NamespaceTable namespaceUris)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(nodeId);
|
|
||||||
ArgumentNullException.ThrowIfNull(namespaceUris);
|
ArgumentNullException.ThrowIfNull(namespaceUris);
|
||||||
|
|
||||||
// A browse can hand back a reference carrying a NamespaceUri or a server index
|
// A browse can hand back a reference carrying a NamespaceUri or a server index
|
||||||
// rather than a plain index. Resolving to session-local first collapses those
|
// rather than a plain index. Resolving to session-local first collapses those
|
||||||
// shapes; without it the raw ToString() can emit a string Resolve cannot re-read.
|
// shapes; without it the raw ToString() can emit a string Resolve cannot re-read.
|
||||||
var local = ExpandedNodeId.ToNodeId(nodeId, namespaceUris);
|
var local = ExpandedNodeId.ToNodeId(nodeId, namespaceUris);
|
||||||
if (NodeId.IsNull(local))
|
if (local.IsNull)
|
||||||
return nodeId.ToString() ?? string.Empty;
|
return nodeId.ToString() ?? string.Empty;
|
||||||
|
|
||||||
// ns=0 is spec-fixed, so its short form is already durable.
|
// ns=0 is spec-fixed, so its short form is already durable.
|
||||||
|
|||||||
@@ -0,0 +1,117 @@
|
|||||||
|
using System.Security.Cryptography.X509Certificates;
|
||||||
|
using Opc.Ua;
|
||||||
|
using Opc.Ua.Security.Certificates;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Builds the OPC UA user identity a DCL session (and the verify probe) presents (ScadaBridge#125).
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// <para>
|
||||||
|
/// <b>UserName.</b> Always the <see cref="LegacyRsaUserNameIdentityTokenHandler"/>: SDK 2's default
|
||||||
|
/// handler sends a password over 64 bytes, such as a 65-character OtOpcUa API key, as an
|
||||||
|
/// <c>RsaEncryptedSecret</c> that an SDK 1.5 server rejects with <c>BadIdentityTokenInvalid</c>
|
||||||
|
/// (lmxopcua#880). The legacy handler sends what the DCL sent under SDK 1.5, which both server
|
||||||
|
/// generations decrypt.
|
||||||
|
/// </para>
|
||||||
|
/// <para>
|
||||||
|
/// <b>X509Certificate.</b> SDK 2 removed <c>new UserIdentity(X509Certificate2)</c>; the identity is
|
||||||
|
/// now a <see cref="X509IdentityTokenHandler"/> that resolves its private key on demand through an
|
||||||
|
/// <see cref="ICertificateProvider"/>. The PFX is read once here, so a missing file, a bad password or
|
||||||
|
/// a certificate without a private key still fails the connect before any session is created, as it
|
||||||
|
/// did under SDK 1.5. The provider re-reads the same file whenever the SDK asks for the key.
|
||||||
|
/// </para>
|
||||||
|
/// </remarks>
|
||||||
|
internal static class OpcUaUserIdentities
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The identity for <paramref name="options"/>, or null for anonymous (no options, or a token
|
||||||
|
/// type this client does not implement).
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="options">The configured user identity.</param>
|
||||||
|
/// <returns>The identity, or null.</returns>
|
||||||
|
internal static UserIdentity? Build(OpcUaUserIdentityOptions? options)
|
||||||
|
{
|
||||||
|
if (options is null) return null;
|
||||||
|
return options.TokenType.ToUpperInvariant() switch
|
||||||
|
{
|
||||||
|
"USERNAMEPASSWORD" => UserName(options.Username ?? string.Empty, options.Password ?? string.Empty),
|
||||||
|
"X509CERTIFICATE" => FromCertificateFile(options.CertificatePath, options.CertificatePassword),
|
||||||
|
_ => null
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>A UserName identity that always uses the legacy RSA password format.</summary>
|
||||||
|
/// <param name="username">The user name.</param>
|
||||||
|
/// <param name="password">The plaintext password, sent UTF-8 encoded.</param>
|
||||||
|
/// <returns>The identity.</returns>
|
||||||
|
internal static UserIdentity UserName(string username, string password)
|
||||||
|
{
|
||||||
|
var bytes = System.Text.Encoding.UTF8.GetBytes(password);
|
||||||
|
try
|
||||||
|
{
|
||||||
|
return new UserIdentity(new LegacyRsaUserNameIdentityTokenHandler(username, bytes));
|
||||||
|
}
|
||||||
|
finally
|
||||||
|
{
|
||||||
|
Array.Clear(bytes);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>An X509 identity backed by a PFX file.</summary>
|
||||||
|
/// <param name="path">The PFX path.</param>
|
||||||
|
/// <param name="password">The PFX password, or null.</param>
|
||||||
|
/// <returns>The identity.</returns>
|
||||||
|
internal static UserIdentity FromCertificateFile(string? path, string? password)
|
||||||
|
{
|
||||||
|
using var certificate = Load(path, password);
|
||||||
|
var identifier = new CertificateIdentifier { Thumbprint = certificate.Thumbprint };
|
||||||
|
return new UserIdentity(new X509IdentityTokenHandler(
|
||||||
|
identifier, new CertificatePasswordProvider(),
|
||||||
|
new PfxFileCertificateProvider(path!, password, certificate.Thumbprint)));
|
||||||
|
}
|
||||||
|
|
||||||
|
private static X509Certificate2 Load(string? path, string? password)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrWhiteSpace(path))
|
||||||
|
throw new InvalidOperationException(
|
||||||
|
"An X509Certificate OPC UA user identity requires a certificate path.");
|
||||||
|
var certificate = X509CertificateLoader.LoadPkcs12FromFile(path, password);
|
||||||
|
if (!certificate.HasPrivateKey)
|
||||||
|
{
|
||||||
|
certificate.Dispose();
|
||||||
|
throw new InvalidOperationException(
|
||||||
|
$"The OPC UA user certificate at '{path}' has no private key; the key is required to sign the " +
|
||||||
|
"user-token challenge when the session activates.");
|
||||||
|
}
|
||||||
|
return certificate;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Resolves the user certificate's private key from its PFX file. The thumbprint read when the
|
||||||
|
/// identity was built is pinned: a file replaced underneath a live identity fails the activation
|
||||||
|
/// rather than presenting a different certificate.
|
||||||
|
/// </summary>
|
||||||
|
private sealed class PfxFileCertificateProvider(string path, string? password, string thumbprint)
|
||||||
|
: ICertificateProvider
|
||||||
|
{
|
||||||
|
public Certificate? TryGetPrivateKeyCertificate(string requestedThumbprint) => null;
|
||||||
|
|
||||||
|
public ValueTask<Certificate?> GetPrivateKeyCertificateAsync(CertificateIdentifier identifier,
|
||||||
|
ICertificatePasswordProvider? passwordProvider = null, string? applicationUri = null,
|
||||||
|
CancellationToken ct = default)
|
||||||
|
{
|
||||||
|
ct.ThrowIfCancellationRequested();
|
||||||
|
var certificate = Load(path, password);
|
||||||
|
if (!string.Equals(certificate.Thumbprint, thumbprint, StringComparison.OrdinalIgnoreCase)
|
||||||
|
|| !string.Equals(identifier.Thumbprint, thumbprint, StringComparison.OrdinalIgnoreCase))
|
||||||
|
{
|
||||||
|
certificate.Dispose();
|
||||||
|
throw new ServiceResultException(StatusCodes.BadIdentityTokenInvalid,
|
||||||
|
"The OPC UA user certificate file changed; reconnect to present the new certificate.");
|
||||||
|
}
|
||||||
|
return ValueTask.FromResult<Certificate?>(Certificate.From(certificate));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
using Opc.Ua;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Converts between OPC UA SDK 2 values and the CLR payloads the rest of ScadaBridge consumes
|
||||||
|
/// (ScadaBridge#125).
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// <para>
|
||||||
|
/// SDK 2 made <see cref="Variant"/>, <see cref="DataValue"/>, <see cref="NodeId"/> and the
|
||||||
|
/// other built-in types immutable structs, and its legacy boxing still hands back a few SDK
|
||||||
|
/// wrapper types (<see cref="ByteString"/>, <see cref="DateTimeUtc"/>, <see cref="Uuid"/>)
|
||||||
|
/// where SDK 1.5 handed back CLR ones. Everything downstream of the DCL (the codec, scripts,
|
||||||
|
/// the alarm mapper) was written against the 1.5 shapes, so this boundary restores them:
|
||||||
|
/// <c>byte[]</c>, <see cref="DateTime"/> (UTC) and <see cref="Guid"/>, and copies arrays so a
|
||||||
|
/// retained value never aliases an SDK buffer.
|
||||||
|
/// </para>
|
||||||
|
/// <para>
|
||||||
|
/// The same mapping OtOpcUa uses at its SDK 2 driver boundary (<c>UpstreamValueMapping</c>),
|
||||||
|
/// except that a matrix is passed through as the SDK boxes it rather than refused: SDK 1.5
|
||||||
|
/// passed one through too, and a value-change callback has no way to report a refusal.
|
||||||
|
/// </para>
|
||||||
|
/// </remarks>
|
||||||
|
internal static class OpcUaValueBoundary
|
||||||
|
{
|
||||||
|
/// <summary>The CLR payload of <paramref name="value"/>, in its SDK 1.5 shape.</summary>
|
||||||
|
/// <param name="value">The SDK value.</param>
|
||||||
|
/// <returns>The detached CLR payload; null for a null variant.</returns>
|
||||||
|
internal static object? ToClr(Variant value)
|
||||||
|
{
|
||||||
|
var boxed = value.AsBoxedObject(Variant.BoxingBehavior.Legacy);
|
||||||
|
return value.TypeInfo.IsMatrix ? boxed : Detach(boxed);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static object? Detach(object? value) => value switch
|
||||||
|
{
|
||||||
|
ByteString bytes => bytes.IsNull ? null : bytes.ToArray(),
|
||||||
|
DateTimeUtc time => ToClrTimestamp(time),
|
||||||
|
Uuid uuid => (Guid)uuid,
|
||||||
|
ByteString[] bytes => bytes.Select(b => b.IsNull ? null : b.ToArray()).ToArray(),
|
||||||
|
DateTimeUtc[] times => times.Select(ToClrTimestamp).ToArray(),
|
||||||
|
Uuid[] uuids => uuids.Select(u => (Guid)u).ToArray(),
|
||||||
|
Variant[] variants => variants.Select(ToClr).ToArray(),
|
||||||
|
object?[] objects when objects.GetType() == typeof(object[]) => objects.Select(Detach).ToArray(),
|
||||||
|
Array array => array.Clone(),
|
||||||
|
_ => value,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// A UTC <see cref="DateTime"/> for an SDK timestamp. The OPC UA "no timestamp" value maps to
|
||||||
|
/// <see cref="DateTime.MinValue"/>, which is what SDK 1.5 decoded it to.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="value">The SDK timestamp.</param>
|
||||||
|
/// <returns>The CLR timestamp.</returns>
|
||||||
|
internal static DateTime ToClrTimestamp(DateTimeUtc value) =>
|
||||||
|
value == DateTimeUtc.MinValue ? DateTime.MinValue : value.ToDateTime();
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The SDK value to write for a CLR payload, with SDK 1.5's <c>new Variant(object)</c>
|
||||||
|
/// semantics: a <c>byte[]</c> is a ByteString scalar, other supported scalars and
|
||||||
|
/// one-dimensional arrays map to their built-in type, and caller buffers are copied.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="value">The CLR payload (null writes a null variant).</param>
|
||||||
|
/// <returns>The variant.</returns>
|
||||||
|
/// <exception cref="ArgumentException">The payload has no OPC UA built-in representation.</exception>
|
||||||
|
internal static Variant ToVariant(object? value)
|
||||||
|
{
|
||||||
|
switch (value)
|
||||||
|
{
|
||||||
|
case null:
|
||||||
|
return Variant.Null;
|
||||||
|
case byte[] bytes:
|
||||||
|
return Variant.From(ByteString.From(bytes.AsSpan()));
|
||||||
|
case Array { Rank: > 1 }:
|
||||||
|
throw new ArgumentException("Multi-dimensional write values are not supported.", nameof(value));
|
||||||
|
case Array array:
|
||||||
|
value = array.Clone();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!VariantHelper.TryCastFrom(value, out Variant variant))
|
||||||
|
throw new ArgumentException(
|
||||||
|
$"A {value.GetType().Name} value has no OPC UA built-in type to write it as.", nameof(value));
|
||||||
|
return variant;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -116,13 +116,14 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
/// the SDK's default 120 s operation timeout, and could not be cancelled by a verify probe's
|
/// the SDK's default 120 s operation timeout, and could not be cancelled by a verify probe's
|
||||||
/// budget.
|
/// budget.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static async Task<EndpointDescriptionCollection> DiscoverEndpointsAsync(
|
private static async Task<IReadOnlyList<EndpointDescription>> DiscoverEndpointsAsync(
|
||||||
ApplicationConfiguration appConfig, string endpointUrl, CancellationToken ct)
|
ApplicationConfiguration appConfig, string endpointUrl, CancellationToken ct)
|
||||||
{
|
{
|
||||||
var discoveryConfig = EndpointConfiguration.Create(appConfig);
|
var discoveryConfig = EndpointConfiguration.Create(appConfig);
|
||||||
using var discoveryClient = await DiscoveryClient.CreateAsync(
|
using var discoveryClient = await DiscoveryClient.CreateAsync(
|
||||||
appConfig, new Uri(endpointUrl), discoveryConfig, DiagnosticsMasks.None, ct).ConfigureAwait(false);
|
appConfig, new Uri(endpointUrl), discoveryConfig, DiagnosticsMasks.None, ct).ConfigureAwait(false);
|
||||||
return await discoveryClient.GetEndpointsAsync(null, ct).ConfigureAwait(false);
|
var endpoints = await discoveryClient.GetEndpointsAsync(default, ct).ConfigureAwait(false);
|
||||||
|
return endpoints.IsNull ? [] : endpoints.ToList();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Raised when the OPC UA connection is lost.</summary>
|
/// <summary>Raised when the OPC UA connection is lost.</summary>
|
||||||
@@ -138,9 +139,9 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
/// </param>
|
/// </param>
|
||||||
/// <returns>The endpoint matching the requested security mode.</returns>
|
/// <returns>The endpoint matching the requested security mode.</returns>
|
||||||
internal static async Task<EndpointDescription> DiscoverEndpointAsync(string url, MessageSecurityMode requested,
|
internal static async Task<EndpointDescription> DiscoverEndpointAsync(string url, MessageSecurityMode requested,
|
||||||
Func<CancellationToken, Task<EndpointDescriptionCollection>> discover, CancellationToken ct = default)
|
Func<CancellationToken, Task<IReadOnlyList<EndpointDescription>>> discover, CancellationToken ct = default)
|
||||||
{
|
{
|
||||||
EndpointDescriptionCollection endpoints;
|
IReadOnlyList<EndpointDescription> endpoints;
|
||||||
try { endpoints = await discover(ct).ConfigureAwait(false); }
|
try { endpoints = await discover(ct).ConfigureAwait(false); }
|
||||||
catch (OperationCanceledException) when (ct.IsCancellationRequested) { throw; }
|
catch (OperationCanceledException) when (ct.IsCancellationRequested) { throw; }
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
@@ -184,7 +185,10 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
"OPC UA connection to {Endpoint} has AutoAcceptUntrustedCerts enabled — every " +
|
"OPC UA connection to {Endpoint} has AutoAcceptUntrustedCerts enabled — every " +
|
||||||
"server certificate is accepted unconditionally. This defeats Sign / " +
|
"server certificate is accepted unconditionally. This defeats Sign / " +
|
||||||
"SignAndEncrypt protection against a man-in-the-middle.", endpointUrl);
|
"SignAndEncrypt protection against a man-in-the-middle.", endpointUrl);
|
||||||
appConfig.CertificateValidator.CertificateValidation += (_, e) => e.Accept = true;
|
// SDK 2 replaced the CertificateValidation event with a per-error AcceptError hook on the
|
||||||
|
// configuration's certificate manager (ScadaBridge#125). Errors the SDK classes as
|
||||||
|
// non-suppressible (an incomplete chain, an empty distinguished name) never reach it.
|
||||||
|
appConfig.CertificateManager.AcceptError = (_, _) => true;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Discover endpoints from the server, pick the preferred security mode
|
// Discover endpoints from the server, pick the preferred security mode
|
||||||
@@ -199,16 +203,14 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
var endpointConfig = EndpointConfiguration.Create(appConfig);
|
var endpointConfig = EndpointConfiguration.Create(appConfig);
|
||||||
var configuredEndpoint = new ConfiguredEndpoint(null, endpoint, endpointConfig);
|
var configuredEndpoint = new ConfiguredEndpoint(null, endpoint, endpointConfig);
|
||||||
|
|
||||||
#pragma warning disable CS0618 // Allow obsolete DefaultSessionFactory constructor for compatibility
|
var sessionFactory = new DefaultSessionFactory(OpcUaApplicationIdentity.SdkTelemetry.Value);
|
||||||
var sessionFactory = new DefaultSessionFactory();
|
|
||||||
#pragma warning restore CS0618
|
|
||||||
var userIdentity = BuildUserIdentity(opts.UserIdentity);
|
var userIdentity = BuildUserIdentity(opts.UserIdentity);
|
||||||
_writeDataTypes.Clear();
|
_writeDataTypes.Clear();
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
_session = await sessionFactory.CreateAsync(
|
_session = await sessionFactory.CreateAsync(
|
||||||
appConfig, configuredEndpoint, false,
|
appConfig, configuredEndpoint, false,
|
||||||
"ScadaBridge-DCL-Session", (uint)opts.SessionTimeoutMs, userIdentity, null, cancellationToken);
|
"ScadaBridge-DCL-Session", (uint)opts.SessionTimeoutMs, userIdentity, default, cancellationToken);
|
||||||
}
|
}
|
||||||
catch
|
catch
|
||||||
{
|
{
|
||||||
@@ -379,19 +381,22 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// Capture the untrusted server cert, then REJECT it (e.Accept = false). The
|
// Capture the untrusted server cert, then REJECT it (e.Accept = false). The
|
||||||
// validator runs on the SDK's connect thread; copying the cert is the only state we
|
// validator runs on the SDK's connect thread; copying the cert is the only state we
|
||||||
// keep. Never accept — this probe must not trust anything.
|
// keep. Never accept — this probe must not trust anything.
|
||||||
CertificateValidationEventHandler captureAndReject = (_, e) =>
|
// SDK 2 (ScadaBridge#125): the per-error AcceptError hook replaces the CertificateValidation
|
||||||
|
// event. Returning false rejects the error exactly as e.Accept = false did.
|
||||||
|
Func<Opc.Ua.Security.Certificates.Certificate, ServiceResult, bool> captureAndReject = (certificate, _) =>
|
||||||
{
|
{
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
// Copy into a stable instance so disposing the SDK's chain doesn't invalidate it.
|
// Copy into a stable instance: the SDK's Certificate is reference-counted and is
|
||||||
capturedCert = X509CertificateLoader.LoadCertificate(e.Certificate.RawData);
|
// released once validation returns.
|
||||||
|
capturedCert ??= X509CertificateLoader.LoadCertificate(certificate.RawData);
|
||||||
}
|
}
|
||||||
catch
|
catch
|
||||||
{
|
{
|
||||||
// Best-effort capture: fall back to the original reference if the copy fails.
|
// Best-effort capture: the SDK's own copy is the fallback.
|
||||||
capturedCert = e.Certificate;
|
capturedCert ??= certificate.AsX509Certificate2();
|
||||||
}
|
}
|
||||||
e.Accept = false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(ct);
|
using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(ct);
|
||||||
@@ -407,7 +412,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
globalOptions, secured: preferredSecurityMode != MessageSecurityMode.None,
|
globalOptions, secured: preferredSecurityMode != MessageSecurityMode.None,
|
||||||
autoAcceptUntrusted: false, config.SessionTimeoutMs, config.OperationTimeoutMs,
|
autoAcceptUntrusted: false, config.SessionTimeoutMs, config.OperationTimeoutMs,
|
||||||
logger, linkedCts.Token);
|
logger, linkedCts.Token);
|
||||||
appConfig.CertificateValidator.CertificateValidation += captureAndReject;
|
appConfig.CertificateManager.AcceptError = captureAndReject;
|
||||||
|
|
||||||
// Discover endpoints, pick the preferred security mode (same logic as ConnectAsync).
|
// Discover endpoints, pick the preferred security mode (same logic as ConnectAsync).
|
||||||
// Bounded by the probe's own budget (linkedCts), not just the SDK operation timeout.
|
// Bounded by the probe's own budget (linkedCts), not just the SDK operation timeout.
|
||||||
@@ -421,9 +426,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
var endpointConfig = EndpointConfiguration.Create(appConfig);
|
var endpointConfig = EndpointConfiguration.Create(appConfig);
|
||||||
var configuredEndpoint = new ConfiguredEndpoint(null, endpoint, endpointConfig);
|
var configuredEndpoint = new ConfiguredEndpoint(null, endpoint, endpointConfig);
|
||||||
|
|
||||||
#pragma warning disable CS0618 // Allow obsolete DefaultSessionFactory constructor for compatibility
|
var sessionFactory = new DefaultSessionFactory(OpcUaApplicationIdentity.SdkTelemetry.Value);
|
||||||
var sessionFactory = new DefaultSessionFactory();
|
|
||||||
#pragma warning restore CS0618
|
|
||||||
|
|
||||||
var userIdentity = BuildUserIdentity(config.UserIdentity is { } ui
|
var userIdentity = BuildUserIdentity(config.UserIdentity is { } ui
|
||||||
? new OpcUaUserIdentityOptions(
|
? new OpcUaUserIdentityOptions(
|
||||||
@@ -434,7 +437,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
session = await sessionFactory.CreateAsync(
|
session = await sessionFactory.CreateAsync(
|
||||||
appConfig, configuredEndpoint, false,
|
appConfig, configuredEndpoint, false,
|
||||||
"ScadaBridge-DCL-Verify", (uint)config.SessionTimeoutMs,
|
"ScadaBridge-DCL-Verify", (uint)config.SessionTimeoutMs,
|
||||||
userIdentity, null, linkedCts.Token);
|
userIdentity, default, linkedCts.Token);
|
||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
@@ -452,8 +455,8 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
catch (Exception ex) { logger.LogDebug(ex, "OPC UA verify session close failed (ignored)."); }
|
catch (Exception ex) { logger.LogDebug(ex, "OPC UA verify session close failed (ignored)."); }
|
||||||
session.Dispose();
|
session.Dispose();
|
||||||
}
|
}
|
||||||
if (appConfig != null)
|
if (appConfig?.CertificateManager is { } manager)
|
||||||
appConfig.CertificateValidator.CertificateValidation -= captureAndReject;
|
manager.AcceptError = null;
|
||||||
OpcUaApplicationIdentity.ReleaseApplicationCertificate(appConfig);
|
OpcUaApplicationIdentity.ReleaseApplicationCertificate(appConfig);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -502,24 +505,18 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
if (HasSocketCause(sre))
|
if (HasSocketCause(sre))
|
||||||
return new VerifyEndpointResult(false, VerifyFailureKind.Unreachable, sre.Message, null);
|
return new VerifyEndpointResult(false, VerifyFailureKind.Unreachable, sre.Message, null);
|
||||||
|
|
||||||
switch (sre.StatusCode)
|
// SDK 2: StatusCodes members are StatusCode structs, not constants, so match by value.
|
||||||
{
|
var status = sre.StatusCode;
|
||||||
case StatusCodes.BadRequestTimeout:
|
if (status == StatusCodes.BadRequestTimeout || status == StatusCodes.BadTimeout)
|
||||||
case StatusCodes.BadTimeout:
|
return new VerifyEndpointResult(false, VerifyFailureKind.Timeout, sre.Message, null);
|
||||||
return new VerifyEndpointResult(false, VerifyFailureKind.Timeout, sre.Message, null);
|
if (status == StatusCodes.BadUserAccessDenied || status == StatusCodes.BadIdentityTokenRejected
|
||||||
case StatusCodes.BadUserAccessDenied:
|
|| status == StatusCodes.BadIdentityTokenInvalid)
|
||||||
case StatusCodes.BadIdentityTokenRejected:
|
return new VerifyEndpointResult(false, VerifyFailureKind.AuthFailed, sre.Message, null);
|
||||||
case StatusCodes.BadIdentityTokenInvalid:
|
if (status == StatusCodes.BadConnectionRejected || status == StatusCodes.BadNotConnected
|
||||||
return new VerifyEndpointResult(false, VerifyFailureKind.AuthFailed, sre.Message, null);
|
|| status == StatusCodes.BadConnectionClosed || status == StatusCodes.BadNoCommunication
|
||||||
case StatusCodes.BadConnectionRejected:
|
|| status == StatusCodes.BadServerNotConnected)
|
||||||
case StatusCodes.BadNotConnected:
|
return new VerifyEndpointResult(false, VerifyFailureKind.Unreachable, sre.Message, null);
|
||||||
case StatusCodes.BadConnectionClosed:
|
return new VerifyEndpointResult(false, VerifyFailureKind.ServerError, sre.Message, null);
|
||||||
case StatusCodes.BadNoCommunication:
|
|
||||||
case StatusCodes.BadServerNotConnected:
|
|
||||||
return new VerifyEndpointResult(false, VerifyFailureKind.Unreachable, sre.Message, null);
|
|
||||||
default:
|
|
||||||
return new VerifyEndpointResult(false, VerifyFailureKind.ServerError, sre.Message, null);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// A bare socket failure (DNS / connection refused) before the SDK wrapped it.
|
// A bare socket failure (DNS / connection refused) before the SDK wrapped it.
|
||||||
@@ -754,9 +751,11 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
{
|
{
|
||||||
if (e.NotificationValue is MonitoredItemNotification notification)
|
if (e.NotificationValue is MonitoredItemNotification notification)
|
||||||
{
|
{
|
||||||
var value = notification.Value?.Value;
|
// SDK 2: DataValue is a struct; restore the SDK 1.5 CLR payload shapes.
|
||||||
var timestamp = notification.Value?.SourceTimestamp ?? DateTime.UtcNow;
|
var dataValue = notification.Value;
|
||||||
var statusCode = notification.Value?.StatusCode.Code ?? 0;
|
var value = OpcUaValueBoundary.ToClr(dataValue.WrappedValue);
|
||||||
|
var timestamp = OpcUaValueBoundary.ToClrTimestamp(dataValue.SourceTimestamp);
|
||||||
|
var statusCode = dataValue.StatusCode.Code;
|
||||||
|
|
||||||
if (_callbacks.TryGetValue(handle, out var cb))
|
if (_callbacks.TryGetValue(handle, out var cb))
|
||||||
{
|
{
|
||||||
@@ -1039,11 +1038,11 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
/// <returns>The friendly type name when known; otherwise the NodeId string (or "" when null).</returns>
|
/// <returns>The friendly type name when known; otherwise the NodeId string (or "" when null).</returns>
|
||||||
internal static string ResolveAlarmTypeName(NodeId? eventType)
|
internal static string ResolveAlarmTypeName(NodeId? eventType)
|
||||||
{
|
{
|
||||||
if (eventType is null)
|
if (eventType is not { } type || type.IsNull)
|
||||||
return "";
|
return "";
|
||||||
return ConditionTypeNamesById.TryGetValue(eventType, out var friendly)
|
return ConditionTypeNamesById.TryGetValue(type, out var friendly)
|
||||||
? friendly
|
? friendly
|
||||||
: eventType.ToString();
|
: type.ToString() ?? "";
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -1067,20 +1066,22 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
internal static EventFilter BuildAlarmEventFilter(AlarmConditionFilter conditionFilter)
|
internal static EventFilter BuildAlarmEventFilter(AlarmConditionFilter conditionFilter)
|
||||||
{
|
{
|
||||||
var filter = new EventFilter();
|
var filter = new EventFilter();
|
||||||
|
// SDK 2: SelectClauses is an immutable ArrayOf; collect the clauses, then assign once.
|
||||||
|
var selectClauses = new List<SimpleAttributeOperand>();
|
||||||
foreach (var name in AlarmStateFields)
|
foreach (var name in AlarmStateFields)
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.BaseEventType, name));
|
selectClauses.Add(SelectField(ObjectTypeIds.BaseEventType, name));
|
||||||
|
|
||||||
// Two-state sub-condition /Id booleans + shelving current-state + identity.
|
// Two-state sub-condition /Id booleans + shelving current-state + identity.
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "ActiveState", "Id")); // 6
|
selectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "ActiveState", "Id")); // 6
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.AcknowledgeableConditionType, "AckedState", "Id")); // 7
|
selectClauses.Add(SelectField(ObjectTypeIds.AcknowledgeableConditionType, "AckedState", "Id")); // 7
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.AcknowledgeableConditionType, "ConfirmedState", "Id"));// 8
|
selectClauses.Add(SelectField(ObjectTypeIds.AcknowledgeableConditionType, "ConfirmedState", "Id"));// 8
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "SuppressedState", "Id")); // 9
|
selectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "SuppressedState", "Id")); // 9
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "ShelvingState", "CurrentState"));// 10
|
selectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "ShelvingState", "CurrentState"));// 10
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.ConditionType, "ConditionName")); // 11
|
selectClauses.Add(SelectField(ObjectTypeIds.ConditionType, "ConditionName")); // 11
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.ConditionType, "Comment")); // 12
|
selectClauses.Add(SelectField(ObjectTypeIds.ConditionType, "Comment")); // 12
|
||||||
|
|
||||||
// APPENDED fields (indices 13+): optional — only present on specific derived types.
|
// APPENDED fields (indices 13+): optional — only present on specific derived types.
|
||||||
// Guard all reads with fields.Count > N so base-ConditionType events still process.
|
// Guard all reads with fields.Length > N so base-ConditionType events still process.
|
||||||
|
|
||||||
// 13: AlarmConditionType/ActiveState/TransitionTime — the UTC instant the active-state
|
// 13: AlarmConditionType/ActiveState/TransitionTime — the UTC instant the active-state
|
||||||
// last flipped to TRUE. Mapped to OriginalRaiseTime; absent on non-AlarmCondition
|
// last flipped to TRUE. Mapped to OriginalRaiseTime; absent on non-AlarmCondition
|
||||||
@@ -1089,16 +1090,16 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// rather than the historical raise instant (OPC UA Part 9 §5.5.2 makes it advisory),
|
// rather than the historical raise instant (OPC UA Part 9 §5.5.2 makes it advisory),
|
||||||
// so a snapshot-derived OriginalRaiseTime can look like the refresh time — it is
|
// so a snapshot-derived OriginalRaiseTime can look like the refresh time — it is
|
||||||
// display-only and not treated as authoritative.
|
// display-only and not treated as authoritative.
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "ActiveState", "TransitionTime")); // 13
|
selectClauses.Add(SelectField(ObjectTypeIds.AlarmConditionType, "ActiveState", "TransitionTime")); // 13
|
||||||
|
|
||||||
// 14–17: LimitAlarmType limit thresholds — configuration-time set-points exposed as
|
// 14–17: LimitAlarmType limit thresholds — configuration-time set-points exposed as
|
||||||
// event fields by LimitAlarmType and all its subtypes (Exclusive/NonExclusive
|
// event fields by LimitAlarmType and all its subtypes (Exclusive/NonExclusive
|
||||||
// Level/Deviation/RateOfChange). Absent on non-limit alarm types (e.g. discrete,
|
// Level/Deviation/RateOfChange). Absent on non-limit alarm types (e.g. discrete,
|
||||||
// off-normal) — guarded by fields.Count > N below.
|
// off-normal) — guarded by fields.Length > N below.
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "HighHighLimit")); // 14
|
selectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "HighHighLimit")); // 14
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "HighLimit")); // 15
|
selectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "HighLimit")); // 15
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "LowLimit")); // 16
|
selectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "LowLimit")); // 16
|
||||||
filter.SelectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "LowLowLimit")); // 17
|
selectClauses.Add(SelectField(ObjectTypeIds.LimitAlarmType, "LowLowLimit")); // 17
|
||||||
|
|
||||||
// 18: AcknowledgeableConditionType/AckedState/TransitionTime — the UTC instant the
|
// 18: AcknowledgeableConditionType/AckedState/TransitionTime — the UTC instant the
|
||||||
// acked-state last flipped. When the condition is currently ACKED that instant IS
|
// acked-state last flipped. When the condition is currently ACKED that instant IS
|
||||||
@@ -1107,8 +1108,9 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// base ConditionType events and on servers that do not expose it, in which case
|
// base ConditionType events and on servers that do not expose it, in which case
|
||||||
// OpcUaAlarmMapper.DeriveAckTime falls back to the event's own Time field. Same
|
// OpcUaAlarmMapper.DeriveAckTime falls back to the event's own Time field. Same
|
||||||
// ConditionRefresh caveat as index 13: a replayed snapshot may re-stamp it.
|
// ConditionRefresh caveat as index 13: a replayed snapshot may re-stamp it.
|
||||||
filter.SelectClauses.Add(
|
selectClauses.Add(
|
||||||
SelectField(ObjectTypeIds.AcknowledgeableConditionType, "AckedState", "TransitionTime")); // 18
|
SelectField(ObjectTypeIds.AcknowledgeableConditionType, "AckedState", "TransitionTime")); // 18
|
||||||
|
filter.SelectClauses = selectClauses;
|
||||||
|
|
||||||
// UNAVAILABLE via standard OPC UA A&C event fields (documented here so future
|
// UNAVAILABLE via standard OPC UA A&C event fields (documented here so future
|
||||||
// maintainers know these were considered, not overlooked):
|
// maintainers know these were considered, not overlooked):
|
||||||
@@ -1159,15 +1161,13 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
for (var i = 1; i < typeIds.Count; i++)
|
for (var i = 1; i < typeIds.Count; i++)
|
||||||
{
|
{
|
||||||
var next = where.Push(FilterOperator.OfType, typeIds[i]);
|
var next = where.Push(FilterOperator.OfType, typeIds[i]);
|
||||||
element = where.Push(FilterOperator.Or, element, next);
|
element = where.Push(FilterOperator.Or, Variant.FromStructure(element), Variant.FromStructure(next));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private static SimpleAttributeOperand SelectField(NodeId typeDefinitionId, params string[] browse)
|
private static SimpleAttributeOperand SelectField(NodeId typeDefinitionId, params string[] browse)
|
||||||
{
|
{
|
||||||
var path = new QualifiedNameCollection();
|
var path = browse.Select(b => new QualifiedName(b)).ToArray();
|
||||||
foreach (var b in browse)
|
|
||||||
path.Add(new QualifiedName(b));
|
|
||||||
return new SimpleAttributeOperand
|
return new SimpleAttributeOperand
|
||||||
{
|
{
|
||||||
TypeDefinitionId = typeDefinitionId,
|
TypeDefinitionId = typeDefinitionId,
|
||||||
@@ -1198,11 +1198,15 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
string handle, string? subscriptionSourceReference, EventFieldList efl,
|
string handle, string? subscriptionSourceReference, EventFieldList efl,
|
||||||
Action<NativeAlarmTransition> onTransition)
|
Action<NativeAlarmTransition> onTransition)
|
||||||
{
|
{
|
||||||
var fields = efl.EventFields;
|
// SDK 2: event fields are an ArrayOf<Variant>; unbox each one to its SDK 1.5 CLR shape once,
|
||||||
if (fields == null || fields.Count < AlarmStateFields.Length)
|
// so every index check below reads the same values it did before ScadaBridge#125.
|
||||||
|
if (efl.EventFields.IsNull || efl.EventFields.Count < AlarmStateFields.Length)
|
||||||
return;
|
return;
|
||||||
|
var fields = new object?[efl.EventFields.Count];
|
||||||
|
for (var i = 0; i < fields.Length; i++)
|
||||||
|
fields[i] = OpcUaValueBoundary.ToClr(efl.EventFields[i]);
|
||||||
|
|
||||||
var eventType = fields[0].Value as NodeId;
|
NodeId? eventType = fields[0] is NodeId et ? et : null;
|
||||||
|
|
||||||
// RefreshStart/End bracket the snapshot replay.
|
// RefreshStart/End bracket the snapshot replay.
|
||||||
if (eventType == ObjectTypeIds.RefreshStartEventType)
|
if (eventType == ObjectTypeIds.RefreshStartEventType)
|
||||||
@@ -1226,30 +1230,30 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// event's name), so DataConnectionActor's NodeId-keyed routing matches — see
|
// event's name), so DataConnectionActor's NodeId-keyed routing matches — see
|
||||||
// OpcUaAlarmMapper.BuildIdentity. SourceName seeds the readable per-condition
|
// OpcUaAlarmMapper.BuildIdentity. SourceName seeds the readable per-condition
|
||||||
// key; fall back to the SourceNode NodeId string only when it is absent.
|
// key; fall back to the SourceNode NodeId string only when it is absent.
|
||||||
var sourceName = fields[2].Value as string;
|
var sourceName = fields[2] as string;
|
||||||
if (string.IsNullOrEmpty(sourceName))
|
if (string.IsNullOrEmpty(sourceName))
|
||||||
sourceName = (fields[1].Value as NodeId)?.ToString() ?? "";
|
sourceName = fields[1] is NodeId sourceNode ? sourceNode.ToString() ?? "" : "";
|
||||||
var conditionName = fields.Count > 11 ? fields[11].Value as string : null;
|
var conditionName = fields.Length > 11 ? fields[11] as string : null;
|
||||||
var (sourceRef, sourceObjectRef) =
|
var (sourceRef, sourceObjectRef) =
|
||||||
OpcUaAlarmMapper.BuildIdentity(subscriptionSourceReference, sourceName, conditionName);
|
OpcUaAlarmMapper.BuildIdentity(subscriptionSourceReference, sourceName, conditionName);
|
||||||
if (string.IsNullOrEmpty(sourceRef))
|
if (string.IsNullOrEmpty(sourceRef))
|
||||||
return; // not a condition event we can key
|
return; // not a condition event we can key
|
||||||
|
|
||||||
var time = fields[3].Value is DateTime dt ? new DateTimeOffset(dt, TimeSpan.Zero) : DateTimeOffset.UtcNow;
|
var time = fields[3] is DateTime dt ? new DateTimeOffset(dt, TimeSpan.Zero) : DateTimeOffset.UtcNow;
|
||||||
var message = (fields[4].Value as LocalizedText)?.Text ?? "";
|
var message = TextOf(fields[4]) ?? "";
|
||||||
var severity = fields[5].Value is null ? 0 : Convert.ToInt32(fields[5].Value);
|
var severity = fields[5] is null ? 0 : Convert.ToInt32(fields[5]);
|
||||||
|
|
||||||
var active = fields.Count > 6 && fields[6].Value is bool a && a;
|
var active = fields.Length > 6 && fields[6] is bool a && a;
|
||||||
var acked = fields.Count <= 7 || fields[7].Value is not bool ak || ak; // default acked when absent
|
var acked = fields.Length <= 7 || fields[7] is not bool ak || ak; // default acked when absent
|
||||||
bool? confirmed = fields.Count > 8 && fields[8].Value is bool cf ? cf : null;
|
bool? confirmed = fields.Length > 8 && fields[8] is bool cf ? cf : null;
|
||||||
var suppressed = fields.Count > 9 && fields[9].Value is bool sp && sp;
|
var suppressed = fields.Length > 9 && fields[9] is bool sp && sp;
|
||||||
var shelve = OpcUaAlarmMapper.MapShelve(fields.Count > 10 ? (fields[10].Value as LocalizedText)?.Text : null);
|
var shelve = OpcUaAlarmMapper.MapShelve(fields.Length > 10 ? TextOf(fields[10]) : null);
|
||||||
var comment = fields.Count > 12 ? (fields[12].Value as LocalizedText)?.Text ?? "" : "";
|
var comment = fields.Length > 12 ? TextOf(fields[12]) ?? "" : "";
|
||||||
|
|
||||||
// Index 13: ActiveState/TransitionTime → OriginalRaiseTime (when active-state last
|
// Index 13: ActiveState/TransitionTime → OriginalRaiseTime (when active-state last
|
||||||
// transitioned to TRUE). Absent on non-AlarmCondition events → guard + null fallback.
|
// transitioned to TRUE). Absent on non-AlarmCondition events → guard + null fallback.
|
||||||
DateTimeOffset? originalRaiseTime = null;
|
DateTimeOffset? originalRaiseTime = null;
|
||||||
if (fields.Count > 13 && fields[13].Value is DateTime activeTransitionTime)
|
if (fields.Length > 13 && fields[13] is DateTime activeTransitionTime)
|
||||||
// OPC UA mandates UTC for DateTime fields; a TimeSpan.Zero offset treats an
|
// OPC UA mandates UTC for DateTime fields; a TimeSpan.Zero offset treats an
|
||||||
// Unspecified Kind as UTC (consistent with the Time→TransitionTime mapping above).
|
// Unspecified Kind as UTC (consistent with the Time→TransitionTime mapping above).
|
||||||
originalRaiseTime = new DateTimeOffset(activeTransitionTime, TimeSpan.Zero);
|
originalRaiseTime = new DateTimeOffset(activeTransitionTime, TimeSpan.Zero);
|
||||||
@@ -1260,16 +1264,16 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// display-only representative limit; the caller is responsible for interpreting
|
// display-only representative limit; the caller is responsible for interpreting
|
||||||
// which limit is active using AlarmTypeName or ConditionName.
|
// which limit is active using AlarmTypeName or ConditionName.
|
||||||
var limitValue = OpcUaAlarmMapper.PickLimitValue(
|
var limitValue = OpcUaAlarmMapper.PickLimitValue(
|
||||||
fields.Count > 14 ? fields[14].Value : null,
|
fields.Length > 14 ? fields[14] : null,
|
||||||
fields.Count > 15 ? fields[15].Value : null,
|
fields.Length > 15 ? fields[15] : null,
|
||||||
fields.Count > 16 ? fields[16].Value : null,
|
fields.Length > 16 ? fields[16] : null,
|
||||||
fields.Count > 17 ? fields[17].Value : null);
|
fields.Length > 17 ? fields[17] : null);
|
||||||
|
|
||||||
// Index 18: AckedState/TransitionTime → the true source ack instant when the condition
|
// Index 18: AckedState/TransitionTime → the true source ack instant when the condition
|
||||||
// is currently acked. Absent on non-acknowledgeable events / servers that omit it →
|
// is currently acked. Absent on non-acknowledgeable events / servers that omit it →
|
||||||
// guard + null fallback, which DeriveAckTime resolves to the event time below.
|
// guard + null fallback, which DeriveAckTime resolves to the event time below.
|
||||||
DateTimeOffset? sourceAckTime = null;
|
DateTimeOffset? sourceAckTime = null;
|
||||||
if (fields.Count > 18 && fields[18].Value is DateTime ackTransitionTime)
|
if (fields.Length > 18 && fields[18] is DateTime ackTransitionTime)
|
||||||
// OPC UA mandates UTC for DateTime fields; TimeSpan.Zero treats an Unspecified
|
// OPC UA mandates UTC for DateTime fields; TimeSpan.Zero treats an Unspecified
|
||||||
// Kind as UTC (consistent with the Time and ActiveState/TransitionTime mappings).
|
// Kind as UTC (consistent with the Time and ActiveState/TransitionTime mappings).
|
||||||
sourceAckTime = new DateTimeOffset(ackTransitionTime, TimeSpan.Zero);
|
sourceAckTime = new DateTimeOffset(ackTransitionTime, TimeSpan.Zero);
|
||||||
@@ -1320,6 +1324,9 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
SnapshotId: inRefresh && _alarmSnapshotIds.TryGetValue(handle, out var epoch) ? epoch : null));
|
SnapshotId: inRefresh && _alarmSnapshotIds.TryGetValue(handle, out var epoch) ? epoch : null));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>The text of a LocalizedText event field (a struct in SDK 2), or null.</summary>
|
||||||
|
private static string? TextOf(object? field) => field is LocalizedText text ? text.Text : null;
|
||||||
|
|
||||||
private static NativeAlarmTransition SnapshotBoundary(AlarmTransitionKind kind, string? source, Guid epoch) => new(
|
private static NativeAlarmTransition SnapshotBoundary(AlarmTransitionKind kind, string? source, Guid epoch) => new(
|
||||||
"", source ?? string.Empty, "", kind,
|
"", source ?? string.Empty, "", kind,
|
||||||
new Commons.Types.Alarms.AlarmConditionState(false, true, null, AlarmShelveState.Unshelved, false, 0),
|
new Commons.Types.Alarms.AlarmConditionState(false, true, null, AlarmShelveState.Unshelved, false, 0),
|
||||||
@@ -1369,31 +1376,33 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
outcomes[i] = new OpcUaReadOutcome(nodeIds[i], null, DateTime.UtcNow, StatusCodes.BadNodeIdUnknown, ex.Message);
|
outcomes[i] = new OpcUaReadOutcome(nodeIds[i], null, DateTime.UtcNow, StatusCodes.BadNodeIdUnknown.Code, ex.Message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
for (var offset = 0; offset < resolvable.Count; offset += MaxNodesPerServiceCall)
|
for (var offset = 0; offset < resolvable.Count; offset += MaxNodesPerServiceCall)
|
||||||
{
|
{
|
||||||
var chunk = resolvable.GetRange(offset, Math.Min(MaxNodesPerServiceCall, resolvable.Count - offset));
|
var chunk = resolvable.GetRange(offset, Math.Min(MaxNodesPerServiceCall, resolvable.Count - offset));
|
||||||
var collection = new ReadValueIdCollection(chunk.Select(c => c.Read));
|
ArrayOf<ReadValueId> collection = chunk.Select(c => c.Read).ToArray();
|
||||||
var response = await session.ReadAsync(
|
var response = await session.ReadAsync(
|
||||||
null, 0, MapTimestampsToReturn(_options.TimestampsToReturn), collection, cancellationToken);
|
null, 0, MapTimestampsToReturn(_options.TimestampsToReturn), collection, cancellationToken);
|
||||||
|
|
||||||
|
var results = response.Results;
|
||||||
for (var i = 0; i < chunk.Count; i++)
|
for (var i = 0; i < chunk.Count; i++)
|
||||||
{
|
{
|
||||||
var (index, nodeId, _) = chunk[i];
|
var (index, nodeId, _) = chunk[i];
|
||||||
if (response.Results is { Count: > 0 } results && i < results.Count)
|
if (!results.IsNull && i < results.Count)
|
||||||
{
|
{
|
||||||
var result = results[i];
|
var result = results[i];
|
||||||
outcomes[index] = new OpcUaReadOutcome(
|
outcomes[index] = new OpcUaReadOutcome(
|
||||||
nodeId, result.Value, result.SourceTimestamp, result.StatusCode.Code, null);
|
nodeId, OpcUaValueBoundary.ToClr(result.WrappedValue),
|
||||||
|
OpcUaValueBoundary.ToClrTimestamp(result.SourceTimestamp), result.StatusCode.Code, null);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
// Non-conformant server: fewer results than requested nodes.
|
// Non-conformant server: fewer results than requested nodes.
|
||||||
outcomes[index] = new OpcUaReadOutcome(
|
outcomes[index] = new OpcUaReadOutcome(
|
||||||
nodeId, null, DateTime.UtcNow, StatusCodes.BadUnexpectedError,
|
nodeId, null, DateTime.UtcNow, StatusCodes.BadUnexpectedError.Code,
|
||||||
"OPC UA read returned no result for this node.");
|
"OPC UA read returned no result for this node.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1431,7 +1440,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
outcomes[i] = new OpcUaWriteOutcome(values[i].NodeId, StatusCodes.BadNodeIdUnknown, ex.Message);
|
outcomes[i] = new OpcUaWriteOutcome(values[i].NodeId, StatusCodes.BadNodeIdUnknown.Code, ex.Message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1451,7 +1460,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
var coerced = OpcUaWriteCoercion.Coerce(value, builtInType);
|
var coerced = OpcUaWriteCoercion.Coerce(value, builtInType);
|
||||||
if (!coerced.Success)
|
if (!coerced.Success)
|
||||||
{
|
{
|
||||||
outcomes[i] = new OpcUaWriteOutcome(values[i].NodeId, StatusCodes.BadTypeMismatch, coerced.Error);
|
outcomes[i] = new OpcUaWriteOutcome(values[i].NodeId, StatusCodes.BadTypeMismatch.Code, coerced.Error);
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
value = coerced.Value;
|
value = coerced.Value;
|
||||||
@@ -1463,32 +1472,33 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
{
|
{
|
||||||
NodeId = nodeId,
|
NodeId = nodeId,
|
||||||
AttributeId = Attributes.Value,
|
AttributeId = Attributes.Value,
|
||||||
Value = new DataValue(new Variant(value))
|
Value = new DataValue(OpcUaValueBoundary.ToVariant(value))
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
outcomes[i] = new OpcUaWriteOutcome(values[i].NodeId, StatusCodes.BadTypeMismatch, ex.Message);
|
outcomes[i] = new OpcUaWriteOutcome(values[i].NodeId, StatusCodes.BadTypeMismatch.Code, ex.Message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
for (var offset = 0; offset < resolvable.Count; offset += MaxNodesPerServiceCall)
|
for (var offset = 0; offset < resolvable.Count; offset += MaxNodesPerServiceCall)
|
||||||
{
|
{
|
||||||
var chunk = resolvable.GetRange(offset, Math.Min(MaxNodesPerServiceCall, resolvable.Count - offset));
|
var chunk = resolvable.GetRange(offset, Math.Min(MaxNodesPerServiceCall, resolvable.Count - offset));
|
||||||
var collection = new WriteValueCollection(chunk.Select(c => c.Write));
|
ArrayOf<WriteValue> collection = chunk.Select(c => c.Write).ToArray();
|
||||||
var response = await session.WriteAsync(null, collection, cancellationToken);
|
var response = await session.WriteAsync(null, collection, cancellationToken);
|
||||||
|
|
||||||
|
var results = response.Results;
|
||||||
for (var i = 0; i < chunk.Count; i++)
|
for (var i = 0; i < chunk.Count; i++)
|
||||||
{
|
{
|
||||||
var (index, nodeId, _) = chunk[i];
|
var (index, nodeId, _) = chunk[i];
|
||||||
if (response.Results is { Count: > 0 } results && i < results.Count)
|
if (!results.IsNull && i < results.Count)
|
||||||
{
|
{
|
||||||
outcomes[index] = new OpcUaWriteOutcome(nodeId, results[i].Code, null);
|
outcomes[index] = new OpcUaWriteOutcome(nodeId, results[i].Code, null);
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
outcomes[index] = new OpcUaWriteOutcome(
|
outcomes[index] = new OpcUaWriteOutcome(
|
||||||
nodeId, StatusCodes.BadUnexpectedError,
|
nodeId, StatusCodes.BadUnexpectedError.Code,
|
||||||
"OPC UA write returned no result for this node.");
|
"OPC UA write returned no result for this node.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1513,16 +1523,18 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
var chunk = missing.GetRange(offset, Math.Min(MaxNodesPerServiceCall, missing.Count - offset));
|
var chunk = missing.GetRange(offset, Math.Min(MaxNodesPerServiceCall, missing.Count - offset));
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
var readIds = new ReadValueIdCollection(
|
ArrayOf<ReadValueId> readIds = chunk
|
||||||
chunk.Select(n => new ReadValueId { NodeId = n, AttributeId = Attributes.DataType }));
|
.Select(n => new ReadValueId { NodeId = n, AttributeId = Attributes.DataType }).ToArray();
|
||||||
var response = await session.ReadAsync(
|
var response = await session.ReadAsync(
|
||||||
null, 0, TimestampsToReturn.Neither, readIds, cancellationToken).ConfigureAwait(false);
|
null, 0, TimestampsToReturn.Neither, readIds, cancellationToken).ConfigureAwait(false);
|
||||||
if (response.Results is not { } results || results.Count != chunk.Count)
|
var results = response.Results;
|
||||||
|
if (results.IsNull || results.Count != chunk.Count)
|
||||||
continue;
|
continue;
|
||||||
|
|
||||||
for (var i = 0; i < chunk.Count; i++)
|
for (var i = 0; i < chunk.Count; i++)
|
||||||
{
|
{
|
||||||
if (!StatusCode.IsGood(results[i].StatusCode) || results[i].Value is not NodeId dataTypeId)
|
if (!StatusCode.IsGood(results[i].StatusCode)
|
||||||
|
|| OpcUaValueBoundary.ToClr(results[i].WrappedValue) is not NodeId dataTypeId)
|
||||||
continue;
|
continue;
|
||||||
|
|
||||||
var builtIn = TypeInfo.GetBuiltInType(dataTypeId);
|
var builtIn = TypeInfo.GetBuiltInType(dataTypeId);
|
||||||
@@ -1574,20 +1586,8 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
await DisconnectAsync();
|
await DisconnectAsync();
|
||||||
}
|
}
|
||||||
|
|
||||||
private static UserIdentity? BuildUserIdentity(OpcUaUserIdentityOptions? options)
|
private static UserIdentity? BuildUserIdentity(OpcUaUserIdentityOptions? options) =>
|
||||||
{
|
OpcUaUserIdentities.Build(options);
|
||||||
if (options is null) return null;
|
|
||||||
return options.TokenType.ToUpperInvariant() switch
|
|
||||||
{
|
|
||||||
"USERNAMEPASSWORD" => new UserIdentity(
|
|
||||||
options.Username,
|
|
||||||
System.Text.Encoding.UTF8.GetBytes(options.Password ?? "")),
|
|
||||||
"X509CERTIFICATE" => new UserIdentity(
|
|
||||||
X509CertificateLoader.LoadPkcs12FromFile(
|
|
||||||
options.CertificatePath, options.CertificatePassword)),
|
|
||||||
_ => null
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
private static MonitoringFilter? BuildDataChangeFilter(OpcUaDeadbandOptions? deadband)
|
private static MonitoringFilter? BuildDataChangeFilter(OpcUaDeadbandOptions? deadband)
|
||||||
{
|
{
|
||||||
@@ -1666,12 +1666,12 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// can be fetched; we pass back exactly the one point we were handed.
|
// can be fetched; we pass back exactly the one point we were handed.
|
||||||
var (_, revisedPoints, results, _) = await session.BrowseNextAsync(
|
var (_, revisedPoints, results, _) = await session.BrowseNextAsync(
|
||||||
null,
|
null,
|
||||||
new ByteStringCollection { Convert.FromBase64String(continuationToken) },
|
new[] { ByteString.From(Convert.FromBase64String(continuationToken)) },
|
||||||
false,
|
false,
|
||||||
cancellationToken).ConfigureAwait(false);
|
cancellationToken).ConfigureAwait(false);
|
||||||
|
|
||||||
var nextPoint = revisedPoints is { Count: > 0 } ? revisedPoints[0] : null;
|
var nextPoint = !revisedPoints.IsNull && revisedPoints.Count > 0 ? revisedPoints[0] : default;
|
||||||
var refs = results is { Count: > 0 } ? results[0] : null;
|
var refs = results is { Count: > 0 } ? results[0] : default;
|
||||||
return await BuildResultAsync(session, refs, nextPoint, cancellationToken).ConfigureAwait(false);
|
return await BuildResultAsync(session, refs, nextPoint, cancellationToken).ConfigureAwait(false);
|
||||||
}
|
}
|
||||||
catch (ServiceResultException ex) when (
|
catch (ServiceResultException ex) when (
|
||||||
@@ -1743,11 +1743,11 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
private async Task<Commons.Interfaces.Protocol.BrowseChildrenResult> BuildResultAsync(
|
private async Task<Commons.Interfaces.Protocol.BrowseChildrenResult> BuildResultAsync(
|
||||||
ISession session,
|
ISession session,
|
||||||
ReferenceDescriptionCollection? references,
|
ArrayOf<ReferenceDescription> references,
|
||||||
byte[]? continuationPoint,
|
ByteString continuationPoint,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
{
|
{
|
||||||
var refs = references ?? new ReferenceDescriptionCollection();
|
var refs = references.IsNull ? [] : references.ToList();
|
||||||
var children = new List<Commons.Interfaces.Protocol.BrowseNode>(refs.Count);
|
var children = new List<Commons.Interfaces.Protocol.BrowseNode>(refs.Count);
|
||||||
foreach (var r in refs)
|
foreach (var r in refs)
|
||||||
{
|
{
|
||||||
@@ -1757,7 +1757,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// read back, and a bare ns= index rots the moment the server's
|
// read back, and a bare ns= index rots the moment the server's
|
||||||
// namespace table changes. What the picker shows is what gets stored.
|
// namespace table changes. What the picker shows is what gets stored.
|
||||||
NodeId: OpcUaNodeReference.ToDurable(r.NodeId, session.NamespaceUris),
|
NodeId: OpcUaNodeReference.ToDurable(r.NodeId, session.NamespaceUris),
|
||||||
DisplayName: r.DisplayName?.Text ?? r.BrowseName?.Name ?? "(unnamed)",
|
DisplayName: r.DisplayName.Text ?? r.BrowseName.Name ?? "(unnamed)",
|
||||||
NodeClass: MapNodeClass(r.NodeClass),
|
NodeClass: MapNodeClass(r.NodeClass),
|
||||||
HasChildren: r.NodeClass == NodeClass.Object));
|
HasChildren: r.NodeClass == NodeClass.Object));
|
||||||
}
|
}
|
||||||
@@ -1775,8 +1775,8 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// A non-empty continuation point means the server has more refs than
|
// A non-empty continuation point means the server has more refs than
|
||||||
// were returned on this page. Surface it as an opaque Base64 token the
|
// were returned on this page. Surface it as an opaque Base64 token the
|
||||||
// caller passes back to fetch the next page via BrowseNext.
|
// caller passes back to fetch the next page via BrowseNext.
|
||||||
var hasMore = continuationPoint != null && continuationPoint.Length > 0;
|
var hasMore = !continuationPoint.IsNull && !continuationPoint.IsEmpty;
|
||||||
var token = hasMore ? Convert.ToBase64String(continuationPoint!) : null;
|
var token = hasMore ? Convert.ToBase64String(continuationPoint.ToArray()) : null;
|
||||||
return new Commons.Interfaces.Protocol.BrowseChildrenResult(children, hasMore, token);
|
return new Commons.Interfaces.Protocol.BrowseChildrenResult(children, hasMore, token);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1795,7 +1795,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// BrowseNode list, so a swallowed failure simply means no type columns.
|
// BrowseNode list, so a swallowed failure simply means no type columns.
|
||||||
private async Task<List<Commons.Interfaces.Protocol.BrowseNode>> EnrichVariableTypeInfoAsync(
|
private async Task<List<Commons.Interfaces.Protocol.BrowseNode>> EnrichVariableTypeInfoAsync(
|
||||||
ISession session,
|
ISession session,
|
||||||
ReferenceDescriptionCollection refs,
|
List<ReferenceDescription> refs,
|
||||||
List<Commons.Interfaces.Protocol.BrowseNode> children,
|
List<Commons.Interfaces.Protocol.BrowseNode> children,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
{
|
{
|
||||||
@@ -1804,7 +1804,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
// Build a flat read of (DataType, ValueRank, UserAccessLevel) per
|
// Build a flat read of (DataType, ValueRank, UserAccessLevel) per
|
||||||
// Variable child, remembering which children-list slot each triple
|
// Variable child, remembering which children-list slot each triple
|
||||||
// maps back to so the read values can be re-stitched in order.
|
// maps back to so the read values can be re-stitched in order.
|
||||||
var readIds = new ReadValueIdCollection();
|
var readIds = new List<ReadValueId>();
|
||||||
var variableSlots = new List<int>();
|
var variableSlots = new List<int>();
|
||||||
for (var i = 0; i < refs.Count; i++)
|
for (var i = 0; i < refs.Count; i++)
|
||||||
{
|
{
|
||||||
@@ -1814,7 +1814,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
}
|
}
|
||||||
|
|
||||||
var nodeId = ExpandedNodeId.ToNodeId(refs[i].NodeId, session.NamespaceUris);
|
var nodeId = ExpandedNodeId.ToNodeId(refs[i].NodeId, session.NamespaceUris);
|
||||||
if (nodeId is null)
|
if (nodeId.IsNull)
|
||||||
{
|
{
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
@@ -1838,7 +1838,7 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
cancellationToken).ConfigureAwait(false);
|
cancellationToken).ConfigureAwait(false);
|
||||||
|
|
||||||
var results = readResponse.Results;
|
var results = readResponse.Results;
|
||||||
if (results is null || results.Count != readIds.Count)
|
if (results.IsNull || results.Count != readIds.Count)
|
||||||
{
|
{
|
||||||
// Defensive: a non-conformant server. Skip enrichment entirely
|
// Defensive: a non-conformant server. Skip enrichment entirely
|
||||||
// rather than risk mis-aligning values to the wrong nodes.
|
// rather than risk mis-aligning values to the wrong nodes.
|
||||||
@@ -1853,19 +1853,22 @@ public class RealOpcUaClient : IOpcUaClient
|
|||||||
var accessLevelResult = results[baseIdx + 2];
|
var accessLevelResult = results[baseIdx + 2];
|
||||||
|
|
||||||
string? dataType = null;
|
string? dataType = null;
|
||||||
if (StatusCode.IsGood(dataTypeResult.StatusCode) && dataTypeResult.Value is NodeId dtNodeId)
|
if (StatusCode.IsGood(dataTypeResult.StatusCode)
|
||||||
|
&& OpcUaValueBoundary.ToClr(dataTypeResult.WrappedValue) is NodeId dtNodeId)
|
||||||
{
|
{
|
||||||
dataType = OpcUaBuiltInTypeNames.Resolve(dtNodeId);
|
dataType = OpcUaBuiltInTypeNames.Resolve(dtNodeId);
|
||||||
}
|
}
|
||||||
|
|
||||||
int? valueRank = null;
|
int? valueRank = null;
|
||||||
if (StatusCode.IsGood(valueRankResult.StatusCode) && valueRankResult.Value is int vr)
|
if (StatusCode.IsGood(valueRankResult.StatusCode)
|
||||||
|
&& OpcUaValueBoundary.ToClr(valueRankResult.WrappedValue) is int vr)
|
||||||
{
|
{
|
||||||
valueRank = vr;
|
valueRank = vr;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool? writable = null;
|
bool? writable = null;
|
||||||
if (StatusCode.IsGood(accessLevelResult.StatusCode) && accessLevelResult.Value is byte accessLevel)
|
if (StatusCode.IsGood(accessLevelResult.StatusCode)
|
||||||
|
&& OpcUaValueBoundary.ToClr(accessLevelResult.WrappedValue) is byte accessLevel)
|
||||||
{
|
{
|
||||||
writable = ((AccessLevelType)accessLevel).HasFlag(AccessLevelType.CurrentWrite);
|
writable = ((AccessLevelType)accessLevel).HasFlag(AccessLevelType.CurrentWrite);
|
||||||
}
|
}
|
||||||
@@ -1949,14 +1952,14 @@ internal static class OpcUaBuiltInTypeNames
|
|||||||
/// <returns>Friendly name for built-ins; NodeId string for unknowns; empty string for null.</returns>
|
/// <returns>Friendly name for built-ins; NodeId string for unknowns; empty string for null.</returns>
|
||||||
public static string Resolve(NodeId? dataTypeNodeId)
|
public static string Resolve(NodeId? dataTypeNodeId)
|
||||||
{
|
{
|
||||||
if (dataTypeNodeId is null)
|
if (dataTypeNodeId is not { } dataType || dataType.IsNull)
|
||||||
{
|
{
|
||||||
return string.Empty;
|
return string.Empty;
|
||||||
}
|
}
|
||||||
|
|
||||||
return Names.TryGetValue(dataTypeNodeId, out var name)
|
return Names.TryGetValue(dataType, out var name)
|
||||||
? name
|
? name
|
||||||
: dataTypeNodeId.ToString();
|
: dataType.ToString() ?? string.Empty;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+3
-3
@@ -40,7 +40,7 @@ public class OpcUaNodeReferenceTests
|
|||||||
var nodeId = OpcUaNodeReference.Resolve("ns=2;s=pymodbus/plc/HR200", V3Table());
|
var nodeId = OpcUaNodeReference.Resolve("ns=2;s=pymodbus/plc/HR200", V3Table());
|
||||||
|
|
||||||
Assert.Equal(2, nodeId.NamespaceIndex);
|
Assert.Equal(2, nodeId.NamespaceIndex);
|
||||||
Assert.Equal("pymodbus/plc/HR200", nodeId.Identifier);
|
Assert.Equal("pymodbus/plc/HR200", nodeId.IdentifierAsString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that the namespace URI form resolves to the server's live namespace index.</summary>
|
/// <summary>Verifies that the namespace URI form resolves to the server's live namespace index.</summary>
|
||||||
@@ -50,7 +50,7 @@ public class OpcUaNodeReferenceTests
|
|||||||
var nodeId = OpcUaNodeReference.Resolve($"nsu={RawUri};s=pymodbus/plc/HR200", V3Table());
|
var nodeId = OpcUaNodeReference.Resolve($"nsu={RawUri};s=pymodbus/plc/HR200", V3Table());
|
||||||
|
|
||||||
Assert.Equal(2, nodeId.NamespaceIndex);
|
Assert.Equal(2, nodeId.NamespaceIndex);
|
||||||
Assert.Equal("pymodbus/plc/HR200", nodeId.Identifier);
|
Assert.Equal("pymodbus/plc/HR200", nodeId.IdentifierAsString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that the namespace URI form tracks the index across servers with different namespace tables.</summary>
|
/// <summary>Verifies that the namespace URI form tracks the index across servers with different namespace tables.</summary>
|
||||||
@@ -159,7 +159,7 @@ public class OpcUaNodeReferenceTests
|
|||||||
var resolved = OpcUaNodeReference.Resolve(durable, table);
|
var resolved = OpcUaNodeReference.Resolve(durable, table);
|
||||||
|
|
||||||
Assert.Equal(3, resolved.NamespaceIndex);
|
Assert.Equal(3, resolved.NamespaceIndex);
|
||||||
Assert.Equal("Area/Line/Equip/Speed", resolved.Identifier);
|
Assert.Equal("Area/Line/Equip/Speed", resolved.IdentifierAsString);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that a URI missing from the namespace table falls back instead of throwing.</summary>
|
/// <summary>Verifies that a URI missing from the namespace table falls back instead of throwing.</summary>
|
||||||
|
|||||||
+2
-2
@@ -13,7 +13,7 @@ public class OpcUaSecurityDowngradeTests
|
|||||||
await Assert.ThrowsAsync<InvalidOperationException>(() => RealOpcUaClient.DiscoverEndpointAsync("opc.tcp://test:4840",
|
await Assert.ThrowsAsync<InvalidOperationException>(() => RealOpcUaClient.DiscoverEndpointAsync("opc.tcp://test:4840",
|
||||||
MessageSecurityMode.SignAndEncrypt, _ => discoveryFails
|
MessageSecurityMode.SignAndEncrypt, _ => discoveryFails
|
||||||
? throw new Exception("discovery unavailable")
|
? throw new Exception("discovery unavailable")
|
||||||
: Task.FromResult(new EndpointDescriptionCollection { new("opc.tcp://test:4840") { SecurityMode = MessageSecurityMode.None } })));
|
: Task.FromResult<IReadOnlyList<EndpointDescription>>([new("opc.tcp://test:4840") { SecurityMode = MessageSecurityMode.None }])));
|
||||||
}
|
}
|
||||||
/// <summary>Verifies that DC4: exact requested mode is selected.</summary>
|
/// <summary>Verifies that DC4: exact requested mode is selected.</summary>
|
||||||
[Fact]
|
[Fact]
|
||||||
@@ -21,6 +21,6 @@ public class OpcUaSecurityDowngradeTests
|
|||||||
{
|
{
|
||||||
var encrypted = new EndpointDescription("opc.tcp://test:4840") { SecurityMode = MessageSecurityMode.SignAndEncrypt };
|
var encrypted = new EndpointDescription("opc.tcp://test:4840") { SecurityMode = MessageSecurityMode.SignAndEncrypt };
|
||||||
Assert.Same(encrypted, await RealOpcUaClient.DiscoverEndpointAsync("opc.tcp://test:4840", MessageSecurityMode.SignAndEncrypt,
|
Assert.Same(encrypted, await RealOpcUaClient.DiscoverEndpointAsync("opc.tcp://test:4840", MessageSecurityMode.SignAndEncrypt,
|
||||||
_ => Task.FromResult(new EndpointDescriptionCollection { new("opc.tcp://test:4840"), encrypted })));
|
_ => Task.FromResult<IReadOnlyList<EndpointDescription>>([new("opc.tcp://test:4840"), encrypted])));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+172
@@ -0,0 +1,172 @@
|
|||||||
|
using System.Security.Cryptography;
|
||||||
|
using System.Text;
|
||||||
|
using Opc.Ua;
|
||||||
|
using Opc.Ua.Security.Certificates;
|
||||||
|
using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Adapters;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// ScadaBridge#125 / lmxopcua#880: under SDK 2.0.1 a DCL UserName login must still send the
|
||||||
|
/// password in the legacy RSA format, whatever its length. SDK 2's own handler sends a password
|
||||||
|
/// over 64 bytes, such as a 65-character OtOpcUa API key, as an <c>RsaEncryptedSecret</c> with a
|
||||||
|
/// null EncryptionAlgorithm, which an SDK 1.5.378 server rejects with <c>BadIdentityTokenInvalid</c>
|
||||||
|
/// ("Unexpected encryption algorithm"): under an RSA policy it accepts only the URIs below.
|
||||||
|
/// </summary>
|
||||||
|
public sealed class OpcUaUserIdentitiesTests
|
||||||
|
{
|
||||||
|
// What SDK 1.5.378's SecurityPolicies.Decrypt demands, per policy, before it decrypts a password.
|
||||||
|
private const string RsaOaep = "http://www.w3.org/2001/04/xmlenc#rsa-oaep";
|
||||||
|
private const string RsaOaepSha256 = "http://opcfoundation.org/UA/security/rsa-oaep-sha2-256";
|
||||||
|
|
||||||
|
/// <summary>The OtOpcUa <c>ApiKeySecret.Generate</c> shape: otua_ + 16 hex + _ + 43 base64url = 65.</summary>
|
||||||
|
internal static string ProductionLengthKey()
|
||||||
|
{
|
||||||
|
var key = $"otua_{Convert.ToHexString(RandomNumberGenerator.GetBytes(8)).ToLowerInvariant()}_"
|
||||||
|
+ Convert.ToBase64String(RandomNumberGenerator.GetBytes(32)).TrimEnd('=').Replace('+', '-').Replace('/', '_');
|
||||||
|
Assert.Equal(65, key.Length);
|
||||||
|
return key;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static Certificate ServerCertificate() =>
|
||||||
|
CertificateBuilder.Create("CN=ScadaBridge#125 receiver").SetRSAKeySize(2048).CreateForRSA();
|
||||||
|
|
||||||
|
private static async Task<UserNameIdentityToken> EncryptAsync(
|
||||||
|
IUserIdentityTokenHandler handler, Certificate cert, string policyUri, byte[] serverNonce)
|
||||||
|
{
|
||||||
|
var context = ServiceMessageContext.CreateEmpty(DefaultTelemetry.Create(_ => { }));
|
||||||
|
await handler.EncryptAsync(cert, serverNonce, policyUri, context);
|
||||||
|
return Assert.IsType<UserNameIdentityToken>(handler.Token);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The unmodified SDK 2 server path: what an SDK 2 OtOpcUa server does with the token on ActivateSession.
|
||||||
|
private static async Task<byte[]?> ServerDecryptAsync(
|
||||||
|
UserNameIdentityToken token, Certificate cert, string policyUri, byte[] serverNonce)
|
||||||
|
{
|
||||||
|
var context = ServiceMessageContext.CreateEmpty(DefaultTelemetry.Create(_ => { }));
|
||||||
|
var policy = SecurityPolicies.Default.GetInfo(policyUri)!;
|
||||||
|
var server = new UserNameIdentityTokenHandler(token);
|
||||||
|
await server.DecryptAsync(cert, Nonce.CreateNonce(policy, serverNonce), policyUri, context);
|
||||||
|
return server.DecryptedPassword;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static byte[] ServerNonce(string policyUri) =>
|
||||||
|
Nonce.CreateNonce(SecurityPolicies.Default.GetInfo(policyUri)!.SecureChannelNonceLength).Data!;
|
||||||
|
|
||||||
|
/// <summary>A production-length API key travels in the format an SDK 1.5 server decrypts, and an SDK 2 server still reads it.</summary>
|
||||||
|
[Theory]
|
||||||
|
[InlineData(SecurityPolicies.Basic256Sha256, RsaOaep)]
|
||||||
|
[InlineData(SecurityPolicies.Aes128_Sha256_RsaOaep, RsaOaep)]
|
||||||
|
[InlineData(SecurityPolicies.Aes256_Sha256_RsaPss, RsaOaepSha256)]
|
||||||
|
public async Task ProductionLengthApiKey_IsSentInTheLegacyFormat(string policyUri, string sdk15RequiredAlgorithm)
|
||||||
|
{
|
||||||
|
using var cert = ServerCertificate();
|
||||||
|
var key = ProductionLengthKey();
|
||||||
|
var nonce = ServerNonce(policyUri);
|
||||||
|
var identity = OpcUaUserIdentities.Build(
|
||||||
|
new OpcUaUserIdentityOptions("UsernamePassword", "apikey", key, null!, null!))!;
|
||||||
|
|
||||||
|
var token = await EncryptAsync(identity.TokenHandler, cert, policyUri, nonce);
|
||||||
|
|
||||||
|
Assert.Equal("apikey", token.UserName);
|
||||||
|
// An SDK 1.5 server rejects any other algorithm URI (null is RsaEncryptedSecret) as BadIdentityTokenInvalid.
|
||||||
|
Assert.Equal(sdk15RequiredAlgorithm, token.EncryptionAlgorithm);
|
||||||
|
Assert.NotEqual(Encoding.UTF8.GetBytes(key), token.Password.ToArray());
|
||||||
|
Assert.Equal(Encoding.UTF8.GetBytes(key), await ServerDecryptAsync(token, cert, policyUri, nonce));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Control: pins the SDK behaviour the handler exists for. If a later SDK stops choosing
|
||||||
|
/// RsaEncryptedSecret for a long password, this fails and the workaround can be revisited.
|
||||||
|
/// </summary>
|
||||||
|
[Fact]
|
||||||
|
public async Task Control_TheSdkDefaultHandler_SendsRsaEncryptedSecretAbove64Bytes()
|
||||||
|
{
|
||||||
|
using var cert = ServerCertificate();
|
||||||
|
var key = ProductionLengthKey();
|
||||||
|
var nonce = ServerNonce(SecurityPolicies.Basic256Sha256);
|
||||||
|
|
||||||
|
var longToken = await EncryptAsync(new UserIdentity("apikey", Encoding.UTF8.GetBytes(key)).TokenHandler,
|
||||||
|
cert, SecurityPolicies.Basic256Sha256, nonce);
|
||||||
|
Assert.Null(longToken.EncryptionAlgorithm);
|
||||||
|
|
||||||
|
var shortToken = await EncryptAsync(new UserIdentity("apikey", Encoding.UTF8.GetBytes(key[..64])).TokenHandler,
|
||||||
|
cert, SecurityPolicies.Basic256Sha256, nonce);
|
||||||
|
Assert.Equal(RsaOaep, shortToken.EncryptionAlgorithm);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Policy None is handed to the SDK handler unchanged.</summary>
|
||||||
|
[Fact]
|
||||||
|
public async Task PolicyNone_IsLeftToTheSdk()
|
||||||
|
{
|
||||||
|
using var cert = ServerCertificate();
|
||||||
|
var key = ProductionLengthKey();
|
||||||
|
|
||||||
|
var ours = await EncryptAsync(OpcUaUserIdentities.UserName("apikey", key).TokenHandler, cert,
|
||||||
|
SecurityPolicies.None, []);
|
||||||
|
var sdk = await EncryptAsync(new UserIdentity("apikey", Encoding.UTF8.GetBytes(key)).TokenHandler, cert,
|
||||||
|
SecurityPolicies.None, []);
|
||||||
|
|
||||||
|
Assert.Equal(sdk.EncryptionAlgorithm, ours.EncryptionAlgorithm);
|
||||||
|
Assert.Equal(sdk.Password.ToArray(), ours.Password.ToArray());
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>The SDK session encrypts <c>TokenHandler.Copy()</c>, so the copy must keep the legacy type.</summary>
|
||||||
|
[Fact]
|
||||||
|
public async Task TheSessionCopy_KeepsTheLegacyFormat()
|
||||||
|
{
|
||||||
|
using var cert = ServerCertificate();
|
||||||
|
var identity = OpcUaUserIdentities.UserName("apikey", ProductionLengthKey());
|
||||||
|
|
||||||
|
var copy = identity.TokenHandler.Copy();
|
||||||
|
|
||||||
|
Assert.IsType<LegacyRsaUserNameIdentityTokenHandler>(copy);
|
||||||
|
Assert.NotSame(identity.TokenHandler, copy);
|
||||||
|
Assert.True(copy.Equals(identity.TokenHandler));
|
||||||
|
var token = await EncryptAsync(copy, cert, SecurityPolicies.Basic256Sha256,
|
||||||
|
ServerNonce(SecurityPolicies.Basic256Sha256));
|
||||||
|
Assert.Equal(RsaOaep, token.EncryptionAlgorithm);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Token-type mapping: UserName uses the legacy handler, anonymous/unknown map to no identity.</summary>
|
||||||
|
[Fact]
|
||||||
|
public void Build_MapsTheConfiguredTokenType()
|
||||||
|
{
|
||||||
|
var userName = OpcUaUserIdentities.Build(
|
||||||
|
new OpcUaUserIdentityOptions("usernamepassword", "apikey", "k", null!, null!))!;
|
||||||
|
Assert.Equal("apikey", Assert.IsType<LegacyRsaUserNameIdentityTokenHandler>(userName.TokenHandler).UserName);
|
||||||
|
Assert.Equal(UserTokenType.UserName, userName.TokenType);
|
||||||
|
|
||||||
|
Assert.Null(OpcUaUserIdentities.Build(null));
|
||||||
|
Assert.Null(OpcUaUserIdentities.Build(new OpcUaUserIdentityOptions("Anonymous", null!, null!, null!, null!)));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>An X509 identity still fails fast on a missing PFX, before any session is created.</summary>
|
||||||
|
[Fact]
|
||||||
|
public void X509_MissingFile_FailsBeforeConnect()
|
||||||
|
{
|
||||||
|
var missing = Path.Combine(Path.GetTempPath(), $"sb125-missing-{Guid.NewGuid():N}.pfx");
|
||||||
|
Assert.ThrowsAny<Exception>(() => OpcUaUserIdentities.Build(
|
||||||
|
new OpcUaUserIdentityOptions("X509Certificate", null!, null!, missing, null!)));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>An X509 identity is built from a PFX with a private key and carries its thumbprint.</summary>
|
||||||
|
[Fact]
|
||||||
|
public void X509_FromPfx_BuildsACertificateIdentity()
|
||||||
|
{
|
||||||
|
using var cert = CertificateBuilder.Create("CN=ScadaBridge#125 user").SetRSAKeySize(2048).CreateForRSA();
|
||||||
|
var path = Path.Combine(Path.GetTempPath(), $"sb125-user-{Guid.NewGuid():N}.pfx");
|
||||||
|
File.WriteAllBytes(path, cert.Export(System.Security.Cryptography.X509Certificates.X509ContentType.Pfx, "pw"));
|
||||||
|
try
|
||||||
|
{
|
||||||
|
var identity = OpcUaUserIdentities.Build(
|
||||||
|
new OpcUaUserIdentityOptions("X509Certificate", null!, null!, path, "pw"))!;
|
||||||
|
Assert.Equal(UserTokenType.Certificate, identity.TokenType);
|
||||||
|
Assert.IsType<X509IdentityTokenHandler>(identity.TokenHandler);
|
||||||
|
}
|
||||||
|
finally
|
||||||
|
{
|
||||||
|
File.Delete(path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+95
@@ -0,0 +1,95 @@
|
|||||||
|
using Opc.Ua;
|
||||||
|
using ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Adapters;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Adapters;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// ScadaBridge#125: SDK 2's legacy boxing hands back SDK wrapper types where SDK 1.5 handed back
|
||||||
|
/// CLR ones. The DCL boundary must restore the SDK 1.5 payload shapes the codec, scripts and the
|
||||||
|
/// alarm mapper were written against, and must not alias SDK buffers.
|
||||||
|
/// </summary>
|
||||||
|
public class OpcUaValueBoundaryTests
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public void Scalars_KeepTheirClrTypes()
|
||||||
|
{
|
||||||
|
Assert.Equal(42, OpcUaValueBoundary.ToClr(Variant.From(42)));
|
||||||
|
Assert.Equal(42.5, OpcUaValueBoundary.ToClr(Variant.From(42.5)));
|
||||||
|
Assert.Equal(true, OpcUaValueBoundary.ToClr(Variant.From(true)));
|
||||||
|
Assert.Equal("abc", OpcUaValueBoundary.ToClr(Variant.From("abc")));
|
||||||
|
Assert.Equal((ushort)500, OpcUaValueBoundary.ToClr(Variant.From((ushort)500)));
|
||||||
|
Assert.Null(OpcUaValueBoundary.ToClr(Variant.Null));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void ByteString_BecomesAByteArray()
|
||||||
|
{
|
||||||
|
var value = OpcUaValueBoundary.ToClr(Variant.From(ByteString.From(new byte[] { 1, 2, 3 })));
|
||||||
|
Assert.Equal(new byte[] { 1, 2, 3 }, Assert.IsType<byte[]>(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void DateTime_BecomesAUtcDateTime_AndNoTimestampIsMinValue()
|
||||||
|
{
|
||||||
|
var when = new DateTime(2026, 11, 12, 10, 30, 0, DateTimeKind.Utc);
|
||||||
|
var value = Assert.IsType<DateTime>(OpcUaValueBoundary.ToClr(Variant.From(when)));
|
||||||
|
Assert.Equal(when, value);
|
||||||
|
Assert.Equal(DateTimeKind.Utc, value.Kind);
|
||||||
|
|
||||||
|
Assert.Equal(DateTime.MinValue, OpcUaValueBoundary.ToClrTimestamp(DateTimeUtc.MinValue));
|
||||||
|
Assert.Equal(when, OpcUaValueBoundary.ToClrTimestamp(when));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Guid_BecomesASystemGuid()
|
||||||
|
{
|
||||||
|
var id = Guid.NewGuid();
|
||||||
|
Assert.Equal(id, Assert.IsType<Guid>(OpcUaValueBoundary.ToClr(Variant.From(new Uuid(id)))));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Int32Array_BecomesADetachedClrArray()
|
||||||
|
{
|
||||||
|
var source = new[] { 1, 2, 3 };
|
||||||
|
var value = Assert.IsType<int[]>(OpcUaValueBoundary.ToClr(Variant.From((ArrayOf<int>)source)));
|
||||||
|
Assert.Equal(source, value);
|
||||||
|
Assert.NotSame(source, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void ToVariant_ByteArray_IsAByteStringScalar()
|
||||||
|
{
|
||||||
|
// SDK 1.5's new Variant(byte[]) was a ByteString scalar; a Byte[] array would change the wire type.
|
||||||
|
var variant = OpcUaValueBoundary.ToVariant(new byte[] { 9, 8 });
|
||||||
|
Assert.Equal(BuiltInType.ByteString, variant.TypeInfo.BuiltInType);
|
||||||
|
Assert.Equal(ValueRanks.Scalar, variant.TypeInfo.ValueRank);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void ToVariant_Int32Array_IsAOneDimensionalInt32Array_AndCopiesTheBuffer()
|
||||||
|
{
|
||||||
|
var source = new[] { 4, 5, 6 };
|
||||||
|
var variant = OpcUaValueBoundary.ToVariant(source);
|
||||||
|
source[0] = 99;
|
||||||
|
|
||||||
|
Assert.Equal(BuiltInType.Int32, variant.TypeInfo.BuiltInType);
|
||||||
|
Assert.Equal(ValueRanks.OneDimension, variant.TypeInfo.ValueRank);
|
||||||
|
Assert.Equal(new[] { 4, 5, 6 }, Assert.IsType<int[]>(OpcUaValueBoundary.ToClr(variant)));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void ToVariant_Scalars_MapToTheirBuiltInType()
|
||||||
|
{
|
||||||
|
Assert.Equal(BuiltInType.Double, OpcUaValueBoundary.ToVariant(1.5).TypeInfo.BuiltInType);
|
||||||
|
Assert.Equal(BuiltInType.Boolean, OpcUaValueBoundary.ToVariant(true).TypeInfo.BuiltInType);
|
||||||
|
Assert.Equal(BuiltInType.String, OpcUaValueBoundary.ToVariant("x").TypeInfo.BuiltInType);
|
||||||
|
Assert.True(OpcUaValueBoundary.ToVariant(null).IsNull);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void ToVariant_UnsupportedType_Throws()
|
||||||
|
{
|
||||||
|
Assert.Throws<ArgumentException>(() => OpcUaValueBoundary.ToVariant(new object()));
|
||||||
|
Assert.Throws<ArgumentException>(() => OpcUaValueBoundary.ToVariant(new int[2, 2]));
|
||||||
|
}
|
||||||
|
}
|
||||||
+5
-4
@@ -187,11 +187,12 @@ public class OpcUaWriteCoercionTests
|
|||||||
[Fact]
|
[Fact]
|
||||||
public void Coerced_string_becomes_a_typed_variant()
|
public void Coerced_string_becomes_a_typed_variant()
|
||||||
{
|
{
|
||||||
// The #58 failure: new Variant("True") is a String Variant. After coercion it is Boolean.
|
// The #58 failure: "True" written as-is is a String Variant. After coercion it is Boolean.
|
||||||
|
// OpcUaValueBoundary.ToVariant is what RealOpcUaClient wraps each write value with.
|
||||||
var coerced = OpcUaWriteCoercion.Coerce("True", BuiltInType.Boolean).Value;
|
var coerced = OpcUaWriteCoercion.Coerce("True", BuiltInType.Boolean).Value;
|
||||||
|
|
||||||
Assert.Equal(BuiltInType.String, new Variant("True").TypeInfo.BuiltInType);
|
Assert.Equal(BuiltInType.String, OpcUaValueBoundary.ToVariant("True").TypeInfo.BuiltInType);
|
||||||
Assert.Equal(BuiltInType.Boolean, new Variant(coerced).TypeInfo.BuiltInType);
|
Assert.Equal(BuiltInType.Boolean, OpcUaValueBoundary.ToVariant(coerced).TypeInfo.BuiltInType);
|
||||||
Assert.Equal(ValueRanks.Scalar, new Variant(coerced).TypeInfo.ValueRank);
|
Assert.Equal(ValueRanks.Scalar, OpcUaValueBoundary.ToVariant(coerced).TypeInfo.ValueRank);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+13
-13
@@ -31,20 +31,20 @@ public class RealOpcUaAlarmLastStateTests
|
|||||||
|
|
||||||
private static void Emit(RealOpcUaClient client, string condition, bool active, bool acked, List<NativeAlarmTransition> sink)
|
private static void Emit(RealOpcUaClient client, string condition, bool active, bool acked, List<NativeAlarmTransition> sink)
|
||||||
{
|
{
|
||||||
var fields = new VariantCollection
|
var fields = new Variant[]
|
||||||
{
|
{
|
||||||
new(ObjectTypeIds.AlarmConditionType), // 0 EventType
|
Variant.From(ObjectTypeIds.AlarmConditionType), // 0 EventType
|
||||||
new(new NodeId("Tank01", 2)), // 1 SourceNode
|
Variant.From(new NodeId("Tank01", 2)), // 1 SourceNode
|
||||||
new("Tank01"), // 2 SourceName
|
Variant.From("Tank01"), // 2 SourceName
|
||||||
new(DateTime.UtcNow), // 3 Time
|
Variant.From(DateTime.UtcNow), // 3 Time
|
||||||
new(new LocalizedText("msg")), // 4 Message
|
Variant.From(new LocalizedText("msg")), // 4 Message
|
||||||
new((ushort)500), // 5 Severity
|
Variant.From((ushort)500), // 5 Severity
|
||||||
new(active), // 6 ActiveState/Id
|
Variant.From(active), // 6 ActiveState/Id
|
||||||
new(acked), // 7 AckedState/Id
|
Variant.From(acked), // 7 AckedState/Id
|
||||||
Variant.Null, // 8 ConfirmedState/Id
|
Variant.Null, // 8 ConfirmedState/Id
|
||||||
new(false), // 9 SuppressedOrShelved
|
Variant.From(false), // 9 SuppressedOrShelved
|
||||||
Variant.Null, // 10 ShelvingState
|
Variant.Null, // 10 ShelvingState
|
||||||
new(condition), // 11 ConditionName
|
Variant.From(condition), // 11 ConditionName
|
||||||
};
|
};
|
||||||
Handler.Invoke(client, [Handle, "ns=2;s=Tank01", new EventFieldList { EventFields = fields },
|
Handler.Invoke(client, [Handle, "ns=2;s=Tank01", new EventFieldList { EventFields = fields },
|
||||||
(Action<NativeAlarmTransition>)sink.Add]);
|
(Action<NativeAlarmTransition>)sink.Add]);
|
||||||
|
|||||||
+10
-10
@@ -17,8 +17,8 @@ public class RealOpcUaClientAlarmFilterTests
|
|||||||
public void BuildAlarmEventFilter_NoFilter_HasNoWhereClause()
|
public void BuildAlarmEventFilter_NoFilter_HasNoWhereClause()
|
||||||
{
|
{
|
||||||
var filter = RealOpcUaClient.BuildAlarmEventFilter(AlarmConditionFilter.AllowAll);
|
var filter = RealOpcUaClient.BuildAlarmEventFilter(AlarmConditionFilter.AllowAll);
|
||||||
Assert.NotEmpty(filter.SelectClauses);
|
Assert.NotEmpty(filter.SelectClauses.ToList());
|
||||||
Assert.Empty(filter.WhereClause.Elements);
|
Assert.Empty(filter.WhereClause.Elements.ToList());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that known condition types produce a non-empty where clause.</summary>
|
/// <summary>Verifies that known condition types produce a non-empty where clause.</summary>
|
||||||
@@ -28,11 +28,11 @@ public class RealOpcUaClientAlarmFilterTests
|
|||||||
var parsed = AlarmConditionFilter.Parse("LimitAlarmType,DiscreteAlarmType");
|
var parsed = AlarmConditionFilter.Parse("LimitAlarmType,DiscreteAlarmType");
|
||||||
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
||||||
|
|
||||||
Assert.NotEmpty(filter.WhereClause.Elements);
|
Assert.NotEmpty(filter.WhereClause.Elements.ToList());
|
||||||
// Two known types → two OfType operands (OR'd when more than one).
|
// Two known types → two OfType operands (OR'd when more than one).
|
||||||
var ofTypeCount = filter.WhereClause.Elements.Count(e => e.FilterOperator == FilterOperator.OfType);
|
var ofTypeCount = filter.WhereClause.Elements.ToList().Count(e => e.FilterOperator == FilterOperator.OfType);
|
||||||
Assert.Equal(2, ofTypeCount);
|
Assert.Equal(2, ofTypeCount);
|
||||||
Assert.Contains(filter.WhereClause.Elements, e => e.FilterOperator == FilterOperator.Or);
|
Assert.Contains(filter.WhereClause.Elements.ToList(), e => e.FilterOperator == FilterOperator.Or);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that a single known condition type produces a single of-type clause with no OR.</summary>
|
/// <summary>Verifies that a single known condition type produces a single of-type clause with no OR.</summary>
|
||||||
@@ -42,8 +42,8 @@ public class RealOpcUaClientAlarmFilterTests
|
|||||||
var parsed = AlarmConditionFilter.Parse("AlarmConditionType");
|
var parsed = AlarmConditionFilter.Parse("AlarmConditionType");
|
||||||
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
||||||
|
|
||||||
Assert.Single(filter.WhereClause.Elements);
|
Assert.Single(filter.WhereClause.Elements.ToList());
|
||||||
Assert.Equal(FilterOperator.OfType, filter.WhereClause.Elements[0].FilterOperator);
|
Assert.Equal(FilterOperator.OfType, filter.WhereClause.Elements.ToList()[0].FilterOperator);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that condition type matching is case-insensitive.</summary>
|
/// <summary>Verifies that condition type matching is case-insensitive.</summary>
|
||||||
@@ -52,7 +52,7 @@ public class RealOpcUaClientAlarmFilterTests
|
|||||||
{
|
{
|
||||||
var parsed = AlarmConditionFilter.Parse("limitalarmtype");
|
var parsed = AlarmConditionFilter.Parse("limitalarmtype");
|
||||||
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
||||||
Assert.Single(filter.WhereClause.Elements, e => e.FilterOperator == FilterOperator.OfType);
|
Assert.Single(filter.WhereClause.Elements.ToList(), e => e.FilterOperator == FilterOperator.OfType);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that a filter of only unknown types omits the where clause.</summary>
|
/// <summary>Verifies that a filter of only unknown types omits the where clause.</summary>
|
||||||
@@ -65,7 +65,7 @@ public class RealOpcUaClientAlarmFilterTests
|
|||||||
// unmapped types at the server and break correctness.
|
// unmapped types at the server and break correctness.
|
||||||
var parsed = AlarmConditionFilter.Parse("MyVendorCustomAlarm,AnotherCustomThing");
|
var parsed = AlarmConditionFilter.Parse("MyVendorCustomAlarm,AnotherCustomThing");
|
||||||
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
||||||
Assert.Empty(filter.WhereClause.Elements);
|
Assert.Empty(filter.WhereClause.Elements.ToList());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that a mix of known and unknown types omits the where clause.</summary>
|
/// <summary>Verifies that a mix of known and unknown types omits the where clause.</summary>
|
||||||
@@ -77,7 +77,7 @@ public class RealOpcUaClientAlarmFilterTests
|
|||||||
// and let the (authoritative) client gate do the filtering.
|
// and let the (authoritative) client gate do the filtering.
|
||||||
var parsed = AlarmConditionFilter.Parse("LimitAlarmType,MyVendorCustomAlarm");
|
var parsed = AlarmConditionFilter.Parse("LimitAlarmType,MyVendorCustomAlarm");
|
||||||
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
var filter = RealOpcUaClient.BuildAlarmEventFilter(parsed);
|
||||||
Assert.Empty(filter.WhereClause.Elements);
|
Assert.Empty(filter.WhereClause.Elements.ToList());
|
||||||
}
|
}
|
||||||
|
|
||||||
// ── SelectClause index alignment ───────────────────────────
|
// ── SelectClause index alignment ───────────────────────────
|
||||||
|
|||||||
+1
-1
@@ -78,7 +78,7 @@ public class RealOpcUaDiscoveryBoundTests
|
|||||||
async ct =>
|
async ct =>
|
||||||
{
|
{
|
||||||
await Task.Delay(Timeout.Infinite, ct);
|
await Task.Delay(Timeout.Infinite, ct);
|
||||||
return new Opc.Ua.EndpointDescriptionCollection();
|
return (IReadOnlyList<Opc.Ua.EndpointDescription>)[];
|
||||||
},
|
},
|
||||||
cts.Token));
|
cts.Token));
|
||||||
}
|
}
|
||||||
|
|||||||
+38
-1
@@ -216,6 +216,42 @@ public sealed class RealOpcUaSecureConnectTests : IDisposable
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// ScadaBridge#125 / lmxopcua#880: a production-length (65-character) API key logs in over every
|
||||||
|
/// security mode, end to end through the real adapter, and a wrong key of the same length reaches
|
||||||
|
/// the server's key check (<c>BadIdentityTokenRejected</c>) rather than failing to decrypt
|
||||||
|
/// (<c>BadIdentityTokenInvalid</c>). The server here is SDK 2, which reads both password formats;
|
||||||
|
/// the SDK 1.5 direction is covered by the wire-compat harness and the handler's own tests.
|
||||||
|
/// </summary>
|
||||||
|
[Theory]
|
||||||
|
[InlineData("None")]
|
||||||
|
[InlineData("Sign")]
|
||||||
|
[InlineData("SignAndEncrypt")]
|
||||||
|
public async Task Connect_ProductionLengthApiKey_IsAdmitted_AndAWrongKeyReachesTheKeyCheck(string mode)
|
||||||
|
{
|
||||||
|
var key = OpcUaUserIdentitiesTests.ProductionLengthKey();
|
||||||
|
using var clientCert = await ProvisionClientAsync();
|
||||||
|
await using var server = await SecureOpcUaTestServer.StartWithApiKeyAsync(key, clientCert);
|
||||||
|
ClientTrusts(server.Certificate);
|
||||||
|
|
||||||
|
OpcUaConnectionOptions WithKey(string password) => Secured(mode) with
|
||||||
|
{
|
||||||
|
UserIdentity = new OpcUaUserIdentityOptions("UsernamePassword", "apikey", password, null!, null!),
|
||||||
|
};
|
||||||
|
|
||||||
|
await using (var client = new RealOpcUaClient(ClientOptions()))
|
||||||
|
{
|
||||||
|
await client.ConnectAsync(server.Url, WithKey(key));
|
||||||
|
Assert.Equal(0u, (await client.ReadValueAsync(ServerStateNode)).StatusCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
var wrong = key[..^1] + (key[^1] == 'A' ? 'B' : 'A');
|
||||||
|
await using var refused = new RealOpcUaClient(ClientOptions());
|
||||||
|
var ex = await Assert.ThrowsAsync<Opc.Ua.ServiceResultException>(
|
||||||
|
() => refused.ConnectAsync(server.Url, WithKey(wrong)));
|
||||||
|
Assert.Equal(Opc.Ua.StatusCodes.BadIdentityTokenRejected, ex.StatusCode);
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>None is unchanged: it connects without reading or creating the own store.</summary>
|
/// <summary>None is unchanged: it connects without reading or creating the own store.</summary>
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task Connect_None_DoesNotTouchTheOwnStore()
|
public async Task Connect_None_DoesNotTouchTheOwnStore()
|
||||||
@@ -245,7 +281,8 @@ public sealed class RealOpcUaSecureConnectTests : IDisposable
|
|||||||
using var again = await ProvisionClientAsync();
|
using var again = await ProvisionClientAsync();
|
||||||
Assert.Equal(certs[0].Thumbprint, again.Thumbprint);
|
Assert.Equal(certs[0].Thumbprint, again.Thumbprint);
|
||||||
Assert.Single(Directory.GetFiles(OwnCertsDir, "*.der"));
|
Assert.Single(Directory.GetFiles(OwnCertsDir, "*.der"));
|
||||||
Assert.True(Opc.Ua.X509Utils.CompareApplicationUriWithCertificate(again, "urn:localhost:SB121Client", out _),
|
using var wrapped = new Opc.Ua.Security.Certificates.Certificate(again.RawData);
|
||||||
|
Assert.True(Opc.Ua.X509Utils.CompareApplicationUriWithCertificate(wrapped, "urn:localhost:SB121Client", out _),
|
||||||
"the certificate carries the configured ApplicationUri");
|
"the certificate carries the configured ApplicationUri");
|
||||||
}
|
}
|
||||||
finally
|
finally
|
||||||
|
|||||||
+1
-1
@@ -15,7 +15,7 @@ public class RealOpcUaSnapshotScopeTests
|
|||||||
var events = new List<NativeAlarmTransition>();
|
var events = new List<NativeAlarmTransition>();
|
||||||
var handler = typeof(RealOpcUaClient).GetMethod("HandleAlarmEvent", BindingFlags.Instance | BindingFlags.NonPublic)!;
|
var handler = typeof(RealOpcUaClient).GetMethod("HandleAlarmEvent", BindingFlags.Instance | BindingFlags.NonPublic)!;
|
||||||
void Emit(string handle, string source, NodeId type) => handler.Invoke(client,
|
void Emit(string handle, string source, NodeId type) => handler.Invoke(client,
|
||||||
[handle, source, new EventFieldList { EventFields = new VariantCollection { new(type), new(), new(), new(), new(), new() } }, (Action<NativeAlarmTransition>)events.Add]);
|
[handle, source, new EventFieldList { EventFields = new Variant[] { Variant.From(type), Variant.Null, Variant.Null, Variant.Null, Variant.Null, Variant.Null } }, (Action<NativeAlarmTransition>)events.Add]);
|
||||||
Emit("a", "A", ObjectTypeIds.RefreshStartEventType);
|
Emit("a", "A", ObjectTypeIds.RefreshStartEventType);
|
||||||
Emit("b", "B", ObjectTypeIds.RefreshStartEventType);
|
Emit("b", "B", ObjectTypeIds.RefreshStartEventType);
|
||||||
Emit("a", "A", ObjectTypeIds.RefreshEndEventType);
|
Emit("a", "A", ObjectTypeIds.RefreshEndEventType);
|
||||||
|
|||||||
+71
-10
@@ -3,7 +3,9 @@ using System.Net.Sockets;
|
|||||||
using System.Security.Cryptography.X509Certificates;
|
using System.Security.Cryptography.X509Certificates;
|
||||||
using Opc.Ua;
|
using Opc.Ua;
|
||||||
using Opc.Ua.Configuration;
|
using Opc.Ua.Configuration;
|
||||||
|
using Opc.Ua.Identity;
|
||||||
using Opc.Ua.Server;
|
using Opc.Ua.Server;
|
||||||
|
using Opc.Ua.Server.Hosting;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Adapters;
|
namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests.Adapters;
|
||||||
|
|
||||||
@@ -35,7 +37,22 @@ internal sealed class SecureOpcUaTestServer : IAsyncDisposable
|
|||||||
/// <summary>Starts a server that trusts exactly <paramref name="trustedClients"/>.</summary>
|
/// <summary>Starts a server that trusts exactly <paramref name="trustedClients"/>.</summary>
|
||||||
/// <param name="trustedClients">Client certificates the server's trusted peer store holds at start.</param>
|
/// <param name="trustedClients">Client certificates the server's trusted peer store holds at start.</param>
|
||||||
/// <returns>The running server.</returns>
|
/// <returns>The running server.</returns>
|
||||||
public static async Task<SecureOpcUaTestServer> StartAsync(params X509Certificate2[] trustedClients)
|
public static Task<SecureOpcUaTestServer> StartAsync(params X509Certificate2[] trustedClients) =>
|
||||||
|
StartCoreAsync(apiKey: null, trustedClients);
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Starts a server that also admits the UserName <c>apikey</c> with exactly
|
||||||
|
/// <paramref name="apiKey"/> as its password (ScadaBridge#125), and refuses any other password
|
||||||
|
/// with <c>BadIdentityTokenRejected</c> once it has decrypted the token. The UserName token
|
||||||
|
/// policy is Basic256Sha256, so the password is encrypted on every channel, None included.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="apiKey">The one password the server accepts.</param>
|
||||||
|
/// <param name="trustedClients">Client certificates the server's trusted peer store holds at start.</param>
|
||||||
|
/// <returns>The running server.</returns>
|
||||||
|
public static Task<SecureOpcUaTestServer> StartWithApiKeyAsync(string apiKey, params X509Certificate2[] trustedClients) =>
|
||||||
|
StartCoreAsync(apiKey, trustedClients);
|
||||||
|
|
||||||
|
private static async Task<SecureOpcUaTestServer> StartCoreAsync(string? apiKey, X509Certificate2[] trustedClients)
|
||||||
{
|
{
|
||||||
var pkiRoot = Path.Combine(Path.GetTempPath(), "sb121-server", Guid.NewGuid().ToString("N"));
|
var pkiRoot = Path.Combine(Path.GetTempPath(), "sb121-server", Guid.NewGuid().ToString("N"));
|
||||||
var port = FreePort();
|
var port = FreePort();
|
||||||
@@ -47,7 +64,8 @@ internal sealed class SecureOpcUaTestServer : IAsyncDisposable
|
|||||||
foreach (var c in trustedClients)
|
foreach (var c in trustedClients)
|
||||||
await File.WriteAllBytesAsync(Path.Combine(trustedCerts, $"{c.Thumbprint}.der"), c.RawData);
|
await File.WriteAllBytesAsync(Path.Combine(trustedCerts, $"{c.Thumbprint}.der"), c.RawData);
|
||||||
|
|
||||||
var config = new ApplicationConfiguration
|
var telemetry = DefaultTelemetry.Create(_ => { });
|
||||||
|
var config = new ApplicationConfiguration(telemetry)
|
||||||
{
|
{
|
||||||
ApplicationName = "SB121TestServer",
|
ApplicationName = "SB121TestServer",
|
||||||
ApplicationUri = $"urn:localhost:SB121TestServer:{port}",
|
ApplicationUri = $"urn:localhost:SB121TestServer:{port}",
|
||||||
@@ -70,30 +88,35 @@ internal sealed class SecureOpcUaTestServer : IAsyncDisposable
|
|||||||
TransportQuotas = new TransportQuotas { OperationTimeout = 15_000 },
|
TransportQuotas = new TransportQuotas { OperationTimeout = 15_000 },
|
||||||
ServerConfiguration = new ServerConfiguration
|
ServerConfiguration = new ServerConfiguration
|
||||||
{
|
{
|
||||||
BaseAddresses = { url },
|
BaseAddresses = [url],
|
||||||
SecurityPolicies =
|
SecurityPolicies =
|
||||||
{
|
[
|
||||||
new ServerSecurityPolicy { SecurityMode = MessageSecurityMode.None, SecurityPolicyUri = SecurityPolicies.None },
|
new ServerSecurityPolicy { SecurityMode = MessageSecurityMode.None, SecurityPolicyUri = SecurityPolicies.None },
|
||||||
new ServerSecurityPolicy { SecurityMode = MessageSecurityMode.Sign, SecurityPolicyUri = SecurityPolicies.Basic256Sha256 },
|
new ServerSecurityPolicy { SecurityMode = MessageSecurityMode.Sign, SecurityPolicyUri = SecurityPolicies.Basic256Sha256 },
|
||||||
new ServerSecurityPolicy { SecurityMode = MessageSecurityMode.SignAndEncrypt, SecurityPolicyUri = SecurityPolicies.Basic256Sha256 },
|
new ServerSecurityPolicy { SecurityMode = MessageSecurityMode.SignAndEncrypt, SecurityPolicyUri = SecurityPolicies.Basic256Sha256 },
|
||||||
},
|
],
|
||||||
UserTokenPolicies = { new UserTokenPolicy(UserTokenType.Anonymous) },
|
UserTokenPolicies = apiKey is null
|
||||||
|
? [new UserTokenPolicy(UserTokenType.Anonymous)]
|
||||||
|
: [new UserTokenPolicy(UserTokenType.Anonymous),
|
||||||
|
new UserTokenPolicy(UserTokenType.UserName) { SecurityPolicyUri = SecurityPolicies.Basic256Sha256 }],
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
await config.ValidateAsync(ApplicationType.Server);
|
await config.ValidateAsync(ApplicationType.Server);
|
||||||
|
|
||||||
var telemetry = DefaultTelemetry.Create(_ => { });
|
|
||||||
var app = new ApplicationInstance(config, telemetry)
|
var app = new ApplicationInstance(config, telemetry)
|
||||||
{
|
{
|
||||||
ApplicationName = config.ApplicationName,
|
ApplicationName = config.ApplicationName,
|
||||||
ApplicationType = ApplicationType.Server,
|
ApplicationType = ApplicationType.Server,
|
||||||
};
|
};
|
||||||
await app.CheckApplicationInstanceCertificatesAsync(silent: true, lifeTimeInMonths: 12);
|
await app.CheckApplicationInstanceCertificatesAsync(silent: true, lifeTimeInMonths: 12);
|
||||||
await app.StartAsync(new StandardServer());
|
await app.StartAsync(new TestServer(telemetry, apiKey));
|
||||||
|
|
||||||
var cert = X509CertificateLoader.LoadCertificate(
|
// SDK 2: the loaded application certificate lives in the certificate manager, not on the identifier.
|
||||||
config.SecurityConfiguration.ApplicationCertificate.Certificate.RawData);
|
using var entry = config.CertificateManager.AcquireApplicationCertificateByType(
|
||||||
|
ObjectTypeIds.RsaSha256ApplicationCertificateType)
|
||||||
|
?? throw new InvalidOperationException("The test server has no application certificate.");
|
||||||
|
var cert = X509CertificateLoader.LoadCertificate(entry.Certificate.RawData);
|
||||||
return new SecureOpcUaTestServer(app, pkiRoot, url, cert);
|
return new SecureOpcUaTestServer(app, pkiRoot, url, cert);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -105,6 +128,44 @@ internal sealed class SecureOpcUaTestServer : IAsyncDisposable
|
|||||||
try { Directory.Delete(_pkiRoot, recursive: true); } catch { /* best-effort */ }
|
try { Directory.Delete(_pkiRoot, recursive: true); } catch { /* best-effort */ }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>A <see cref="StandardServer"/> that registers the API-key authenticator before it starts.</summary>
|
||||||
|
private sealed class TestServer : StandardServer
|
||||||
|
{
|
||||||
|
public TestServer(ITelemetryContext telemetry, string? apiKey) : base(telemetry)
|
||||||
|
{
|
||||||
|
if (apiKey is not null)
|
||||||
|
AddPreStartupTask(new RegisterAuthenticator(new ApiKeyAuthenticator(apiKey)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private sealed class RegisterAuthenticator(IUserTokenAuthenticator authenticator) : IServerPreStartupTask
|
||||||
|
{
|
||||||
|
public ValueTask OnServerStartingAsync(IServerContext server, CancellationToken cancellationToken = default)
|
||||||
|
{
|
||||||
|
((IServerInternal)server).IdentityRegistry.Register(authenticator);
|
||||||
|
return ValueTask.CompletedTask;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private sealed class ApiKeyAuthenticator(string apiKey) : IUserTokenAuthenticator
|
||||||
|
{
|
||||||
|
public UserTokenType TokenType => UserTokenType.UserName;
|
||||||
|
|
||||||
|
public string? IssuedTokenProfileUri => null;
|
||||||
|
|
||||||
|
public ValueTask<AuthenticationResult> AuthenticateAsync(AuthenticationContext context, CancellationToken ct = default)
|
||||||
|
{
|
||||||
|
if (context.TokenHandler is not UserNameIdentityTokenHandler userName)
|
||||||
|
return ValueTask.FromResult(AuthenticationResult.NotHandled);
|
||||||
|
var accepted = userName.UserName == "apikey"
|
||||||
|
&& userName.DecryptedPassword is { } password
|
||||||
|
&& System.Text.Encoding.UTF8.GetString(password) == apiKey;
|
||||||
|
return ValueTask.FromResult(accepted
|
||||||
|
? AuthenticationResult.Accept(new UserIdentity(userName))
|
||||||
|
: AuthenticationResult.Reject(new ServiceResult(StatusCodes.BadIdentityTokenRejected)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private static int FreePort()
|
private static int FreePort()
|
||||||
{
|
{
|
||||||
var l = new TcpListener(IPAddress.Loopback, 0);
|
var l = new TcpListener(IPAddress.Loopback, 0);
|
||||||
|
|||||||
@@ -34,8 +34,9 @@ public class OpcUaDataTypeNameMapTests
|
|||||||
// Look up the well-known DataType NodeId by its standard name on
|
// Look up the well-known DataType NodeId by its standard name on
|
||||||
// DataTypeIds (e.g. DataTypeIds.Double) so the test mirrors exactly
|
// DataTypeIds (e.g. DataTypeIds.Double) so the test mirrors exactly
|
||||||
// the constants the helper maps against.
|
// the constants the helper maps against.
|
||||||
var field = typeof(DataTypeIds).GetField(typeName)!;
|
// SDK 2 (ScadaBridge#125) exposes the ids as static properties, not fields.
|
||||||
var nodeId = (NodeId)field.GetValue(null)!;
|
var property = typeof(DataTypeIds).GetProperty(typeName)!;
|
||||||
|
var nodeId = (NodeId)property.GetValue(null)!;
|
||||||
|
|
||||||
Assert.Equal(typeName, OpcUaBuiltInTypeNames.Resolve(nodeId));
|
Assert.Equal(typeName, OpcUaBuiltInTypeNames.Resolve(nodeId));
|
||||||
}
|
}
|
||||||
|
|||||||
+18
-11
@@ -7,18 +7,25 @@ namespace ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Tests;
|
|||||||
/// <summary>ScadaBridge#117: quality follows the StatusCode severity bits, not "== 0".</summary>
|
/// <summary>ScadaBridge#117: quality follows the StatusCode severity bits, not "== 0".</summary>
|
||||||
public class OpcUaStatusCodeMappingTests
|
public class OpcUaStatusCodeMappingTests
|
||||||
{
|
{
|
||||||
|
// SDK 2 (ScadaBridge#125): StatusCodes members are StatusCode structs, not constants, so the
|
||||||
|
// cases are a TheoryData rather than InlineData.
|
||||||
|
public static TheoryData<uint, QualityCode> Cases => new()
|
||||||
|
{
|
||||||
|
{ StatusCodes.Good.Code, QualityCode.Good },
|
||||||
|
{ StatusCodes.GoodLocalOverride.Code, QualityCode.Good },
|
||||||
|
{ StatusCodes.GoodClamped.Code, QualityCode.Good },
|
||||||
|
{ StatusCodes.Good.Code | 0x0480u, QualityCode.Good }, // info bits set
|
||||||
|
{ StatusCodes.Uncertain.Code, QualityCode.Uncertain },
|
||||||
|
{ StatusCodes.UncertainLastUsableValue.Code, QualityCode.Uncertain },
|
||||||
|
{ StatusCodes.UncertainSensorNotAccurate.Code, QualityCode.Uncertain },
|
||||||
|
{ StatusCodes.Bad.Code, QualityCode.Bad },
|
||||||
|
{ StatusCodes.BadNodeIdUnknown.Code, QualityCode.Bad },
|
||||||
|
{ StatusCodes.BadResourceUnavailable.Code, QualityCode.Bad },
|
||||||
|
{ 0xC0000000u, QualityCode.Bad },
|
||||||
|
};
|
||||||
|
|
||||||
[Theory]
|
[Theory]
|
||||||
[InlineData(StatusCodes.Good, QualityCode.Good)]
|
[MemberData(nameof(Cases))]
|
||||||
[InlineData(StatusCodes.GoodLocalOverride, QualityCode.Good)]
|
|
||||||
[InlineData(StatusCodes.GoodClamped, QualityCode.Good)]
|
|
||||||
[InlineData(StatusCodes.Good | 0x0480u, QualityCode.Good)] // info bits set
|
|
||||||
[InlineData(StatusCodes.Uncertain, QualityCode.Uncertain)]
|
|
||||||
[InlineData(StatusCodes.UncertainLastUsableValue, QualityCode.Uncertain)]
|
|
||||||
[InlineData(StatusCodes.UncertainSensorNotAccurate, QualityCode.Uncertain)]
|
|
||||||
[InlineData(StatusCodes.Bad, QualityCode.Bad)]
|
|
||||||
[InlineData(StatusCodes.BadNodeIdUnknown, QualityCode.Bad)]
|
|
||||||
[InlineData(StatusCodes.BadResourceUnavailable, QualityCode.Bad)]
|
|
||||||
[InlineData(0xC0000000u, QualityCode.Bad)]
|
|
||||||
public void MapStatusCode_UsesSeverityBits(uint code, QualityCode expected) =>
|
public void MapStatusCode_UsesSeverityBits(uint code, QualityCode expected) =>
|
||||||
Assert.Equal(expected, OpcUaDataConnection.MapStatusCode(code));
|
Assert.Equal(expected, OpcUaDataConnection.MapStatusCode(code));
|
||||||
}
|
}
|
||||||
|
|||||||
+14
-9
@@ -109,12 +109,12 @@ public class VerifyEndpointResultMappingTests
|
|||||||
/// <summary>Verifies that ServiceResultException authentication status codes map to an auth-failed result.</summary>
|
/// <summary>Verifies that ServiceResultException authentication status codes map to an auth-failed result.</summary>
|
||||||
/// <param name="statusCode">The status code.</param>
|
/// <param name="statusCode">The status code.</param>
|
||||||
[Theory]
|
[Theory]
|
||||||
[InlineData(StatusCodes.BadUserAccessDenied)]
|
[InlineData(nameof(StatusCodes.BadUserAccessDenied))]
|
||||||
[InlineData(StatusCodes.BadIdentityTokenRejected)]
|
[InlineData(nameof(StatusCodes.BadIdentityTokenRejected))]
|
||||||
[InlineData(StatusCodes.BadIdentityTokenInvalid)]
|
[InlineData(nameof(StatusCodes.BadIdentityTokenInvalid))]
|
||||||
public void ServiceResultException_AuthCodes_MapToAuthFailed(uint statusCode)
|
public void ServiceResultException_AuthCodes_MapToAuthFailed(string statusCode)
|
||||||
{
|
{
|
||||||
var ex = new ServiceResultException(statusCode, "access denied");
|
var ex = new ServiceResultException(Status(statusCode), "access denied");
|
||||||
|
|
||||||
var result = RealOpcUaClient.MapVerifyOutcome(ex, null);
|
var result = RealOpcUaClient.MapVerifyOutcome(ex, null);
|
||||||
|
|
||||||
@@ -126,11 +126,11 @@ public class VerifyEndpointResultMappingTests
|
|||||||
/// <summary>Verifies that ServiceResultException connection status codes map to an unreachable result.</summary>
|
/// <summary>Verifies that ServiceResultException connection status codes map to an unreachable result.</summary>
|
||||||
/// <param name="statusCode">The status code.</param>
|
/// <param name="statusCode">The status code.</param>
|
||||||
[Theory]
|
[Theory]
|
||||||
[InlineData(StatusCodes.BadConnectionRejected)]
|
[InlineData(nameof(StatusCodes.BadConnectionRejected))]
|
||||||
[InlineData(StatusCodes.BadNotConnected)]
|
[InlineData(nameof(StatusCodes.BadNotConnected))]
|
||||||
public void ServiceResultException_ConnectionCodes_MapToUnreachable(uint statusCode)
|
public void ServiceResultException_ConnectionCodes_MapToUnreachable(string statusCode)
|
||||||
{
|
{
|
||||||
var ex = new ServiceResultException(statusCode, "no route");
|
var ex = new ServiceResultException(Status(statusCode), "no route");
|
||||||
|
|
||||||
var result = RealOpcUaClient.MapVerifyOutcome(ex, null);
|
var result = RealOpcUaClient.MapVerifyOutcome(ex, null);
|
||||||
|
|
||||||
@@ -138,6 +138,11 @@ public class VerifyEndpointResultMappingTests
|
|||||||
Assert.Equal(VerifyFailureKind.Unreachable, result.FailureKind);
|
Assert.Equal(VerifyFailureKind.Unreachable, result.FailureKind);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SDK 2 (ScadaBridge#125): StatusCodes members are StatusCode structs, not constants, so the
|
||||||
|
// theories name them and resolve the value here.
|
||||||
|
private static StatusCode Status(string name) =>
|
||||||
|
(StatusCode)typeof(StatusCodes).GetField(name)!.GetValue(null)!;
|
||||||
|
|
||||||
/// <summary>Verifies that a socket exception maps to an unreachable result.</summary>
|
/// <summary>Verifies that a socket exception maps to an unreachable result.</summary>
|
||||||
[Fact]
|
[Fact]
|
||||||
public void SocketException_MapsToUnreachable()
|
public void SocketException_MapsToUnreachable()
|
||||||
|
|||||||
Reference in New Issue
Block a user