feat(security): per-client pre-auth API-key miss budget; widen IOpcUaUserAuthenticator with the remote endpoint (lmxopcua#751)
The #733 miss budget (MissBurst / MissRefillPerSecond) was process-wide, because the impersonation seam did not carry the client's address, so one noisy client could drain it for everybody while the known-id set was unavailable. - IOpcUaUserAuthenticator gains AuthenticateUserNameAsync(username, password, IPEndPoint? remoteEndpoint, ct) (default: ignore it and delegate); the server calls it. IApiKeyStore gains the matching FindAsync(..., IPAddress?, ...). - The SDK (1.5.378) exposes no client address publicly. SecureChannelRemoteEndpoint reads it from the TCP listener's private channel map by reflection (through the protected TransportListeners, exposed by OtOpcUaSdkServer), keyed by the session's secure channel id. Fail-soft: null => process-wide accounting only. - BoundedApiKeyStore charges a miss to the client's own bucket (keyed by IP address) and then to the process-wide one, which stays as the backstop. A refusal by either takes from neither; a hit refunds both. New options Security:ApiKeys:MissBurstPerEndpoint (10) / MissRefillPerSecondPerEndpoint (2), 0 disables; telemetry outcome endpoint_miss_budget. At most 4096 addresses are tracked; idle buckets are pruned and an address beyond the cap is charged process-wide only. Tests: BoundedApiKeyStorePerEndpointTests (noisy client vs quiet one, process-wide backstop, refund + refill, off switch, authenticator forwards the address) and over the wire ApiKeyMissBudgetPerEndpointTests (activation hands the authenticator the loopback endpoint; real authenticator + bounded store refuse a client's 3rd and 4th unknown key without a store read). Each new behaviour test fails with its fix mutated out. Host.Tests 224/0, OpcUaServer.Tests 1019/1 (the one failure is the wall-clock NodeManagerLockTimeBenchmarkTests under suite load; passes alone). Docs: security.md. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
@@ -303,7 +303,21 @@ public sealed class OpcUaApplicationHost : IAsyncDisposable
|
||||
}
|
||||
|
||||
private void OnImpersonateUser(ISession session, ImpersonateEventArgs args) =>
|
||||
HandleImpersonation(_userAuthenticator, args, _logger, _options.AllowAnonymous);
|
||||
HandleImpersonation(_userAuthenticator, args, _logger, _options.AllowAnonymous,
|
||||
// Only a UserName activation consults the endpoint (the per-client API-key miss budget, #751), so
|
||||
// the reflection walk is skipped for anonymous / X509.
|
||||
args.NewIdentity is UserNameIdentityToken ? ResolveRemoteEndpoint(session) : null);
|
||||
|
||||
/// <summary>The remote endpoint of the client activating <paramref name="session"/>, or null when unknown.</summary>
|
||||
/// <param name="session">The session being activated.</param>
|
||||
/// <returns>The client's IP endpoint, or null.</returns>
|
||||
/// <remarks>
|
||||
/// Read from the session's secure channel — the SDK raises impersonation without the request's channel
|
||||
/// context (<c>SecureChannelContext.Current</c> is obsolete in 1.5.378). A client that re-activates over
|
||||
/// a NEW channel after its old one closed resolves to null and is accounted process-wide only.
|
||||
/// </remarks>
|
||||
private System.Net.IPEndPoint? ResolveRemoteEndpoint(ISession? session) =>
|
||||
_server is OtOpcUaSdkServer sdk ? sdk.TryResolveRemoteEndpoint(session?.SecureChannelId) : null;
|
||||
|
||||
/// <summary>
|
||||
/// Pure(-ish) impersonation handler: extracted so unit tests can drive it without booting
|
||||
@@ -329,11 +343,14 @@ public sealed class OpcUaApplicationHost : IAsyncDisposable
|
||||
/// <param name="args">The impersonation event arguments to process.</param>
|
||||
/// <param name="logger">The logger for diagnostic output.</param>
|
||||
/// <param name="allowAnonymous">Whether anonymous sessions may connect.</param>
|
||||
/// <param name="remoteEndpoint">The activating client's IP endpoint when known (lmxopcua#751), handed to
|
||||
/// the authenticator for per-client accounting; null when it could not be resolved.</param>
|
||||
internal static void HandleImpersonation(
|
||||
IOpcUaUserAuthenticator authenticator,
|
||||
ImpersonateEventArgs args,
|
||||
ILogger logger,
|
||||
bool allowAnonymous = true)
|
||||
bool allowAnonymous = true,
|
||||
System.Net.IPEndPoint? remoteEndpoint = null)
|
||||
{
|
||||
if (args.NewIdentity is AnonymousIdentityToken anonymousToken)
|
||||
{
|
||||
@@ -367,7 +384,7 @@ public sealed class OpcUaApplicationHost : IAsyncDisposable
|
||||
try
|
||||
{
|
||||
result = authenticator
|
||||
.AuthenticateUserNameAsync(token.UserName ?? string.Empty, password, CancellationToken.None)
|
||||
.AuthenticateUserNameAsync(token.UserName ?? string.Empty, password, remoteEndpoint, CancellationToken.None)
|
||||
.GetAwaiter().GetResult();
|
||||
}
|
||||
catch (Exception ex)
|
||||
|
||||
Reference in New Issue
Block a user