使用 GPG 密钥签署提交
PyCharm 依赖于 Git 内置的 GPG 提交签名 功能。 为获得最佳体验,建议使用带有图形界面的 gpg2 软件包来处理密码短语提示。
配置环境
设置 GPG 支持
请执行以下任一操作:
下载并安装最新的 GitForWindows 版本(您需要 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命令,确保 pinentry 显示 GUI 提示。下载并安装 Gpg4Win 软件包,并通过以下操作确保
git config gpg.program指向该软件包中的gpg.exe文件:运行
where.exe gpg。如果输出返回多个可执行文件,请找到来自 Gpg4Win 的那个(默认路径为 C:\Program Files (x86)\GnuPG\bin\gpg.exe )。
运行
git config --global gpg.program "path/to/gpg/from/Gpg4Win"。
设置 GPG 支持
请执行以下任一操作:
下载并安装 GPGTools。 预配置的 GPG 是该软件包的一部分。
确保
git config gpg.program指向该软件包中的 gpg 文件(默认路径为 /usr/local/MacGPG2/bin/gpg )。下载并打开 Homebrew ,然后运行以下命令:
brew install gnupg pinentry-mac。为验证一切设置正确,打开 Terminal,运行
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命令,确保 pinentry 显示 GUI 提示。
设置 GPG 支持
使用随您的 Linux 发行版提供的包管理器安装
gpg2。 确切的软件包列表会因您使用的发行版而异,最重要的是 gnupg2 、 gnupg-agent ,以及能够显示 GUI 提示的 pinentry 。例如,在 Ubuntu/Debian 上运行
sudo apt -y install gnupg2 gnupg-agent pinentry-gnome3。为验证一切设置正确,打开 Terminal,运行
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 ,用于存储您的密钥的私有部分。 有关设置 Yubikey 的更多信息,请参阅 YubiKey-Guide。
导入 GPG 密钥
如果您已有 GPG 密钥,则需要将其导入到相应的 GPG 密钥环。
打开 终端 / 命令提示符 / GitBash / 您系统上的任何其他 shell 并运行以下命令:
gpg --import <path to your private gpg.key>
生成 GPG 密钥
如果尚无密钥,您需要生成一对新的密钥。
打开 终端 / 命令提示符 / GitBash / 您系统上的任何其他 shell 并运行以下命令:
gpg --full-generate-key(对于 pgp 2.1.17 及以下版本,请使用gpg --gen-key命令)。回答该工具提出的问题。 建议的选择为:
密钥类型 :RSA
密钥大小 :至少 4096 位
密钥有效期 :1 年(每年轮换一次密钥是一个良好实践)
输入您的用户 ID 信息。 建议使用与您的提交作者信息一致的用户名和电子邮件地址。 如果您计划将签名与电子邮件地址隐私功能配合使用,请指定 GitHub noreply 电子邮件地址。
输入安全的密码短语。 请确保在弹出的对话框中输入,而不要在命令行中输入,因为使用 GUI 处理此类提示非常重要。
通过运行以下命令,确保密钥已导入:
gpg --list-keys。
启用提交签名
在启用提交签名之前,请确保您已先 设置 GPG 密钥。
启动 PyCharm(或重新启动它,以确保其加载您对环境所做的更改)。
在 设置 对话框(Ctrl+Alt+S )中,转到 版本控制 | Git ,然后点击 配置 GPG 密钥 按钮。
在打开的对话框中,点击 使用GPG 密钥签署提交 ,并从列表中选择您要使用的密钥。
现在,每个提交都会使用所选密钥进行签名。 GPG 签名的状态将显示在日志选项卡的提交详细信息窗格中。
将 GPG 密钥添加到您的帐户
如果您使用的 Git 托管服务支持验证 GPG 签名,请将您的密钥的公钥部分上传到该处。
请按照以下说明操作。