Переключение настроек из клиента

botblocker/set-setting включает или выключает одну булеву настройку защиты. Возможность идёт тем же путём сохранения, что и Панель управления, поэтому строка настроек, сгенерированный runtime-файл и работающий плагин получают одно и то же значение.

Она нужна, когда клиент должен пройти по режимам защиты без человека, который щёлкает переключатели. Основной случай — стенд, который проверяет плагин и его аддоны в разных комбинациях.

Чтобы опубликовать возможность, откройте BotBlocker → Интеграции → API возможностей WP, включите главный переключатель, затем включите Смена настройки-переключателя. Оба переключателя по умолчанию выключены.

Что меняет вызов

Возможность записывает строку настройки в таблицу настроек BotBlocker, пересобирает settings.php в папке данных и обновляет объект настроек, который уже держит текущий запрос. Ранняя защита читает settings.php до загрузки WordPress, поэтому без пересборки первый слой остался бы на старом значении.

У нескольких настроек есть дополнительная работа, и возможность делает её так же, как Панель управления:

  • early_init_enable и mu_enable остаются взаимоисключающими. Включение одного выключает другое, а файл MU-загрузчика устанавливается или удаляется соответственно.
  • block_rkn при включении планирует обновление списков угроз.
  • redis_enable, memcached_enable и apcu_enable сначала проверяют бэкенд. Если проверка не прошла, переключатель остаётся выключенным, а вызов возвращает ошибку вместо сохранения мёртвой интеграции.

Подтверждение, пробные вызовы и лимиты

Каждому вызову нужен confirm со значением SET. Без него возможность отказывает и ничего не пишет.

dry_run: true сообщает значение, которое было бы записано, и что изменилось бы, после чего останавливается. Используйте его перед серией настоящих вызовов.

Возможность ограничена по частоте, как остальные разрушительные возможности. Каждый вызов от вошедшего пользователя попадает в журнал аудита с именем настройки, старым и новым значением.

Поля ответа

Поле Значение
key Настройка, которую запросили.
previous Значение до вызова.
enabled Действующее значение после вызова.
changed Отличается ли значение от предыдущего.
applied Записал ли этот вызов строку. Пробный вызов и отклонённая PRO-настройка оставляют false.
reason Пусто при успехе, license когда PRO-настройка не покрыта активной лицензией.
protection_enabled Включена ли сама защита BotBlocker.

Какие настройки можно менять

Принимаются только ключи из этого списка. Всё остальное отклоняется с ability_invalid_input.

Защита и проверки запроса:

  • check — главная проверка ботов.
  • botblocker_force_check проверяет каждую загрузку страницы, включая вошедших пользователей и белый список.
  • skip_logged_in_users распространяет обход на все вошедшие роли.
  • allow_self_ip_req разрешает серверу обращаться к себе.
  • allow_self_call_header подписывает исходящие самовызовы.
  • allow_app_password_rest пропускает валидные application password мимо защиты.
  • autosave_admin_ip сохраняет адреса администраторов в доверенный список.
  • options_preflight пропускает CORS preflight.
  • iframe_stop блокирует показ сайта во фрейме.
  • check_get_ref проверяет GET-параметры в referer.
  • bbcs_ddos_resilience укрепляет цикл проверки за WAF или CDN.

Обнаружение ботов:

  • block_simplebot_ua, block_empty_ua, block_empty_lang, block_http10_users
  • block_fake_ref, block_incorrect_lang_users, block_ip_ptr_match
  • block_cf_users, block_proxy_users, block_ipv6_users
  • block_adblocker_users, block_incognito_users, block_simple_antidetect
  • fingerprint_sticky_block, whitelist_whatsapp_preview
  • get_browser_type, get_device_type, get_os_type
  • bbcs_allow_empty_accept_lang
  • bbcs_edge_autotrust (выключение сразу снимает всё авто-доверие)

CAPTCHA:

  • bbcs_honeypot_enabled
  • recaptcha_check
  • bbcs_captcha_img_inline
  • recaptcha_v3_ipv6_block

Cookie и заголовки:

  • session_token_enabled, vary_cookie
  • noarchive, utm_noindex, utm_referrer
  • bbcs_cors_strict_headers

Облако и кэш:

  • force_cloud_validation, cloud_fallback_block
  • transients_enable, cache_ui_data
  • redis_enable, memcached_enable, apcu_enable

Логирование:

  • botblocker_log_error, botblocker_log_admin, botblocker_log_allow
  • botblocker_log_bbcs, botblocker_log_block, botblocker_log_cli
  • botblocker_log_disabled, botblocker_log_fake, botblocker_log_goodip
  • botblocker_log_local, botblocker_log_tests, botblocker_log_wp
  • audit_log_enable

Учётные записи, оплата и слои:

  • login_brutforce_enabled
  • payment_bypass_enable, payment_bypass_log
  • payment_strict_method, payment_keep_ip_rules
  • bbcs_2fa_enable, bbcs_2fa_xmlrpc_block
  • mu_enable, mu_geo_enable
  • early_init_enable, early_geo_enable, early_cache_gate

Ограничение частоты, TLS и обратный DNS:

  • bbcs_rate_check_enabled, bbcs_rate_subnet_enabled
  • tls_fingerprint_check
  • ptr_cache_in_db

PRO-настройки тоже в списке: hosting_block, block_device_options, block_web_engine_options, block_override, block_vpn_users, block_tor_users, block_rkn. Без подходящей лицензии вызов их не включает. Ответ будет applied: false и reason: license, как и при сохранении в Панели управления, когда PRO-значение остаётся без лицензии.

Какие настройки отклоняются

У части настроек есть своя возможность, а часть не должна записываться клиентом никогда:

  • disable принадлежит botblocker/set-protection.
  • secure_mode принадлежит botblocker/set-secure-mode.
  • bbcs_captcha_mode и bbcs_captcha_wait принадлежат botblocker/set-captcha-mode.
  • Секреты не трогаем: salt, secret_botblocker_get_param, action_disable, action_off, action_on, ключи и пароли Cloud, ключи reCAPTCHA и пароли кэша.
  • Все переключатели bbcs_ability_* и bbcs_wp_abilities_enabled остаются вне списка. Клиент не должен уметь публиковать или скрывать собственные возможности.
  • Числа и строки, которые определяют поведение сайта, не являются переключателями: hits_per_user, time_ban, header_error_code, cookie, samesite, таймауты и пороги.

Примеры

Выключить главную проверку ботов перед базовым прогоном:

wp eval '
$result = wp_get_ability( "botblocker/set-setting" )->execute( array(
	"key"     => "check",
	"enabled" => false,
	"confirm" => "SET",
	"reason"  => "baseline run",
) );
print_r( $result );
'

Ответ покажет previous: true, enabled: false и applied: true. В таблице настроек теперь check = 0, и в settings.php тоже.

Посмотреть, что даст изменение, без записи:

wp eval '
$result = wp_get_ability( "botblocker/set-setting" )->execute( array(
	"key"     => "bbcs_honeypot_enabled",
	"enabled" => true,
	"confirm" => "SET",
	"dry_run" => true,
) );
print_r( $result );
'

Здесь changed равен true, если значение отличается, а applied остаётся false.

Тот же вызов через REST, под администратором:

curl -X POST "https://example.com/wp-json/wp-abilities/v1/abilities/botblocker/set-setting/run" \
  -u "admin:application-password" \
  -H "Content-Type: application/json" \
  -d '{"key":"early_cache_gate","enabled":1,"confirm":"SET"}'

Для запроса подойдёт application password администратора. Самой возможности всё равно нужно право manage_options.

Включить режим MU, когда включён Early Init:

wp eval '
$result = wp_get_ability( "botblocker/set-setting" )->execute( array(
	"key"     => "mu_enable",
	"enabled" => true,
	"confirm" => "SET",
) );
print_r( $result );
'

Ответ будет applied: true, а early_init_enable после этого читается как 0. MU-загрузчик на месте, потому что Панель управления сделала бы то же самое.

Ошибки

Код Когда
ability_confirmation_required confirm отсутствовал или не равен SET.
ability_invalid_input Ключа нет в списке разрешённых или enabled не передан.
ability_backend_unavailable Бэкенд кэша не ответил на проверку. Переключатель остаётся выключенным.
ability_rate_limited Слишком много разрушительных вызовов за короткое время.
ability_execution_failed Строку настроек записать не удалось.
rest_forbidden Вызывающий не администратор.

Если изменение не дало эффекта

Сначала включите переключатель возможности, затем главный переключатель. Если главный выключен, ничего не зарегистрировано, и вызов до плагина не доходит.

Для Early Init и режима MU проверьте botblocker/get-layer-state. Она сообщает, какой слой отвечает и развёрнуты ли роутер или MU-загрузчик.

Если бэкенд кэша не включается, причина в проверке соединения. Исправьте хост или порт в настройках кэша и повторите.

Смена настройки-переключателя

По умолчанию: Выключено

Этот переключатель публикует botblocker/set-setting. Включайте его только для клиента, который вы контролируете, и только пока стенду это нужно. Клиент с этой возможностью может менять настройки защиты в пределах списка выше, и действует он с правами администратора.

  • Включено: возможность регистрируется, когда включён главный переключатель.
  • Выключено: возможности не существует для REST, MCP и ИИ-клиентов.

Связанные страницы: Возможности и подключения WordPress.