Windows環境でのGitコミット署名設定手順

この手順では、Windows環境でGPG (GNU Privacy Guard) を使用してGitコミットに署名を付ける方法を説明します。これにより、GitHubでコミットに”Verified”マークが表示されるようになります。

1. GPG for Windows (Gpg4win) のインストール

choco install gpg4win -y --ignore-checksums

2. GPG鍵の生成

gpg --full-generate-key

コマンドを実行すると、以下の情報を入力するよう求められます：

鍵の種類: RSA and RSA (デフォルト)
鍵長: 4096ビット
有効期限: 0 (無期限) または適切な期間
名前: あなたの名前またはGitHubユーザー名
メールアドレス: GitHubに登録しているメールアドレス
パスフレーズ: 安全なパスフレーズ

注意: パスフレーズは必ず覚えておくか、安全な場所に保管してください。

出力例

gpg: C:\\Users\\n0166\\AppData\\Roaming\\gnupg\\trustdb.gpg: 信用データベースができました
gpg: ディレクトリ'C:\\Users\\n0166\\AppData\\Roaming\\gnupg\\openpgp-revocs.d'が作成されました
gpg: 失効証明書を 'C:\\Users\\n0166\\AppData\\Roaming\\gnupg\\openpgp-revocs.d\\571397233557986B568D5F009ABD5929EBDD32F7.rev' に保管しました。
公開鍵と秘密鍵を作成し、署名しました。

pub   rsa4096 2024-10-09 [SC]
      571397233557986B568D5F009ABD5929EBDD32F7
uid                      nichicom-sakurai <sakurai.yuki@nck.co.jp>
sub   rsa4096 2024-10-09 [E]

3. 生成したGPG鍵の確認

gpg --list-secret-keys --keyid-format LONG

gpg: 信用データベースの検査
gpg: marginals needed: 3  completes needed: 1  trust model: pgp
gpg: 深さ: 0  有効性:   1  署名:   0  信用: 0-, 0q, 0n, 0m, 0f, 1u
[keyboxd]
---------
sec   rsa4096/9ABD5929EBDD32F7 2024-10-09 [SC]
      571397233557986B568D5F009ABD5929EBDD32F7
uid                 [  究極  ] nichicom-sakurai <sakurai.yuki@nck.co.jp>
ssb   rsa4096/02B1C3AC0203DC74 2024-10-09 [E]

上記の出力から、sec行の鍵ID（この例では9ABD5929EBDD32F7）をメモしておきます。

4. GPG公開鍵のエクスポート

先ほどメモした鍵IDを使用して、公開鍵をエクスポートします：

$ gpg --armor --export 9ABD5929EBDD32F7

出力された-----BEGIN PGP PUBLIC KEY BLOCK-----から-----END PGP PUBLIC KEY BLOCK-----までの全てをコピーします。

5. GitHubにGPG鍵を登録

GitHubのGPG鍵設定ページにアクセス
先ほどコピーした公開鍵をテキストエリアに貼り付け
“Add GPG key”をクリック

6. Gitの設定

署名鍵の設定

# グローバル設定（あなたの鍵IDに置き換えてください）
git config --global user.signingkey 9ABD5929EBDD32F7

# 設定確認
git config --global -e

自動署名の設定

毎回-Sオプションを付ける代わりに、全てのコミットで自動的に署名するよう設定できます：

# グローバル設定（推奨）
git config --global commit.gpgsign true

# 特定のリポジトリのみで設定する場合
git config commit.gpgsign true

GPGプログラムのパス設定（Windows特有）

git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

注意: Gpg4winのインストール先によってパスが異なる場合があります。以下のコマンドで確認できます：
Terminal window
where gpg

7. 署名付きコミットの実行

手動で署名する場合

# -Sオプションを付けてコミット
$ git commit -S -m 'コミットメッセージ'

自動署名が設定されている場合

# 通常通りコミットするだけで署名される
$ git commit -m 'コミットメッセージ'

8. トラブルシューティング

「 No secret key」エラーが出る場合

gpg: skipped "XXXXXX": No secret key

このエラーは以下の原因が考えられます：

GPGプログラムのパスが正しく設定されていない

git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

鍵IDが正しく設定されていない

# 鍵の再確認
gpg --list-secret-keys --keyid-format LONG
# 正しい鍵IDで再設定
git config --global user.signingkey YOUR_KEY_ID

Gitのユーザー情報とGPG鍵のメールアドレスが一致していない
Terminal window
```
# Gitのユーザー情報確認
git config --global user.email
```

パスフレーズ入力が求められない場合

Windows環境では、GPGエージェントが動作していない可能性があります。Gpg4winに含まれるKleopatraを起動しておくと解決することがあります。

署名の確認

コミットが正しく署名されているか確認するには：

# 最新のコミットの署名を確認
git log --show-signature -1

# 署名の検証
git verify-commit HEAD

9. 署名の確認

GitHubでの確認

署名付きコミットをプッシュした後、GitHub上でコミットの横に”Verified”バッジが表示されれば成功です。

ローカルでの確認

# 署名付きコミットの一覧表示
git log --show-signature

# 特定のコミットの署名検証
git verify-commit <commit-hash>

参考リンク

🔰【Win/Mac】Gitコミットに署名（verifiedマーク）を付けよう！