コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

GitHub 権限・セキュリティ

リポジトリの権限、Secrets・環境変数と本番用の機密情報の管理、アカウントの保護、コミット時の機密情報の検出、依存関係の脆弱性管理、機密情報の漏洩時の対応

権限ロール

リポジトリの権限レベル

権限レベル 説明 主な操作
Read 読み取り専用 コードの閲覧、Issue・PR の閲覧
Triage Issue・PR 管理 Issue のラベル付け、Assignee 設定
Write 書き込み権限 コードの push、PR のマージ
Maintain リポジトリ運用管理 Issue・PR・ラベルの管理、リリースの管理
Admin 完全な管理権限 権限管理、ブランチ保護・Rulesets、Webhook の設定、リポジトリ削除

権限付与の原則

最小権限の原則に従い、役割に必要な権限だけを付与します。役割の内容はリポジトリ運用を参照してください。

役割 権限レベル
外部協力者 Read(開発に参加する場合は Write)
開発メンバー Write
テックリード・リードエンジニア Maintain
プロジェクトオーナー Admin

Secrets・環境変数の管理

Secrets の種類

GitHub Actions では、次の 3 種類の Secrets を管理できます。

  1. Repository Secrets: 特定のリポジトリでのみ使用
  2. Environment Secrets: 特定の環境(production、staging など)で使用
  3. Organization Secrets: Organization 内の指定したリポジトリで共有

本番環境とステージング環境で値が異なる場合は、Environment Secrets を使います。ワークフローからは ${{ secrets.API_KEY }} のように参照します。ワークフロー全体の例はデプロイを参照してください。

リポジトリに含めてはいけない情報

  • API キー、トークン
  • データベース接続情報
  • パスワード、秘密鍵
  • OAuth クライアントシークレット
  • 暗号化キー

.env ファイルの管理

環境変数は .env ファイルで管理し、.gitignore に必ず追加します。

# 環境変数ファイル(.env.example 以外)
.env*
!.env.example

代わりに、.env.example ファイルをリポジトリに含め、必要な環境変数の例を示します。

# データベース接続情報
DATABASE_URL=postgresql://user:password@localhost:5432/dbname

# API 設定
API_KEY=your_api_key_here
API_SECRET=your_api_secret_here

# アプリケーション設定
NODE_ENV=development
PORT=3000

本番用の機密情報の保管

本番用の API キーやパスワードは、ローカル環境に置きません。次のいずれかで保管します。

  • GitHub Actions の Secrets
  • シークレット管理サービス(1Password CLI など)
  • ホスティングサービスの環境変数やシークレット管理

ローカルの .env には開発用の値だけを置きます。必要に応じて dotenvx などで暗号化します。

アカウントとリポジトリの保護

直接 push の禁止や承認の必須化などの保護ルールは、ブランチ戦略で設定します。

2 要素認証の必須化

Organization の Settings > Authentication security で「Require two-factor authentication」を有効にし、メンバーと外部協力者に 2 要素認証(2FA)を必須にします。

secret scanning と push protection

GitHub の secret scanning は、リポジトリ内の API キーやトークンを検出します。push protection を有効にすると、検出された機密情報を含む push がブロックされます。

  • Public リポジトリ: 無料で利用できます
  • Private リポジトリ: 有料の GitHub Secret Protection が必要です

利用できない場合も、コミット時の検出で代替できます。

コミット時の機密情報の検出

コミット時に gitleaks でスキャンし、機密情報が含まれている場合はコミットを中断します。 Git hook ツール(Lefthook、pre-commit など)から実行します。開発環境テンプレートの lefthook の設定には含まれていないため、案件ごとに追加してください。

gitleaks 本体は hook ツールに含まれないため、各メンバーの環境にインストールしておきます。

brew install gitleaks
pre-commit:
  commands:
    gitleaks:
      run: gitleaks git --staged --redact --verbose

プロジェクト固有の機密情報の形式(独自の API キーの接頭辞など)は、.gitleaks.toml にルールを追加して検出します。

メンバーの離脱と納品時の対応

  • メンバーの離脱時: Organization から外し、個人に付与した権限と、そのメンバーが発行したトークンや Deploy key を削除します
  • 案件終了時: 外部協力者の権限を削除します
  • 納品時: リポジトリをクライアントに引き渡す場合は、Settings > General の「Transfer ownership」で移管します。移管前に Secrets を削除し、README に必要な情報がそろっていることを確認してください

個人アクセストークンの管理

GitHub の個人アクセストークン(PAT)は、次のルールで管理します。

  • Personal access token(classic)ではなく Fine-grained personal access token を使い、対象リポジトリと権限を限定する
  • トークンに有効期限を設定する
  • 使用しなくなったトークンは削除する

依存関係の脆弱性管理

npm パッケージを改ざんして不正なコードを配布する攻撃が起きています。依存パッケージは次のように管理してください。

  • ロックファイルをコミットする: pnpm-lock.yaml を Git で管理し、全員が同じバージョンをインストールするようにする
  • 脆弱性を確認する: pnpm audit で既知の脆弱性を確認し、修正版があれば更新する
  • 公開直後の版を避ける: pnpm の minimumReleaseAge を設定し、公開から一定期間が経っていない版をインストールしないようにする
  • 更新を自動化する: Dependabot で脆弱性の修正と定期的な更新の PR を自動で作成する

リポジトリの Settings のセキュリティ設定で Dependabot alerts と Dependabot security updates を有効にすると、依存パッケージの脆弱性が検出され、修正用の PR が作成されます。 あわせて .github/dependabot.yml を置き、依存パッケージを定期的に更新します。

version: 2
updates:
  # pnpm のプロジェクトも "npm" を指定する
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
    # 公開直後のバージョンを避ける(悪意あるバージョンへの対策)
    cooldown:
      default-days: 7
    # minor と patch の更新を 1 つの PR にまとめる
    groups:
      minor-and-patch:
        update-types: ["minor", "patch"]
    commit-message:
      prefix: "chore"
      include: "scope"
  # GitHub Actions のバージョンも更新する
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "weekly"
    commit-message:
      prefix: "ci"

機密情報の漏洩時の対応

機密情報を誤ってコミット・公開した場合は、次の手順で対応します。AI ツールに渡してしまった場合は、機密情報の保護を参照してください。

  1. 該当の API キー・パスワードを**無効化し、新しいものを発行(ローテーション)**します(最優先)
  2. 関係者(クライアントを含む)に状況を共有します
  3. 必要に応じて、git filter-repo で履歴から削除します。作業用に --mirror でクローンし直し、すべてのブランチとタグを対象にします
brew install git-filter-repo

git clone --mirror git@github.com:<organization>/<repository>.git
cd <repository>.git

# ファイルごと削除する場合(--dry-run で確認してから実行)
git filter-repo --path <ファイルパス> --invert-paths

# ファイルを残して機密情報の文字列だけ置換する場合
# replacements.txt には置換したい文字列を 1 行ずつ書く
git filter-repo --replace-text ../replacements.txt
  1. リモートを再設定して force push します(git filter-repo 実行後はリモート登録が削除されます)
git remote add origin git@github.com:<organization>/<repository>.git
git push --force --all origin
git push --force --tags origin
  1. PR の差分やキャッシュされた表示に機密情報が残るため、GitHub Support に削除を依頼します
  2. 再発防止策を検討します(push protection の有効化、gitleaks によるコミット時の検出など)

このページは役に立ちましたか?