# GPG キーを使用してコミットに署名する。

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

CLion は、Git の組み込み [GPG コミット署名](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) 機能を利用しています。 最高のエクスペリエンスを得るには、パスフレーズプロンプトを処理するためのグラフィカルインターフェースを備えた  gpg2  パッケージを使用することをお勧めします。

## 環境を構成する

Windows:

Procedure: GPG サポートを設定する

* 次のいずれかを実行します：

* 最新の [GitForWindows(英語)](https://gitforwindows.org) バージョンをダウンロードしてインストールします（バージョン 2.19.2 以降が必要です）。 事前設定された GPG はパッケージの一部です。 すべてが正しく設定されていることを確認するには、GitBash を開き、 `gpgconf` コマンドを実行して、出力が次のようになっていることを確認します。 ``` gpg:OpenGPG:/usr/bin/gpg gpg-agent:Private Keys:/usr/bin/gpg-agent scdaemon:Smartcards:/usr/lib/gnupg/scdaemon gpgsm:S/MIME:/usr/bin/gpgsm dirmngr:Network:/usr/bin/dirmngr pinentry:Passphrase Entry:/usr/bin/pinentry ``` `echo GETPIN | pinentry` コマンドを実行して、ピンエントリに GUI プロンプトが表示されることを確認します。

* [Gpg4Win(英語)](https://www.gpg4win.org) パッケージをダウンロードしてインストールし、次の手順を実行して、 `git config gpg.program` がパッケージの `gpg.exe` ファイルを指していることを確認します。 1. `where.exe gpg` を実行します。 2. 出力が複数の実行可能ファイルを返す場合は、Gpg4Win から 1 つを見つけます（デフォルトでは、パスは `C:\Program Files (x86)\GnuPG\bin\gpg.exe` です）。 3. `git config --global gpg.program "path/to/gpg/from/Gpg4Win"` を実行します。

macOS:

Procedure: GPG サポートを設定する

* 次のいずれかを実行します：

* [GPGTools(英語)](https://gpgtools.org) をダウンロードしてインストールします。 事前設定された GPG はパッケージの一部です。 `git config gpg.program` がパッケージの `gpg` ファイルを指していることを確認してください（デフォルトでは、パスは `/usr/local/MacGPG2/bin/gpg` です）。

* [Homebrew(英語)](https://brew.sh) をダウンロードして開き、次のコマンドを実行します: `brew install gnupg pinentry-mac` すべてが正しくセットアップされていることを確認するには、ターミナルを開き、 `gpgconf` コマンドを実行して、出力が次のようになっていることを確認します。 ``` pg:OpenGPG:/usr/local/MacGPG2/bin/gpg gpg-agent:Private Keys:/usr/local/MacGPG2/bin/gpg-agent scdaemon:Smartcards:/usr/local/MacGPG2/libexec/scdaemon gpgsm:S/MIME:/usr/local/MacGPG2/bin/gpgsm dirmngr:Network:/usr/local/MacGPG2/bin/dirmngr pinentry:Passphrase Entry:/usr/local/bin/pinentry ``` `echo GETPIN | pinentry-mac` コマンドを実行して、ピンエントリに GUI プロンプトが表示されることを確認します。

Linux:

Procedure: GPG サポートを設定する

1. `gpg2`  を、使用している Linux ディストリビューション付属のパッケージマネージャーでインストールします。 利用しているディストリビューションによって、パッケージの正確なリストは異なりますが、特に重要なのは  `gnupg2` 、  `gnupg-agent` 、そして GUI プロンプトを表示する  `pinentry`  です。

例: Ubuntu/Debian で、  `sudo apt -y install gnupg2 gnupg-agent pinentry-gnome3`  を実行します。

2. すべてが正しくセットアップされていることを確認するには、ターミナルを開き、  `gpgconf`  コマンドを実行して、出力が次のようになっていることを確認します。

```
gpg:OpenPGP:/usr/bin/gpg
gpg-agent:Private Keys:/usr/bin/gpg-agent
scdaemon:Smartcards:/usr/lib/gnupg/scdaemon
gpgsm:S/MIME:/usr/bin/gpgsm
dirmngr:Network:/usr/bin/dirmngr
pinentry:Passphrase Entry:/usr/bin/pinentry

```

`echo GETPIN | pinentry`  コマンドを使用して、  `pinentry`  が GUI プロンプトを表示することを確認してください。

## GPG キーを設定する

最も安全な方法は、スマートカード ( [Yubikey(英語)](https://www.yubico.com/products/) など) を使用してキーの秘密部分を保存することです。 Yubikey のセットアップの詳細については、「 [YubiKey-Guide(英語)](https://github.com/drduh/YubiKey-Guide)」を参照してください。

Procedure: GPG キーをインポートする

すでに GPG キーをお持ちの場合は、それぞれの GPG キーリングにインポートする必要があります。

* ターミナル / コマンドプロンプト / GitBash / システム上にあるその他のシェル   を開き、次のコマンドを実行します:  `gpg --import <path to your private gpg.key>`

Procedure: GPG キーを生成する

キーがまだない場合は、新しいペアを生成する必要があります。

1. ターミナル / コマンドプロンプト / GitBash / システム上にあるその他のシェル   を開き、次のコマンドを実行します:  `gpg --full-generate-key`  (pgp 2.1.17 以下の場合は、  `gpg --gen-key`  コマンドを使用します)。

2. ツールが返す質問に答えます。 推奨される選択肢は次のとおりです。

* キーの種類 : RSA

* キーサイズ : 少なくとも 4096 ビット

* 主要な有効期間 : 1 年 (キーを 1 年に 1 回回転させることをお勧めします)

3. ユーザー ID 情報を入力します。 コミットの作成者として表示されているものと同じユーザー名とメールアドレスを使用することをお勧めします。 メールアドレスのプライバシー機能と一緒に署名を使用する場合は、GitHubnoreply メールアドレスを指定してください。

4. 安全なパスフレーズを入力します。 このようなプロンプトには GUI を使用することが重要であるため、コマンドラインではなくポップアップするダイアログに必ず入力してください。

5. 次のコマンドを実行して、キーがインポートされていることを確認します:  `gpg --list-keys`

## コミット署名を有効にする

コミット署名を有効にする前に、まず [GPG キーが設定されて](#set-up-gpg-keys)いることを確認してください。

Procedure:

1. CLion を起動します（または再起動して、環境への変更が正しく反映されることを確認してください）。

2. 設定   ダイアログ（ `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) ）で、   バージョン管理 | Git   に移動し、   GPG キーを構成する   ボタンをクリックします。

3. 開いたダイアログで、   GPG キーでコミットに署名する   をクリックし、使用するキーをリストから選択します。

これで、すべてのコミットが選択したキーで署名されるようになります。 GPG 署名の状態は、ログタブのコミットの詳細ペインに表示されます。

> **Tip:**
> MacOS での GPG 署名が  `fatal: failed to write commit object`  というエラーで失敗する場合は、 [簡単なトラブルシューティングガイド(英語)](https://youtrack.jetbrains.com/articles/SUPPORT-A-1234)に従って問題を修正してください。

## アカウントに GPG キーを追加する

使用している Git ホスティングが GPG 署名の検証をサポートしている場合は、そこに公開鍵部分をアップロードしてください。

指示に従ってください

* [GitHub(英語)](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account)

* [Space](https://www.jetbrains.com/ja-jp/help/space/git-keys-and-passwords.html#gpg-key)

* [GitLab(英語)](https://docs.gitlab.com/ee/user/project/repository/signed_commits/gpg.html#add-a-gpg-key-to-your-account)

* [Bitbucket(英語)](https://confluence.atlassian.com/bitbucketserver/using-gpg-keys-913477014.html#UsingGPGkeys-AddaGPGkey)

