Введение

Добро пожаловать 🎇 🎇 🎇

Шерлок — это не просто инструмент, а помощник, с которым удобно работать каждый день. Его можно воспринимать как напарника: к нему обращаются по имени, его упоминают в разговоре. Поэтому название Шерлока естественно склоняется и живет в языке — «в Шерлоке», «с Шерлоком», «передать Шерлоку» звучит так же органично, как в общении с коллегой.

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

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

Шерлок берет на себя рутинные процессы, помогая сосредоточиться на более важных задачах. Автоматизация постепенно расширяется, делая работу быстрее и удобнее — так, чтобы взаимодействие с продуктом ощущалось как помощь надежного напарника.

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

Документация структурирована по разделам:

• Установка Шерлока
  • Описание различных способов установки и запуска Шерлока.
• Настройка Шерлока
  • Описание настроек интеграций со сканерами, системами разработки (GitLab, Jira), подключение LDAP, управление пользователями и ролями.
• Работа с активами
  • Создание активов, настройка прав доступа, настройки интеграций со сканерами, системами разработки (GitLab, Jira), анализ рисков активов, работа с карточкой репозитория.
• Работа с ИБ-дефектами
  • Сценарии импорта данных в Шерлока, возможные действия с ИБ-дефектами, описание карточек ИБ-дефектов, дашборды, история сканирований, настройка Security Gate и создание отчетов.
• Поиск ИБ-дефектов
  • Глобальный поиск ИБ-дефектов по всем репозиториям, существующим в Шерлоке.
• Логи
  • Получение сведений/информации о событиях в Шерлоке и о том, кто выполнял действия.
• Работа с API
  • Автоматизация действий при работе с Шерлоком.
• О Системе
  • Информация об вашей версии Шерлока.
• Функциональные характеристики
  • Общее описание возможностей Шерлока.
• Релизы
  • Информация о новых функциях, изменениях и доработках.