GitHub Actionsにcode scanningを導入してみた

7755 ワード
CICD Python GitHubActions GitHub Python テキストリンク

こんにちは

4回目の投稿です！

今日はGitHubに最近リリースされたcode scanningを試しに導入してみました！

本当はPHPでcode scanningを実装したかったのですが、対応言語は'cpp', 'csharp', 'go', 'java', 'javascript', 'python'だったので、pythonでやりました！

code scanningとは

・コードに潜むセキュリティ問題を防ぐためのものである。
・本当に修正すべき問題だけを提示してくれる。

CI/CDの実装方法

2020/11/09時点ではパブリックリポジトリなら無料で使えるが、プライベートリポジトリはGitHub Enterprise向けのGitHub Advanced Security機能をオプション購入することで利用できるそうです。
それを踏まえて、今回はテスト用のパブリックリポジトリを作成し、やっていきます。

まず、「security」を選択し、「Set up code scanning」をクリックします。
※プライベートリポジトリの場合は「Contact sales」となっています（2020/11/09時点）

「Set up this workflow」をクリック

「Start commit」をクリック

.github/workflows配下にcodeql-analysis.ymlができました。

codeql-analysis.yml
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
# ******** NOTE ********

name: "CodeQL"

on:
  push:
    branches: [ main ]
  pull_request:
    # The branches below must be a subset of the branches above
    branches: [ main ]
  schedule:
    - cron: '39 0 * * 0'

jobs:
  analyze:
    name: Analyze
    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        language: [ 'python' ]
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
        # Learn more...
        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection

    steps:
    - name: Checkout repository
      uses: actions/checkout@v2

    # Initializes the CodeQL tools for scanning.
    - name: Initialize CodeQL
      uses: github/codeql-action/init@v1
      with:
        languages: ${{ matrix.language }}
        # If you wish to specify custom queries, you can do so here or in a config file.
        # By default, queries listed here will override any specified in a config file.
        # Prefix the list here with "+" to use these queries and those in the config file.
        # queries: ./path/to/local/query, your-org/your-repo/queries@main

    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
    # If this step fails, then you should remove it and run the build manually (see below)
    #- name: Autobuild
    #  uses: github/codeql-action/autobuild@v1

    # ℹ️ Command-line programs to run using the OS shell.
    # 📚 https://git.io/JvXDl

    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
    #    and modify them (or add more) to build your code if your project
    #    uses a compiled language

    #- run: |
    #   make bootstrap
    #   make release

    - name: Perform CodeQL Analysis
      uses: github/codeql-action/analyze@v1

mainブランチにプルリクかプッシュされたときにcode scanningが実行されます。
今回は言語をpythonを選択したので、Autobuildの部分はコメントアウトしております。

実行

試しにtest.pyという簡単なファイルをプルリクしてみます。

test.py
print("hello world!")

プルリクしてから、コードの解析まで少し時間がかかります。

なんの問題もなく、プルリクすることができました。

まとめ

本当は脆弱性のあるコードを記述して、alertsを出すところを見せたかったのですが、脆弱性のあるコードが思いつかないので、コメント等でいただけたら、実際に試してみますので、お願いします！

今回はGitHub Actionsにリリースされたcode scanningを導入してみたでした！