docs(PROJECT): актуализирована архитектура и структура директорий

- Добавлена директория strategies/ с описанием .conf файлов
- Уточнено, что general*.sh — обёртки run_strategy.sh <name>
- run_strategy.sh теперь читает .conf, а не собирает аргументы вручную
- Добавлен ensure_wrappers.sh в дерево проекта
This commit is contained in:
OpenCode Agent
2026-05-10 19:51:52 +04:00
parent e0b6c1e0d6
commit cec0a7b037
+176 -171
View File
@@ -1,171 +1,176 @@
# Zapret Discord + YouTube for Linux — Project Documentation # Zapret Discord + YouTube for Linux — Project Documentation
## Overview ## Overview
Linux-перенос проекта [Flowseal/zapret-discord-youtube](https://github.com/Flowseal/zapret-discord-youtube) (v1.9.8c) с полной автоматизацией установки, тестирования и обновления. Linux-перенос проекта [Flowseal/zapret-discord-youtube](https://github.com/Flowseal/zapret-discord-youtube) (v1.9.8c) с полной автоматизацией установки, тестирования и обновления.
**Архитектура:** **Архитектура:**
- `nfqws` (bol-van/zapret) — ядерный обработчик пакетов - `nfqws` (bol-van/zapret) — ядерный обработчик пакетов
- iptables/nftables + NFQUEUE — перехват трафика - iptables/nftables + NFQUEUE — перехват трафика
- 20 стратегий обхода DPI (fake, multisplit, fakedsplit, hostfakesplit, syndata и др.) - 20 стратегий обхода DPI (fake, multisplit, fakedsplit, hostfakesplit, syndata и др.), хранятся в `strategies/*.conf`
- systemd — сервисы и таймеры - systemd — сервисы и таймеры
--- ---
## Directory Map ## Directory Map
``` ```
zapret/ zapret/
├── bin/ # nfqws + fake .bin пакеты (собираются при install) ├── bin/ # nfqws + fake .bin пакеты (собираются при install)
├── lib/functions.sh # Общие: firewall setup/cleanup, colors, distro detect ├── lib/
├── lists/ # Домены и IP для обхода │ └── functions.sh # Общие: firewall setup/cleanup, colors, distro detect
├── list-general.txt # Discord, YouTube, Google, GitHub, Telegram, Steam ├── lists/ # Домены и IP для обхода
│ ├── list-google.txt # Google-специфичные домены │ ├── list-general.txt # Discord, YouTube, Google, GitHub, Telegram, Steam
│ ├── list-exclude.txt # Что НЕ трогать (банки, госуслуги) │ ├── list-google.txt # Google-специфичные домены
│ ├── ipset-all.txt # IP-диапазоны (placeholder → обновляется) │ ├── list-exclude.txt # Что НЕ трогать (банки, госуслуги)
── ipset-exclude.txt # локальные диапазоны ── ipset-all.txt # IP-диапазоны (placeholder → обновляется)
├── .service/ # Runtime-конфигурация + hosts │ └── ipset-exclude.txt # локальные диапазоны
│ ├── version.txt # Текущая версия ├── strategies/ # Конфиги стратегий (RULE1=...), конвертируются из .bat
│ ├── installed_strategy # Какая стратегия в systemd │ ├── general.conf
── hosts # Статичные IP для hosts (GitHub, Telegram, Discord) ── general_ALT2.conf
│ ├── game_filter_enabled # Флаг ├── .service/ # Runtime-конфигурация + hosts
── check_updates_enabled ── version.txt # Текущая версия
├── systemd/ │ ├── installed_strategy # Какая стратегия в systemd
│ ├── zapret.service │ ├── hosts # Статичные IP для hosts (GitHub, Telegram, Discord)
│ ├── zapret-update.service │ ├── game_filter_enabled # Флаг
│ └── zapret-update.timer │ └── check_updates_enabled
├── utils/ ├── systemd/
│ ├── test_zapret.sh # curl-проверка доступности │ ├── zapret.service
── targets.txt # Цели теста ── zapret-update.service
├── general*.sh # 20 обёрток → run_strategy.sh │ └── zapret-update.timer
├── run_strategy.sh # Единый движок: собирает аргументы nfqws ├── utils/
├── autotest.sh # Автоподбор: запускает каждую, тестит curl, ставит systemd │ ├── test_zapret.sh # curl-проверка доступности
├── install.sh # Входная точка: setup + build + autotest + systemd │ └── targets.txt # Цели теста
├── service.sh # Меню управления (аналог service.bat) ├── general*.sh # Обёртки → run_strategy.sh <name>
├── setup.sh # Зависимости по дистру, модуль ядра, user lists ├── run_strategy.sh # Единый движок: читает .conf, подставляет %BIN%/%LISTS%
├── install_nfqws.sh # git clone bol-van/zapret → make nfqws → fake .bin ├── autotest.sh # Автоподбор: запускает каждую, тестит curl, ставит systemd
── update.sh # Pipeline: check version → update files → rebuild autotest ── install.sh # Входная точка: setup + build + autotest + systemd
``` ├── service.sh # Меню управления (аналог service.bat)
├── setup.sh # Зависимости по дистру, модуль ядра, user lists
--- ├── install_nfqws.sh # git clone bol-van/zapret → make nfqws → fake .bin
├── ensure_wrappers.sh # Создаёт general_*.sh из strategies/*.conf
## Core Scripts Deep Dive └── update.sh # Pipeline: check version → update files → rebuild → autotest
```
### `run_strategy.sh <STRATEGY_NAME>`
- Принимает имя стратегии (`general`, `ALT`, `ALT2`, ...) ---
- Определяет `RULE1` (UDP 443 general), `RULE2` (Discord/stun), `RULE3-9` (стратегия-специфичные)
- Собирает финальный массив аргументов для `nfqws` ## Core Scripts Deep Dive
- Вызывает `run_nfqws()` из `lib/functions.sh`
### `run_strategy.sh <STRATEGY_NAME>`
### `lib/functions.sh` - Принимает имя стратегии (`general`, `ALT`, `ALT2`, ...)
- `setup_firewall()` — nftables или iptables правила для портов 80,443,2053,2083,2087,2096,8443, UDP 443, 19294-19344, 50000-50100 - Определяет `RULE1` (UDP 443 general), `RULE2` (Discord/stun), `RULE3-9` (стратегия-специфичные)
- `cleanup_firewall()` — удаляет правила, убивает nfqws - Собирает финальный массив аргументов для `nfqws`
- `run_nfqws()` — проверяет бинарник, очищает старые правила, поднимает новые, запускает nfqws - Вызывает `run_nfqws()` из `lib/functions.sh`
- `get_game_filter()` — читает `.service/game_filter_enabled`, меняет порты на 1024:65535
- `describe_strategy()` — человекочитаемые описания ### `lib/functions.sh`
- `setup_firewall()` — nftables или iptables правила для портов 80,443,2053,2083,2087,2096,8443, UDP 443, 19294-19344, 50000-50100
### `autotest.sh [--auto]` - `cleanup_firewall()` — удаляет правила, убивает nfqws
- Перебирает STRATEGIES[] по порядку - `run_nfqws()` — проверяет бинарник, очищает старые правила, поднимает новые, запускает nfqws
- Каждую запускает (`sudo ./general*.sh &`) - `get_game_filter()` — читает `.service/game_filter_enabled`, меняет порты на 1024:65535
- Ждёт 3 сек - `describe_strategy()` — человекочитаемые описания
- Тестит `youtube.com` и `discord.com` через curl (timeout 8s)
- При успехе: ### `autotest.sh [--auto]`
- `--auto` → сразу создаёт systemd unit, enable, start - Перебирает STRATEGIES[] по порядку
- интерактив → ждёт подтверждения - Каждую запускает (`sudo ./general*.sh &`)
- Ждёт 3 сек
### `update.sh [--auto|--full-auto]` - Тестит `youtube.com` и `discord.com` через curl (timeout 8s)
``` - При успехе:
Step 1: curl GitHub API → проверка версии - `--auto` → сразу создаёт systemd unit, enable, start
Step 2: update_files() → lists + lib + utils (atomic: .tmp + mv) - интерактив → ждёт подтверждения
Step 3: rebuild_nfqws() → install_nfqws.sh + verify --help
Step 4: run_autotest_pipeline() → cleanup → autotest.sh --auto → systemd install ### `update.sh [--auto|--full-auto]`
``` ```
Step 1: curl GitHub API → проверка версии
--- Step 2: update_files() → lists + lib + utils (atomic: .tmp + mv)
Step 3: rebuild_nfqws() → install_nfqws.sh + verify --help
## Strategy Parameters (nfqws) Step 4: run_autotest_pipeline() → cleanup → autotest.sh --auto → systemd install
```
Каждая стратегия — это комбинация фильтров `--filter-tcp`, `--filter-udp`, `--filter-l7` с DPI обходом:
---
| Параметр | Описание |
|----------|----------| ## Strategy Parameters (nfqws)
| `--dpi-desync=fake` | Отправка фейкового пакета |
| `--dpi-desync=multisplit` | Разделение пакета | Каждая стратегия — это комбинация фильтров `--filter-tcp`, `--filter-udp`, `--filter-l7` с DPI обходом:
| `--dpi-desync=fakedsplit` | Фейк + разделение |
| `--dpi-desync=hostfakesplit` | Фейк по хосту | | Параметр | Описание |
| `--dpi-desync=syndata` | SYN data | |----------|----------|
| `--dpi-desync=multidisorder` | Множественное нарушение порядка | | `--dpi-desync=fake` | Отправка фейкового пакета |
| `--dpi-desync-repeats=N` | Повторить N раз | | `--dpi-desync=multisplit` | Разделение пакета |
| `--dpi-desync-fooling=ts` | TCP timestamp fooling | | `--dpi-desync=fakedsplit` | Фейк + разделение |
| `--dpi-desync-fooling=badseq` | Bad sequence number | | `--dpi-desync=hostfakesplit` | Фейк по хосту |
| `--dpi-desync-fake-tls="file.bin"` | Фейковый TLS ClientHello | | `--dpi-desync=syndata` | SYN data |
| `--dpi-desync-fake-quic="file.bin"` | Фейковый QUIC initial | | `--dpi-desync=multidisorder` | Множественное нарушение порядка |
| `--ip-id=zero` | Обнулить IP ID field | | `--dpi-desync-repeats=N` | Повторить N раз |
| `--dpi-desync-any-protocol=1` | Применять к любому протоколу UDP | | `--dpi-desync-fooling=ts` | TCP timestamp fooling |
| `--dpi-desync-fooling=badseq` | Bad sequence number |
--- | `--dpi-desync-fake-tls="file.bin"` | Фейковый TLS ClientHello |
| `--dpi-desync-fake-quic="file.bin"` | Фейковый QUIC initial |
## Firewall Backend | `--ip-id=zero` | Обнулить IP ID field |
| `--dpi-desync-any-protocol=1` | Применять к любому протоколу UDP |
**Priority:** nftables → iptables fallback
---
```bash
# nftables (if nft available) ## Firewall Backend
nft add table ip zapret
nft add chain ip zapret postrouting { type filter hook postrouting priority mangle; } **Priority:** nftables → iptables fallback
nft add rule ip zapret postrouting tcp dport 443 counter queue num 200
```bash
# iptables fallback # nftables (if nft available)
iptables -t mangle -I POSTROUTING -p tcp --dport 443 -j NFQUEUE --queue-num 200 nft add table ip zapret
``` nft add chain ip zapret postrouting { type filter hook postrouting priority mangle; }
nft add rule ip zapret postrouting tcp dport 443 counter queue num 200
Queue num: 200. nfqws: `--qnum=200`.
# iptables fallback
--- iptables -t mangle -I POSTROUTING -p tcp --dport 443 -j NFQUEUE --queue-num 200
```
## Supported Distros
Queue num: 200. nfqws: `--qnum=200`.
- Ubuntu / Debian / Linux Mint / Pop!_OS / Zorin / Kali
- Arch / Manjaro / EndeavourOS / Garuda / Artix / Arco ---
- Fedora / RHEL / CentOS / AlmaLinux / Rocky
- Alpine Linux ## Supported Distros
- Gentoo / Funtoo
- openSUSE / SUSE - Ubuntu / Debian / Linux Mint / Pop!_OS / Zorin / Kali
- Void Linux - Arch / Manjaro / EndeavourOS / Garuda / Artix / Arco
- NixOS - Fedora / RHEL / CentOS / AlmaLinux / Rocky
- Alpine Linux
Package managers: `apt`, `pacman/yay/paru`, `dnf`, `apk`, `emerge`, `zypper`, `xbps`, `nix`. - Gentoo / Funtoo
- openSUSE / SUSE
--- - Void Linux
- NixOS
## Known Resources Included (v1.9.8c)
Package managers: `apt`, `pacman/yay/paru`, `dnf`, `apk`, `emerge`, `zypper`, `xbps`, `nix`.
**Discord:** все discord.* домены, .gg, .media, .app, .net, .com, статичные IP для Discord media
---
**YouTube:** googlevideo.com, youtube.com, ytimg.com, jnn-pa.googleapis.com, play.google.com
## Known Resources Included (v1.9.8c)
**GitHub** (добавлено в 1.9.8c): github.com, raw.githubusercontent.com, avatars.githubusercontent.com, gist.github.com и др.
**Discord:** все discord.* домены, .gg, .media, .app, .net, .com, статичные IP для Discord media
**Telegram** (добавлено в 1.9.8c): t.me, telegram.org, telegram.me, web.telegram.org, api.telegram.org, my.telegram.org
**YouTube:** googlevideo.com, youtube.com, ytimg.com, jnn-pa.googleapis.com, play.google.com
**Steam:** steampowered.com, steamcommunity.com, steamcontent.com, steamstatic.com
**GitHub** (добавлено в 1.9.8c): github.com, raw.githubusercontent.com, avatars.githubusercontent.com, gist.github.com и др.
**Исключения (не трогаем):** Яндекс, ВК, Твич, Сбер, Тинькофф, Госуслуги, банки (полный список в `lists/list-exclude.txt`)
**Telegram** (добавлено в 1.9.8c): t.me, telegram.org, telegram.me, web.telegram.org, api.telegram.org, my.telegram.org
---
**Steam:** steampowered.com, steamcommunity.com, steamcontent.com, steamstatic.com
## Git / Gitea
**Исключения (не трогаем):** Яндекс, ВК, Твич, Сбер, Тинькофф, Госуслуги, банки (полный список в `lists/list-exclude.txt`)
- Repo: `https://giteas.stitch505.su/Stitch505/zapret-discord-youtube-linux`
- Branch: `main` (единственная) ---
- Version: `1.9.8c-linux`
## Git / Gitea
---
- Repo: `https://giteas.stitch505.su/Stitch505/zapret-discord-youtube-linux`
## Contributing / Debug - Branch: `main` (единственная)
- Version: `1.9.8c-linux`
Если нужно добавить стратегию:
1. Создать `general_NEW.sh` → вызов `run_strategy.sh NEW` ---
2. В `run_strategy.sh` добавить `case NEW:` с `RULE3-9`
3. В `lib/functions.sh` добавить `describe_strategy` ## Contributing / Debug
4. В `autotest.sh` добавить в массив `STRATEGIES[]`
Если нужно добавить стратегию:
1. Создать `general_NEW.sh` → вызов `run_strategy.sh NEW`
2. В `run_strategy.sh` добавить `case NEW:` с `RULE3-9`
3. В `lib/functions.sh` добавить `describe_strategy`
4. В `autotest.sh` добавить в массив `STRATEGIES[]`