Перейти к содержанию

Шаблоны описания дефектов

Примечание

Для выполнения нижеописанных действий требуется роль Администратора.

Нажмите иконку администрирования в правом верхнем углу. На открывшейся странице администрирования выберите слева в консоли пункт меню Templates.

На странице Templates расположены шаблоны описания дефектов. Они используются для автоматического заполнения полей дефекта безопасности при его создании на основе одной или нескольких проблем безопасности.

Для каждого типа проблем безопасности (SAST, SCA Compliance, SCA Security, DAST) должен быть использован свой шаблон описания дефектов.

В AppSec.Hub существуют предустановленные шаблоны описания дефектов для всех типов проблем безопасности.

Примечание

В системе может быть только один активный шаблон каждого для каждого типа проблем безопасности (SAST, SCA Compliance, SCA Security, DAST).

Все новые дефекты на основе проблем безопасности создаются с помощью шаблонов, находящихся в активном состоянии (Active).

Для каждого шаблона отображается следующая информация:

  • Имя шаблона.
  • Состояние шаблона – активное / неактивное (Active / Inactive).
  • Type — тип шаблона (SAST, SCA Compliance, SCA Security, DAST).
  • Author — имя пользователя, создавшего шаблон.
  • Created — дата создания шаблона.
  • Updated — дата последнего обновления шаблона.

Кроме того, справа в конце строки каждого шаблона представлено выпадающее меню «», содержащее пункты:

  • Activate template — с помощью этого пункта можно перевести шаблон в из неактивного в активное состояние. При активации шаблона все остальные шаблоны того же типа будут переведены в неактивное состояние.
  • Clone template — этот пункт позволяет клонировать существующий шаблон со всеми его параметрами. После нажатия на этот пункт выпадающего меню система позволяет внести изменения во все редактируемые поля создаваемого шаблона перед его сохранением.
  • Delete template — этот пункт используется для удаления шаблона. Удалить можно только шаблон, находящийся в неактивном состоянии.

Предусмотрена возможность фильтрации шаблонов описания дефектов с помощью кнопки Show filters в правом верхнем углу по следующим параметрам:

  • by name — по имени шаблона;
  • by status — по статусу шаблона (Active / Inactive);
  • by type — по типу шаблона (SAST, SCA Compliance, SCA Security, DAST).

Редактирование шаблона

Чтобы отредактировать существующий шаблон, нажмите на его имя в таблице шаблонов.

Если редактируемый шаблон находится в неактивном состоянии, его можно активировать в окне редактирования с помощью кнопки Activate. После внесения необходимых изменений нажмите кнопку Save template.

AppSec.Hub позволяет редактировать все существующие шаблоны.

Создание шаблона

Для создания нового шаблона нажмите кнопку Add template в верхнем правом углу страницы Templates и заполните следующие поля:

  • Template name — имя шаблона.
  • Select issue type — тип шаблона (SAST, SCA Compliance, SCA Security, DAST).
  • Defect template info — информация о создаваемом шаблоне.
  • Defect summary template — шаблон, используемый для заполнения строки с кратким описанием создаваемого дефекта (поля Summary данного дефекта).
  • Defect description template — шаблон, используемый для заполнения подробного описания создаваемого дефекта (информации, отображаемой в дефекте на вкладке Description).

После заполнения полей нажмите кнопку Create template.

Примечание

Поля шаблона Defect summary template и Defect description template необходимо заполнять в соответствии с документацией инструмента FreeMarker. Валидация синтаксиса двух данных полей проводится на этапе сохранения шаблона.

Описание параметров шаблонов и примеры готовых шаблонов всех типов приведены в «Приложении 16. Шаблоны дефектов безопасности», а также в репозитории GitHub с шаблонами дефектов.

Проверка шаблонов

Для проверки измененных шаблонов можно использовать следующий инструмент.

К началу