此 Ansible 角色部署一个基于 Python 的脚本,通过从受影响的 Log4j JAR 文件中移除存在漏洞的 JndiLookup 类,以编程方式缓解 Log4Shell 漏洞(CVE-2021-44228)。
它设计为通过 Ansible 运行,但你也可以根据需要手动执行该脚本。
在此了解更多关于 Log4Shell 漏洞的信息:
.jar、.war 和 .ear 文件JndiLookup.classzipfile 移除 JndiLookup.class--apply 的情况下,脚本以只读方式打开每个归档文件,并报告仍携带 JndiLookup.class 的归档文件;不会备份或重写任何内容。除非设置 log4shell_apply: false,否则该角色会传递 --applyPyYAML,仅用于读取 YAML 配置文件的运行(已安装的 apply)。该角色从发行版(python3-yaml、py3-yaml 或 python3-pyyaml)安装它,绝不从 PyPI 安装。检测入口仅需要标准库:其配置以 JSON 形式通过 stdin 传入不需要 zip 或 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、带默认值的选项、apply 会写入的每个路径(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 会失败。切勿在此处编辑它;请使用 samp-common 的 scripts/vendor.py 重新引入。
发布版本是 SSH 签名的附注标签 samp/v<version>(本次为:samp/v1.0.3),使用硬件支持的密钥签名。substrate 导入的是已签名的标签,绝不会是分支。
MIT
欢迎提交 PR 和改进 -> 请 fork 并提交合并请求。
本软件及随附的 Ansible 角色按**“原样”**提供,不附带任何明示或暗示的保证。在将本代码应用于任何环境之前,您需自行负责评估和测试其适用性、安全性和有效性。AxisOps Ltd (GB08681761) 明确声明对因使用或误用本代码而导致的损害、数据丢失、服务中断或其他伤害不承担任何责任。
使用风险自负。在部署到生产环境之前,请务必在受控环境中审计、测试并验证代码。
SysOps 团队 @ AxisOps