Свой хаб или зеркало
b4hub - сервис, который стоит за hub.b4core.app. Он хранит каталог, принимает то, что отправляют роутеры, подписывает то, что публикует, и раздаёт консоль модерации. Это отдельный от b4 бинарник со своими релизами, и на роутере он не запускается.
| Свой хаб | Зеркало | |
|---|---|---|
| Команда | b4hub serve | b4hub mirror |
| Каталог | Собирается из сетов, одобренных его модераторами, и подписывается своим ключом | Копируется с вышестоящего хаба вместе с его подписью |
| Записи от роутеров | Сохраняются и учитываются, есть база данных и консоль | Проверяются и передаются вышестоящему хабу |
| Что нужно роутерам | Адрес и идентификатор ключа, введённые вручную | Ничего, после того как вышестоящий хаб одобрит зеркало |
Свой хаб - это второй каталог со своими сетами и оценками. Зеркало раздаёт тот же каталог по другому адресу, для сетей, где хаб не отвечает. Поле Зеркала хаба на роутере не имеет отношения к зеркалам обновления.
Сервис
Один статический бинарник со встроенной консолью. Каждая команда принимает --data - каталог, в котором лежит всё, что принадлежит сервису.
| Команда | Что делает |
|---|---|
b4hub keygen | Создаёт ключ подписи и печатает его идентификатор. Существующий ключ не перезаписывает |
b4hub serve | Запускает хаб: сборщик каталога, точки входа для роутеров и консоль |
b4hub mirror | Запускает зеркало другого хаба |
b4hub build | Один раз собирает и подписывает каталог и завершается |
b4hub moderate | Модерация из командной строки, см. Без консоли |
b4hub version | Печатает версию хаба и исходники b4, из которых он собран |
| Флаг | Переменная | По умолчанию |
|---|---|---|
--data | B4HUB_DATA | data |
--listen | B4HUB_LISTEN | 127.0.0.1:7100 |
--public-url | B4HUB_PUBLIC_URL | пусто |
--geosite-url, --geoip-url | B4HUB_GEOSITE_URL, B4HUB_GEOIP_URL | релизы v2ray-rules-dat и b4geoip |
--upstream | B4HUB_UPSTREAM | пусто, обязателен для mirror |
--upstream-key | B4HUB_UPSTREAM_KEY | пусто: ключ, встроенный в b4 |
--trusted-proxies | B4HUB_TRUSTED_PROXIES | пусто |
| нет | B4HUB_ADMIN_PASSWORD | пусто: консоль закрыта |
| нет | B4HUB_TELEGRAM_TOKEN, B4HUB_TELEGRAM_CHAT, B4HUB_WEBHOOK_URL, B4HUB_WEBHOOK_SECRET | пусто, см. Уведомления |
--new-epoch, --revoke, --new-database, --announce, --refresh и --queue-limit задаются только в командной строке.
В каталоге данных лежат hub.key (ключ подписи), hub.db (хранилище SQLite), secret, blobs/ (файлы payload), public/ (подписанные файлы, которые скачивают роутеры) и geo/.
b4hub работает по обычному HTTP и рассчитан на обратный прокси для TLS, поэтому по умолчанию слушает только локальный адрес. В репозитории b4hub опубликован комплект для развёртывания: vhost для nginx, unit-файл systemd и файл Compose.
Роутеры обращаются к /b4/health и к путям под /b4/hub/. Консоль находится по адресу /admin.
Свой хаб
b4hub keygen --data /var/lib/b4hub
B4HUB_ADMIN_PASSWORD=... b4hub serve --data /var/lib/b4hub \
--listen 127.0.0.1:7100 --public-url https://hub.example.org
keygen печатает идентификатор ключа - единственное, по чему роутер узнаёт хаб. Сменить ключ нельзя. --public-url - адрес, по которому роутеры приходят к хабу; его хаб объявляет в манифесте.
Пароль консоли берётся только из окружения. Без него консоль отклоняет любой вход, и модерировать можно только через b4hub moderate. Новый хаб начинает с пустого каталога: пока модератор ничего не одобрил, ничего не публикуется.
Подключение роутера
На роутере, в Настройки > Интеграции > Хаб сообщества:
- Введите базовый адрес хаба в поле Зеркала хаба.
- Введите идентификатор ключа в поле Публичный ключ хаба.
- Сохраните настройки и нажмите Синхронизировать.
Нужны оба поля. С одним только ключом роутер продолжает синхронизироваться с hub.b4core.app и отклоняет его каталог из-за чужой подписи.
Адрес должен начинаться с https://. Обычный http:// принимается только для localhost и для петлевых, частных и link-local адресов, а адрес, который b4 не принимает, отбрасывается без сообщения. Неверный ключ проваливает каждую синхронизацию с ошибкой «manifest is not signed by a trusted key».
Каталог, который он публикует
Сборка запускается примерно через 10 секунд после действия модератора и не реже раза в сутки. Подписанный манифест действителен 14 дней. Роутеры, которые столько времени не получали ответа ни от одного хаба, помечают свою копию истёкшей и продолжают работать с применёнными сетами.
Роутеры принимают только манифест новее своего: с большей эпохой или с той же эпохой и большим порядковым номером. Хаб отказывается от сборки, которая не окажется новее каталога в public/ или каталога, который отдаёт одобренное зеркало, а причина видна в истории сборок.
База, которая ещё ни разу не публиковала каталог, отказывается публиковать поверх существующего или подписывать пустой каталог ключом, встроенным в b4. Так выглядит serve с рабочим ключом не на том каталоге данных. Флаг --new-database у serve или build подтверждает, что новая база задумана.
Сеть, к которой относят вклад
Запись относится к ASN и стране адреса, с которого она пришла. Хаб определяет их DNS-запросом, поэтому ему нужен работающий исходящий DNS.
За обратным прокси хаб видит адрес прокси, если только прокси не на петлевом адресе и не указан в --trusted-proxies адресом или подсетью. С недоверенным прокси любая запись относится к прокси, и все роутеры делят одни сетевые лимиты.
Зеркало со своим ключом на b4hub 1.3.0 или новее подписывает записи, которые пересылает. Если зеркало одобрено, а его часы расходятся с часами хаба не больше чем на 10 минут, такая запись сохраняется без сети. Голос тогда учитывается только в мировой оценке, с пониженным весом, а жалоба никогда не идёт в счёт автоматического скрытия. Для адреса зеркала сетевой лимит запросов в 10 раз выше, а лимит новых ключей - в 20 раз. Любая другая запись от зеркала относится к адресу самого зеркала.
Зеркало чужого хаба
b4hub mirror --data /var/lib/b4hub-mirror \
--upstream https://hub.b4core.app \
--listen 127.0.0.1:7101
Зеркало проверяет манифест вышестоящего хаба раз в пять минут или с интервалом из --refresh. Более новый каталог и недостающие файлы payload оно копирует, проверяет подпись, размеры и хеши и раздаёт без изменений. Неудачная проверка оставляет прежнюю копию. Если вышестоящий хаб недоступен, зеркало продолжает раздавать последний скопированный каталог.
Зеркалу собственного хаба нужен --upstream-key с идентификатором ключа этого хаба. Без него зеркало доверяет только встроенному ключу hub.b4core.app. Страница / зеркала показывает, что оно хранит и когда в последний раз проверяло вышестоящий хаб.
Подменить раздаваемое зеркало не может. Роутеры проверяют подпись хаба и каждый хеш и отвергают ответ с любым изменённым байтом. Если проверку не прошёл манифест или каталог, роутер переходит к следующему адресу.
Объявление зеркала
Роутеры узнают зеркала из подписанного манифеста хаба, до 32 адресов, и пробуют их после введённых вручную и встроенного. Зеркало попадает в манифест, объявив о себе:
b4hub keygen --data /var/lib/b4hub-mirror
b4hub mirror --data /var/lib/b4hub-mirror \
--upstream https://hub.b4core.app \
--public-url https://mirror.example.org --announce
Для --announce нужны собственный ключ зеркала и --public-url - объявляемый адрес. К этому адресу применяются те же правила, что к адресу хаба на роутере. Объявление уходит при запуске и раз в сутки и приходит на хаб со статусом ожидает.
Роутерам зеркало объявляется только после того, как модератор одобрит его на странице «Зеркала». Повторное объявление никогда не меняет принятого решения. Объявление, подписанное не тем ключом, для которого принималось решение, отклоняется с mirror_key_mismatch.
Хаб проверяет каждое одобренное зеркало раз в 10 минут: /b4/health должен отвечать ok, а манифест - проходить проверку ключом хаба. Зеркало остаётся в списке, пока проверка удавалась в последние 24 часа.
Записи, отправленные через зеркало
Зеркало передаёт хабу общие сеты, отчёты и жалобы и возвращает ответ хаба. Запись с неверной подписью оно отклоняет само. Одна клиентская сеть, /24 для IPv4 или /48 для IPv6, может отправить до 600 записей в час.
Пока вышестоящий хаб не отвечает, отчёты и жалобы ждут в очереди зеркала, а общий сет отклоняется с 502 hub_unreachable. В очереди не больше --queue-limit записей, по умолчанию 5000, и не больше 200 в сутки от одной клиентской сети и 40 в сутки от одного ключа. Запись сверх лимита остаётся в очереди самого роутера.
За прокси, которого нет в --trusted-proxies, все роутеры делят лимиты одного клиента, а зеркало пишет предупреждение в журнал. Зеркало не отвечает на /b4/hub/v1/network, поэтому роутер, который синхронизируется только через зеркала, берёт свою сеть из DPI Детектора.
Хаб и зеркало на одном хосте
Это разные процессы и разные развёртывания: каталоги двух хабов не сливаются, а роутер доверяет одному ключу хаба за раз. На одной машине им нужны два каталога данных и два адреса прослушивания.
Сохранность данных
Каталог данных переносится целиком: hub.key, hub.db, secret, blobs/ и public/ принадлежат друг другу.
Файл secret задаёт HMAC, которым в базе заменён ключ каждого участника, и создаётся молча, если его нет. База, восстановленная без исходного secret, никого не узнаёт: блокировки, отметки доверия, авторство сетов и устранение повторов в отчётах перестают работать.
Восстановление старой базы откатывает эпоху и порядковый номер назад. Роутеры отклоняют каталог старее своего, а хаб отказывается собирать такой каталог, пока более новый лежит в public/ или есть у одобренного зеркала. Опубликовать восстановленную базу позволяет Начать новую эпоху на странице «Каталог» консоли или b4hub build --new-epoch --data <каталог>.
Потерянный hub.key со стороны хаба не восстановить. Тогда новый идентификатор ключа придётся вручную ввести на каждом роутере, который направлен на этот хаб.