ソフトウェアエンジニアの為の SSH 鍵ペアの生成方法 2022

SSH 鍵ペアの生成
近々作り直す予定があるので備忘録を記載しておきます。
実際には Windows の msys2 bash 環境での例ですが mac ksh, linux bash でもほぼ同様で大丈夫なはずです

鍵を作成する

# 作業用ディレクトリの作成と移動
mkdir ~/ssh-keygen-work
pushd ~/ssh-keygen-work

# 個人用 .ssh ディレクトリの作成
mkdir ~/.ssh
chmod 700 ~/.ssh

# このマシンにログインする時に使える秘密鍵に対応する公開鍵を登録しておくファイルの作成
touch ~/.ssh/authorized_keys
chmod 600 ~/.ssh/authorized_keys

# 鍵ペアの作成, 古い形式はセキュリティ的に推奨できなくなっている可能性があるので作成する時点で最適なアルゴリズムを確認すべき (新しすぎても古いサーバーで使えなかったりするのでちょうどいい所を見極めること)
ssh-keygen -t ed25519 -C '[e-mail]-20211217' -f '[e-mail]-with-pp'

# 鍵名に含めた key-with-pp は公開鍵には冗長なので名前を変えておく
mv ./[e-mail] [e-mail]

# (一般的には非推奨) パスフレーズ解除版を作る場合にコピー
# cp ./[e-mail]-with-pp     ./[e-mail]-without-pp

# (一般的には非推奨) パスフレーズ解除版を作る場合に解除
# ssh-keygen -p -f ./[e-mail]-without-pp

# 秘密鍵は他のユーザーが触れないパーミッションを設定しておく
chmod 600 ./[e-mail]-with-pp
chmod 600 ./[e-mail]-without-pp

# 一連のファイルを .ssh に移動
mv ./[e-mail]-20211217.* ~/.ssh/

# 作成した公開鍵は authorized_keys に追記しておく
cat ~/.ssh/[e-mail] >> ~/.ssh/authorized_keys

# 作業用ディレクトリの後始末
popd
rm -rf ~/ssh-keygen-work

PuTTY keygen でインポート

(Windows の場合のみ)
[e-mail]
[e-mail]

gitlab に OpenSSH 形式の公開鍵を登録

(gitlab の場合の例、但し github や GHE, Bitbucket でも似たようなページがあったはず)
URL は https://brabrabra.example.com/-/profile/keys のような形

~/.ssh/[e-mail]

ssh-ed25519 -------------------------------------------------------------------- [e-mail]-20211217

SourceTree Options General SSH Key に ppk を登録

Windows の場合に設定する.
Mac の場合は指定できないので, ~/.ssh/config に指定して, 更に設定で embedded git ではなく system git を使用するようにする

~/.ssh/config

Host github.com
    IdentityFile ~/.ssh/[e-mail]-without-pp
    User git

Pagent に ppk を登録

(Windows の場合)
explorer のアドレスに shell:startup を指定して開き, pageant.exe へのショートカットの引数に ppk を指定

target: (リンク先) のパスは PuTTY を実際にインストールしたパスに読み替えて下さい。

ppk ファイルは target: に実行ファイルのパスに続けて引数として指定します。複数の ppk を指定できます。

target:(リンク先)の例

"C:\Users\your_name\programs\PuTTY\pageant.exe" "C:\Users\your_name\.ssh\[e-mail]" "C:\Users\your_name\.ssh\[e-mail]"

git コマンドを直接使用する場合の id_rsa 以外の名前の鍵の指定方法

GIT_SSH_COMMAND="ssh -i ~/.ssh/[e-mail]-with-pp -F /dev/null" git fetch