- PROXY v2 header parsing is now the pure, total function `parse_v2_header(buf, limit) -> (SocketAddr, consumed)`; the async reader only reads bytes and delegates. This makes the parser reachable from tests and fuzz targets and keeps every index bounds-checked. - tests/proxy_v2_parser.rs: valid v4/v6 headers, bad signature, non-PROXY command, TLVs, every truncated prefix, oversized header, unsupported family, short address block, and a deterministic sweep over family/length. - fuzz/: cargo-fuzz targets `http_head` (scan_head + evaluate) and `proxy_v2` with invariants (no panic, no out-of-buffer consumption, family matches the header). Seeds for the HTTP head keep coverage useful; `make fuzz` runs 60 s per target. Both targets ran clean (7M and 3M executions). - docs/testing.md documents the fuzz workflow; .gitignore covers the generated corpus/artifacts. |
||
|---|---|---|
| .. | ||
| kb | ||
| research | ||
| api.md | ||
| configuration.md | ||
| deployment.md | ||
| disaster_recovery.md | ||
| minecraft-java.md | ||
| README.md | ||
| runbook.md | ||
| testing.md | ||
| troubleshooting.md | ||
| vds_compatibility.md | ||
Документация Rampart
Индекс всей документации проекта и правила её ведения. Точка входа — README.md; текущий статус и планы — TODO.md.
1. С чего начать
| Документ | Когда читать |
|---|---|
| deployment.md | Первый деплой edge-ноды и manager'а |
| configuration.md | Настройка config.toml, секция [xdp], переменные manager'а |
| runbook.md | Ежедневная эксплуатация и типовые операции |
2. Эксплуатация (how-to)
| Документ | О чём |
|---|---|
| runbook.md | Метрики, рестарты, снятие банов, аварийные процедуры |
| troubleshooting.md | Диагностика типовых проблем |
| disaster_recovery.md | Восстановление после отказа Redis/ноды |
| testing.md | Гейты, тесты, XDP-smoke на реальном ядре |
3. Справочник (reference)
| Документ | О чём |
|---|---|
| configuration.md | Все поля конфига и значения по умолчанию |
| api.md | HTTP API manager'а: аутентификация, эндпоинты |
| vds_compatibility.md | Ограничения окружений и ядер |
4. Протоколы
| Документ | О чём |
|---|---|
| minecraft-java.md | Minecraft-edge: Paper, PROXY protocol, закрытый backend |
5. Теория и исследования
| Раздел | О чём |
|---|---|
| kb/ | База знаний: анатомия атак, уровни защиты, практика (двуязычная) |
| research/ | Глубокие разборы: архитектура, eBPF, DDoS, Rust-производительность, конкуренты |
kb/ отвечает на вопрос «как это работает и как защищаться», research/ — на вопрос
«какое решение выбрать и почему». Статус проекта не живёт ни там, ни там — только в
TODO.md.
6. Как вести документацию
- Язык.
docs/— русский. Исключение: docs/kb/, где статьи двуязычные (## English/## Русский). Комментарии в коде — английский (TODO §0.8). - Один документ = одна задача. How-to начинается с цели («что получится в конце»), содержит копируемые команды и заканчивается проверкой результата.
- Reference синхронизируется с кодом в том же PR. Меняешь поле конфига, флаг CLI
или эндпоинт — правишь
configuration.md/api.mdтам же. Расхождение = баг. - Новый документ кладётся в подходящую категорию (2–4) и сразу добавляется в эту таблицу; если он является точкой входа — ссылка добавляется и в корневой README.
- Не размножай папки. Плоская структура
docs/*.md— норма; подпапка нужна только для серии документов (kb/,research/). - Имена файлов — kebab-case,
.md, без дат в имени; дата и версия — внутри документа. - Никаких битых ссылок. Перед коммитом:
grep -o '](\.\?[^)]*)' docs/*.mdи проверь, что цели существуют.