Zum Inhalt springen

Permission Denied (publickey) in GitHub Actions: Beheben

Zuletzt aktualisiert am

git@github.com: Permission denied (publickey) bedeutet, dass git versucht hat, GitHub per SSH zu erreichen, und der Runner keinen Schlüssel besitzt, den GitHub akzeptiert. Ein frischer Runner hat überhaupt keine SSH-Schlüssel. Daher schlägt jede git@github.com:-URL, jedes SSH-Submodul und jede SSH-basierte Abhängigkeit fehl, bis Sie dem Job einen Schlüssel geben oder die URL mit einem Token auf HTTPS umstellen.

Die genaue Meldung

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.

Ein ähnlicher Fehler über HTTPS lautet could not read Username.

Lösung 1: HTTPS und ein Token verwenden (meist am einfachsten)

Schreiben Sie SSH-URLs für den Job auf HTTPS um und verwenden Sie dann ein Token, wie in der Lösung für 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 }}

Lösung 2: Dem Job einen SSH-Schlüssel geben

Erstellen Sie ein Schlüsselpaar ohne Passphrase, fügen Sie den öffentlichen Schlüssel dem Ziel-Repository als Deploy Key hinzu (Settings, Deploy keys) und speichern Sie den privaten Schlüssel als Repository-Secret mit dem Namen DEPLOY_KEY. Anschließend lassen Sie actions/checkout ihn verwenden:

- uses: actions/checkout@v4
  with:
    repository: my-org/private-lib
    ssh-key: ${{ secrets.DEPLOY_KEY }}

oder Sie laden ihn in einen SSH-Agenten für alle nachfolgenden git- und ssh-Befehle. Das funktioniert auch für Submodule und Paketinstallationen aus git:

- uses: webfactory/ssh-agent@v0.9.0
  with:
    ssh-private-key: ${{ secrets.DEPLOY_KEY }}
- run: git submodule update --init --recursive

Einen Schlüssel erzeugen Sie mit ssh-keygen -t ed25519 -C "ci" -f deploy_key -N "". Löschen Sie die lokale Kopie, sobald sie im Secret gespeichert ist.

Grenzen von Deploy Keys

Ein Deploy Key funktioniert nur für ein einziges Repository, und GitHub erlaubt nicht denselben öffentlichen Schlüssel in zwei Repositories. Braucht ein Job mehrere private Repositories per SSH, laden Sie mehrere Schlüssel, einen pro Repository, oder verwenden Sie ein Token mit Zugriff auf alle. Ein Machine-User oder eine GitHub App ist oft sauberer als viele Deploy Keys.

Weitere Ursachen

  1. Der Schlüssel wurde dem falschen Repository hinzugefügt oder beim Pushen nur als Lesezugriff. Aktivieren Sie "Allow write access" nur für Jobs, die pushen.
  2. Das Secret enthält einen privaten Schlüssel mit verlorenen Zeilenumbrüchen oder Windows-Zeilenenden. Fügen Sie die gesamte Datei ein, einschließlich der Zeilen BEGIN und END.
  3. Der Schlüssel hat eine Passphrase. Nicht interaktive Jobs können sie nicht eingeben.
  4. Der Schlüssel ist im Secret hinterlegt, wird aber nie geladen, weil der Agent-Schritt in einem anderen Job steht.
  5. Bei einem Job in einem Docker-Container läuft ssh im Container, der keinen Zugriff auf den Agent-Socket des Hosts hat. Laden Sie den Schlüssel im Container.

Schlüssel schnell testen

- run: ssh -T -o StrictHostKeyChecking=accept-new git@github.com || true

Ein funktionierender Schlüssel gibt Hi <repo>! You've successfully authenticated aus. Das || true ist nötig, weil der Befehl bei einem Konto ohne Shell immer mit einem Fehlercode endet. Lesen Sie daher die Ausgabe.

So verhindern Sie den Fehler

  1. Verwenden Sie für CI möglichst HTTPS mit einem eingeschränkten Token oder einem GitHub-App-Token.
  2. Wenn Sie Deploy Keys nutzen, benennen Sie sie nach dem Repository und rotieren Sie sie nach einem Zeitplan.
  3. Bewahren Sie SSH-Schlüssel in Secrets auf, niemals im Repository.
  4. Geben Sie Schlüsseln, die nur lesen sollen, keinen Schreibzugriff.

FAQ

Warum funktioniert es auf meinem Laptop?

Auf Ihrem Laptop ist Ihr SSH-Schlüssel geladen. Ein Runner ist eine frische Maschine ohne Schlüssel.

Kann ich meinen persönlichen SSH-Schlüssel in CI verwenden?

Technisch ja, aber dann hat CI dieselben Zugriffsrechte wie Sie. Verwenden Sie einen Deploy Key oder einen Machine-Account mit den minimal nötigen Rechten.

Braucht actions/checkout einen SSH-Schlüssel für das aktuelle Repository?

Nein. Für das Repository, in dem der Workflow läuft, verwendet es über HTTPS das GITHUB_TOKEN.

Was ist mit known_hosts-Fehlern?

Die Action ssh-agent fügt die Host-Schlüssel von GitHub für Sie hinzu. Wenn Sie ssh direkt aufrufen, verwenden Sie StrictHostKeyChecking=accept-new oder fügen Sie die veröffentlichten Host-Schlüssel von GitHub hinzu.