この Ansible ロールは、Python ベースのスクリプトをデプロイし、影響を受ける Log4j JAR ファイルから脆弱な JndiLookup クラスを削除することで、Log4Shell 脆弱性 (CVE-2021-44228) をプログラム的に緩和します。
Ansible 経由で実行するように設計されていますが、必要に応じてスクリプトを手動で実行することもできます。
Log4Shell 脆弱性の詳細については、以下を参照してください:
.jar、.war、.ear ファイルを検索しますJndiLookup.class が存在するかどうかを検証しますzipfile を使用して JndiLookup.class を削除します--apply を指定しない場合、スクリプトは
すべてのアーカイブを読み取り専用で開き、JndiLookup.class をまだ含んでいる
ものを報告します。バックアップや書き換えは一切行われません。ロールは
log4shell_apply: false でない限り --apply を渡しますPyYAML は、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 を
stdout に出力します。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 でも動作します。
適用。 log4shell_apply: true を指定した tasks/main.yml。オプション:
オプションで指定されない限り、何も再起動または再読み込みされず、何も 元に戻されることはありません。ダウングレードは脆弱性を復活させます。
結果。 stdout 上のスクリプトの最終行は
SAMP-RESULT {"format":1,"verdict":…,"counters":{…},"backups":[…],…} であり、
人間向けの key=N サマリー行の後に出力されます。verdict は 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 や改善を歓迎します -> フォークしてマージリクエストを送信してください。
本ソフトウェアおよび付属の Ansible ロールは**「現状のまま」**提供され、明示的または黙示的を問わず、いかなる種類の保証も行いません。本コードをいかなる環境に適用する前に、その適合性、安全性、有効性を評価およびテストする責任はすべてお客様にあります。AxisOps Ltd (GB08681761) は、本コードの使用または誤用に起因する損害、データ損失、サービス中断、その他の危害について、一切の責任を明示的に否認します。
自己責任でご使用ください。本番環境への展開前に、必ず管理された環境でコードを監査、テスト、検証してください。
SysOps Team @ AxisOps