SASTのGitHub Actionsへの組み込み
サンプルコードが用意できたので、Semgrep を GitHub Actions のワークフローに組み込み、プルリクエスト時にマージ前チェックとして機能する 状態まで作っていきます。GitHub Actionsはリポジトリ上のコードを起点に動くため、まずローカルのコードをGitHub上に置く準備から始めます。
1. GitHubリポジトリの準備
GitHub Actionsを動かすには、その入れ物となるGitHubリポジトリにコードが乗っている必要があります。本章専用の検証用リポジトリを新規に作成し、ローカルのサンプルコードをPushします。
1.1 リポジトリの新規作成
GitHubの画面右上の「+」ボタンから「New repository」をクリックします。
| 設定項目 | 値 | 設定の基準 |
|---|---|---|
| Repository name | sast-handson |
識別しやすい名前にする |
| Visibility | Private | 検証用のため外部公開する必要はない |
| Add a README file | チェックしない | ローカルにすでにファイルがあるため初期化不要 |
「Create repository」をクリックします。
| 💡 ポイント |
|---|
| GitHub Actions は、PrivateリポジトリでもGitHub Free プランで月2,000分まで無料で利用できます。Semgrepジョブは1回あたり1〜2分なので、本章の数回分の実行であれば十分無料枠に収まります。さらに、GitHubにクレジットカードを未登録の状態であっても無料枠の範囲で実行できます(無料枠を使い切ると自動停止し、追加課金は発生しません)。詳しい料金体系はAbout billing for GitHub Actions(GitHub公式ドキュメント)に記載があります。 |
1.2 ローカルリポジトリをGitHubにPush
続いて、サンプルコードをGitHubにPushしていきます。
以下のコマンドで、Git がインストールされていることを確認します。
git --version
以下のように Git のバージョンが表示されれば、インストールは確認できています。
git version 2.x.x
バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。
インストールが確認できたら、sast-handson フォルダで、Gitリポジトリとして初期化します。
git init
ファイルをコミットします。
git add vulnerable_app.py .gitignore
git commit -m "Add vulnerable app for SAST handson"
リモートリポジトリを設定します(<your-username> をご自身のGitHubユーザ名に置き換えてください)。
git remote add origin https://github.com/<your-username>/sast-handson.git
mainブランチを作成してPushします。
git branch -M main
git push -u origin main
GitHubのリポジトリページで vulnerable_app.py がコミットされていれば、リポジトリの準備は完了です。
2. ワークフロー追加用ブランチの作成
ワークフローファイルを追加するための新しいブランチを作成します。
git switch -c add-sast
3. ワークフローファイルの作成
Semgrepを動作させるためのワークフローを作成していきます。
Visual Studio Codeのエクスプローラーで sast-handson フォルダを右クリックし、「新しいフォルダー」から .github/workflows を作成し、その中に sast.yml を作成します。
sast-handson
├── vulnerable_app.py
├── .gitignore
└── .github/
└── workflows/
└── sast.yml ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。
name: SAST
on:
pull_request:
branches:
- main
jobs:
semgrep:
name: Semgrep scan
runs-on: ubuntu-latest
container:
image: semgrep/semgrep
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run Semgrep
run: semgrep scan --config auto --error .
ワークフローを解説します。
on:
pull_request:
branches:
- main
main ブランチをターゲットにしたプルリクエストの作成・更新時にこのワークフローが実行されます。本章では「mainへの変更は必ずプルリクエスト経由」というチーム開発のスタイルを前提にしているため、mainへのプルリクエスト時のチェックさえ通っていれば品質は担保できます。push: トリガーは付けず、branches: で対象を main に絞ることで、mainに入るコードだけを確実にチェックする構成にしています。
container:
image: semgrep/semgrep
ジョブの実行環境としてSemgrep公式のDockerイメージを指定しています。これによりSemgrepが事前にインストールされた状態で実行できるため、追加のインストール処理が不要になります。
- name: Run Semgrep
run: semgrep scan --config auto --error .
semgrep scan でリポジトリ全体(.)をスキャンします。--config auto で対象言語のルールセットを自動適用し、--error で 検知が1件でもあれば終了コード1で終了 します。これによりSemgrepの検知がそのままワークフローの失敗に繋がり、マージ前チェックの仕組みが成立します。
4. ブランチのコミットとPush
作成したワークフローファイルをGitHubにPushしていきます。
git add .github/workflows/sast.yml
git commit -m "Add Semgrep workflow"
git push -u origin add-sast
5. プルリクエストの作成
ブランチがGitHub上に上がったので、main に取り込むためのプルリクエストを作ります。今回のワークフローはプルリクエスト時にだけ動く設定にしているため、このプルリクエストが作られた瞬間に 初めてSemgrepが起動 し、現在のリポジトリ状態に対する初回スキャン結果が出てきます。GitHubのリポジトリページに表示される「Compare & pull request」ボタンをクリックし、プルリクエストを作成します。
プルリクエストが作成されると、ワークフローが自動で実行されます。続いてこの初回ワークフロー実行結果を読み解き、Semgrepが何を検出したかを確認します。
6. 初回ワークフロー実行結果と検出内容の確認
プルリクエストには、ワークフロー追加の変更と、まだ手付かずの脆弱なコードの両方が含まれた状態でSemgrepが実行されるため、結果はFailureで完了します。プルリクエスト画面下部の「Checks」セクション、または「Actions」タブで実行された「SAST」ワークフローを開き、「Semgrep scan」ジョブの Run Semgrep ステップを展開すると、以下のようなログが表示されます。
| 💡 ポイント |
|---|
| 実際の出力はバージョンによって若干異なります。 |
┌────────────────┐
│ 7 Code Findings │
└────────────────┘
vulnerable_app.py
❯❱ generic.secrets.security.detected-generic-api-key.detected-generic-api-key
Detected a generic API key. Verify whether this is a real credential.
8┆ API_KEY = "sk-1234567890abcdef"
❯❱ python.lang.security.audit.dangerous-system-call.dangerous-system-call
Found user-controlled data in system call. This could lead to a command
injection vulnerability.
35┆ os.system(f"echo {message} >> {log_path}")
❯❱ python.lang.security.audit.eval-detected.eval-detected
Detected the use of eval(). eval() can be dangerous if used to evaluate
dynamic content.
23┆ return eval(code)
❯❱ python.lang.security.audit.formatted-sql-query.formatted-sql-query
Detected possible formatted SQL query. Use parameterized queries instead.
28┆ query = f"SELECT * FROM users WHERE id = {user_id}"
❯❱ python.lang.security.audit.hardcoded-password.hardcoded-password
A hardcoded password was detected. Never hardcode passwords.
7┆ DATABASE_PASSWORD = "admin123"
❯❱ python.lang.security.audit.hashing.weak-hash.weak-hash
Detected MD5 hash algorithm which is considered insecure. MD5 is not
collision resistant and is therefore not suitable as a cryptographic
signature.
13┆ return hashlib.md5(password.encode()).hexdigest()
❯❱ python.lang.security.audit.subprocess-shell-true.subprocess-shell-true
Found 'subprocess' function with 'shell=True'. This is dangerous because
it can lead to command injection.
18┆ subprocess.run(user_input, shell=True)
Ran 1000+ rules on 1 file: 7 findings.
検出結果を解説します。
6.1 ハードコードされた認証情報の検出
python.lang.security.audit.hardcoded-password.hardcoded-password
generic.secrets.security.detected-generic-api-key.detected-generic-api-key
パスワードやAPIキーといった認証情報が、ソースコードに直接書き込まれている箇所が検出されています。ソースコードはGit履歴やリポジトリに残り続けるため、漏洩リスクが高くなります。例えば、リポジトリが公開された場合や開発者の端末が侵害された場合に、認証情報がそのまま外部に流出してしまう恐れがあります。認証情報は環境変数やシークレット管理サービスから読み込む形に変更するなどの対策が必要です。
6.2 任意コード実行(eval)の検出
python.lang.security.audit.eval-detected.eval-detected
ユーザから受け取った文字列を、そのままプログラムのコードとして実行している箇所が検出されています。例えば、画面の入力フォームから悪意のあるコードを入力されると、それがそのままサーバ上で実行されてしまう恐れがあります。外部入力をそのままコードとして実行しないように制御するなどの対策が必要です。
6.3 SQLインジェクションの検出
python.lang.security.audit.formatted-sql-query.formatted-sql-query
f-stringで構築されたSQLクエリが検出されています。文字列補間でクエリを構築すると、ユーザ入力に含まれる ' や ; などが解釈され、SQLインジェクションが可能になります。例えば、ユーザ入力をクエリ文字列に直接埋め込まず、クエリ実行時に安全に展開する仕組みを使うなどの対策が必要です。
6.4 弱いハッシュ関数(MD5)の検出
python.lang.security.audit.hashing.weak-hash.weak-hash
パスワードのハッシュ化に、安全性が不十分とされる古いハッシュアルゴリズム(MD5)の使用が検出されています。攻撃者にパスワードを解読されやすくなる恐れがあります。パスワード保存用に設計された強度の高いハッシュアルゴリズムに置き換えるなどの対策が必要です。
6.5 コマンドインジェクション(subprocess)の検出
python.lang.security.audit.subprocess-shell-true.subprocess-shell-true
ユーザから受け取った文字列を、サーバ上のコマンド(OSの操作)として実行している箇所が検出されています。悪意のあるコマンドを混入されると、サーバ上で意図しない操作(ファイル削除や情報の盗み出しなど)を実行されてしまう恐れがあります。シェルを介さずに目的の処理を実行する形に変更するなどの対策が必要です。
6.6 コマンドインジェクション(os.system)の検出
python.lang.security.audit.dangerous-system-call.dangerous-system-call
こちらも、ユーザから受け取った文字列をサーバ上のコマンドとして実行している箇所が検出されています。前述のコマンドインジェクションと同様に、悪意のあるコマンドを混入されてサーバ上で意図しない操作を実行されてしまう恐れがあります。シェルを介さずに目的の処理を実行できる安全な仕組みに置き換えるなどの対策が必要です。
ワークフローの実行結果に7件の脆弱性が表示され、ワークフロー全体のステータスが Failure になっていれば、Semgrepが脆弱性を検知してワークフローをエラーにしてくれることが確認できました。ここから先は脆弱性を1つずつ修正してワークフローが成功するまでの流れを体験していきます。
| 💡 ポイント |
|---|
本章ではワークフローが失敗してもプルリクエストのマージボタン自体は押せる状態のままです。main ブランチへのマージを物理的にブロックしたい場合は、別セクションGitHubで保護ブランチを設定しようで扱う保護ブランチ設定(必須ステータスチェックの指定)と組み合わせることで、「Semgrepが失敗している間はマージボタンが押せない」状態を作れます。 |
7. 脆弱性の修正
ワークフローがエラーになる挙動は確認できたので、次は逆に「指摘事項をすべて修正するとワークフローが成功する」ところまで体験して、修正→再検知のサイクルがワークフロー上で正しく回ることを確かめます。vulnerable_app.py を以下の内容で全置換します。
import ast
import hashlib
import os
import subprocess
# 認証情報は環境変数から読み込む
DATABASE_PASSWORD = os.environ.get("DATABASE_PASSWORD")
API_KEY = os.environ.get("API_KEY")
def hash_password(password: str, salt: bytes) -> str:
"""パスワードを安全にハッシュ化する"""
return hashlib.scrypt(password.encode(), salt=salt, n=16384, r=8, p=1).hex()
def execute_user_command(allowed_command: list[str]) -> None:
"""事前に許可されたコマンドのみ実行"""
subprocess.run(allowed_command, shell=False, check=True)
def run_user_code(code: str):
"""ユーザ提供のコードを安全に評価"""
return ast.literal_eval(code)
def get_user_by_id(user_id: int, cursor) -> None:
"""パラメータ化クエリでSQLインジェクションを防止"""
cursor.execute("SELECT * FROM users WHERE id = %s", (user_id,))
def write_log(message: str, log_path: str) -> None:
"""ファイルAPIでログを書き込む"""
with open(log_path, "a") as f:
f.write(message + "\n")
それぞれ、Semgrepが検知していた問題を以下のように直しています。
DATABASE_PASSWORD/API_KEY: ハードコードを止め、環境変数から読み込む形に変更したhash_password: MD5を、ソルト付きのscryptに置き換えてパスワードハッシュとして安全な形にしたexecute_user_command:shell=Trueで受けていたユーザ入力を、許可済みコマンドのリストに限定してshell=Falseで実行する形に変更したrun_user_code:evalを、Pythonリテラルしか評価しないast.literal_evalに置き換えたget_user_by_id: f-stringによるSQL文字列構築を、パラメータ化クエリ(%sプレースホルダ)に変更したwrite_log:os.systemでのシェル実行を、Python標準のファイルAPIに置き換えた
修正をコミットして、同じ add-sast ブランチにPushします。同じブランチへのPushはプルリクエストに自動で反映されるため、Pushを契機にプルリクエストのワークフローが再実行されます。
git add vulnerable_app.py
git commit -m "Fix all SAST findings"
git push origin add-sast
プルリクエストページの「Checks」セクションでワークフローが再実行され、今度はSemgrepの検出が0件になり、ワークフローが「Success」に変われば、検出 → 修正 → 再検知でグリーン、というサイクルがワークフロー上で正しく回っていることが確認できます。