ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
GitHub AEは、現在限定リリース中です。詳細については営業チームにお問い合わせください。

リポジトリのシークレットスキャンを設定する

GitHub がリポジトリでシークレットをスキャンする方法を設定できます。

People with admin permissions to a repository can enable secret scanning for the repository.

Secret scanningは、ベータリリースの間は無料であるGitHub Advanced Securityの一部として利用できます。 詳しい情報については、「GitHub Advanced Security について」を参照してください。

ノート: Organizationが所有するリポジトリのためのSecret scanningは現在ベータで、変更されることがあります。

リポジトリへの secret scanning を有効化する

有効化されると、secret scanningはGitHubリポジトリ中に存在するすべてのブランチのGit履歴全体に対して、あらゆるシークレットをスキャンします。

  1. GitHub AEで、リポジトリのメインページにアクセスしてください。

  2. リポジトリ名の下で Settings(設定)をクリックしてください。 リポジトリの設定ボタン

  3. 左のサイドバーで、Security & analysis(セキュリティと分析)をクリックしてください。 リポジトリ設定の"セキュリティと分析"タブ

  4. secret scanning を有効化する前に、まず GitHub Advanced Security を有効化する必要があります。 その場合、[GitHub Advanced Security] の右にある [Enable] をクリックします。 リポジトリに対して GitHub Advanced Security を有効化する

  5. [Enable GitHub Advanced Security for this repository] をクリックして、処理を確認します。 リポジトリに対する GitHub Advanced Security の有効化を確認する

  6. その場合、[Secret scanning] の右にある [Enable] をクリックします。 リポジトリに対して secret scanning を有効化する

リポジトリで secret scanning からのアラートを除外する

secret_scanning.yml ファイルを使用して、secret scanning からディレクトリを除外できます。 たとえば、テストまたはランダムに生成されたコンテンツを含むディレクトリを除外できます。

  1. GitHub AEで、リポジトリのメインページにアクセスしてください。

  2. ファイルのリストの上で、Add file(ファイルの追加)ドロップダウンを使い、Create new file(新規ファイルの作成をクリックしてください。 "ファイルの追加"ドロップダウン内の"新規ファイル作成"

  3. ファイル名フィールドに、.github/secret_scanning.yml と入力します。

  4. [Edit new file] に paths-ignore: と入力してから、secret scanning から除外するパスを入力します。

    paths-ignore:
      - "foo/bar/*.js"
    

    * などの特殊文字を使用して、パスをフィルタできます。 フィルタパターンに関する詳しい情報については、「GitHub Actionsのワークフロー構文」を参照してください。

    ノート:

    • paths-ignore に 1,000 以上のエントリがある場合、secret scanning は最初の 1,000 ディレクトリのみをスキャン対象から除外します。
    • secret_scanning.yml が 1MB 以上ある場合、secret scanning はファイル全体を無視します。

secret scanning からの個々のアラートを無視することもできます。 詳しい情報については、「secret scanning からのアラートを管理する」を参照してください。

参考リンク

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?