SEDATED

Проект SEDATED® (Sensitive Enterprise Data Analyzer To Eliminate Disclosure) направлен на предотвращение попадания в Git конфиденциальных данных, таких как учётные данные и токены пользователей.

Оглавление

• Назначение
• Настройка
  • Клонируйте SEDATED®
  • Обновите файлы .example
  • Настройте переменные и функции /config/custom_configs.sh (по желанию)
  • Отправьте SEDATED® с реализацией, специфичной для организации
  • Укажите pre-receive hook на файл pre-receive.sh от SEDATED®
• Локальное тестирование
• Описания файлов
  • pre-receive.sh
  • /config/custom_configs.sh
  • /config/enforced_repos_list.txt
  • /config/regexes.json
  • /config/whitelists/commit_whitelist.txt
  • /config/whitelists/repo_whitelist.txt
  • /testing/regex_testing/regex_test_script.sh
  • /testing/regex_testing/test_cases.txt
• Настройка
  • Пользовательские переменные
  • Пользовательские функции
• Совместимость
  • GitHub
  • GitLab
  • Git
  • Любой другой Git SCM-инструмент
• Участие
• Авторы
• Лицензия

Назначение

Из-за огромного количества изменений кода, необходимых в современной среде CICD, разработчики постоянно отправляют код, который может непреднамеренно содержать конфиденциальную информацию. Такое потенциальное раскрытие конфиденциальных данных представляет собой огромный риск для организаций (2017 OWASP Top Ten #3 — Раскрытие конфиденциальных данных). SEDATED® решает эту проблему, автоматически проверяя все входящие изменения кода и предоставляя разработчику мгновенную обратную связь. Если он обнаруживает конфиденциальные данные, он предотвращает отправку коммита(ов) на Git-сервер.

**ПРИМЕЧАНИЕ: ТОЛЬКО добавляемые или изменяемые строки (начинающиеся с + в файле патча) в отправляемых коммитах сканируются SEDATED®. Удаляемые строки (начинающиеся с - в файле патча) при отправке коммитов НЕ сканируются SEDATED®.

Настройка

1. Клонируйте SEDATED®

git clone https://github.com/OWASP/SEDATED.git

cd SEDATED/

2. Обновите файлы .example

cp /config/whitelists/commit_whitelist.txt.example /config/whitelists/commit_whitelist.txt

cp /config/whitelists/repo_whitelist.txt.example /config/whitelists/repo_whitelist.txt

cp /config/enforced_repos_list.txt.example /config/enforced_repos_list.txt

3. Настройте переменные и функции /config/custom_configs.sh (по желанию)

4. Отправьте SEDATED® с реализацией, специфичной для организации

Отправьте реализацию SEDATED®, специфичную для организации, в нужный Git-репозиторий организации (GitHub, GitLab, Git и т. д.).

5. Укажите pre-receive hook на файл pre-receive.sh от SEDATED®

Инструкции по выполнению этого на экземпляре GitHub Enterprise можно найти в GitHub_Enterprise_Setup.md.

Локальное тестирование

• Настройка GitHub Docker — общие инструкции по настройке docker-контейнера GitHub в качестве Git-сервера с включённым pre-receive hook для локального тестирования.
  • Потребуются некоторые изменения, чтобы SEDATED® работал как задумано.
    • always_reject.sh необходимо заменить на скрипт pre-receive.sh от SEDATED®.
    • Сопутствующие файлы/структуру папок SEDATED® необходимо разместить в том же каталоге или сделать доступными для скрипта pre-receive.sh.
    • Могут также потребоваться некоторые дополнительные настройки, но приведённые выше инструкции — хорошая отправная точка для локального тестирования.