
журнал log4j по снижению рисков
Эта роль Ansible развёртывает скрипт на Python для программного смягчения уязвимости Log4Shell (CVE-2021-44228) путём удаления уязвимого класса JndiLookup из затронутых JAR-файлов Log4j.
Она предназначена для запуска через Ansible, но при желании вы можете выполнить скрипт и вручную.
Подробнее об уязвимости Log4Shell читайте здесь:
.jar, .war и .ear в указанных каталогах приложенийJndiLookup.classJndiLookup.class с помощью модуля Python zipfile--apply скрипт открывает каждый архив
только для чтения и сообщает о тех, которые всё ещё содержат JndiLookup.class; ничего не
копируется и не перезаписывается. Роль передаёт --apply, если не указано
log4shell_apply: falsePyYAML, только для запуска, читающего YAML-файл конфигурации (установленный
apply). Роль устанавливает его из дистрибутива (python3-yaml,
py3-yaml или python3-pyyaml), никогда из PyPI. Точке входа обнаружения
нужна только стандартная библиотека: её конфигурация передаётся как JSON через stdinzip или zipinfo не требуются: архивы читаются и перезаписываются с помощью
стандартной библиотеки zipfile, что важно на минимальных базовых образах контейнеров,
где ни один из них не установлен.
Скрипт настраивается через YAML-файл, который автоматически шаблонизируется ролью.
Пример config.yaml:
app_directories:
- /opt/apps
backup_directory: /opt/backups
log_file: /var/log/log4j_mitigation.log
app_directories: список каталогов для поиска JAR-файловbackup_directory: где хранить резервные копии исходных JAR-файловlog_file: путь к файлу журнала для отслеживания операцийДобавьте эту роль в свой playbook:
- name: Mitigate Log4Shell CVE-2021-44228
hosts: all
become: true
roles:
- log4shell_mitigation
Если вы хотите запустить скрипт вручную, вы можете сделать это следующим образом:
Скопируйте скрипт и общую библиотеку рядом с ним на целевую машину:
files/log4shell_mitigator.py
files/samp_common.py
Создайте собственный файл config.yaml в том же каталоге.
Запустите его:
python3 log4shell_mitigator.py # dry run, config.yaml beside the script
python3 log4shell_mitigator.py --config /path/to/config.yaml
sudo python3 log4shell_mitigator.py --apply # back up and rewrite
scanned=N vulnerable=N patched=N already_stripped=N unreadable=N failed=N nested_needing_review=N dry_run=N. vulnerable подсчитывает архивы, всё ещё содержащие JndiLookup.class; already_stripped подсчитывает архивы log4j-core без него. Если nested_needing_review или unreadable не равны нулю, эти архивы не были оценены и требуют ручной обработки; в логе указан каждый из них.0 — не осталось ничего, содержащего класс, 2 — архив всё ещё содержит его или не может быть оценён, 1 — сбой резервного копирования или перезаписи, 130 — прервано/var/log/log4j_mitigation.log), чтобы увидеть, какие JAR-файлы были пропатченыЭтот репозиторий является SAMP: Microcelium Substrate импортирует его по этому точному URL, фиксирует по коммиту, проверяет подпись тега релиза, сканирует его, и человек одобряет его перед запуском где-либо.
Манифест. samp.yaml объявляет CVE, хосты, к которым он применяется, точки входа обнаружения и применения, необходимость root для каждой из них, опции с их значениями по умолчанию, каждый путь, который записывает применение (touches), каждую программу, которую оно запускает (commands), и юниты, которые оно может перезапустить. Ревьюер читает его первым; substrate сверяет код с ним.
Обнаружение ничего не записывает. tasks/detect.yml размещает скрипт и samp_common.py во временном каталоге с приватным доступом, запускает его с конфигурацией в виде JSON на stdin и логом на stdout, а затем удаляет каталог. Никакой скрипт не устанавливается, никакая конфигурация не шаблонизируется, никакой каталог резервных копий не создаётся, никакой файл лога не записывается и никакой пакет не устанавливается. Он также работает под ansible-playbook --check, потому что только читает.
Применение. tasks/main.yml с log4shell_apply: true. Опции:
Ничего не перезапускается и не перезагружается, если опция не указывает на это, и ничего никогда не откатывается: понижение версии восстанавливает уязвимость.
Результат. Последняя строка скрипта в stdout — SAMP-RESULT {"format":1,"verdict":…,"counters":{…},"backups":[…],…}, после человекочитаемой строки сводки key=N. Вердикт — один из vulnerable, no_fix, unknown, fixed (с "workaround":true, когда действует обходной путь, а не исправленный пакет), not_affected или failed.
Коды выхода. 0 — чисто (fixed, not_affected), 2 — уязвимо или не определено (vulnerable, no_fix, unknown: никогда не чисто), 1 — сам запуск завершился неудачей, 130 — прервано.
Общий код. log4shell_mitigation/files/samp_common.py — побайтовая копия samp-common 1.0.3 (сравнения версий dpkg, rpm и apk, строка результата, загрузка конфигурации). Его sha256 указан в samp.yaml, и tests/test_samp_pack.py завершается с ошибкой, если копия отличается. Никогда не редактируйте его здесь; повторно вендорьте его с помощью scripts/vendor.py из samp-common.
Релизы — это аннотированные теги с SSH-подписью, samp/v<version> (этот: samp/v1.0.3), подписанные ключом с аппаратной поддержкой. Substrate импортирует подписанный тег, никогда не ветку.
MIT
PR и улучшения приветствуются -> пожалуйста, сделайте форк и отправьте merge request.