Add a pluggable ban seam: BanChannel fans locally-decided bans out to IBanReporter sinks (Report/Retract) and the accept path enforces locally. CrowdSec is a write-only reporter living in UOContent (registered into the Core seam via BanChannel.Register) — it batches decisions onto a bounded, coalescing, drop-on-overflow queue and POSTs /v1/alerts with watcher creds, retry/backoff, and a bounded flush-on-stop. CrowdSec never enforces in-app. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
204 lines
7.3 KiB
C#
204 lines
7.3 KiB
C#
/*************************************************************************
|
|
* ModernUO *
|
|
* Copyright 2019-2026 - ModernUO Development Team *
|
|
* Email: hi@modernuo.com *
|
|
* File: CrowdSecReporterTests.cs *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation, either version 3 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
|
*************************************************************************/
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Net;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Server.Network.Bans.CrowdSec;
|
|
using Xunit;
|
|
|
|
namespace Server.Tests.Network.Bans;
|
|
|
|
public class CrowdSecReporterTests
|
|
{
|
|
private static CrowdSecSettings Settings() => new()
|
|
{
|
|
MachineId = "shard",
|
|
Password = "secret",
|
|
Origin = "modernuo",
|
|
ManualBanDuration = TimeSpan.FromHours(168)
|
|
};
|
|
|
|
[Fact]
|
|
public void BuildAlerts_DedupsByIp()
|
|
{
|
|
var now = DateTime.UnixEpoch;
|
|
var items = new List<CrowdSecReporter.ReportItem>
|
|
{
|
|
new(IPAddress.Parse("1.1.1.1"), TimeSpan.FromHours(1), "rate-limit", false),
|
|
new(IPAddress.Parse("1.1.1.1"), TimeSpan.FromHours(1), "rate-limit", false),
|
|
new(IPAddress.Parse("2.2.2.2"), TimeSpan.FromHours(1), "rate-limit", false)
|
|
};
|
|
|
|
var alerts = CrowdSecReporter.BuildAlerts(items, Settings(), now);
|
|
|
|
Assert.Equal(2, alerts.Count);
|
|
Assert.All(alerts, a => Assert.Single(a.Decisions));
|
|
Assert.Contains(alerts, a => a.Source.Value == "1.1.1.1");
|
|
Assert.Contains(alerts, a => a.Source.Value == "2.2.2.2");
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildAlerts_ScenarioFromReason_OriginFromSettings()
|
|
{
|
|
var alerts = CrowdSecReporter.BuildAlerts(
|
|
[new(IPAddress.Parse("3.3.3.3"), TimeSpan.FromHours(1), "manual", false)],
|
|
Settings(),
|
|
DateTime.UnixEpoch);
|
|
|
|
var decision = Assert.Single(alerts).Decisions[0];
|
|
Assert.Equal("modernuo/manual", alerts[0].Scenario);
|
|
Assert.Equal("modernuo", decision.Origin);
|
|
Assert.Equal("ban", decision.Type);
|
|
Assert.Equal("Ip", decision.Scope);
|
|
Assert.Equal("3.3.3.3", decision.Value);
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildAlerts_ScenarioFromReason_Blocklist()
|
|
{
|
|
var alerts = CrowdSecReporter.BuildAlerts(
|
|
[new(IPAddress.Parse("5.5.5.5"), TimeSpan.FromHours(1), "blocklist", false)],
|
|
Settings(),
|
|
DateTime.UnixEpoch);
|
|
|
|
var decision = Assert.Single(alerts).Decisions[0];
|
|
Assert.Equal("modernuo/blocklist", alerts[0].Scenario);
|
|
Assert.Equal("modernuo/blocklist", decision.Scenario);
|
|
}
|
|
|
|
[Fact]
|
|
public void FormatDuration_UsesSeconds_FloorsAtOne()
|
|
{
|
|
Assert.Equal("3600s", CrowdSecReporter.FormatDuration(TimeSpan.FromHours(1)));
|
|
Assert.Equal("1s", CrowdSecReporter.FormatDuration(TimeSpan.Zero));
|
|
Assert.Equal("1s", CrowdSecReporter.FormatDuration(TimeSpan.FromMilliseconds(10)));
|
|
}
|
|
|
|
[Fact]
|
|
public void Report_WhenQueueFull_DropsAndCounts()
|
|
{
|
|
var reporter = new CrowdSecReporter(new NullAlertClient(), new CrowdSecSettings
|
|
{
|
|
MachineId = "shard",
|
|
Password = "secret",
|
|
MaxQueue = 2
|
|
});
|
|
// Do NOT Start() the drain — so the queue fills and overflows deterministically.
|
|
|
|
for (var i = 0; i < 10; i++)
|
|
{
|
|
reporter.Report(IPAddress.Parse("4.4.4." + i), TimeSpan.FromHours(1), "rate-limit");
|
|
}
|
|
|
|
Assert.True(reporter.DroppedCount >= 8);
|
|
}
|
|
|
|
// Stop() without a prior Start() drives FlushRemainingOnStop() synchronously (no drain task, no
|
|
// Task.Delay backoff involved), so this is deterministic — no wall-clock timing dependency.
|
|
[Fact]
|
|
public void Stop_FlushesQueuedReports_ViaClient()
|
|
{
|
|
var client = new RecordingAlertClient();
|
|
var reporter = new CrowdSecReporter(client, Settings());
|
|
|
|
reporter.Report(IPAddress.Parse("6.6.6.6"), TimeSpan.FromHours(1), "rate-limit");
|
|
reporter.Stop();
|
|
|
|
var posted = Assert.Single(client.Posted);
|
|
Assert.Equal("6.6.6.6", Assert.Single(posted).Source.Value);
|
|
Assert.Equal(0, reporter.SendFailureCount);
|
|
}
|
|
|
|
[Fact]
|
|
public void Stop_FlushesQueuedRetracts_ViaClient()
|
|
{
|
|
var client = new RecordingAlertClient();
|
|
var reporter = new CrowdSecReporter(client, Settings());
|
|
|
|
reporter.Retract(IPAddress.Parse("8.8.8.8"));
|
|
reporter.Stop();
|
|
|
|
Assert.Equal(IPAddress.Parse("8.8.8.8"), Assert.Single(client.Deleted));
|
|
Assert.Equal(0, reporter.SendFailureCount);
|
|
}
|
|
|
|
[Fact]
|
|
public void Stop_WhenFlushSendFails_CountsSendFailure()
|
|
{
|
|
var reporter = new CrowdSecReporter(new ThrowingAlertClient(), Settings());
|
|
|
|
reporter.Report(IPAddress.Parse("7.7.7.7"), TimeSpan.FromHours(1), "rate-limit");
|
|
reporter.Stop();
|
|
|
|
Assert.Equal(1, reporter.SendFailureCount);
|
|
}
|
|
|
|
[Fact]
|
|
public void Stop_WithEmptyQueue_DoesNotInvokeClientOrFail()
|
|
{
|
|
var client = new RecordingAlertClient();
|
|
var reporter = new CrowdSecReporter(client, Settings());
|
|
|
|
reporter.Stop();
|
|
|
|
Assert.Empty(client.Posted);
|
|
Assert.Equal(0, reporter.SendFailureCount);
|
|
}
|
|
|
|
private sealed class NullAlertClient : ICrowdSecAlertClient
|
|
{
|
|
public ValueTask PostAlertsAsync(IReadOnlyList<CrowdSecAlert> alerts, CancellationToken token) =>
|
|
ValueTask.CompletedTask;
|
|
|
|
public ValueTask DeleteDecisionsAsync(string origin, IPAddress ip, CancellationToken token) =>
|
|
ValueTask.CompletedTask;
|
|
|
|
public void Dispose() { }
|
|
}
|
|
|
|
private sealed class RecordingAlertClient : ICrowdSecAlertClient
|
|
{
|
|
public List<IReadOnlyList<CrowdSecAlert>> Posted { get; } = [];
|
|
public List<IPAddress> Deleted { get; } = [];
|
|
|
|
public ValueTask PostAlertsAsync(IReadOnlyList<CrowdSecAlert> alerts, CancellationToken token)
|
|
{
|
|
Posted.Add(alerts);
|
|
return ValueTask.CompletedTask;
|
|
}
|
|
|
|
public ValueTask DeleteDecisionsAsync(string origin, IPAddress ip, CancellationToken token)
|
|
{
|
|
Deleted.Add(ip);
|
|
return ValueTask.CompletedTask;
|
|
}
|
|
|
|
public void Dispose() { }
|
|
}
|
|
|
|
private sealed class ThrowingAlertClient : ICrowdSecAlertClient
|
|
{
|
|
public ValueTask PostAlertsAsync(IReadOnlyList<CrowdSecAlert> alerts, CancellationToken token) =>
|
|
throw new InvalidOperationException("simulated LAPI outage");
|
|
|
|
public ValueTask DeleteDecisionsAsync(string origin, IPAddress ip, CancellationToken token) =>
|
|
ValueTask.CompletedTask;
|
|
|
|
public void Dispose() { }
|
|
}
|
|
}
|