最初のコードの脆弱性を見つけて修正する

コーディングを学習している段階では、プロジェクトに誤って脆弱性を持ち込んでしまうことはよくあります。 作業を共有する前にこれらのセキュリティの問題に対処しないと、攻撃者がそれを利用してコードを操作し、機密データにアクセスする可能性があります。そのため、できるだけ早く特定してパッチを適用することが重要です。

幸いなことに、パブリック リポジトリの脆弱性を自動的に検出、説明、修正する code scanning などのツールがあります。 このチュートリアルでは、 code scanningを使用して作業をセキュリティで保護する方法について説明します。

デモ リポジトリの設定

セキュリティの脆弱性を持つデモ プロジェクトをフォークすることから始めましょう。 このプロジェクトは単純な Web ページを構築しますが、プロジェクトを配置しないため、この演習ではセキュリティ リスクはありません。

1. new2code/code-scanning-demo リポジトリに移動します。
2. ページの右上にある [ Fork] をクリックします。
3. 表示されたページで、[Create fork] をクリックします。

コードの脆弱性を見つける

プロジェクトを設定したので、フォークの code scanning をオンにして、コードの脆弱性を確認してみましょう。

1. GitHubに戻り、リポジトリのホーム ページで [ Security and quality] をクリックします。
2. Code scanningアラートの行で、[code scanningを設定] をクリックします。
3. [ツール] セクションの [CodeQL 分析] の横にある [ 設定] を選択し、[ 既定] をクリックします。
4. 表示されたポップアップで、[CodeQLを有効にする] をクリックします。 これにより、コードの脆弱性をスキャンする GitHub Actions ワークフローがトリガーされます。
5. ワークフローの状態を確認するには、ナビゲーション バーの [ Actions] をクリックします。
6. ワークフローが完了したら、ナビゲーション バーの [ Security and quality] をクリックします。
7. ワークフローによって検出された code scanning アラートを表示するには、サイド ナビゲーションで [ Code scanning] をクリックし、[ Reflected cross-site scripting](反映されたクロスサイト スクリプティング) をクリックします。

code scanning アラートについて

code scanningコードの脆弱性が特定されたので、アラートで提供される情報を分解しましょう。

位置

アラートには、脆弱性を生み出すコード行を中心に、ファイルの小さなプレビューが表示されます。 この例では、脆弱性はサイト内でユーザー指定の入力を実装する index.js ファイルの 8 行目に検出されています。

詳しく見てみると、7 行目で、悪意のあるコードをチェックせずにユーザーによる入力に greet を割り当てるときに根本的な問題が発生していることがわかります。 コード内の脆弱性を段階的に表示するには、脆弱な行の下の吹き出しで [Show paths] をクリックします。

説明と推奨事項

ファイル プレビューの下に、 code scanning 脆弱性の詳細な説明が表示されます。 推奨される修正プログラムと、脆弱なコードと修正されたコードの例を表示するには、[さらに表示] をクリック。

ここでは、ユーザーによる入力を使う前にサニタイズすることをお勧めします。 つまり、入力に悪意のあるコードが含まれるかチェックし、必要に応じてクリーンする必要があります。

タイムライン

最後に、ページの下部にアラートのタイムラインが表示されます。 タイムラインには脆弱性が最初に検出されたコミットが含まれており、脆弱性を修正すると自動的に更新されます。

脆弱性を自動的に修正する

プロジェクトを迅速かつ簡単にセキュリティで保護するために、GitHub Copilotの自動修正機能にcode scanningを使用しましょう。

1. アラート のタイトルの下のボックスに、"Copilot の自動修正のCodeQLを使用してこのアラートの修復を高速化する" と表示されている場合は、[Generate fix] をクリックします。

2. 修正候補 Copilot 生成された後、提案されている変更を記述し、変更のプレビューを表示し、追加された依存関係を呼び出します。 少し時間を取って、 Copilotの作品を読んでください。

3. 修正を含む pull request を作成するには、[Commit to new branch] をクリックし、[Commit change] をクリックします。

4. ドラフトの pull request が作成されたら、ページの下部にある [Ready for review] をクリックして、マージできるようにします。

5. 修正を適用するには、[Merge pull request] をクリックして、[Confirm merge] をクリックします。

   pull request がマージされ、 code scanning ワークフローが再度実行されると、アラートは自動的に閉じられ、脆弱性を修正するコミットがタイムラインに追加されます。

次のステップ

デモ リポジトリで code scanning を試したので、 独自のプロジェクトで有効に して、現在および将来の脆弱性をすばやく見つけて修正します。

自分で記述したコードをセキュリティで保護したので、依存関係のセキュリティを調べて、コードのセキュリティ保護に向けた次のステップに進みます。 「初めての依存関係の脆弱性の検出と修正」を参照してください。