GitHub ActionsでのPermission Denied (publickey)の修正方法
最終更新:
git@github.com: Permission denied (publickey) は、gitがSSHでGitHubに接続しようとしたものの、ランナーにGitHubが受け入れる鍵がないことを意味します。新しいランナーにはSSH鍵が一切ないため、git@github.com: 形式のURL、SSHサブモジュール、SSHベースの依存関係はすべて、ジョブに鍵を渡すか、トークンを使ったHTTPSのURLに切り替えるまで失敗します。
表示される正確なメッセージ
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
HTTPSで同様の失敗が起きた場合は、could not read Username と表示されます。
修正1: HTTPSとトークンを使う(通常は最も簡単)
ジョブ内でSSHのURLをHTTPSに書き換え、could not read Username の修正と同様にトークンを使用します:
- run: git config --global url."https://x-access-token:${GH_TOKEN}@github.com/".insteadOf "git@github.com:"
env:
GH_TOKEN: ${{ secrets.CROSS_REPO_TOKEN }}
修正2: ジョブにSSH鍵を渡す
パスフレーズなしで鍵ペアを作成し、公開鍵を対象リポジトリにデプロイキーとして追加します(Settings、Deploy keys)。秘密鍵は DEPLOY_KEY という名前のリポジトリシークレットに保存します。そのうえで、actions/checkout に鍵を使わせるか:
- uses: actions/checkout@v4
with:
repository: my-org/private-lib
ssh-key: ${{ secrets.DEPLOY_KEY }}
以降のgitおよびsshコマンドすべてで使えるように、SSHエージェントに鍵を読み込みます。サブモジュールやgitベースのパッケージインストールでも機能します:
- uses: webfactory/ssh-agent@v0.9.0
with:
ssh-private-key: ${{ secrets.DEPLOY_KEY }}
- run: git submodule update --init --recursive
ssh-keygen -t ed25519 -C "ci" -f deploy_key -N "" で鍵を生成し、シークレットに保存したらローカルのコピーは削除してください。
デプロイキーの制限
デプロイキーは1つのリポジトリでのみ使用でき、GitHubでは同じ公開鍵を2つのリポジトリに登録することはできません。1つのジョブでSSH経由で複数のプライベートリポジトリにアクセスする必要がある場合は、リポジトリごとに鍵を読み込むか、すべてにアクセスできる1つのトークンを使用してください。多数のデプロイキーを管理するより、マシンユーザーやGitHub Appを使うほうが管理しやすい場合が多くあります。
その他の原因
- 鍵を誤ったリポジトリに追加した、またはプッシュ時に必要な権限が読み取り専用になっている。プッシュを行うジョブに限り「Allow write access」にチェックを入れてください。
- シークレットの秘密鍵で改行が失われている、またはWindowsの改行コードが混入している。
BEGINとENDの行を含むファイル全体を貼り付けてください。 - 鍵にパスフレーズが設定されている。非対話型のジョブではパスフレーズを入力できません。
- 鍵はシークレットに保存されているものの、エージェントのステップが別のジョブにあるため読み込まれていない。
- Dockerコンテナのジョブでは、
sshはコンテナ内で実行されるため、ホストのエージェントソケットにアクセスできません。コンテナ内で鍵を読み込んでください。
鍵をすばやく確認する
- run: ssh -T -o StrictHostKeyChecking=accept-new git@github.com || true
正常に動作している鍵では Hi <repo>! You've successfully authenticated と表示されます。|| true を付けているのは、シェルを持たないアカウントではこのコマンドが常に非ゼロで終了するためです。出力を確認してください。
予防方法
- CIにはスコープを限定したトークンまたはGitHub Appのトークンを使ったHTTPSを推奨します。
- デプロイキーを使う場合は、リポジトリ名で識別できる名前を付け、定期的にローテーションしてください。
- SSH鍵はリポジトリに置かず、必ずシークレットに保存してください。
- 読み取りしか行わない鍵に書き込み権限を与えないでください。
よくある質問
なぜ自分のノートPCでは動くのですか?
ノートPCには自分のSSH鍵が読み込まれていますが、ランナーは鍵を一切持たない新しいマシンだからです。
CIで個人のSSH鍵を使えますか?
技術的には可能ですが、CIに自分と同じアクセス権を与えることになります。必要最小限のアクセス権を持つデプロイキーまたはマシンアカウントを使用してください。
actions/checkout は現在のリポジトリにSSH鍵を必要としますか?
いいえ。ワークフローが実行されるリポジトリに対しては、HTTPS経由で GITHUB_TOKEN を使用します。
known_hostsのエラーについてはどうすればよいですか?
ssh-agent アクションがGitHubのホスト鍵を自動的に追加します。ssh を直接呼び出す場合は、StrictHostKeyChecking=accept-new を使うか、GitHubが公開しているホスト鍵を追加してください。
関連記事
- github-actions[bot]によるアクセス拒否(403): 修正方法ワークフローがプッシュする際に発生する「github-actions[bot]によるrepo.gitへのアクセス権がありません」(403)の修正: contentsの書き込み権限を設定し、ブランチルールとフォークの制限を確認してください。
- GitHub Appによるワークフローの更新を拒否される:修正方法「refusing to allow a GitHub App to create or update workflow without workflows permission」の修正方法:ワークフローへの書き込み権限を持つPATまたはAppトークンを使用してください。
- Cache Service Responded With 429: 修正方法GitHub Actions の「Failed to restore: Cache service responded with 429」を修正します。キャッシュへのリクエストが多すぎる場合の対処法です。actions/cache を更新し、復元は何度行っても構いませんが、保存は一度だけにしてください。
- fatal: could not read Username for github.com: 修正方法GitHub Actionsで"fatal: could not read Username for 'https://github.com'"を解決する方法:プライベートリポジトリ、サブモジュール、gitの依存関係にはトークンが必要です。