Signing commits with GPG

Signing commits with GPG
Signing commits with GPG

Signing commits with GPG

原文：https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/

How GitLab handles GPG
Generating a GPG key
Adding a GPG key to your account
Associating your GPG key with Git
Signing commits
Verifying commits
Revoking a GPG key
Removing a GPG key
Rejecting commits that are not signed
GPG signing API
Further reading

Signing commits with GPG

版本历史

在 GitLab 9.5 中引入 .
在 GitLab 10.1 中添加了子项支持.

您可以使用 GPG 密钥对在 GitLab 存储库中进行的 Git 提交进行签名. 如果可以验证提交者的身份，则已签名的提交将标记为” 已验证”. 为了验证提交者的身份，GitLab 需要他们的公共 GPG 密钥.

注意：术语 GPG 用于所有与 OpenPGP / PGP / GPG 相关的材料和实现.

目前尚不支持通过 GPG 验证的标签.

有关 GPG 的更多详细信息，请参见进一步阅读部分.

How GitLab handles GPG

GitLab 使用其自己的密钥环来验证 GPG 签名. 它不访问任何公钥服务器.

对于要由 GitLab 验证的提交：

提交者必须具有 GPG 公钥/私钥对.
提交者的公钥必须已上传到其 GitLab 帐户.
GPG 密钥中的一封电子邮件必须与提交者在 GitLab 中使用的经过验证的电子邮件地址匹配.
提交者的电子邮件地址必须与 GPG 密钥中验证的电子邮件地址匹配.

Generating a GPG key

如果您还没有 GPG 密钥，则以下步骤将帮助您入门：

为您的操作系统安装 GPG . 如果您的操作系统具有gpg2安装，更换gpg与gpg2在下面的命令.
使用以下命令生成私钥/公钥对，这将产生一系列问题：
```
gpg --full-gen-key
```
注意：在某些情况下，例如 Windows 和其他 macOS 版本上的 Gpg4win，此处的命令可能是gpg --gen-key .

第一个问题是可以使用哪种算法. 选择所需的类型或按Enter 键选择默认类型（RSA 和 RSA）：

Please select what kind of key you want:
   (1) RSA and RSA (default)
   (2) DSA and Elgamal
   (3) DSA (sign only)
   (4) RSA (sign only)
Your selection? 1

下一个问题是密钥长度. 我们建议您选择4096 ：

RSA keys may be between 1024 and 4096 bits long.
What keysize do you want? (2048) 4096
Requested keysize is 4096 bits

指定密钥的有效期. 这是主观的，您可以使用默认值，该值永远不会过期：

Please specify how long the key should be valid.
         0 = key does not expire
      <n>  = key expires in n days
      <n>w = key expires in n weeks
      <n>m = key expires in n months
      <n>y = key expires in n years
Key is valid for? (0) 0
Key does not expire at all

通过输入y确认您给出的答案是正确的：
```
Is this correct? (y/N) y
```

输入您的真实姓名，与此键关联的电子邮件地址（应与您在 GitLab 中使用的经过验证的电子邮件地址匹配）和可选注释（按Enter跳过）：

GnuPG needs to construct a user ID to identify your key.
Real name: Mr. Robot
Email address: <your_email>
Comment:
You selected this USER-ID:
    "Mr. Robot <your_email>"
Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O

在询问时选择一个强密码，然后输入两次以确认.
使用以下命令列出您刚刚创建的私密 GPG 密钥：
```
gpg --list-secret-keys --keyid-format LONG <your_email>
```
将<your_email>替换为您在上面输入的电子邮件地址.

复制以sec开头的 GPG 密钥 ID. 在以下示例中，即30F2B65B9246B6CA ：

sec   rsa4096/30F2B65B9246B6CA 2017-08-18 [SC]
     D5E4F29F3275DC0CDA8FFC8730F2B65B9246B6CA
uid                   [ultimate] Mr. Robot <your_email>
ssb   rsa4096/B7ABC0813E4028C0 2017-08-18 [E]

导出该 ID 的公共密钥（替换上一步中的密钥 ID）：
```
gpg --armor --export 30F2B65B9246B6CA
```
最后，复制公钥并将其添加到您的个人资料设置中

Adding a GPG key to your account

注意：添加密钥后，就无法对其进行编辑，只能将其删除. 如果粘贴无效，则必须删除有问题的密钥并重新添加.

您可以在个人资料的设置中添加 GPG 密钥：

点击右上角的头像，然后转到“设置” .
导航至GPG 密钥标签，然后将您的公共密钥粘贴到”密钥”框中.
最后，单击添加键将其添加到 GitLab. 您将能够看到其指纹，相应的电子邮件地址和创建日期.

Associating your GPG key with Git

创建 GPG 密钥并将其添加到您的帐户之后，是时候告诉 Git 使用哪个密钥了.

使用以下命令列出您刚刚创建的私密 GPG 密钥：
```
gpg --list-secret-keys --keyid-format LONG <your_email>
```
将<your_email>替换为您在上面输入的电子邮件地址.

复制以sec开头的 GPG 密钥 ID. 在以下示例中，即30F2B65B9246B6CA ：

sec   rsa4096/30F2B65B9246B6CA 2017-08-18 [SC]
      D5E4F29F3275DC0CDA8FFC8730F2B65B9246B6CA
uid                   [ultimate] Mr. Robot <your_email>
ssb   rsa4096/B7ABC0813E4028C0 2017-08-18 [E]

告诉 Git 使用该密钥对提交进行签名：
```
git config --global user.signingkey 30F2B65B9246B6CA
```
用您的 GPG 密钥 ID 替换30F2B65B9246B6CA .
（可选）如果 Git 使用gpg并且出现诸如secret key not available或gpg: signing failed: secret key not available ，请运行以下命令更改为gpg2 ：
```
git config --global gpg.program gpg2
```