feat(xdp): IPv6 UDP rate limit, working loader; English comments and docs

XDP behaviour:
- udp_rate_limit6 (LRU, full 128-bit source key) plus throttle_hit6, so
  udp_policy = "rate-limit" applies to native IPv6 as well.
- scripts/xdp_ipv6_smoke.sh: phase 4 patches .rodata before load and
  verifies policy=2 on a real kernel (3 pass / 3 rate-limited).

Loader (XDP could never load before this):
- .rodata is one struct rampart_config with frozen offsets enforced by
  _Static_assert; XdpGlobals is #[repr(C)] and the image is built with
  offset_of!. Before, a 96-byte image was written into a 76-byte map at
  offsets clang had reordered, so load() failed with EINVAL.
- patch_rodata fails loudly when the map size and image size diverge.
- build.rs tracks xdp/core and xdp/hooks, not just universal_filter.c.
- build_ringbuf looked for "events_map"; the map is "events_ringbuf".
- tests/xdp_object_maps.rs checks map names and .rodata size without root.

Docs and style:
- Code comments are English, JavaDoc/Rustdoc style, without emoji or
  banners (new project rule, TODO §0.8).
- README rewritten bilingual: Russian first, English below, nav buttons,
  compact TOC and copy-paste quick start.
- docs/README.md: documentation index and maintenance rules;
  configuration.md documents the whole [xdp] section and IPv4/IPv6
  coverage; testing.md covers the real-kernel smoke; stale links removed.
This commit is contained in:
Loki 2026-11-15 23:50:52 +01:00
parent b64c329125
commit a8a3057719
Signed by: boba
GPG key ID: 6CDE87BC9A778D97
104 changed files with 2155 additions and 1030 deletions

View file

@ -1,4 +1,4 @@
//! Wiring-логика edge-демона: сборка сервисов и главный цикл запуска.
//! Edge daemon wiring: service construction and the main run loop.
pub mod runtime;
pub mod services;

View file

@ -1,4 +1,5 @@
//! Runtime edge-демона: сборка компонентов, фоновые задачи и запуск listener.
//! Edge daemon runtime: component assembly, background tasks and listener
//! startup.
use crate::config::Config;
use crate::engine::challenge::DifficultyAdjuster;
@ -32,12 +33,12 @@ fn attack_status_value(status: AttackStatus) -> i64 {
}
}
/// Точка входа edge-демона (`rampart`): то, что делал `main` бинаря.
/// Entry point of the edge daemon (`rampart`).
///
/// Возвращает [`RunExit`] — выбор кода и самого завершения делает бинарь.
/// Returns [`RunExit`]; the binary decides whether and how the process ends.
///
/// # Errors
/// Ошибки старта: нечитаемый конфиг, пустой реестр протоколов, сбой listener.
/// Startup failures: unreadable config, empty protocol registry, listener error.
pub async fn run() -> anyhow::Result<RunExit> {
tracing_subscriber::fmt()
.with_env_filter(EnvFilter::from_default_env().add_directive("rampart=info".parse()?))
@ -163,7 +164,7 @@ pub async fn run() -> anyhow::Result<RunExit> {
let status = det.lock().expect("detector lock poisoned").analyze(pps, cps);
metrics::ATTACK_STATUS.set(attack_status_value(status));
if let Some(alert) = alert_dispatcher.on_status(status) {
// Дедупликация: алерт только на переходе состояния атаки.
// Deduplication: an alert is emitted only on an attack state transition.
metrics::INTEL_ALERTS_TOTAL.inc();
tracing::warn!(pps, cps, "{alert}");
push_attack_event(&ch, pps).await;
@ -208,8 +209,8 @@ pub async fn run() -> anyhow::Result<RunExit> {
result?;
Ok(RunExit::Ok)
}
// Drain-таймаут сработал: возвращаем сигнал бинарю завершить процесс
// немедленно, как это делал прежний `process::exit(0)`.
// The drain timeout fired: hand the signal back so the binary can end the
// process immediately, replacing the former `process::exit(0)`.
_ = drain_rx => Ok(RunExit::DrainTimeout),
}
}

View file

@ -1,4 +1,5 @@
//! Сервисы edge-демона: реестр протоколов, whitelist, XDP и subnet-трекер.
//! Edge daemon services: protocol registry, whitelist, XDP and the subnet
//! tracker.
use crate::config::Config;
use crate::engine::subnet::tracker::SubnetTracker;
@ -13,11 +14,11 @@ use std::sync::Arc;
use std::sync::Mutex;
use tokio::sync::watch;
/// Собирает реестр протоколов из скомпилированных реализаций.
/// Builds the protocol registry from the compiled handlers.
///
/// Обработчики поставляются фичами: `protocol-http` регистрирует
/// HTTP/1.1-обработчик с политикой из секции `[protocol.http]`.
/// Внешние крейты регистрируют свои обработчики в этом же месте.
/// Handlers are supplied by features: `protocol-http` registers the HTTP/1.1
/// handler with the policy from `[protocol.http]`. External crates register
/// their handlers at the same point.
pub(crate) fn build_registry(config: &Config) -> ProtocolRegistry {
#[cfg(feature = "protocol-minecraft")]
if config.protocol.minecraft.enabled {
@ -115,8 +116,8 @@ pub(crate) fn start_xdp(
Ok(None)
}
/// Юзерспейс-агрегатор префиксов: активен, когда detect.prefix включён,
/// а XDP-путь не работает (не собран или выключен в конфиге).
/// Userspace prefix aggregator: active when `detect.prefix` is enabled and the
/// XDP path does not run (not compiled in or disabled in the config).
pub(crate) fn start_subnet_tracker(config: &Config) -> Option<Arc<SubnetTracker>> {
let xdp_active = cfg!(feature = "xdp") && config.xdp.enabled;
if config.detect.prefix.enabled && !xdp_active {
@ -131,11 +132,12 @@ pub(crate) fn start_subnet_tracker(config: &Config) -> Option<Arc<SubnetTracker>
}
}
/// Store-фичи проверяются на старте edge-демона: конфиг, запрашивающий redis,
/// в бинаре без `store-redis` должен упасть сразу, а не молча потерять
/// blacklist-sync (sync-задача в runtime.rs живёт под тем же cfg).
/// Точка вызова — `build_whitelist`: ближайший `?`-хук, принимающий конфиг
/// до бинда listener'а (сам runtime.rs вне правок этой задачи).
/// Validates store features at edge startup: a config that asks for redis in a
/// binary without `store-redis` must fail immediately instead of silently losing
/// blacklist sync (the sync task in `runtime.rs` lives behind the same cfg).
///
/// Called from `build_whitelist`, the closest `?` hook that receives the config
/// before the listener binds.
fn ensure_store_features(config: &Config) -> anyhow::Result<()> {
#[cfg(not(feature = "store-redis"))]
if config.store.redis_url.as_deref().is_some_and(|url| !url.is_empty()) {
@ -146,6 +148,11 @@ fn ensure_store_features(config: &Config) -> anyhow::Result<()> {
Ok(())
}
/// Parses `whitelist` entries into a shared address set.
///
/// # Errors
/// Fails on an invalid entry or when the config requires store features that are
/// not compiled in.
pub(crate) fn build_whitelist(config: &Config) -> anyhow::Result<Arc<HashSet<IpAddr>>> {
ensure_store_features(config)?;
let mut set = HashSet::with_capacity(config.whitelist.len());
@ -191,10 +198,10 @@ mod tests {
assert!(ensure_store_features(&config_with_redis()).is_ok());
}
/// Wiring-тасовка XDP auto-ban: `start_xdp` обязан принимать `Arc<Blacklist>`
/// (т.е. существовать в сигнатуре с blacklist) и при выключенном `[xdp]`
/// не трогать ни ядро, ни blacklist. Порядок `set_autoban` -> `load()`
/// внутри enabled-ветки без ядра непроверяем — см. комментарий на месте вызова.
/// XDP auto-ban wiring: `start_xdp` must accept the `Arc<Blacklist>` and, with
/// `[xdp]` disabled, touch neither the kernel nor the blacklist. The
/// `set_autoban` -> `load()` order inside the enabled branch cannot be checked
/// without a kernel.
#[test]
fn start_xdp_accepts_blacklist_and_skips_kernel_when_disabled() {
let (_tx, rx) = watch::channel(false);

View file

@ -1,23 +1,23 @@
//! Shutdown-drain машина edge-демона: сигнал, drain-таймер и код завершения.
//! Edge daemon shutdown drain: signal handling, drain timer and exit code.
use std::time::Duration;
use tokio::sync::oneshot;
use tokio::sync::watch;
/// Результат завершения демона. Код выхода вычисляется здесь, но сам
/// `process::exit` вызывается только в точке входа бинаря (`src/bin/rampart.rs`),
/// поэтому библиотечный код остаётся свободным от lint `exit`.
/// Daemon exit outcome. The exit code is computed here, but `process::exit` is
/// only called from the binary entry point (`src/bin/rampart.rs`), which keeps
/// the library free of the `exit` lint.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RunExit {
/// Listener отработал штатно: drain уложился в таймаут.
/// The listener finished cleanly: the drain fit into the timeout.
Ok,
/// Истёк drain-таймаут: бинарь обязан завершить процесс немедленно
/// (замена прежнему `process::exit(0)` внутри shutdown-таймера).
/// The drain timeout expired: the binary must terminate the process immediately
/// (replaces the former `process::exit(0)` inside the shutdown timer).
DrainTimeout,
}
impl RunExit {
/// Код завершения процесса для данного результата.
/// Process exit code for this outcome.
#[must_use]
pub const fn code(self) -> i32 {
match self {
@ -27,11 +27,11 @@ impl RunExit {
}
}
/// Ставит фоновую shutdown-задачу.
/// Spawns the background shutdown task.
///
/// shutdown-таймер обязан завершить процесс: сам `process::exit` вынесен в
/// бинарь, а здесь мы лишь уведомляем `run` об истечении drain-таймаута через
/// oneshot-канал. Логи и тайминг (5s после сигнала) сохранены без изменений.
/// The timer must end the process, but `process::exit` now lives in the binary,
/// so this only reports the drain timeout to `run` over a oneshot channel. The
/// process is given five seconds to drain after the signal.
pub(crate) fn spawn_shutdown_drain(shutdown_tx: watch::Sender<bool>, drain_tx: oneshot::Sender<()>) {
tokio::spawn(async move {
wait_for_signal().await;
@ -60,7 +60,7 @@ mod tests {
#[test]
fn run_exit_codes_match_previous_process_exit() {
// Штатный путь и прежний drain-timeout (`process::exit(0)`) завершались с кодом 0.
// Both the clean path and the former drain timeout (`process::exit(0)`) exited with code 0.
assert_eq!(RunExit::Ok.code(), 0);
assert_eq!(RunExit::DrainTimeout.code(), 0);
}