アップデート一覧に戻る
New releaseSep 1, 2026

allstar v4.6

セキュリティポリシーを設定・適用するGitHubアプリ

共有

OpenSSF Scorecard

Allstar

[!IMPORTANT] OpenSSF がホストする Allstar GitHub App は提供終了となりました。 OpenSSF Scorecard のサブプロジェクトである Allstar 自体は引き続き メンテナンスされていますが、今後はご自身で実行する必要があります。 GitHub Action として実行するか、 サービスデーモンとして実行してください。

詳細については ossf/allstar#881 を 参照してください。

組織がホスト版アプリに依存していた場合は、 ホスト版アプリからの移行を参照してください。

概要

Allstar の新機能

不要な Issue の無効化

はじめに

ポリシーとアクション

上級者向け

コントリビュート



概要

Allstar とは?

Allstar は、GitHub の組織やリポジトリがセキュリティのベストプラクティスに 準拠しているかを継続的に監視する GitHub App です。Allstar がセキュリティ ポリシーの違反を検出すると、リポジトリまたは組織のオーナーに警告するための Issue を作成します。一部のセキュリティポリシーでは、Allstar は違反の原因と なったプロジェクト設定を自動的に変更し、期待される状態に戻すこともできます。

Allstar の目標は、プロジェクトのセキュリティに影響するファイルや設定を、 きめ細かく制御できるようにすることです。組織レベルとリポジトリレベルの両方で、 監視するセキュリティポリシーとポリシー違反の処理方法を選択できます。また、 新しいポリシーを開発したり、コントリビュートしたりすることもできます。

Allstar は OpenSSF Scorecard プロジェクトの 一部として開発されています。

Allstar の新機能

不要な Issue の無効化

Allstar によって不要な Issue が作成されている場合は、こちらの手順に従ってオプトアウトしてください。

はじめに

背景

Allstar は高度に設定可能です。主に 3 つの制御レベルがあります。

  • 組織レベル: 組織の管理者は、Allstar を有効にする対象を選択できます。
    • 組織内のすべてのリポジトリ。
    • 一部のオプトアウトされたリポジトリを除く、ほとんどのリポジトリ。
    • オプトインされた一部のリポジトリのみ。

これらの設定は、組織の .allstar リポジトリで行います。

  • リポジトリレベル: Allstar を使用する組織内のリポジトリメンテナーは、 自身のリポジトリを組織レベルの適用対象にオプトインまたはオプトアウト できます。注: これらのリポジトリレベルの制御は、組織レベルの設定で 「リポジトリによる上書き」が許可されている場合にのみ機能します。これらの 設定は、リポジトリの .allstar ディレクトリで行います。

  • ポリシーレベル: 管理者またはメンテナーは、特定のリポジトリで有効にする ポリシーと、ポリシー違反時に Allstar が実行するアクションを選択できます。 これらの設定は、組織の .allstar リポジトリ(管理者)またはリポジトリの .allstar ディレクトリ(メンテナー)にあるポリシー yaml ファイルで行います。

組織レベルのオプション

組織レベルで Allstar をインストールする前に、Allstar を実行するリポジトリの概算数を決めておく必要があります。これにより、オプトイン戦略とオプトアウト戦略のどちらを選ぶかを判断しやすくなります。

  • オプトイン戦略では、Allstar を実行したいリポジトリを手動で追加します。リポジトリを何も指定しない場合、Allstar はインストールされていても実行されません。全リポジトリのうちごく少数のリポジトリにのみポリシーを適用したい場合や、有効化する前に単一のリポジトリで Allstar を試したい場合にオプトイン戦略を選択してください。v4.3 リリース以降、類似した名前の複数リポジトリを簡単に追加できる glob がサポートされています。

  • オプトアウト戦略(推奨)では、すべてのリポジトリで Allstar が有効になり、Allstar の適用から除外するリポジトリを手動で選択できます。すべてのパブリックリポジトリ、またはすべてのプライベートリポジトリを除外することもできます。組織内のすべてのリポジトリで Allstar を実行したい場合や、ごく少数のリポジトリ、または特定の種類(パブリックかプライベートか)のリポジトリのみを除外したい場合にこのオプションを選択してください。v4.3 リリース以降、類似した名前の複数リポジトリを簡単に追加できる glob がサポートされています。

オプトアウト(推奨)
optOutStrategy = true
オプトイン
optOutStrategy = false
デフォルトの動作 すべてのリポジトリが有効 どのリポジトリも有効にならない
リポジトリの手動追加 リポジトリを手動で追加すると、それらのリポジトリで Allstar が無効になる リポジトリを手動で追加すると、それらのリポジトリで Allstar が有効になる
追加の設定 optOutRepos: リストされたリポジトリで Allstar が無効になる

optOutPrivateRepos: true の場合、すべてのプライベートリポジトリで Allstar が無効になる

optOutPublicRepos: true の場合、すべてのパブリックリポジトリで Allstar が無効になる

(optInRepos: この設定は無視される)
optInRepos: リストされたリポジトリで Allstar が有効になる

(optOutRepos: この設定は無視される)
リポジトリによる上書き true の場合: リポジトリは自身のリポジトリファイル内の設定を使用して、組織の Allstar 適用からオプトアウトできる。そのリポジトリに適用される組織レベルのオプトイン設定は無視される。

false の場合: リポジトリは組織レベルで設定された Allstar の適用からオプトアウトできない。
true の場合: リポジトリは組織レベルでそのリポジトリ向けに設定されていなくても、組織の Allstar 適用にオプトインできる。そのリポジトリに適用される組織レベルのオプトアウト設定は無視される。

false の場合: リポジトリは組織レベルで設定されていない限り、Allstar の適用にオプトインできない。

インストールオプション

Allstar は GitHub App として組織に対して動作します。アプリを作成し、そのアプリとして認証するプロセスを実行します。したがって、セットアップはすべてのデプロイに共通する 2 つのステップ — アプリの作成 と コントロールリポジトリの作成 — に加えて、実行方法の選択からなります:

GitHub Actionサービスデーモン
実行方法.allstar リポジトリ内のスケジュールされたジョブ自身でホストする常駐プロセス
用意するものGitHub 以外には何も不要サーバーまたはコンテナオーケストレーター
実行頻度cron に設定したとおり継続的で、結果は 5〜10 分で得られる
セットアップの手間中程度高い
適している場合インフラを最小限にしたい場合最大限の制御を望む場合、またはすでにサービスを運用している場合

Action は 2 つのうちオーバーヘッドが小さく、ほとんどの組織はここから始めるべきです。ポリシー設定を変更することなく、後からデーモンに移行できます。

GitHub App の作成

App は、組織内で一連の権限を持つユーザーのような ID です。Allstar はコンプライアンスを検出するためにほとんどの設定とファイル内容への読み取りアクセスを必要とし、issue を起票して block アクションをサポートするために issue とチェックへの書き込みアクセスを必要とします。

Operator instructions - Create a GitHub App に従い、App ID と秘密鍵を記録してください。どちらの実行モードでもこれらが必要です。

.allstar 制御リポジトリを作成する

Allstar は、組織内の .allstar という名前のリポジトリから設定を読み取ります。

最も簡単に作成する方法は、サンプルから作成することです:

  1. サンプルリポジトリを開き、「Use this template」ボタンをクリックします
  2. Repository Name のフィールドに .allstar と入力します
  3. 「Create repository from template」をクリックします

これにより、Opt Out 戦略を使用して、issue アクションで、すべてのリポジトリに対して現在のすべての Allstar ポリシーが有効になります。後からいつでも変更できます。

最初からきめ細かく制御する場合 — Opt In または Opt Out 戦略を選択し、個々のポリシーファイルを自分で記述する場合 — は、代わりに手動インストール手順に従ってください。

Allstar を GitHub Action として実行する

このオプションは、GitHub Actions を使用して Allstar をスケジュールされたジョブとして実行するため、GitHub 自体以外に運用するインフラストラクチャはありません。

GitHub Actions インストール手順に従って、.allstar リポジトリで定期的な Action を設定し、それを強化し、その結果を監視してください。

Allstar をサービスデーモンとして実行する

このオプションは、Allstar を常駐プロセスとして実行し、スケジュールではなく継続的に違反を検出して解決します。

プロセスの実行、シークレットの管理、サイジング、および利用可能な環境変数については、Operator instructionsを参照してください。

ホスト型アプリからの移行

組織が OpenSSF ホスト型アプリを使用していた場合、設定はそのまま引き継がれます。.allstar 制御リポジトリ、allstar.yaml、およびすべてのポリシーファイルは変更なしで動作し続けます。置き換えるのは、それらを読み取るプロセスのみです。

移行するには:

  1. 独自の GitHub App を作成し、ホスト型アプリと同じリポジトリアクセス権で組織にインストールします。
  2. 既存の .allstar リポジトリをそのまま維持します。
  3. Allstar を Action としてまたはデーモンとして実行します。
  4. allstar-app がまだ Settings -> GitHub Apps に表示される場合は、組織からアンインストールします。

ホスト型アプリによって以前に起票された issue は、リポジトリに残ります。独自のインスタンスは、同じ allstar ラベル(または設定した issueLabel)で issue を識別するため、違反が解決されると重複して起票するのではなく、それらを引き継いでクローズします。

ポリシーとアクション

アクション

各ポリシーは、Allstar がリポジトリのコンプライアンス違反を検出したときに実行するアクションで設定できます。

カテゴリ