Перейти к основному содержимому
Версия: v1.1.x

Действия с ИБ-дефектами

Шерлок предоставляет множество различных возможностей по работе с ИБ-дефектами, которые могут пригодиться специалисту по безопасной разработке при реализации повседневных задач.
Возможна реализация действий как с конкретным ИБ-дефектом, так и совершение массовых операций над множеством ИБ-дефектов.

Одиночные действия с ИБ-дефектами​

Изменение статуса​

  1. Для изменения статуса ИБ-дефекта необходимо открыть карточку ИБ-дефекта.

  2. Нажать кнопку изменения статуса ().

  3. Заполнить необходимые параметры в открывшемся окне:

    • Статус: выбрать новый статус из предложенного списка;

      к сведению

      Некоторые статусы проставляются автоматически и не могут быть проставлены вручную:

      В работе: статус устанавливается при создании задачи в Jira.

      Устранен: статус устанавливается в случае, если при повторном импорте ИБ-дефектов (любым из возможных способов), ИБ-дефект не был обнаружен.

      Повторно найден: статус устанавливается для ИБ-дефектов, которые были устранены, но впоследствии были повторно обнаружены.

      Возможные сценарии перехода статусов могу варьироваться в зависимости от текущего.

      Часть переходов между статусами возможна только для типа ИБ-дефектов Secrets. Это обусловлено анализом, при котором осуществляется сканировании истории git-репозитория.

      Допустим сценарий:

      • В коммите №1 был добавлен секрет;
      • В коммите №2 - устранён. Получается, что секрет все равно присутствует в кодовой базе, но был "удалён" из неё, что не является обязательным показателем того, что он был изменён и более не валиден.

      Таблица возможных переходов статусов.
      СтатусВозможные переходы
      Новый Подтвержден
      Ложное срабатывание
      Риск принят
      Проигнорирован
      Подтвержден Ложное срабатывание
      Риск принят
      Проигнорирован
      Ложное срабатывание Подтвержден
      Проигнорирован
      Устранен (только для Secrets)
      В работе Проигнорирован
      Устранен (только для Secrets)
      Риск принят Подтвержден
      Проигнорирован
      Устранен Подтвержден
      В работе
      Удалён (только для Secrets) Подтвержден
      Ложное срабатывание
      В работе
      Риск принят
      Устранен
      Проигнорирован
      Повторно найден Подтвержден
      Ложное срабатывание
      Риск принят
      Проигнорирован
      Проигнорирован Подтвержден

    • Комментарий: указать причину изменения статуса.

  4. Нажать кнопку Изменить. В случае успеха Шерлок оповестит о том, что статус ИБ-дефекта изменен и можно продолжать работу.

Изменение уровня критичности​

  1. Для изменения уровня критичности ИБ-дефекта необходимо открыть карточку ИБ-дефекта.

  2. Нажать кнопку изменения уровня критичности ().

  3. Выбрать новый уровень критичности из предложенного списка.

  4. Указать причину изменения уровня критичности.

  5. Нажать кнопку Изменить. В случае успеха Шерлок оповестит о том, что уровень критичности ИБ-дефекта изменен и можно продолжать работу.

к сведению

Шерлок сохраняет исходный уровень критичности, получаемый от сканера. Он отображается в Карточке ИБ-дефекта, на вкладке сканера.

Работа с комментариями​

Создание комментария​

  1. Для создания комментария необходимо открыть карточку ИБ-дефекта.
  2. Написать комментарий в поле для ввода текста раздела Комментарии.
  3. Нажать кнопку Добавить. В случае успеха, добавленный комментарии отобразится в общем списке.

Редактирование комментария​

  1. Для создания комментария необходимо открыть карточку ИБ-дефекта.

  2. Выбрать комментарий, который требуется изменить, нажать на Меню действий () и выбрать Изменить ().

  3. Отредактировать комментарий в открывшемся окне.

  4. Нажать кнопку Сохранить. В случае успеха Шерлок оповестит о том, что комментарий изменен и можно продолжать работу.

к сведению

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

Удаление комментария​

  1. Для удаление комментария необходимо открыть карточку ИБ-дефекта.

  2. Выбрать комментарий, который требуется удалить, нажать на Меню действий () и выбрать Удалить ().

  3. В открывшейся форме нажать кнопку Да, удалить. В случае успеха Шерлок оповестит о том, что комментарий удален и можно продолжать работу.

Работа с исключениями​

Добавление ИБ-дефекта в исключения позволяет не учитывать его при анализе выполнения правил Security Gate.

Добавление исключения​

  1. Для ИБ-дефекта в исключения необходимо открыть карточку ИБ-дефекта.

  2. Нажать на Меню действий () и выбрать Добавить в исключения ().

  3. Заполнить необходимые параметры в открывшемся окне:

    • Период: срок действия исключения;
    • Комментарий: указать причину добавления ИБ-дефекта в исключения.

  4. Нажать кнопку Добавить. В случае успеха Шерлок оповестит о том, что ИБ-дефект был добавлен в исключения и можно продолжать работу.

Отзыв исключения​

  1. Для отзыва исключения ИБ-дефекта необходимо открыть карточку ИБ-дефекта.

  2. Нажать на Меню действий () и выбрать Добавить в исключения ().

  3. Нажать кнопку Отозвать исключение.

  4. Нажать кнопку Да, удалить. В случае успеха Шерлок оповестит о том, что исключение ИБ-дефекта было отозвано и можно продолжать работу.

Просмотр всех исключений​

  1. Для просмотра всех исключений необходимо, находясь в репозитории, перейти в раздел Исключения ().

  2. Для получения полной информации об ИБ-дефекте, находящемся в исключениях, необходимо нажать на Меню действий () и выбрать К дефекту (). В этом случае Шерлок откроет новую страницу с карточкой ИБ-дефекта.

  3. Находясь во вкладке Исключения можно отозвать его у произвольного ИБ-дефекта. Для этого необходимо нажать на Меню действий () и выбрать Удалить ().

  4. Нажать кнопку Да, удалить. В случае успеха Шерлок оповестит о том, что исключение ИБ-дефекта было отозвано и можно продолжать работу.

Создание задачи в Jira​

внимание

Функционал создания задач в Jira доступен только при условии, то настроена интеграция репозитория с Jira-пространством.

  1. Для создания задачи в Jira необходимо открыть карточку ИБ-дефекта.

  2. Нажать на Меню действий () и выбрать Создать задачу в Jira ().

  3. Заполнить необходимые параметры в открывшемся окне:

    • Название: наименование задачи, как оно будет отображаться в Jira;
    • Тип: тип создаваемой в Jira задачи;
    • Приоритет: приоритет создаваемой в Jira задачи.

  4. Нажать кнопку Создать. В случае успеха Шерлок оповестит о том, что задача в Jira была создана и можно продолжать работу.

Массовые действия с ИБ-дефектами​

  1. Для совершения массовых действий необходимо, находясь в таблице ИБ-дефектов, выбрать произвольное количество ИБ-дефектов ().

  2. Выбрать необходимое действие. Набор массовых действий аналогичен набору одиночных действий для ИБ дефектов:

    • Создание задачи в Jira (одна задача для выбранных ИБ-дефектов);
    • Создание задач в Jira (одна задача для каждого выбранного ИБ-дефекта);
    • Изменение статуса;
    • Добавление в ИБ-дефекта в исключения;
    • Изменение уровня критичности;
    • Создание комментария.

  3. Заполнить информацию в открывшемся окне.

    к сведению

    Информация, которую необходимо предоставить аналогична информации при совершении одиночных действий над ИБ-дефектом.

  4. Нажать над кнопку подтверждения операции (Создать, Изменить, Добавить — в зависимости от выбранного действия). В случае успеха Шерлок оповестит о том, что действие успешно выполнено и можно продолжать работу.

Просмотр истории изменения ИБ-дефекта​

  1. Для просмотра истории изменения ИБ-дефекта необходимо открыть карточку ИБ-дефекта.
  2. Нажать на Меню действий ().
  3. Нажать на иконку истории изменения ().
к сведению

В истории изменения ИБ-дефектов поддерживаются фильтры по таким параметрам, как:

  • Статус: действия со статусом ИБ-дефекта;
  • Критичность: действия с уровнем критичности ИБ-дефекта;
  • Задача в Jira: информация о задаче в Jira, связанной с ИБ-дефектом;
  • Комментарий: действия с комментариями ИБ-дефекта.

Фильтрация и поиск ИБ-дефектов​

Фильтрация ИБ-дефектов​

Шерлок предоставляет возможность фильтрации для того, чтобы получить релевантную выборку данных ИБ-дефектов. Набор фильтров будет варьироваться в зависимости от типа ИБ-дефектов. Группировка фильтров влияет только на их отображение и не изменяет состав доступных фильтров.

Для использования фильтров необходимо нажать кнопку Фильтр () и выбрать необходимые фильтры из доступных.

Возможно использование следующих фильтров для ИБ-дефектов типа Secrets:

  • Критичность: уровень критичности ИБ-дефекта;
  • Статус: статус ИБ-дефекта;
  • Сканер: сканер, выявивший ИБ-дефект;
  • Статус в Jira: статус задачи в Jira;
  • Исполнитель: логин пользователя в Jira, на которого назначена задача;
  • Только пересечения: отображение только тех ИБ-дефектов, которые были выявлены двумя и более сканерами.
к сведению

Фильтры Статус в Jira и Исполнитель доступны в случае, если настроена двусторонняя интеграция с Jira (зарегистрирован веб-хук).

Поиск ИБ-дефектов​

Шерлок предоставляет возможность поиска для того, чтобы было проще найти определенный ИБ-дефект в общем списке. Критерии поиска будут варьироваться в зависимости от типа ИБ-дефектов.

Для использования поиска необходимо указать в строке поиска критерии, подходящие для выбранного типа ИБ-дефектов.

Возможно использование следующих критериев для поиска ИБ-дефектов типа Secrets:

  • Файл: файл, в котором был найден ИБ-дефект;
  • Задача в Jira: кодовое обозначение задачи в Jira.

Группировка ИБ-дефектов​

Шерлок предоставляет возможность группировки ИБ-дефектов для более удобной работы и реализации разметки. Критерии группировки будут варьироваться в зависимости от типа ИБ-дефектов.

Для использования группировки необходимо нажать кнопку Группировать () и выбрать критерий для группировки (в случае, если это применимо для ИБ-дефектов выбранного типа).

Возможно использование следующих критериев группировки ИБ-дефектов типа Secrets:

  • Уязвимому файлу: файл, в котором был найден ИБ-дефект.