詳細ガイド

GitHub Actionsとの連携手順

1. XEIZE_TOKENを追加する

GitHub Actions用のシークレット XEIZE_TOKEN を、以下のように追加します。

GitHub Actionsのシークレット設定

2. GitHub Actionsのワークフローを追加する

  • ボタンを選択してファイルを作成します。
ワークフローファイルの作成

ワークフローの内容を入力し、Commit changes で保存すると、GitHub Actionsが適用されます。

ファイルの内容はGitHub Actionsのページを参照してください。

ワークフローの保存

3. PRで動作を確認する

リポジトリをクローンする

GitHub Actionsを設定したリポジトリをクローンします。git clone REPOSITORY_URL の REPOSITORY_URL は、コピーしたリポジトリのURLに置き換えてください。

クローン用のURLは、以下の画面で確認できます。

リポジトリのクローン用URL

ブランチを作成する

ターミナルでプルリクエストを準備します。

  1. cd repository でクローンしたディレクトリに移動します。repository は実際のディレクトリ名に置き換えてください。
  2. git checkout -b pr-test で pr-test ブランチを作成します。
  3. そのディレクトリに、動作確認用の脆弱なファイルを以下の内容で作成します。

vuln_crypto.py

python
# 安全でない暗号アルゴリズムとハードコードされた鍵
from Crypto.Cipher import DES
ENCRYPTION_KEY = b"weak_key"
cipher = DES.new(ENCRYPTION_KEY, DES.MODE_ECB)

vuln_exec.py

python
# Flaskでの安全でないコード実行
from flask import Flask, request

app = Flask(__name__)

@app.route('/exec')
def unsafe_exec():
    code = request.args.get('code')
    eval(code)
    return "Dangerous Code executed"
  1. ファイルを作成したら、以下を実行します。
text
git add . 
git commit -m "add tests"
git push origin pr-test
  1. リポジトリに戻り、Pull requests から New pull request を選択します。
プルリクエストの作成画面
  1. pr-test を選び、Create pull request でPRを作成します。
テスト用ブランチの選択
  1. GitHub Actionsの完了後、以下のようにコメントが投稿されたことを確認します。
プルリクエストに投稿されたXEIZEのコメント