使用 GPG、SSH 或 S/MIME,可以在本地对标记和提交进行签名。 这些标记或提交在 GitHub 上标示为已验证,便于其他人信任更改来自可信的来源。
对于大多数个人用户,GPG 或 SSH 会是对提交进行签名的最佳选择。 在较大型组织的环境中通常需要 S/MIME 签名。 SSH 签名是最容易生成的。 甚至可以将现有身份验证密钥上传到 GitHub 以用作签名密钥。 生成 GPG 签名密钥比生成 SSH 密钥更复杂,但 GPG 具有 SSH 所没有的功能。 GPG 密钥可以在不再使用时过期或撤销。 GitHub 将已使用此类密钥进行签名的提交显示为“已验证”,除非密钥标记为已泄露。 SSH 密钥没有此功能。
GitHub 提交签名状态类型:
状态 | 说明 |
---|---|
已验证 | 提交已签名且签名已成功验证。 |
未验证 | 提交已签名,但签名无法验证。 |
无验证状态 | 提交未签名。 |
预期状态:
配置 GPG 密钥方法与步骤
如果没有现有的 GPG 密钥,您可以生成新的 GPG 密钥以用于签名提交和标记。
GitHub 支持多种 GPG 密钥算法。 如果您尝试添加使用不支持的算法生成的密钥,可能会发生错误。
- RSA
- ElGamal
- DSA
- ECDH
- ECDSA
- EdDSA
windows 端生成 GPG 密钥
注意
在生成新 GPG 密钥之前,请确保已验证你的电子邮件地址。 如果尚未验证电子邮件地址,将无法使用 GPG 对提交和标记进行签名。
下载并安装适用于操作系统的 GPG 命令行工具
方法一 (经过测试,这条路不通)
按提示安装完 GPG 工具后,会弹出他的桌面UI Kleopatra
第一步 新建openGPG
密钥对
第二步 设置openGPG
密钥对(/名字/邮箱/密码/密钥类型rsa4096/用途/有效期/)
第三步 导出/备份openGPG
公钥/私钥
第四步 上传openGPG
公钥至GitHub
方法二
打开Git Bash。
生成 GPG 密钥对。 由于 GPG 有多个版本,因此可能需要查阅相关手册页来查找相应的密钥生成命令。
如果您使用的是 2.1.17 或更高版本,请粘贴以下文本以生成 GPG 密钥对。
gpg --full-generate-key
如果使用的不是版本 2.1.17 或更高版本,则 gpg –full-generate-key 命令不起作用。 请粘贴以下文本并跳到第 6 步。
gpg --default-new-key-algo rsa4096 --gen-key
在提示时,指定要生成的密钥类型,或按 Enter 键接受默认值。
在提示时,指定要生成的密钥大小,或按 Enter 键接受默认值。
输入密钥的有效时长。 按 Enter 键将指定默认选择,表示该密钥不会过期。 除非你需要过期日期,否则我们建议接受此默认值。
验证您的选择是否正确。
输入您的用户 ID 信息。
注意:要求你输入电子邮件地址时,请确保输入 GitHub 帐户的经过验证的电子邮件地址。 要将电子邮件地址保密,请使用 GitHub 提供的 no-reply 电子邮件地址。 有关详细信息,请参阅“验证电子邮件地址”和“设置提交电子邮件地址”。
输入安全密码。
使用 gpg --list-secret-keys --keyid-format=long
命令列出你拥有其公钥和私钥的长形式 GPG 密钥。 签名提交或标记需要私钥。
Shell
gpg --list-secret-keys --keyid-format=long
注意:Linux 上的某些 GPG 安装可能需要改用 gpg2 –list-keys –keyid-format LONG 查看现有密钥的列表。 在这种情况下,还需要通过运行 git config –global gpg.program gpg2 来配置 Git 以使用 gpg2。
从 GPG 密钥列表中复制您想要使用的 GPG 密钥 ID 的长形式。 在本例中,GPG 密钥 ID 为 3AA5C34371567BD2:
$ gpg --list-secret-keys --keyid-format=long
/Users/hubot/.gnupg/secring.gpg
------------------------------------
sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
uid Hubot <hubot@example.com>
ssb 4096R/4BB6D45482678BE3 2016-03-10
粘贴下面的文本(替换为您要使用的 GPG 密钥 ID)。 在本例中,GPG 密钥 ID 为 3AA5C34371567BD2:
gpg --armor --export 3AA5C34371567BD2
# Prints the GPG key ID, in ASCII armor format
复制以 —–BEGIN PGP PUBLIC KEY BLOCK—– 开头并以 —–END PGP PUBLIC KEY BLOCK—– 结尾的 GPG 密钥。
将 GPG 密钥新增到 GitHub 帐户。
设置本地 git 环境变量
git config --global user.signingkey 3AA5C34371567BD2
git config --global user.name xxxx
git config --global user.email xxxx@xxxxx.com
git config --global commit.gpgsign true
GPG 签名重置后要检查本地的git config有没有这几个配置git config --list
user.name=xxxx
user.email=xxxx@xxxxxxx.com
user.signingkey=3AA5C34371567BD2
commit.gpgsign=true