docs: fill missing XML docs and strip tracking IDs from src comments
Clears CommentChecker findings in src/ (3,280 -> 209, the remainder being false positives like PLC-5/IEEE-754/M0.0) by adding missing summaries/params/returns, normalising inheritdoc usage, and removing Gitea/review tracking IDs while keeping the rationale they annotated. Comment-only: comment-stripped sources are identical to the parent commit.
This commit is contained in:
@@ -9,7 +9,7 @@ using ZB.MOM.WW.OtOpcUa.OpcUaServer.Security;
|
||||
namespace ZB.MOM.WW.OtOpcUa.Host.OpcUa;
|
||||
|
||||
/// <summary>
|
||||
/// Production <see cref="IOpcUaUserAuthenticator"/> for the machine-to-machine data plane (#520):
|
||||
/// Production <see cref="IOpcUaUserAuthenticator"/> for the machine-to-machine data plane:
|
||||
/// the client presents the static username <c>apikey</c> with an
|
||||
/// <c>otua_<keyId>_<secret></c> credential as the password. Replaces the LDAP adapter.
|
||||
/// </summary>
|
||||
@@ -156,12 +156,10 @@ public sealed class ApiKeyOpcUaUserAuthenticator : IOpcUaUserAuthenticator
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>
|
||||
/// Resolves the <c>anonymous</c> principal's grants through the same mapper a key's principal
|
||||
/// goes through, so anonymous is authorized by ordinary ACL rows rather than by a special case.
|
||||
/// Whether anonymous may connect at all is the host's decision
|
||||
/// (<c>OpcUa:AllowAnonymous</c>) and is settled before this is called.
|
||||
/// </remarks>
|
||||
// Resolves the <c>anonymous</c> principal's grants through the same mapper a key's principal
|
||||
// goes through, so anonymous is authorized by ordinary ACL rows rather than by a special case.
|
||||
// Whether anonymous may connect at all is the host's decision
|
||||
// (<c>OpcUa:AllowAnonymous</c>) and is settled before this is called.
|
||||
public async Task<OpcUaUserAuthResult> AuthenticateAnonymousAsync(CancellationToken ct)
|
||||
{
|
||||
IReadOnlyList<NodeAcl> grants;
|
||||
@@ -171,9 +169,9 @@ public sealed class ApiKeyOpcUaUserAuthenticator : IOpcUaUserAuthenticator
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
// Deny rather than admit-with-no-roles. Admitting would be the pre-#520 behaviour, and doing
|
||||
// Deny rather than admit-with-no-roles. Admitting would be the previous behaviour, and doing
|
||||
// it precisely when we could not read what anonymous is allowed to do is the wrong default:
|
||||
// once reads are gated (stage 6) a no-roles admission stops being harmless.
|
||||
// once reads are gated a no-roles admission stops being harmless.
|
||||
_log.LogError(ex, "ApiKeyAuth: key store threw resolving anonymous grants");
|
||||
return OpcUaUserAuthResult.Deny("Anonymous access is unavailable.");
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user