Nemesida WAF API | Немезида ВАФ

# curl http://api.example.com:8080/nw-api/get_dyn_settings?format=json --data 'key=%Лицензионный ключ%'

Пример ответа:

{"nwaf_ip_wl": "127.0.0.1", "nwaf_limit": "nwaf_limit domain=example.com rate=3r/s block_time=300, nwaf_limit rate=5r/s block_time=300", "nwaf_body_exclude": "a.example.com/upload/1/", "nwaf_rfc_violation_lm": "*, .example.com/uploads/uploads.php", "nwaf_rfc_violation_wl": "example.com, *.example.com/uploads/", "nwaf_b64_decode_disable": "example.com z:BODY|URL|ARGS|HEADERS", "status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_settings --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "nwaf_ip_wl": "127.0.0.1, 127.0.0.2",
    "nwaf_ai_extra_host_lm": "example.com",
    "active": true
  }
}'

set — параметры настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_settings --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": "nwaf_ip_wl"
}'

del — параметр настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_dyn_bl?format=json --data 'key=%Лицензионный ключ%'

Пример ответа:

{"status": "success", "active": true, "bl": ["10.0.0.1-10.0.0.25", "2.2.2.2", "10.0.0.15 domain=example.com", "domain=example.com 1.1.1.1", "4.4.4.4-5.5.5.5 api=yes", "10.0.0.15", "3.3.3.0/24", "domain=example.com 3.3.3.3-4.4.4.4", "domain=example.com 10.0.0.15", "domain=example.com 3.4.5.6"]}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_bl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "active": true,
    "bl": [
      "domain=example.com 1.1.1.1",
      "2.2.2.2",
      "3.3.3.0/24",
      "4.4.4.4-5.5.5.5 api=yes"
    ]
  }
}'

set — параметры настроек в формате JSON.
api=yes — параметр отправки событий о блокировках при обращении с указанного IP-адреса(ов) в Nemesida WAF API.

Запросы с IP-адреса 1.1.1.1 будут заблокированы только для домена example.com. Обращения с IP-адресов 2.2.2.2, 3.3.3.0/24 и 4.4.4.4-5.5.5.5 будут блокироваться для всех доменов, включая example.com.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_bl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": ""
}'

del — параметр настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_dyn_sync_ban --data 'key=%Лицензионный ключ%'

Пример ответа:

{
  "status": "success",
  "ban_data": [
    {
      "ip-address": "127.0.0.1",
      "ttl": 30,
      "is_banned": true,
      "domain": "1.example.com",
      "timestamp": 1234567890
    },
    {
      "ip-address": "127.0.0.2",
      "ttl": 30,
      "is_banned": true,
      "domain": "2.example.com",
      "timestamp": 1234567891
    },
    {
      "ip-address": "127.0.0.3",
      "ttl": 30,
      "is_banned": true,
      "domain": "DEFAULT",
      "timestamp": 1234567892
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

ip-address — IP-адрес;
ttl — оставшееся время блокировки в секундах;
is_banned — параметр указывает, заблокирован ли IP-адрес;
domain — виртуальный хост (доменное имя), обращения к которому блокируются для IP-адреса. DEFAULT означает, что для IP-адреса блокируются обращения на любой виртуальный хост;
timestamp — дата добавления IP-адреса в список в формате Unix Timestamp.

# curl http://api.example.com:8080/nw-api/del_dyn_sync_ban --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "ip-address": "127.0.0.1"
}'

ip-address — IP-адрес для удаления в формате IPv4/IPv6. Допускается использование * для удаления всех IP-адресов.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_dyn_wl?format=json --data 'key=%Лицензионный ключ%'

Пример ответа:

{"status": "success", "wl": [{"mz": "ARGS", "rl_id": "515", "active": true, "domain": "example.com.com", "modify": "2023-06-22T18:55:13.800437", "extension": null, "rid": 20}]}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_wl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "add": {
    "rl_id": "1",
    "domain": "example.com",
    "mz": "url",
    "extension": "$URL_X:/test"
  }
}'

add — параметры настроек в формате JSON.

Пример ответа:

{"status": "success", "rid": 20}

или

{"status": "fail", "description": "%описание ошибки%"}

{... "active": true ...}

{... "rl_id": "1" ...}

{... "rl_id": "*" ...}

{... "domain": "example.com" ...}

{... "domain": "*" ...}

{... "mz": "URL|ARGS|BODY|HEADERS|cookie|user-agent|content-type|x-forward-for|range|referer|NoMLA" ...}

{... "extension": "$BODY:abc|$Cookie_X:id=[a-z0-9]+" ...}

Необдуманное добавление правил исключения сигнатуры небезопасно и может привести к пропускам атак. Поэтому рекомендуется максимально конкретизировать условия срабатывания правила, используя уточнения.

# curl http://api.example.com:8080/nw-api/set_dyn_wl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "upd": {
    "rid": "20",
    "mz": "URL"
  }
}'

upd — параметры настроек в формате JSON;
rid — ID правила, который генерируется при создании правила исключения.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_wl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "rid": "8"
  }
}'

del — параметры настроек в формате JSON.
rid — ID правила, который генерируется при создании правила исключения.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

• ip — IP-адрес атакующего;
• api — отправлять результат срабатывания правила в модуль Nemesida WAF API;
• lm — обработка правила в режиме LM (фиксируется срабатывание правила, но запрос не блокируется);
• noban — со значением false при срабатывании правила запрос будет заблокирован, но счетчик rate параметра nwaf_limit, необходимый для блокировки IP-адреса источника запросов, не будет увеличиваться;
• no_cookie — со значением true правило применяется только к запросу с пустой зоной Cookie;
• country — страна;
• domain — домен;
• url — вхождение строки в содержимое зоны URL;
• args — вхождение строки в содержимое зоны ARGS;
• body — вхождение строки в содержимое зоны BODY;
• cookies — вхождение строки в содержимое зоны Cookie;
• ua — вхождение строки в содержимое зоны User-Agent;
• referer — вхождение строки в содержимое зоны Referer;
• other_headers — вхождение строки в содержимое зоны HEADERS, за исключением зон Cookie, User-Agent и Referer.

Для поля domain допускается использовать строгое соответствие и wildcard-значения: *, example.com, .example.com, *.example.com.

Пример:

{... "domain": "base64(*.example.com)" ...}

При таком значении правило будет применяться ко всем поддоменам (a.example.com, b.example.com и т.д.), исключая основной домен example.com. Если значение поля domain пустое, то правило будет применяться ко всем запросам.

Префикс base64 перед параметром означает, что значение параметра при составлении правила необходимо передавать в формате base64. Например: "domain": "base64(*.example.com)" будет выглядеть как "domain": "Ki5leGFtcGxlLmNvbQ=="

Для всех параметров (кроме api,lm, noban и no_cookie) допускается использовать несколько значений в одном параметре, используя логические операторы условий «не» (!), «и» (&), «или» (|). Операторы не имеют приоритета и выполняются по очереди, слева направо.

Пример:

{... "ip": "192.168.61.0/24|192.168.62.0/24" ...}

При таком значении правило будет применяться ко всем IP-адресам из диапазонов 192.168.61.1-192.168.61.255 или 192.168.62.1-192.168.62.255.

Пример:

{... "country": "!base64(RU)&!base64(US)" ...}

При таком значении правило будет применяться ко всем запросам, в которых IP-адрес источника запроса не из России и не из США.

Пример:

{... "cookie": "!base64(abc)&!base64(def)" ...}

При таком значении правило будет применяться ко всем запросам, которые не содержат abc и def в Cookie.

При проверке срабатывания расширенного правила блокирования запроса все поля, кроме ip, country, api, lm и noban, проверяются на вхождение содержимого поля из правила блокирования в проверяемое поле запроса. Например, при "url": "base64(/abc)" будет заблокирован запрос с вхождением /abcd в URL.

other_headers

Формат поля:

{... "other_headers": ["base64(header_name):base64(header_value)", "base64(header_name):base64(header_value)" ...] ...}

base64(header_name) — название заголовка в base64;
base64(header_value) — значение заголовка в base64.

Для поля other_headers содержимое секций base64(header_name) и base64(header_value) являются опциональными, но необходимо указать хотя бы одну из секций . Например, при наличии заголовка header_name будет проверяться содержимое header_value только этого заголовка, а при отсутствии — содержимое всех заголовков.

Пример:

{... "other_headers": ["base64(example_header):base64(abcd)"] ...}

При таком значении запрос будет заблокирован при наличии abcd в заголовке example_header.

Пример:

{... "other_headers": [":base64(abcd)"] ...}

При таком значении запрос будет заблокирован при наличии abcd в любом заголовке.

Если base64(header_name) указан без последующего значения, то блокирование запроса произойдет при любом значении заголовка header_name (блокировка по наличию заголовка).

Пример:

{... "other_headers": ["base64(example_header):"] ...}

Пример:

{... "other_headers": ["base64(example1_header):base64(abc)","base64(example2_header):base64(def)"] ...}

При таком значении запрос будет заблокирован при наличии заголовков example1_header, который содержит abc и example2_header, который содержит def.

Пример:

{... "other_headers": ["base64(example1_header):","base64(example2_header):"] ...}

При таком значении запрос будет заблокирован при наличии заголовков example1_header и example1_header с любыми значениями.

Для имени заголовка допустимо применение логического оператора !!, означающего отсутствие заголовка с таким именем в запросе. Блокирование запроса сработает в том случае, если среди всех заголовков запроса отсутствует заголовок с указанным именем. При этом, значение заголовка игнорируется, даже если присутствует в правиле.

Пример:

{... "other_headers": ["!!base64(example_header):"] ...}

Пример:

{... "other_headers": ["base64(example_header):base64(abc)&base64(def)"] ...}

При таком значении запрос будет заблокирован при наличии заголовка example_header, который содержит abc и def.

Пример:

{... "other_headers": ["base64(example_header):!base64(abc)"] ...}

При таком значении запрос будет заблокирован при наличии заголовка example_header, который не содержит abc.

Пример:

{... "other_headers": ["base64(example_header):!base64(a)&!base64(b)&!base64(c)"] ...}

При таком значении запрос будет заблокирован при наличии заголовка example_header, который не содержит a, b и c.

Пример:

{... "other_headers": ["base64(example_header):!base64(a)|base64(b)"] ...}

При таком значении запрос будет заблокирован при наличии заголовка example_header, который не содержит a или содержит b.

Если в запросе недоступно получение какого-либо поля, указанного в расширенном правиле блокирования, то запрос будет пропущен.

# curl http://api.example.com:8080/nw-api/get_dyn_erl?format=json --data 'key=%Лицензионный ключ%'

Пример ответа:

{"status": "success", "erl": [{"id": 100052, "ip": "1.1.1.1|3.3.3.3", "lm": false, "ua": null, "api": true, "url": null, "args": null, "body": null, "noban": false, "active": true, "cookie": null, "domain": null, "modify": "2023-06-28T15:07:46.002211", "country": null, "referer": null, "no_cookie": false, "other_headers": null, "rid": 100052}]}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "add": {
    "ip": "1.1.1.1|2.2.2.2",
    "active": true
  }
}'

add — параметры настроек в формате JSON.

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "add": {
    "ip": "!1.1.1.0/24",
    "domain": "ZXhhbXBsZS5jb20=",
    "active": true
  }
}'

Запрос будет заблокирован, если на example.com поступит запрос c любого IP-адреса, кроме 1.1.1.1-1.1.1.255.

Из-за особенностей обработки запросов функционал не предназначен для работы с большим количеством IP-адресов. Если необходимо блокировать обращения для списка IP-адресов — воспользуйтесь функционалом добавления IP-адреса в список «Заблокированные IP».

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "add": {
    "ip": "1.1.1.1",
    "domain": "ZXhhbXBsZS5jb20=",
    "other_headers": [
      "dGVzdC1oZWFkZXI=:YWJj"
    ],
    "active": true
  }
}'

Запрос будет заблокирован правилом в случае, если на example.com поступит запрос с IP-адреса 1.1.1.1 и заголовок test-header содержит строку abc.

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "add": {
    "сountry": "Q0g=|UlU=",
    "domain": "ZXhhbXBsZS5jb20=",
    "other_headers": [
      "dGVzdC1oZWFkZXI=:YWJj"
    ],
    "cookie": "!dGVzdF9jb29raWU=",
    "referer": "!aHR0cDovL2V4YW1wbGUuY29t",
    "active": true
  }
}'

Запрос будет заблокирован правилом в случае, если на example.com поступит запрос с IP-адреса из региона RU или CH, заголовок test-header содержит строку abc, заголовок Cookie не содержит строку test_cookie и заголовок Referer не содержит http://example.com.

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "add": {
    "ip": "1.1.1.1",
    "other_headers": [
      "VGVzdC1GaWVsZA==:"
    ],
    "referer": "aHR0cDovL2V4YW1wbGUuY29tLw==",
    "ua": "TW96aWxsYS81LjA=",
    "cookie": "dGVzdF9jb29raWU=",
    "body": "YmM9MyZjYz0x",
    "args": "P3BhZ2U9Mw==",
    "url": "aW50ZXJuYWx0ZXN0",
    "domain": "ZXhhbXBsZS5jb20=",
    "api": false,
    "country": "Q0g=|VFc=",
    "active": true
  }
}'

Запрос будет заблокирован правилом в случае, если на example.com поступит запрос c IP-адреса 1.1.1.1 из региона RU или CH, который будет содержать:

Пример ответа:

{"status": "success", "rid": 100053}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "upd": {
    "rid": "1",
    "ip": "1.1.1.1",
    "active": true
  }
}'

upd — параметры настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_dyn_erl --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "rid": "1"
  }
}'

del — параметры настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_mlc_settings?format=json --data 'key=%Лицензионный ключ%'

Пример ответа:

{"ddos__wl_ip": "10.0.0.2", "ddos__enable": true, "ddos__wl_url": "[\"example.com\"]", "brute__enable": true, "brute__max_val": 10, "ddos__interval": 120, "main__ai_extra": false, "brute__interval": 30, "ddos__latest_only": false, "brute__latest_only": false, "brute__brute_detect": "[\"example.com/index.php\", \"example.by\"]", "brute__flood_detect": "[\"example.com/index.php\", \"example.by\", \"example.com/wp-login.php\"]", "ddos__send_possible": false, "brute__send_possible": false, "openapi__vhosts_list": "[\"example.com\", \"example.ru\"]", "status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_vhosts_list --data 'key=%Лицензионный ключ%'

Пример ответа:

{"status": "success", "vhosts_list": "["example.com", "example.ru"]"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_vhosts_list --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "vhosts_list": ["example.com, example.org"]
}'

vhosts_list — список виртуальных хостов, для которых будут созданы и применены модели.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_mlc_settings --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "main__ai_extra": "false",
    "brute__interval": "11",
    "brute__brute_detect": [
      "example.com/a1",
      "example.com/b1"
    ],
    "active": true
  }
}'

set — параметры настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_mlc_settings --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": "brute_detect"
}'

del — параметры настроек в формате JSON.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_models_list_uri --data 'key=%Лицензионный ключ%'

Пример ответа:

["example.ru"]

или

[]

# curl http://api.example.com:8080/nw-api/del_models_uri --data 'key=%Лицензионный ключ%&vhost=example.com'

vhost — имя виртуального хоста, для которого необходимо удалить поведенческую модель.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

1. Остановите сервис Nemesida AI MLC:

# service mlc_main stop

2. Переместите файл /opt/mlc/ml/backup/[vhost].d_[timestamp], где [timestamp] — дата создания резервной копии обучающей выборки, созданной Nemesida AI MLC перед началом построения модели, в /opt/mlc/ml/[vhost].d. Например, для модели example.com:

# mv /opt/mlc/ml/backup/example.com.d_1613587613 /opt/mlc/ml/example.com.d

3. Запустите обучение:

# curl http://api.example.com:8080/nw-api/set_training_uri --data 'key=%Лицензионный ключ%&vhost=*.example.com&complete=no'

4. Запустите сервис Nemesida AI MLC:

# service mlc_main start

# curl http://api.example.com:8080/nw-api/rep_models_uri --data 'key=%Лицензионный ключ%&src=example.com&dst=example.ru'

src — виртуальный хост, поведенческая модель которого копируется;
dst — виртуальный хост, для которого необходимо скопировать модель.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_training_uri --data 'key=%Лицензионный ключ%&vhost=example.com'

Пример ответа:

{'status': 'success', 'duration': 4, 'complete': True, 'progress': 11}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_training_uri --data 'key=%Лицензионный ключ%&vhost=example.com&duration=4'

duration — период обучения в днях.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_training_uri --data 'key=%Лицензионный ключ%&vhost=*.example.com&complete=no'

complete — статус обучения модели.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_training_uri --data 'key=%Лицензионный ключ%&vhost=.example.com&duration=4&complete=no'

Выполнение команды со значением параметра complete=no позволяет запустить процесс переобучения модели, а complete=yes — прерывает процесс обучения.

Перед запуском процесса обучения модели виртуальный хост должен быть добавлен в список виртуальных хостов.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_openapi_schemas --header 'Content-type: application/json' --data '{"key": "%Лицензионный ключ%"}'

Пример ответа:

{"schemas": [{"schema_name": "example.ru", "schema": null}, {"schema_name": "example.com", "schema": "eyJvcGVuYXBpIjogIjMuMC4xIiwgImluZm8iOilY2lwaGVyT25seSJdfSwgIlg1MDlLZXlVc2FnZUZsYWdzQ3NyRGlmZmVyZW5jZSI6IHsidHlwZSI6ICJvYmplY3QiLCAicHJvcGVydGllcyI6IHsiRXhwZWN0ZWRWYWx1ZSI6IHsiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy9YNTA5S2V5VXNhZ2VGbGFncyJ9LCAiQ3NyVmFsdWUiOiB7IiRyZWYiOiAiIy9jb21wb25lbnRzL3NjaGVtYXMvWDUwOUtleVVzYWdlRmxhZ3MifX0sICJhZGRpdGlvbmFsUHJvcGVydGllcyI6IGZhbHNlLCAiZGVzY3JpcHRpb24iOiAiXHUwNDFlXHUwNDQyXHUwNDNiXHUwNDM4XHUwNDQ3XHUwNDM4XHUwNDRmIFx1MDQzZlx1MDQzMFx1MDQ0MFx1MDQzMFx1MDQzY1x1MDQzNVx1MDQ0Mlx1MDQ0MFx1MDQzMCBcdTA0MzdcdTA0MzBcdTA0M2ZcdTA0NDBcdTA0M2VcdTA0NDFcdTA0MzAgXHUwNDNkXHUwNDMwIFx1MDQzMlx1MDQ0Ylx1MDQzZlx1MDQ0M1x1MDQ0MVx1MDQzYSBcdTA0NDFcdTA0MzVcdTA0NDBcdTA0NDJcdTA0MzhcdTA0NDRcdTA0MzhcdTA0M2FcdTA0MzBcdTA0NDJcdTA0MzAifX0sICJzZWN1cml0eVNjaGVtZXMiOiB7ImJhc2ljQXV0aCI6IHsidHlwZSI6ICJodHRwIiwgImRlc2NyaXB0aW9uIjogIklucHV0IHlvdXIgdXNlcm5hbWUgYW5kIHBhc3N3b3JkIHRvIGFjY2VzcyB0aGlzIEFQSSIsICJzY2hlbWUiOiAiYmFzaWMifX19LCAic2VjdXJpdHkiOiBbeyJiYXNpY0F1dGgiOiBbXX1dLCAic2VydmVycyI6IFt7InVybCI6ICIvIn1dfQ=="}]}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_openapi_schema --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "schema_name": "%Имя спецификации%",
    "schema": "%base64(Спецификация)%"
  }
}'

Для корректной работы в качестве имени спецификации необходимо использовать доменное имя, заданное в спецификации. Например, если в спецификации задан параметр servers со значением:

"servers": [
    {
      "url": "http://example.com"
    }
  ]

Допускается использовать строгое соответствие и wildcard-значения: *, example.com, .example.com, *.example.com.

После создания или изменения спецификации необходимо задать список URL-адресов для фильтрующей ноды, при обращении на которые будет выполняться анализ на соответствие запроса его спецификации. Если список URL-адресов не задан или не соответствует спецификации, то анализ запроса проводиться не будет.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_openapi_url --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "url": [
    "example.com/admin",
    "example.com/admin/info",
    "example.com/v1/client/info",
  ]
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_openapi_schema --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "schema_name": "%Имя спецификации%",
    "old_name": "%Имя спецификации%"
  }
}'

Для корректной работы в качестве имени спецификации необходимо использовать доменное имя, заданное в спецификации. Например, если в спецификации задан параметр servers со значением:

"servers": [
    {
      "url": "http://example.com"
    }
  ]

Допускается использовать строгое соответствие и wildcard-значения: *, example.com, .example.com, *.example.com.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/set_openapi_schema --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "schema_name": "%Имя спецификации%"
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_openapi_schema_paths --header 'Content-type: application/json' --data '{"key": "%Лицензионный ключ%"}'

Nemesida AI MLC генерирует paths со спецификациями, представленные в виде конечного URL-адреса ресурса (исключая базовый путь) и метода получения доступа к ресурсу (например: GET, POST, PUT, DELETE).

Пример ответа:

{"paths": ["example.com/url_1/", "example.com/url_2"]}

или

{"paths": []}

# curl http://api.example.com:8080/nw-api/set_openapi_exclude_paths --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "exclude_paths": ["/url_1/", "/url_2/"]
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_openapi_exclude_paths --header 'Content-type: application/json' --data '{"key": "%Лицензионный ключ%"}'

Пример ответа:

{"exclude_paths": ["/test_84/", "/test_85/"]}

или

{"exclude_paths": []}

# curl http://api.example.com:8080/nw-api/nginx/get_nginx --data 'key=%Лицензионный ключ%'

Пример ответа:

{
  "status": "success",
  "configuration": [
    {
      "active": true,
      "resolver": "127.0.0.1 [::1]:5353 valid=30s",
      "limit_req_zone": [
        "$binary_remote_addr zone=mylimit_1:10m rate=10r/s",
        "$binary_remote_addr zone=mylimit_2:10m rate=10r/s"
      ],
      "real_ip_header": "X-Forwarded-For",
      "resolver_timeout": "30s",
      "set_real_ip_from": [
        "192.168.1.0/24",
        "192.168.2.1"
      ],
      "client_max_body_size": "100m"
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_nginx --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "active": true,
    "resolver": "127.0.0.1 [::1]:5353 valid=30s",
    "resolver_timeout": "30s",
    "set_real_ip_from": [
      "192.168.1.0/24",
      "192.168.2.1"
    ],
    "real_ip_header": "X-Forwarded-For",
    "client_max_body_size": "100m",
    "limit_req_zone": [
      "$binary_remote_addr zone=mylimit_1:10m rate=10r/s",
      "$binary_remote_addr zone=mylimit_2:10m rate=10r/s"
    ]
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_nginx --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "resolver": null,
    "resolver_timeout": null,
    "set_real_ip_from": null,
    "real_ip_header": null,
    "client_max_body_size": null,
    "limit_req_zone": null
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/get_vhost --data 'key=%Лицензионный ключ%'

Пример ответа:

{
  "status": "success",
  "configuration": [
    {
      "name": "example.com",
      "root": "/var/www/site",
      "index": "index index.html index.php",
      "active": true,
      "listen": [
        "localhost:80 default_server",
        "[::1]:443 default_server ssl http2"
      ],
      "add_header": {
        "Content-Encoding": "gzip",
        "Content-Type": "text/html; charset=utf-8"
      },
      "error_page": {
        "504": "=200 @bad_gateway",
        "404 502": "=200 /404.html"
      },
      "locations": [
        {
          "location": "/static_1",
          "pass_type": "root",
          "path": "/var/www/html",
          "index": "index.php",
          "add_header": {
            "Content-Encoding": "gzip",
            "Content-Type": "text/html; charset=utf-8"
          },
          "error_page": {
            "504": "=200 @bad_gateway",
            "404 502": "=200 /404.html"
          },
          "limit_req": "zone=mylimit_1 burst=20 nodelay",
          "limit_req_status": 444
        },
        {
          "location": "/static_2",
          "pass_type": "alias",
          "path": "/var/www/static_2",
          "autoindex": "on",
          "limit_req": "zone=mylimit_1 burst=20 nodelay",
          "limit_req_status": 444
        },
        {
          "location": "/abc_1",
          "pass_type": "proxy_pass",
          "proxy_pass": "http://main_proxy",
          "proxy_http_version": 1.0,
          "proxy_set_header": {
            "X-Real_IP": "$remote_address",
            "Host": "$http_host"
          },
          "proxy_connect_timeout": "60s",
          "proxy_send_timeout": "60s",
          "proxy_read_timeout": "60s",
          "proxy_intercept_errors": "on",
          "limit_req": "zone=mylimit_1 burst=20 nodelay",
          "limit_req_status": 444
        },
        {
          "location": "/abc_2",
          "pass_type": "memcached_pass",
          "memcached_pass": "memc_upstream",
          "limit_req": "zone=mylimit_1 burst=20 nodelay",
          "limit_req_status": 444
        }
      ],
      "server_name": "www.example.com example.com",
      "ssl_ciphers": "AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5",
      "dhparam_name": "dhparam",
      "ssl_protocols": "TLSv1 TLSv1.1 TLSv1.2",
      "certificate_name": "SSL",
      "ssl_session_timeout": "10m"
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_vhost --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "name": "%Имя конфигурации%",
    "active": true,
    "listen": [
      "localhost:80 default_server",
      "[::1]:443 default_server ssl http2"
    ],
    "server_name": "www.example.com example.com",
    "certificate_name": "%name%",
    "dhparam_name": "%name%",
    "ssl_session_timeout": "10m",
    "ssl_ciphers": "AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5",
    "ssl_protocols": "TLSv1 TLSv1.1 TLSv1.2",
    "root": "/var/www/site",
    "index": "index.php index.html",
    "add_header": {
      "Content-Encoding": "gzip",
      "Content-Type": "text/html; charset=utf-8"
    },
    "error_page": {
      "404 502": "=200 /404.html",
      "504": "=200 @bad_gateway"
    },
    "locations": [
      {
        "location": "/static_1",
        "pass_type": "root",
        "path": "/var/www/html",
        "index": "index.php",
        "add_header": {
          "Content-Encoding": "gzip",
          "Content-Type": "text/html; charset=utf-8"
        },
        "error_page": {
          "504": "=200 @bad_gateway",
          "404 502": "=200 /404.html"
        },
        "limit_req": "zone=mylimit_1 burst=20 nodelay",
        "limit_req_status": 444
      },
      {
        "location": "/static_2",
        "pass_type": "alias",
        "path": "/var/www/static_2",
        "autoindex": "on",
        "limit_req": "zone=mylimit_1 burst=20 nodelay",
        "limit_req_status": 444
      },
      {
        "location": "/abc_1",
        "pass_type": "proxy_pass",
        "proxy_pass": "http://main_proxy",
        "proxy_http_version": 1.0,
        "proxy_set_header": {
          "X-Real_IP": "$remote_address",
          "Host": "$http_host"
        },
        "proxy_connect_timeout": "60s",
        "proxy_send_timeout": "60s",
        "proxy_read_timeout": "60s",
        "proxy_intercept_errors": "on",
        "limit_req": "zone=mylimit_1 burst=20 nodelay",
        "limit_req_status": 444
      },
      {
        "location": "/abc_2",
        "pass_type": "memcached_pass",
        "memcached_pass": "memc_upstream",
        "limit_req": "zone=mylimit_1 burst=20 nodelay",
        "limit_req_status": 444
      }
    ]
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_vhost --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "name": "%Имя конфигурации%",
    "listen": null,
    "server_name": null,
    "certificate_name": null,
    "dhparam_name": null,
    "ssl_session_timeout": null,
    "ssl_ciphers": null,
    "ssl_protocols": null,
    "root": null,
    "index": null,
    "add_header": null,
    "error_page": null,
    "locations": null
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_vhost --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "name": "%Имя конфигурации%"
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/get_upstream --data 'key=%Лицензионный ключ%'

Пример ответа:

{
  "status": "success",
  "configuration": [
    {
      "name": "upstream_main",
      "servers": [
        {
          "server": "backend1.example.com",
          "weight": 3
        },
        {
          "server": "127.0.0.1:8080",
          "fail_timeout": "60s"
        },
        {
          "server": "192.0.2.1",
          "max_fails": 5
        },
        {
          "server": "backend3.example.com",
          "weight": 3,
          "fail_timeout": "60s",
          "max_fails": 5
        },
        {
          "server": "backend4.example.com"
        },
        {
          "server": "backend5.example.com",
          "backup": true
        },
        {
          "server": "backend4.example.com",
          "down": true
        }
      ],
      "balancing_method": "ip_hash"
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_upstream --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "name": "%Имя конфигурации%",
    "balancing_method": "ip_hash",
    "servers": [
      {
        "server": "backend1.example.com",
        "weight": 3
      },
      {
        "server": "127.0.0.1:8080",
        "fail_timeout": "60s"
      },
      {
        "server": "192.0.2.1",
        "max_fails": 5
      },
      {
        "server": "backend3.example.com",
        "weight": 3,
        "fail_timeout": "60s",
        "max_fails": 5
      },
      {
        "server": "backend4.example.com"
      },
      {
        "server": "backend5.example.com",
        "backup": true
      },
      {
        "server": "backend4.example.com",
        "down": true
      }
    ]
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_upstream --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "name": "%Имя конфигурации%",
    "balancing_method": null,
    "servers": null
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_upstream --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "name": "%Имя конфигурации%"
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/get_certificate --data 'key=%Лицензионный ключ%'

Пример ответа:

{
  "status": "success",
  "configuration": [
    {
      "name": "SSL",
      "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURVekNDQWpzQ0ZGei9jNjhLYk9USnlYOWpibWZMbjdmK1YwdWtNQTBHQ1NxR1NJYjNEUUVCQ3dVQU1IOHgKQ3pBSkJnTlZCQVlUQWtGVk1RNHdEQVlEVlFRSURBVkJVMEZGUmpFTk1Bc0dBMVVFQnd3RVQzSmxiREVSTUE4RwpBMVVFQ2d3SVUxTlNSMEZCUldZeERqQU1CZ05WQkFzTUJYTnlaWFJuTVE0d0RBWURWUVFEREFWM1pUUm1aekVlCk1Cd0dDU3FHU0liM0RRRUpBUllQWVdSdGFXNUFZV1J0YVc0dVkyOXRNQjRYRFRJek1EY3hOekV3TlRZME0xb1gKRFRJMk1EUXhNVEV3TlRZME0xb3dUVEVMTUFrR0ExVUVCaE1DUTBFeERUQUxCZ05WQkFnTUJFNXZibVV4Q3pBSgpCZ05WQkFjTUFrNUNNUTB3Q3dZRFZRUUtEQVJPYjI1bE1STXdFUVlEVlFRRERBcGxlR0Z0Y0d4bExuSjFNSUlCCklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFySitBMkZ3cHFjMDhNVnRhVzZKeUsvbDkKQy9NWXFJRXZtRjZvdUt5V01ZRWFGMmlPK0l2VG1pN2hETkxQakR2ekhKRHJMYTZycjhJMkdMN0Nxdi9tdkN5NQpKZVBaSVZxeU9PQ0NLUEJFVXFrUkl4NUwvQ0hLMnVieHlxL1ZIWUExRysxanVqNzNINXZqUHM4anRyeFFNVG5OCkNacVBycmdoOTRlU0ViRmpER2JyZGlGSFpURmwyT01QdTlBVEJoRjF3dStwYS8yN3BJVm91S21BTnVTa0pTaUoKM29wRTkzZFJDYkUvWVhoTjJKTlNjdmdzcjBVbXBRd2t5VDJ4bGVKbHV0Sm5PZkZiK1NsdWFHVlloOUtncEwrcQorN2x3MFk0OEtYNnJGeXUzNko1RjBxNUN6T1hoMS9BZWFneStJQTdGanVSOU9tTFEvQVlwSGE1QmZMK0Fid0lECkFRQUJNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUNnV1VGTVZrMkVSaHF3WGpBT0YxVCt1cWZJM3pKZkVrTHAKYlZieW90d2dRMnZPU2VZdlAyU1dqdjZCMDExZEFONWNYTUIvOFhOVEdhdUNSajN1cEtTTUtvd1JaY1hjdUlKMApocUNDc01JZGw1bDFBQVFJWCtPTTJTeEpKdHVRK0dkWlhkQ294RStzN20zSHNCQ3UwbWRzY3doU0hGSnRmbXRhCit6eFJ4VmY5QkU3NDJSUE5ydXNFZmxwdVQ2Rm14QkpMUy9WYzVLOWtQMngwdjZQTjZYMUF4M09vRGhrQ3Nma2cKeXpwSFhtK3J1ZWJmcnNvcFdwUzJBM083T09CRk1lTVhZeHl3WjJUR2hmanh3R3ZGZml0ZnhFNnpTUnZnQ1A5WQphaUM5RUlMSXpodUdDNDFXNFFZYTJBUzNoaVF4Qms0eDcyeGZ1cXpmc212OE5Zd0lzY3BxCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K",
      "certificate_key": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2QUlCQURBTioqKioqSjIyTmViTm5pVlE9PQotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tCg=="
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_certificate --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "name": "%Имя конфигурации%",
    "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURVekNDQWpzQ0ZGei9jNjhLYk9USnlYOWpibWZMbjdmK1YwdWtNQTBHQ1NxR1NJYjNEUUVCQ3dVQU1IOHgKQ3pBSkJnTlZCQVlUQWtGVk1RNHdEQVlEVlFRSURBVkJVMEZGUmpFTk1Bc0dBMVVFQnd3RVQzSmxiREVSTUE4RwpBMVVFQ2d3SVUxTlNSMEZCUldZeERqQU1CZ05WQkFzTUJYTnlaWFJuTVE0d0RBWURWUVFEREFWM1pUUm1aekVlCk1Cd0dDU3FHU0liM0RRRUpBUllQWVdSdGFXNUFZV1J0YVc0dVkyOXRNQjRYRFRJek1EY3hOekV3TlRZME0xb1gKRFRJMk1EUXhNVEV3TlRZME0xb3dUVEVMTUFrR0ExVUVCaE1DUTBFeERUQUxCZ05WQkFnTUJFNXZibVV4Q3pBSgpCZ05WQkFjTUFrNUNNUTB3Q3dZRFZRUUtEQVJPYjI1bE1STXdFUVlEVlFRRERBcGxlR0Z0Y0d4bExuSjFNSUlCCklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFySitBMkZ3cHFjMDhNVnRhVzZKeUsvbDkKQy9NWXFJRXZtRjZvdUt5V01ZRWFGMmlPK0l2VG1pN2hETkxQakR2ekhKRHJMYTZycjhJMkdMN0Nxdi9tdkN5NQpKZVBaSVZxeU9PQ0NLUEJFVXFrUkl4NUwvQ0hLMnVieHlxL1ZIWUExRysxanVqNzNINXZqUHM4anRyeFFNVG5OCkNacVBycmdoOTRlU0ViRmpER2JyZGlGSFpURmwyT01QdTlBVEJoRjF3dStwYS8yN3BJVm91S21BTnVTa0pTaUoKM29wRTkzZFJDYkUvWVhoTjJKTlNjdmdzcjBVbXBRd2t5VDJ4bGVKbHV0Sm5PZkZiK1NsdWFHVlloOUtncEwrcQorN2x3MFk0OEtYNnJGeXUzNko1RjBxNUN6T1hoMS9BZWFneStJQTdGanVSOU9tTFEvQVlwSGE1QmZMK0Fid0lECkFRQUJNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUNnV1VGTVZrMkVSaHF3WGpBT0YxVCt1cWZJM3pKZkVrTHAKYlZieW90d2dRMnZPU2VZdlAyU1dqdjZCMDExZEFONWNYTUIvOFhOVEdhdUNSajN1cEtTTUtvd1JaY1hjdUlKMApocUNDc01JZGw1bDFBQVFJWCtPTTJTeEpKdHVRK0dkWlhkQ294RStzN20zSHNCQ3UwbWRzY3doU0hGSnRmbXRhCit6eFJ4VmY5QkU3NDJSUE5ydXNFZmxwdVQ2Rm14QkpMUy9WYzVLOWtQMngwdjZQTjZYMUF4M09vRGhrQ3Nma2cKeXpwSFhtK3J1ZWJmcnNvcFdwUzJBM083T09CRk1lTVhZeHl3WjJUR2hmanh3R3ZGZml0ZnhFNnpTUnZnQ1A5WQphaUM5RUlMSXpodUdDNDFXNFFZYTJBUzNoaVF4Qms0eDcyeGZ1cXpmc212OE5Zd0lzY3BxCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K",
    "certificate_key": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2QUlCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktZd2dnU2lBZ0VBQW9JQkFRQ3NuNERZWENtcHpUd3gKVzFwYm9uSXIrWDBMOHhpb2dTK1lYcWk0ckpZeGdSb1hhSTc0aTlPYUx1RU0wcytNTy9NY2tPc3RycXV2d2pZWQp2c0txLythOExMa2w0OWtoV3JJNDRJSW84RVJTcVJFakhrdjhJY3JhNXZIS3I5VWRnRFViN1dPNlB2Y2ZtK00rCnp5TzJ2RkF4T2MwSm1vK3V1Q0gzaDVJUnNXTU1adXQySVVkbE1XWFk0dys3MEJNR0VYWEM3NmxyL2J1a2hXaTQKcVlBMjVLUWxLSW5laWtUM2QxRUpzVDloZUUzWWsxSnkrQ3l2UlNhbERDVEpQYkdWNG1XNjBtYzU4VnY1S1c1bwpaVmlIMHFDa3Y2cjd1WERSamp3cGZxc1hLN2ZvbmtYU3JrTE01ZUhYOEI1cURMNGdEc1dPNUgwNll0RDhCaWtkCnJrRjh2NEJ2QWdNQkFBRUNnZ0VBWENKSjM3RFpIK01GeElZd3BRWUFFQTU2T24yR1pMR0cyTGwxTGhRWG1kYUIKT1lzNSs5aU5tUlo2VWFEVzI4OUhnN0NwaFZsY0UxUUNFWlVIUzhPSHdGblNmREd2TzBrd0pJRlhsMGdkLzB4egpkQjRBaWxMeTlZRWIvb1Y0cHVVOTgyanh1SDlRNE5NUUovN2czZkNHa0s5OEN5c3VreDkrS2FKM1NQQTNvRzhSCnlLNDVKckRZK1l4WktLNS9EZmtrZlRGdXF6TDkxSzdIcFdBKzkxc3FnRUM5c0hqTzJyME9KUmlEK1lFekFLZisKb0hsSHZmTjhrblBSTDZRMWFJaUgvL1o3S053YTlmOHFvK0prZmR3bExaS21KS21ScEtqQUppMWd1ckZSaklzUgpQeU5sTm43VHljQmZUKzIvS3hoNm1pR2F1UWg1ZC9saXg2QVJLMjhTdVFLQmdRRFNSQkxmQ3RiYWR2OThtWWJsCnREUS95OUZoSWo0WHJML2xPZVhJaEZEbFpKc3U4R3dpSzZZczNqWFQvOEhwUlZUbll6TkdtdUhUNk5Pb1lkakoKWk5IWDFINHlCT2xMV3oyQ3RvNk1aMWJSWkVlcHplV29GM2txMWc2TmNabmJYdk4xNmNhSXJzTG9LY0NYQ2h6UwpFQ245TytrS1FBYk1PL3d2WXVMUWJpRlU4d0tCZ1FEU0syc09WWGIrbm83MVZmR1BUSDJpQUV2bWxFRlZwVkNhClNxMmtWZE9hQkVOR3BnWnRwNmZ4Lzh5bUlPbGczWnZpQ2JQZnVhK2FGOENqVUYzaGRkcDFRdTI3RjdCaGswbGUKUXNrRGVBaEU4KzVxWWZtWEUwZUo1dE11bmtYUHM2b2o3eHRTTlR2c01CZEwwK3AwVUtia0EzaDVvLzlqdytkLwp2OHRpYytKMWxRS0JnQ1RNd1RqRUh1SlJYVm1qVFJhNnVVSkpHN1lTVmlleWxrczZITnRCUFI5SXdsZ3V2OTRqCklZeE12OE1BeWlGWGZ3cVlOQXN4WkVEQVNQcjVWUVc2WFhlV3V4ZHFBS0t0cjFCSFB4K1hubnc3UHNlYlA0eHgKdjBVZC9hSUh0ZFBOQkhNb25SU2k4WDNNZ09adVlLanJKMDRveEJxRkppdHNmRENXNy9kbXJ2SzlBb0dBZVR4OApsQmN1L25BZXpWMVhiQzlXcFpZQU1ySEJBcFBMYkVXNTV2dHZoZ0FCZ3dhUTNMNkMvZkZ1YjBLNi9acTRxbXFvCmJWMWk4OFBSNXlPY0ZFdjB5Z0hpdXpOT0Z1dHN2a2hPUm9iK1ZqQlVqdCtYcDlPQ1NBVjBPd2NvQkVtQzB4bkMKSytqemVTckF0WWc0VGdLY1V4bkJiSUh5OSt6eFpOc1JpdWlJY1FVQ2dZQUpQN3pBck5IQ0FVYWwwOUQvQVFjbAppMGVxQnkvZ2xJOXlIS1BVcDFlU1BnUnhSL3Y4ZVBPOGM2azA5YkM3bk1TeDQ5bEVWWnhvT1lkM3ZkSyszQXZCCnByZWZscnZXTk5hSWhBMHdsZTRjWXdObHlMZDVKRU5zeDZ1RTBwNUd4UVRLeEZNUE16L2JaSlU0YzZkUWsyUDIKNFdVME1SLzRLdU9KMjJOZWJObmlWUT09Ci0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0K"
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_certificate --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "name": "%Имя конфигурации%"
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/get_dhparam --data 'key=%Лицензионный ключ%'

Пример ответа:

{
  "status": "success",
  "configuration": [
    {
      "name": "dhparam",
      "dhparam": "LS0tLS1CRUdJTiBESCBQQVJBTUVURVJTLS0tLS0KTUlHSEFvR0JBTyoqKioqV2N1TkFEYkFnRUMKLS0tLS1FTkQgREggUEFSQU1FVEVSUy0tLS0tCg=="
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_dhparam --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "name": "%Имя конфигурации%",
    "dhparam": "LS0tLS1CRUdJTiBESCBQQVJBTUVURVJTLS0tLS0KTUlHSEFvR0JBT1lpNi9OQmljaHU5UDlPS3BpZ1RLQTB4WjNUWnZKQ3pWNzMvWkxCMkgvRFFzc2xUNWgyWEltcQpiazR0SHRGc2ViNDU0S29IR3JoM2FCbzFmcXB5REJQMDcxR0M3eE12c2xUQXVBanVIRmFVckd6NVNDTWRRN3A3CnJvaWNJdExNWE5razQ1WWpzazRPZjZHVXhDZXQ1MkdqSHo3a01yemdvbUtWTldjdU5BRGJBZ0VDCi0tLS0tRU5EIERIIFBBUkFNRVRFUlMtLS0tLQo="
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nginx/set_dhparam --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "del": {
    "name": "%Имя конфигурации%"
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_event --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "startTime": 1234567891,
  "endTime": 1987654321,
  "limit": 100,
  "offset": 1,
  "level": [
    "info",
    "error"
  ],
  "ip": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "uuid": [
    "198be506d69ba8a9bdbcf87b22ef5bc",
    "198be506d69ba8a9bdbcf87b22ef5bb"
  ],
  "agent": [
    "dyn",
    "mlc"
  ],
  "category": [
    "auth",
    "settings"
  ]
}'

Опциональные параметры:

• startTime — начальная дата в формате Unix Timestamp, за который будет запрошена информация;
• endTime — конечная дата в формате Unix Timestamp, за который будет запрошена информация;
• limit — максимальное количество выводимых записей;
• offset — смещение для вывода последующих записей;
• level — уровень серьезности сообщения;
• ip — IP-адрес сервера, где установлен компонент;
• uuid — идентификатор сервера, где установлен компонент;
• agent — название компонента;
• category — категория события.

Пример ответа:

{
  "status": "success",
  "count": 28,
  "waf_id": "1674726761",
  "events": [
    {
      "id": 2798306,
      "ip": "1.1.1.1",
      "uuid": "bd4f447720189ca3c5a42e1395fa6021",
      "agent": "dyn",
      "level": "debug",
      "category": "nginx",
      "timestamp": 1688404169,
      "description": "This is log 1"
    }
  ]
}

Добавленные параметры сочетаются по принципу логического «И», а их значения — по принципу логического «ИЛИ».

• startTime — начальная дата в формате Unix Timestamp, за который будет запрошена информация;
• endTime — конечная дата в формате Unix Timestamp, за который будет запрошена информация.

Количество записей:

• limit — максимальное количество выводимых записей;
• offset — смещение для вывода последующих записей. При значении 0 и значении limit 100 будут выводиться записи с порядковым номером 1-100, при значении 1 — записи с порядковым номером 101-200 и т.д. Использование параметра без указания максимального количества выводимых записей (limit) невозможно.

Ранжирование событий:

• level — уровень серьезности события;
  • debug — события с отладочной информацией;
  • info — информационные сообщения о состоянии компонента;
  • warn — предупреждения о потенциальной проблеме в работе компонента;
  • error — сообщения об ошибках в работе компонента;
  • fatal — сообщения о критических ошибках в работе компонента, приводящие к сбою в работе.
• category — категория события:
  • Динамический модуль:
    • auth — события, связанные с проверкой программного ключа, тарифного плана и т.д.;
    • os — события взаимодействия с операционной системой (память, диск);
    • network — события, связанные с сетью (невозможно установить соединение, отправки, таймауты, обрывы, запуск/остановка сокета/порта);
    • api — события, связанные со взаимодействием с Nemesida WAF API;
    • settings — события, связанные с настройками модуля;
    • nginx — события, связанные со взаимодействием с Nginx (несоответствие настроек, необходимых для работы динамического модуля, нарушения RFC);
    • signature — события, связанные с сигнатурным анализом;
    • clamav — события, связанные со взаимодействием с ClamAV;
    • mla — события, связанные со взаимодействием с Nemesida AI MLA;
    • mlc — события, связанные со взаимодействием с Nemesida AI MLC;
    • rabbitmq — события, связанные со взаимодействием с RabbitMQ;
    • autoban — события, связанные механизмом автоматической блокировки;
    • geo — события, связанные с функционалом GeoIP;
    • openapi — события, связанные с работой OpenAPI;
    • parsing — события, связанные с декодом и нормализацией данных;
    • analysis — события, связанные с обработкой запроса, но не вошедшие ни в одну группу (signature, ml, openapi и т.д.);
    • misc — события, не вошедшие ни в одну категорию (например, вывод информаци об UUID, WAF ID, количестве сигнатур и т.д.).
  • Nemesida AI MLA:
    • auth — события, связанные с проверкой программного ключа, тарифного плана и т.д.;
    • os — события взаимодействия с операционной системой (память, диск);
    • network — события, связанные с сетью (невозможно установить соединение, отправки, таймауты, обрывы, запуск/остановка сокета/порта);
    • api — события, связанные со взаимодействием с Nemesida WAF API;
    • settings — события, связанные с настройками модуля;
    • dyn — события, связанные со взаимодействием с динамическим модулем;
    • ml — события, связанные с работой машинного обучения;
    • geo — события, связанные с функционалом GeoIP;
    • mgmt — события, связанные с функционалом сервисного интерфейса управления;
    • openapi — события, связанные с работой OpenAPI;
    • parsing — события, связанные с декодом и нормализацией данных;
    • analysis — события, связанные с обработкой запроса, но не вошедшие ни в одну группу (signature, ml, openapi и т.д.);
    • misc — события, не вошедшие ни в одну категорию (например, вывод информаци об UUID, WAF ID и т.д.).
  • Nemesida AI MLC:
    • auth — события, связанные с проверкой программного ключа, тарифного плана и т.д.;
    • os — события взаимодействия с операционной системой (память, диск);
    • network — события, связанные с сетью (невозможно установить соединение, отправки, таймауты, обрывы, запуск/остановка сокета/порта);
    • api — события, связанные со взаимодействием с Nemesida WAF API;
    • settings — события, связанные с настройками модуля;
    • dyn — события, связанные со взаимодействием с динамическим модулем;
    • rabbitmq — события, связанные со взаимодействием с RabbitMQ;
    • ml — события, связанные с работой машинного обучения;
    • geo — события, связанные с функционалом GeoIP;
    • bf — события, связанные с работой Brute-force/Flood анализа;
    • ddos — события, связанные с работой DDoS анализа;
    • openapi — события, связанные с работой OpenAPI;
    • parsing — события, связанные с декодом и нормализацией данных;
    • analysis — события, связанные с обработкой запроса, но не вошедшие ни в одну группу (signature, ml, openapi и т.д.);
    • misc — события, не вошедшие ни в одну категорию (например, вывод информаци об UUID, WAF ID и т.д.).
• Nemesida WAF Scanner:
  • auth — события, связанные с проверкой программного ключа, тарифного плана и т.д.;
  • os — события взаимодействия с операционной системой (память, диск);
  • network — события, связанные с сетью (невозможно установить соединение, отправки, таймауты, обрывы, запуск/остановка сокета/порта);
  • api — события, связанные со взаимодействием с Nemesida WAF API;
  • settings — события, связанные с настройками модуля;
  • scan — события, связанные с работой компонента;
  • %ModuleName% — события, связанные с работой определенного модуля сканирования;
  • parsing — события, связанные с декодом и нормализацией данных;
  • db — события, связанные cо взаимодействием с базой данных;
  • misc — события, не вошедшие ни в одну категорию (например, вывод информаци об UUID, WAF ID и т.д.).

Идентификация компонентов:

• ip — IP-адрес сервера, где установлен компонент;
• uuid — идентификатор сервера, где установлен компонент;
• agent — название компонента:
  • dyn — динамический модуль;
  • mla — Nemesida AI MLA;
  • mlc — Nemesida AI MLC;
  • cabinet — Личный кабинет;
  • nws — Nemesida WAF Scanner.

# curl http://api.example.com:8080/nw-api/del_event --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "timestamp": "1686655813",
  "id": [
    1,
    2,
    3
  ],
  "ip": [
    "1.1.1.1",
    "2.2.2.2"
  ],
  "uuid": [
    "198be506d69ba8a9bdbcf87b22ef5bc",
    "198be506d69ba8a9bdbcf87b22ef5bb"
  ],
  "agent": [
    "dyn",
    "mla"
  ],
  "level": [
    "info",
    "error"
  ],
  "category": [
    "os",
    "api"
  ]
}'

Опциональные параметры:

• timestamp — дата в формате Unix Timestamp, до которой (включительно) все события будут удалены;
• id — ID записей, которые будут удалены;
• ip — IP-адрес сервера, где установлен компонент;
• uuid — идентификатор сервера, где установлен компонент;
• agent — название компонента;
• level — уровень серьезности сообщения;
• category — категория события.

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

Добавленные параметры сочетаются по принципу логического «И», а их значения — по принципу логического «ИЛИ».

Все события старше 90 дней удаляются автоматически.

# curl http://api.example.com:8080/nw-api/get_attack --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "startTime": 1677211703,
  "endTime": 1677211703,
  "limit": 100,
  "offset": 1,
  "bt": [
    1,
    2,
    3,
    7,
    9
  ],
  "ip": [
    "1.1.1.1",
    "2.2.2.2",
    "3.3.3.3"
  ],
  "cc": [
    "RU",
    "US",
    "UK"
  ],
  "vhost": [
    "example.com",
    "api.example.com",
    "shop.example.com"
  ]
}'

Опциональные параметры:

• startTime и endTime — начальная и конечная дата в формате Unix Timestamp, за который будет запрошена информация;
• limit — максимальное количество выводимых записей;
• offset — смещение для вывода последующих записей. При значении 0 и значении limit 100 будут выводиться записи с порядковым номером 1-100, при значении 1 — записи с порядковым номером 101-200 и т.д. Использование параметра без указания максимального количества выводимых записей (limit) невозможно.
• bt — идентификатор блокировки;
• ip — IP-адрес;
• cc — код страны;
• vhost — виртуальный хост, доменное имя.

Пример ответа:

{
  "status": "success",
  "count": "1234",
  "waf_id": "1234567890",
  "attacks": [
    {
      "id": 1,
      "timestamp": 1677211703,
      ...
      "description": "%data in plain-text%"
    },
    {
      "id": 2,
      "timestamp": 1234567891,
      ...
      "description": "%data in plain-text%"
    },
    ...
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/get_attack_stats --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "startTime": 1677211703,
  "endTime": 1677211753
}'

Опциональные параметры:
startTime и endTime — начальная и конечная дата в формате Unix Timestamp, за который будет запрошена информация.

Пример ответа:

{
  "status": "success",
  "bt": [
    {
      "bt": 1,
      ...
      "period": 14
    },
    {
      "bt": 2,
      ...
      "period": 14
    }
  ],
  "ip": [
    {
      "ip": "1.1.1.1",
      ...
      "period": 14
    },
    {
      "ip": "2.2.2.2",
      ...
      "period": 14
    }
  ],
  "cc": [
    {
      "cc": "RU",
      ...
      "period": 14
    },
    {
      "cc": "US",
      ...
      "period": 14
    }
  ],
  "vhost": [
    {
      "vhost": "example.com",
      ...
      "period": 14
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

period — количество событий по каждому bt/сс/vhost/ip за выбранный период;
bt — идентификатор блокировки;
ip — IP-адрес;
cc — код страны;
vhost — виртуальный хост, доменное имя.

Если период, за который необходимо получить данные, не задан параметрами startTime и endTime, то информация будет выводиться за последние 24 часа, 7 и 30 дней.

Пример ответа:

{
  "status": "success",
  "bt": [
    {
      "bt": 1,
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    },
    {
      "bt": 2,
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    }
  ],
  "ip": [
    {
      "ip": "1.1.1.1",
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    },
    {
      "ip": "2.2.2.2",
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    }
  ],
  "cc": [
    {
      "cc": "RU",
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    },
    {
      "cc": "US",
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    }
  ],
  "vhost": [
    {
      "vhost": "example.com",
      ...
      "lastDay": 1,
      "last7Days": 13,
      "last30Days": 84
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

bt — идентификатор блокировки;
ip — IP-адрес;
cc — код страны;
vhost — виртуальный хост, доменное имя.

# curl http://api.example.com:8080/nw-api/nws/get_target --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%"
}'

Пример ответа:

{
  "status": "success",
  "targets": [
    {
      "active": true,
      "target": "http://example.com",
      "scan_proxy": "http://example.com:3128",
      "auth_params": {
        "active": true,
        "url": "/login.php",
        "username_field": "username",
        "username_value": "admin",
        "password_field": "password",
        "password_value": "123456"
      },
      "exclude_modules": [
        "ba", "ca", "lfi", "rce", "rfi", "sde", "sqli", "ssrf", "ssti", "xss"
      ]
    },
    {
      "active": true,
      "target": "https://1.example.com"
      ...
    }
  ]
}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nws/set_target --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "active": true,
  "target": "http://example.com",
  "scan_proxy": "http://example.com:3128",
  "auth_params": {
    "active": true,
    "url": "/login.php",
    "username_field": "username",
    "username_value": "admin",
    "password_field": "password",
    "password_value": "123456"
  },
  "exclude_modules": [
    "ba", "ca", "lfi", "rce", "rfi", "sde", "sqli", "ssti", "xss"
  ]
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nws/set_target --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "set": {
    "target": "http://example.com",
    "scan_proxy": "null",
    "auth_params": {
      "active": true,
      "url": "null",
      "username_field": "null",
      "username_value": "null",
      "password_field": "null",
      "password_value": "null"
    },
    "exclude_modules": []
  }
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}

# curl http://api.example.com:8080/nw-api/nws/del_target --header 'Content-type: application/json' --data '{
  "key": "%Лицензионный ключ%",
  "target": "%Адрес веб-приложения%"
}'

Пример ответа:

{"status": "success"}

или

{"status": "fail", "description": "%описание ошибки%"}