Signing commits with GPG

Signing commits with GPG

版本历史

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

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

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

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

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

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

对于要由 GitLab 验证的提交：

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

Generating a GPG key

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

  1. 为您的操作系统安装 GPG . 如果您的操作系统具有安装，更换gpg与gpg2在下面的命令.

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

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

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

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

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

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

  5. 通过输入y确认您给出的答案是正确的：

    1. Is this correct? (y/N) y

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

  7. 在询问时选择一个强密码，然后输入两次以确认.

    1. gpg --list-secret-keys --keyid-format LONG <your_email>

    将<your_email>替换为您在上面输入的电子邮件地址.

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

    1. sec   rsa4096/30F2B65B9246B6CA 2017-08-18 [SC]
    2.      D5E4F29F3275DC0CDA8FFC8730F2B65B9246B6CA

  10. 导出该 ID 的公共密钥（替换上一步中的密钥 ID）：

    1. gpg --armor --export 30F2B65B9246B6CA

  11. 最后，复制公钥并将其

Adding a GPG key to your account

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

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

  1. 点击右上角的头像，然后转到“设置” .

  2. 导航至GPG 密钥标签，然后将您的公共密钥粘贴到”密钥”框中.

    Paste GPG public key

  3. 最后，单击添加键将其添加到 GitLab. 您将能够看到其指纹，相应的电子邮件地址和创建日期.

创建 GPG 密钥并将其 ，是时候告诉 Git 使用哪个密钥了.

  1. 使用以下命令列出您刚刚创建的私密 GPG 密钥：

    1. gpg --list-secret-keys --keyid-format LONG <your_email>

    将<your_email>替换为您在上面输入的电子邮件地址.

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

    1. git config --global user.signingkey 30F2B65B9246B6CA

    用您的 GPG 密钥 ID 替换30F2B65B9246B6CA .

  4. （可选）如果 Git 使用gpg并且出现诸如secret key not available或gpg: signing failed: secret key not available ，请运行以下命令更改为gpg2 ：

    1. git config --global gpg.program gpg2

Signing commits

并将其添加到您的帐户之后 ，您可以开始对提交进行签名：

  1. 像以前一样提交，唯一的区别是添加了-S标志：

    1. git commit -S -m "My commit msg"

  2. 询问时输入 GPG 密钥的密码.

  3. 推送至 GitLab 并检查您的提交 .

如果您不想在每次提交时都键入标志，则可以告诉 Git 自动签名您的提交：

  1. git config --global commit.gpgsign true

Verifying commits

  1. 在项目或 ，导航到” 提交”选项卡. 签名的提交将显示包含” Verified”或” Unverified”的徽章，具体取决于 GPG 签名的验证状态.

    Signed and unsigned commits

  2. 通过单击 GPG 徽章，将显示签名的详细信息.

    Signed commit with verified signature

撤消密钥将取消验证已签名的提交. 使用此密钥验证的提交将变为未验证状态. 撤销此密钥后，将来的提交也将保持不变. 如果您的密钥已被盗用，则应使用此操作.

撤销 GPG 密钥：

  1. 点击右上角的头像，然后转到“设置” .
  2. 导航到GPG 键标签.
  3. 单击您要删除的 GPG 键旁边的撤消 .

Removing a GPG key

删除密钥不会取消验证已签名的提交. 使用此密钥验证的提交将保持验证状态. 删除此密钥后，只有未按下的提交才会保持未验证状态. 要取消验证已签名的提交，您需要从您的帐户中撤销关联的 GPG 密钥 .

要从您的帐户中删除 GPG 密钥，请执行以下操作：

  1. 点击右上角的头像，然后转到“设置” .
  2. 导航到GPG 键标签.
  3. 单击您要删除的 GPG 密钥旁边的垃圾桶图标.

Rejecting commits that are not signed

您可以将您的项目配置为拒绝不是通过推送规则进行 GPG 签名的提交.

Further reading

有关 GPG 的更多详细信息，请参见：