Mac と GitHub の SSH 接続設定の覚書(2024年3月)

この記事について

内容

Mac と GitHub の SSH 接続設定をした作業の覚書

特徴

2024年3月時点の作業。
作業をしたのが古い MacBook であるため、この時点としては古い macOS Monterey を使用しているが、内容に影響はないと思われる。

参考記事

• GitHub Docs 既存の SSH キーの確認
• GitHub Docs 新しい SSH キーを生成して ssh-agent に追加する
• GitHub Docs GitHub アカウントへの新しい SSH キーの追加
• GitHubDocs SSH 接続をテストする

作業時期

2024年03月23日

作業の覚書

既存 SSH キーの確認

ターミナルを開いて ls -al ~/.ssh を入力して、ホームディレクトリに既存の SSH キーが存在するかどうかを確認する。

% ls -al ~/.ssh

No such file or directory と表示される場合、SSH キーは存在しないので、新しい SSH キーを作成する
保存場所とパスフレーズ(2回)を聞かれる。
パスフレーズは無しもできるが、今回は設定している。(後記の作業が必要になる)

% ssh-keygen -t ed25519 -C "(メールアドレス)"
Generating public/private ed25519 key pair.
Enter file in which to save the key (/Users/(ホーム)/.ssh/id_ed25519): 
Created directory '/Users/(ホーム)/.ssh'.
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /Users/(ホーム)/.ssh/id_ed25519
Your public key has been saved in /Users/(ホーム)/.ssh/id_ed25519.pub
The key fingerprint is:
SHA256:04・・・(省略)・・・
The key's randomart image is:
+--[ED25519 256]--+
|+.o..*.E         |
|.+o+*o*.o        |
・・・・(以下省略)・・

GitHub アカウントに SSH キーを追加する

SSH 公開鍵をクリップボードにコピーする

GitHub の [Settings] - [SSH and GPG Keys] の画面で [New SSH Key] を選択してタイトルとクリップボードのコピーした SSH 公開鍵を記入して、[Add SSH Kye] で登録する。

SSH設定ファイルを更新

~/.ssh/config が存在しない場合ファイルを作成し、以下を記入する。

Host github.com
  AddKeysToAgent yes
  UseKeychain yes
  IdentityFile ~/.ssh/id_ed25519

SSH キーのパスフレーズをキーチェーンに保存

以下を実行

% ssh-add --apple-use-keychain ~/.ssh/id_ed25519
Enter passphrase for /Users/(ホーム)/.ssh/id_ed25519: 
Identity added: /Users/(ホーム)/.ssh/id_ed25519 (メールアドレス)

接続テスト

以下で接続テストを実施

% ssh -T [e-mail]                         
Hi (アカウント名)! You've successfully authenticated, but GitHub does not provide shell access.