Формат шаблона (YAML)

Актуально для Kraken 2.22.4.

Шаблон событий Kraken - структурированный файл в формате YAML.

Формат шаблона

  • Данные в шаблоне в формате YAML
  • Если ключ или значение содержит специальные символы (':', '#', '@', '-', '?', ',', '[', ']', '{', '}', '&', '*', '!', '|', '>', '''', '"', '%', '`'), значение заключается в двойные кавычки.

Секция Template

Общая информация о шаблоне

  • Version - версия шаблона
  • Name - имя шаблона
  • Author - автор шаблона
  • Enable - флаг активации шаблона
  • Type - тип шаблона (служебное поле)

Секция Data

Данные, относящиеся ко всем событиям шаблона.

  • Index - индекс, топик или URL - в зависимости от используемого коннектора
  • _type - для Elasticsearch/OpenSearch
  • UserAgent - Строка пользовательского агента, для HTTP коннекторов
  • RawField - имя поля для «сырого» сообщения в JSON-коннекторах (по умолчанию Message)

Секция SMTP

Настройки SMTP коннектора

  • From - Адрес отправителя, пример sender@local
  • To - Адрес получателя, пример rec@local
  • Attachment - Прикреплять вложения
  • Random_attachment - прикреплять случайно выбранное вложение из папки attachment

Секция управляется только через файл шаблона.

Секция POST

Данные в этой секции хранятся в формате ключ=значение и применяются в соответствующих коннекторах (HTTP POST).

Секция JSON

Данные в этой секции хранятся в формате ключ=значение, используются при включении опции JSON и добавляются во все события.

Секция Templates

Массив строк шаблона

Переменные

В шаблоне используются переменные в синтаксисе {{имя}}; регистр имени не важен. Запись %имя% не поддерживается, запись {{{имя}}} тоже; неизвестная переменная заменяется на **ERROR**.

  • {{eps}} - EPS текущего генератора (String), пример: 19075; служебная переменная, доступна при генерации.
  • {{luuid}} - случайный UUID из списка LGuidList в нижнем регистре, пример: d38f422d-84ad-4a4f-a165-8845cee4e3dd; значение зависит от содержимого LGuidList.
  • {{shostname}} - статическое имя сервера (hostname из StaticVariables), String, пример: app-alkaphrah-prd; значение задаётся в StaticVariables.
  • {{CVE}} - случайный идентификатор CVE; формат CVE-YYYY-NNNN, год 2019..текущий, номер 0001..125000, минимум 4 цифры (5-6 при номере больше 9999); примеры: CVE-2019-0001, CVE-2024-125000.

Полный список 263 переменных с описанием, форматами и примерами - на странице Переменные.

Ограничения

  • Файл должен быть валидным YAML; для отступов используйте пробелы, а не табы.
  • Значения со специальными символами обрамляйте двойными кавычками (см. раздел «Формат шаблона»).
  • Используйте только секции, относящиеся к выбранному коннектору (SMTP, POST, JSON, Templates).
  • Ограничения подстановки переменных: списки (ip_list, domain_list, fqdn_list, hostname_list, useragent_list и т.п.) читаются из папки data; пустой или отсутствующий файл даёт пустую строку, а не ошибку.
  • referer_empty: в 94% случаев пустая строка, в остальных 6% - URL из списка.
  • Неизвестная переменная заменяется на **ERROR**; регистр имени не важен.
  • Литералы {{, }} и {{}} рендерятся пустой строкой.
  • Синтаксис %name% и {{{name}}} не поддерживается; используйте только {{name}}.

Примеры

Связанные разделы

Поделиться с друзьями