Функции могут быть вызваны как UseModule("AbuseProtection")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| BuildFingerprint | Построить fingerprint отправки
 Подробнее...
Строит стабильный hash fingerprint по безопасным нормализованным признакам запроса без сохранения исходных IP, email, user-agent и текста обращения в открытом виде. | | Тип | Параметр | По умолчанию | Описание | | Array | $context | Обязательный | Контекст запроса или уже нормализованный контекст AbuseProtection. | | Array | $policy | array (
) | Policy с настройкой config.fingerprint.fields. Если не передана, используется default policy. |
|
| CreateChallenge | Создать challenge
Подробнее...
Создает challenge для публичного действия, привязывает его к policy, каналу, host, session и fingerprint. В dryRun-режиме возвращает будущий challenge без записи. | | Тип | Параметр | По умолчанию | Описание | | Array | $context | Обязательный | Контекст запроса, для которого выдается challenge. | | Array | $options | array (
) | Опции: policy, ttl, answer, dryRun. answer нужен только для тестового или внутреннего provider-а; пользователю он не возвращается. |
|
| EnsureSchema | Установить runtime-схему AbuseProtection
Подробнее...
Создает или обновляет SID-хранилища AbuseProtection, фиксирует версию схемы и загружает системные policy из JSON. | Отсутствуют |
| EvaluateRequest | Оценить входящий запрос
Подробнее...
Применяет policy AbuseProtection к контексту публичной формы, webhook, письма или мессенджера и возвращает решение allow, challenge, throttle, quarantine или reject с безопасным сообщением и диагностикой. | | Тип | Параметр | По умолчанию | Описание | | Array | $request | Обязательный | Контекст запроса: policyKey, channel, hostKey, projectKey, formKey, endpointKey, actor, sessionKey, ip, email, payload/text, submissionToken, idempotencyKey, signals, traceId. | | Array | $options | array (
) | Опции: dryRun, autoCreateChallenge. |
|
| GetIncidents | Получить incidents защиты
Подробнее...
Возвращает список AbuseProtectionIncident с фильтрацией по policy, decision, channel, host, project, form, state и trace id. Проверку прав просмотра должен выполнять вызывающий слой через Security. | | Тип | Параметр | По умолчанию | Описание | | Array | $filter | array (
) | Фильтр: policyKey, decision, channel, hostKey, projectKey, formKey, state, traceId. | | Array | $options | array (
) | Опции: limit. |
|
| GetPolicy | Получить policy защиты
Подробнее...
Возвращает AbuseProtectionPolicy из runtime-хранилища, system JSON или кодового default. Функция не проверяет доменные права и не знает структуру записи вызывающего модуля. | | Тип | Параметр | По умолчанию | Описание | | string | $policyKey | Обязательный | Ключ policy AbuseProtection. Пустое значение заменяется default-public-intake. | | Array | $options | array (
) | Опции: allowDefault. |
|
| GetSchemaStatus | Получить состояние runtime-схемы AbuseProtection
Подробнее...
Возвращает целевую и текущую версии схемы, наличие записи модуля, список SID-хранилищ, недостающие колонки и количество строк. | Отсутствуют |
| GetSystemDefinitions | Прочитать системные определения AbuseProtection
Подробнее...
Читает system JSON AbuseProtection с описанием решений, типов правил, runtime-хранилищ, default policy, событий, API и TestA-сценариев. | Отсутствуют |
| HealthCheck | Диагностика модуля защиты публичных каналов
Подробнее...
Проверяет system JSON, runtime-схему и доступность внешних контрактов Security, EventBus, Queue, WorkflowScreen, WorkflowView и TestA. Модуль не выполняет чужие проверки вместо владельцев этих контрактов. | Отсутствуют |
| RecordIncident | Записать incident защиты
Подробнее...
Создает диагностическую запись AbuseProtectionIncident по решению защиты. В incident сохраняются только безопасные идентификаторы, hash-значения, trace id и диагностический JSON без лишних персональных данных. | | Тип | Параметр | По умолчанию | Описание | | Array | $decision | Обязательный | Результат EvaluateRequest или совместимый массив решения. | | Array | $context | Обязательный | Контекст запроса. | | Array | $policy | array (
) | Policy AbuseProtection. Если не передана, используется default policy. | | Array | $options | array (
) | Опции: dryRun. |
|
| RegisterPolicy | Зарегистрировать policy защиты
Подробнее...
Нормализует и сохраняет AbuseProtectionPolicy с набором правил. В dryRun-режиме возвращает нормализованную policy без записи в runtime-хранилище. | | Тип | Параметр | По умолчанию | Описание | | Array | $policy | Обязательный | Описание policy: policyKey, title, scopeKey, active, retentionDays, challengeTtl, safeMessage, config, rules. | | Array | $options | array (
) | Опции выполнения: dryRun, schemaReady, systemSeed. |
|
| ValidateSystemDefinitions | Проверить системные определения AbuseProtection
Подробнее...
Проверяет обязательные секции system JSON, наличие всех решений, типов правил, политик маскирования и runtime-хранилищ AbuseProtection. | | Тип | Параметр | По умолчанию | Описание | | Array | $definitions | Обязательный | Опциональный массив системных определений. Если не передан, JSON читается из файла модуля. |
|
| VerifyChallenge | Проверить challenge
Подробнее...
Проверяет ответ на ранее выданный challenge, учитывает срок действия, повторную проверку и число попыток. Возвращает verified, failed или expired. | | Тип | Параметр | По умолчанию | Описание | | string | $challengeKey | Обязательный | Ключ challenge, выданный CreateChallenge. | | string | $answer | Обязательный | Ответ пользователя или канала на challenge. | | Array | $context | array (
) | Опции проверки: dryRun, verified. |
|