Приложение 6. HTTPS-запросы для управления правилами KWTS

Для управления параметрами правил KWTS внешняя программа должна выполнять HTTPS-запросы к KWTS. Ниже запросы описаны на примере программы curl. Вы можете выполнить их из командной строки терминала.

Чтобы управлять параметрами правил с помощью внешней программы:

1. На Управляющем узле подключитесь к консоли управления виртуальной машиной KWTS под учетной записью root, используя закрытый ключ SSH.

   Вы войдете в режим Technical Support Mode.

2. Получите токен для работы с KWTS. Для этого выполните следующий запрос:

   HOSTNAME=$(hostname); \

   curl -q --silent --show-error --max-time 5 --noproxy '*' \

     --cacert /var/opt/kaspersky/kwts/certs/webapi.crt \

     --cookie-jar ./cookies.dat \

     https://${HOSTNAME}/web/api/get-auth-info

   Вы получите XSRF-токен, который будет сохранен в файле cookies.dat, и в консоли отобразятся данные в формате JSON. Пример

   {     "data": {         "attempts": {             "local": {                 "fails": 0,                 "max_allowed_fails": 5,                 "time_left": 0             },             "ntlm": {                 "fails": 0,                 "max_allowed_fails": 5,                 "time_left": 0             }         },         "is_authorized": false,         "is_kerberos_enabled": false,         "is_ntlm_enabled": true     } }

3. Создайте файл login_data.json следующего содержания:

   {

     "username":"<имя пользователя KWTS>",

     "password":"<пароль пользователя KWTS>"

   }

4. Для авторизации в KWTS выполните запрос:

   XSRF_TOKEN=$(grep XSRF-TOKEN ./cookies.dat | awk '{print $NF}'); \

   HOSTNAME=$(hostname); \

   curl -q --silent --show-error --fail --max-time 5 --noproxy '*' \

     --cacert /var/opt/kaspersky/kwts/certs/webapi.crt \

     -H "KWTS-XSRF-TOKEN:$XSRF_TOKEN" \

     -X POST -H 'Content-Type: application/json' \

     --data "$(cat ./login_data.json)" \

     --cookie ./cookies.dat --cookie-jar ./cookies.dat \

     https://${HOSTNAME}/web/api/user-login

   В консоли отобразится информация о пользователе. Пример

   {     "data": {          "cert_digest": "<Дайджест сертификата SHA256>",         "cluster_state": "normal",         "ip": "<IP-адрес узла>",         "kata_alert_enabled": false,         "kata_upload_enabled": false,         "ksn_regions": [],         "node_role": "master",         "port": <node port>,         "suggest_ksn": true,         "user_info": {             "capabilities": [                 "delete_global_role",                 "delete_global_rule",                 "delete_workspace",                 "diagnostic",                 "get_node_info",                 "integrity_check",                 "manage_global_dashboard",                 "manage_global_role",                 "manage_global_rule",                 "manage_node",                 "manage_settings",                 "manage_workspace",                 "reset_user_password",                 "show_audit_log",                 "show_global_dashboard",                 "show_global_roles",                 "show_global_rules",                 "show_global_traffic_events",                 "show_settings",                 "show_system_events",                 "show_workspaces",                 "ssh_access"             ],             "is_local": true,             "session_remaining_seconds": 600,             "user_id": 1,             "username": "<Имя пользователя>",             "workspaces": []         }     } }

   Время действия авторизации составляет 10 минут. В случае неактивности более 10 минут необходимо повторить шаг авторизации.

5. Для получения списка правил из раздела Защита выполните запрос:

   XSRF_TOKEN=$(grep XSRF-TOKEN ./cookies.dat | awk '{print $NF}'); \

   HOSTNAME=$(hostname); \

   curl -q --silent --show-error --fail --max-time 5 --noproxy '*' \

     --cacert /var/opt/kaspersky/kwts/certs/webapi.crt \

     -H "KWTS-XSRF-TOKEN:$XSRF_TOKEN" \

     -X GET -H "Content-Type: application/json" \

     --cookie ./cookies.dat --output ./protection_rules.json \

     https://${HOSTNAME}/web/api/show-rules?section=protection

   В текущей папке будет сохранен файл protection_rules.json, содержащий информацию обо всех правилах защиты. Пример

   {     "data": {         "rules": [             {                 "node_type": "rule",                 "rule_exclusions": [],                 "rule_general": {                     "rule_actions": {                         "doc_with_macro_action": "Block",                         "encrypted_action": "Block",                         "malicious_link_action": "Block",                         "malware_action": "Cure",                         "phishing_action": "Block"                     },                     "rule_blocking_template_text": "",                     "rule_comment": null,                     "rule_destinations": {},                     "rule_is_enabled": true,                     "rule_name": "Test 1",                     "rule_sources": {}                 },                 "rule_group_id": null,                 "rule_id": 11,                 "rule_time_restrictions": {                     "enable_revoke_at": false,                     "enable_schedule": false,                     "revoke_at": 1750663620,                     "schedule": {                         "days": {                             "Fri": true,                             "Mon": true,                             "Sat": true,                             "Sun": true,                             "Thu": true,                             "Tue": true,                             "Wed": true                         },                         "from": {                             "hour": 10,                             "minute": 27                         },                         "to": {                             "hour": 10,                             "minute": 27                         }                     }                 },                 "rule_version": 0,                 "section": "protection",                 "workspace_id": null             },             {                 "node_id": 3,                 "node_type": "workspace_placeholder",                 "section": "protection"             }         ]     } }

6. Если вы хотите получить детальную информацию о конкретном правиле, выполните запрос:

   XSRF_TOKEN=$(grep XSRF-TOKEN ./cookies.dat | awk '{print $NF}'); \

   HOSTNAME=$(hostname); \

   curl -q --silent --show-error --fail --max-time 5 --noproxy '*' \

     --cacert /var/opt/kaspersky/kwts/certs/webapi.crt \

     -H "KWTS-XSRF-TOKEN:$XSRF_TOKEN" \

     -X GET -H "Content-Type: application/json" \

     --cookie ./cookies.dat --output ./protection_rule.json \

     https://${HOSTNAME}/web/api/get-rule-info?rule_id=<ID правила из файла protection_rules.json, полученного на шаге 5>

   Информация о правиле будет сохранена в файл protection_rule.json. Пример

   { "data": { "node_type": "rule", "rule_exclusions": [], "rule_general": { "rule_actions": { "doc_with_macro_action": "Block", "encrypted_action": "Block", "malicious_link_action": "Block", "malware_action": "Cure", "phishing_action": "Block" }, "rule_blocking_template_text": "", "rule_comment": null, "rule_destinations": {}, "rule_is_enabled": true, "rule_name": "Rule_1", "rule_sources": { "operation": "any_of", "sources": [ { "type": "useragent", "values": [ "Firefox" ] }, { "type": "ip", "values": [ "10.0.0.0" ] } ] } }, "rule_group_id": null, "rule_id": 5, "rule_time_restrictions": { "enable_revoke_at": false, "enable_schedule": false, "revoke_at": 1750942260, "schedule": { "days": { "Fri": true, "Mon": true, "Sat": true, "Sun": true, "Thu": true, "Tue": true, "Wed": true }, "from": { "hour": 15, "minute": 51 }, "to": { "hour": 15, "minute": 51 } } }, "rule_version": 0, "section": "protection", "workspace_id": null } }

7. Если вы хотите изменить правило, выполните следующие действия:
   1. В файле protection_rule.json удалите объект "data". В примере ниже показаны только удаляемые строки:

      Пример:      "data": {     }

   2. В файле protection_rule.json измените параметры правила. Вы можете изменить следующие параметры:
      • rule actions – настройка действий для правил:
        • malware_action – действия при обнаружении вредоносной программы. Возможные значения: Cure – заблокировать, по возможности вылечить, Block – заблокировать, Allow – пропустить проверку.
        • phishing_action – действия при обнаружении фишинга. Возможные значения: Block – заблокировать, Allow – пропустить проверку.
        • malicious_link_action – действия при обнаружении вредоносной ссылки. Возможные значения: Block – заблокировать, Allow – пропустить проверку.
        • encrypted_action – действия при обнаружении зашифрованного объекта. Возможные значения: Block – заблокировать, Allow – пропустить проверку.
        • doc_with_macro_action – действия при обнаружении документа с макросом. Возможные значения: Block – заблокировать, Allow – пропустить проверку.
      • rule_name – название правила.
      • rule_is_enabled – статус правила. Возможные значения: true – включено, false – выключено.
      • rule_sources – инициатор, массив значений:
        • type – тип инициатора. Возможные значения: useragent – браузер, ip – IP-адрес.
        • values – значения инициатора.
        • operation – логический оператор. Возможные значения: any_of – любой из, all_of – все из.

      Пример измененного файла

      { "node_type": "rule", "rule_exclusions": [], "rule_general": { "rule_actions": { "doc_with_macro_action": "Block", "encrypted_action": "Block", "malicious_link_action": "Block", "malware_action": "Cure", "phishing_action": "Block" }, "rule_blocking_template_text": "", "rule_comment": null, "rule_destinations": {}, "rule_is_enabled": true, "rule_name": "Rule_1", "rule_sources": { "operation": "any_of", "sources": [ { "type": "useragent", "values": [ "Firefox" ] }, { "type": "ip", "values": [ "10.0.0.0" ] } ] } }, "rule_group_id": null, "rule_id": 5, "rule_time_restrictions": { "enable_revoke_at": false, "enable_schedule": false, "revoke_at": 1750942260, "schedule": { "days": { "Fri": true, "Mon": true, "Sat": true, "Sun": true, "Thu": true, "Tue": true, "Wed": true }, "from": { "hour": 15, "minute": 51 }, "to": { "hour": 15, "minute": 51 } } }, "rule_version": 0, "section": "protection", "workspace_id": null }

   3. Выполните запрос:

      XSRF_TOKEN=$(grep XSRF-TOKEN ./cookies.dat | awk '{print $NF}'); HOSTNAME=$(hostname); curl -H "Expect:" -q --silent --show-error --fail --max-time 5 --noproxy '*' --cacert /var/opt/kaspersky/kwts/certs/webapi.crt -H "KWTS-XSRF-TOKEN:$XSRF_TOKEN" -X POST -H 'Content-Type: application/json' --data "$(cat ./protection_rule.json)" --cookie ./cookies.dat https://${HOSTNAME}/web/api/edit-rule

   В консоли отобразится ответ:

   {"data":"success"}

8. Если вы хотите удалить правило, выполните следующие действия:
   1. Создайте файл delete_protection_rule_id.json следующего содержания:

      {

      "rule_id":<ID удаляемого правила>,

      "section":"protection"

      }

   2. Выполните запрос:

      XSRF_TOKEN=$(grep XSRF-TOKEN ./cookies.dat | awk '{print $NF}'); \

      HOSTNAME=$(hostname); \

      curl -q --silent --show-error --fail --max-time 5 --noproxy '*' \

      --cacert /var/opt/kaspersky/kwts/certs/webapi.crt \

      -H "KWTS-XSRF-TOKEN:$XSRF_TOKEN" \

      -X POST -H 'Content-Type: application/json' \

      --data "$(cat ./delete_protection_rule_id.json)" \

      --cookie ./cookies.dat \

      https://${HOSTNAME}/web/api/delete-rule

   В консоли отобразится ответ:

   {"data":"success"}