HOWTO · Git

SSH キーを使用した Git プッシュ

このチュートリアルでは、コマンド ラインを使用して、特定の SSH キーで Git ファイルをリモート サーバーにプッシュするプロセスについて説明します。SSH キーの設定、Git リポジトリの構成、変更を安全にプッシュする方法を学びます。ワークフローを効率化し、セキュリティを強化したい開発者に最適です。

このページの内容

SSH鍵を使ってGitブランチをpushするには、鍵ペアを作成し、公開鍵をGitホスティングアカウントに登録して、リポジトリのリモートをSSH URLに設定したうえで、公開するブランチをpushします。秘密鍵は自分のマシンに保管します。SSHはホストに対する認証を行い、そのホストが別途、アカウントにリポジトリへの書き込み権限があるかを確認します。

SSH鍵ペアを生成する

このアカウントで使う鍵がまだない場合は、ssh-keygenでEd25519鍵ペアを生成します。以下の例では、コマンドの使い方を示すための一時的な鍵ペアを作成するので、普段使っている~/.ssh内のファイルは変更されません。POSIXシェルで実行してください。SSH設定も変更しません。

set -e
key_dir=$(mktemp -d)
trap 'rm -rf "$key_dir"' EXIT
ssh-keygen -q -t ed25519 -C "git@example.com" -f "$key_dir/id_ed25519" -N ""
test -s "$key_dir/id_ed25519.pub"
printf 'Created the Ed25519 public key file.\n'
Created the Ed25519 public key file.

この例では-N ""を使ってパスフレーズを空にするため、ssh-keygenは対話形式の質問をしません。継続して使う鍵を作る場合は、既定の保存先を使うために-fを省略するか、~/.ssh/id_ed25519_workのようなパスを指定します。ssh-keygenは保存先、続いてパスフレーズを尋ねます。保存時に鍵を保護するにはパスフレーズを入力し、空のままにするにはEnterキーを2回押します。.pubが付いていないファイルが秘密鍵です。秘密にして、アップロードしないでください。.pubファイルが公開鍵です。適切な鍵ペアをすでに持っている場合は、新しく生成せず、それを使えます。

公開鍵をGitホスティングアカウントに登録する

選んだ公開鍵ファイルを表示し(たとえばcat ~/.ssh/id_ed25519.pubを実行)、行全体をコピーします。Gitホストのアカウント設定でSSH鍵の項目を開き、その公開鍵を追加してください。GitHub、GitLabなどのプロバイダーでは、ページ名やアカウントポリシーが異なります。利用しているプロバイダーの案内に従ってください。秘密鍵を貼り付けたり、アップロードしたりしてはいけません。

1つまたは複数の鍵を使うSSH設定

SSHの既定の鍵選択を使うことも、複数のアカウントや鍵を使う場合にホスト別名で特定の鍵を選ぶこともできます。次のエントリ全体を~/.ssh/configに追加します。

このコマンドを実行するとエントリの例全体が表示されるので、それを~/.ssh/configにコピーします。

cat <<'SSH_CONFIG'
Host github-work
    HostName github.com
    User git
    IdentityFile ~/.ssh/id_ed25519_work
    IdentitiesOnly yes
SSH_CONFIG

~/.ssh/id_ed25519_workは例示用のパスです。実際の秘密鍵のパスに置き換えてください。Gitのリモートでは、Hostエントリと同じgithub-workという別名を使う必要があります。IdentityFileには秘密鍵のパスを指定します。IdentitiesOnly yesを設定すると、SSHはエージェントのほかの鍵を順番に試すのではなく、設定した鍵を提示します。別のアカウントには別の別名と鍵のパスを使います。Gitのリモートに指定する別名は、Hostの値と完全に一致させてください。ファイルの権限やSSHエージェントの起動方法は、OSやシェルによって異なります。エージェントを使う場合は、お使いの環境に合った方法で起動してから、ssh-addで秘密鍵を読み込んでください。SSHが鍵を直接読み込める場合、この手順は不要です。

リポジトリのSSHリモートを設定する

ローカルリポジトリでgit remote -vを実行し、設定済みのリモートを確認します。GitHubのSSHリモートはgit@github.com:OWNER/REPOSITORY.gitの形式です。2つのプレースホルダーを、アカウントまたは組織名とリポジトリ名に置き換えてください。git remote set-url origin git@github.com:OWNER/REPOSITORY.gitで既存のoriginを変更し、もう一度git remote -vを実行してSSH URLになったことを確認します。リモート名がorigin以外の場合は、現在の名前を使ってください。

github-workのような別名を設定した場合は、URLにもその別名を使います。たとえばgit@github-work:OWNER/REPOSITORY.gitです。別のホストでは、そのプロバイダーが示すSSH URLを使ってください。URLがhttps://で始まる場合はHTTPS認証が使われているため、リモートをSSHに変更するまでは鍵を変えても影響しません。

変更をコミットしてpushする

コミットに含めるファイルを選び、たとえばgit add path/to/fileのように明示してステージします。現在のディレクトリ内の変更をすべてこのコミットに含める場合に限り、git add .を使ってください。git commit -m "Describe the change"でコミットを作成します。次にgit push origin BRANCHで対象のブランチをpushし、originとBRANCHはリポジトリで使っているリモート名とブランチ名に置き換えます。ブランチを初めてpushするときは、git push -u origin BRANCHを使うと、そのリモートブランチを追跡先として記録できます。

SSH認証の確認とよくある問題の対処

ssh -T git@github.comでホストへの接続を確認します。SSHの別名を使っている場合は、たとえばssh -T git@github-workのように置き換えてください。ホストの応答はプロバイダーによって異なり、アカウントを確認しても対話型シェルを提供しないホストもあります。認証で確認できるのは、鍵がどのアカウントを示しているかです。そのアカウントにこのリポジトリへのpush権限があることまでは確認できません。また、認証成功のメッセージに対して、プロバイダーが0以外の終了ステータスを返す場合もあります。

テストで別のアカウントが識別された場合や認証できない場合は、そのアカウントに公開鍵を登録したか、IdentityFileが対応する秘密鍵を指しているか、リモートが一致するHost別名を使っているかを確認してください。ssh -vT git@github-workを実行すると、SSHがどの鍵を提示するか確認できます。診断出力は手元で確認し、秘密鍵の内容は共有しないでください。git remote -vでリモートURLも確認します。認証は成功するのにpushが拒否される場合は、リポジトリへの書き込み権限、ブランチ名、ホスト側のブランチルールを確認してください。

秘密鍵を紛失した場合や漏えいした場合は、新しい鍵ペアを作成して公開鍵をホストに登録し、必要に応じてSSH設定やリモートを更新してから、アカウントから古い公開鍵を削除します。公開鍵はGitホストに共有するものですが、秘密鍵は秘密に保つ必要があります。