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

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

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

Secret scanningは、Organizationが所有するリポジトリでGitHub Advanced Securityが有効化されていれば利用できます。 詳しい情報については、「GitHub Advanced Security について」を参照してください。

ノート: Secret scanningはGitHub Enterprise Server 3.0ではベータでした。 secret scanningの一般に利用なリリースについては、GitHub Enterprise Serverの最新リリースにアップグレードしてください。

ノート: この機能を使う前には、サイト管理者がGitHub Enterprise Serverのインスタンスのsecret scanningを有効化していなければなりません。 詳しい情報については「アプライアンスのためのsecret scanningの設定」を参照してください。

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

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

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

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

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

  4. If Advanced Securityがまだリポジトリで有効化されていなければ、"GitHub Advanced Security" の右でEnable(有効化)をクリックしてください。 Enable GitHub Advanced Security for your repository

  5. Advanced Securityの有効化の影響をレビューしてから、Enable GitHub Advanced Security for this repository(このリポジトリで有効化)をクリックしてください。

  6. Advanced Securityを有効化すると、Organizationの設定によってはリポジトリでsecret scanningが自動的に有効化されることがあります。 [Secret scanning] と [Enable] ボタンが表示されている場合でも、[Enable] をクリックして secret scanning を有効化する必要があります。 [Disable] ボタンが表示されている場合、secret scanning はすでに有効化されています。 リポジトリに対して secret scanning を有効化する

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

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

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

  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, コントリビューションの方法を学んでください。

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