章节 ▾ 第二版

7.4 Git 工具 - 签署工作

签署工作

Git 在密码学上是安全的，但这并不意味着它无懈可击。如果你从互联网上获取他人的工作成果，并希望验证提交确实来自可信来源，Git 提供了一些使用 GPG 对工作进行签署和验证的方法。

GPG 简介

首先，如果你想签署任何内容，你需要配置好 GPG 并安装你的个人密钥。

$ gpg --list-keys
/Users/schacon/.gnupg/pubring.gpg
---------------------------------
pub   2048R/0A46826A 2014-06-04
uid                  Scott Chacon (Git signing key) <schacon@gmail.com>
sub   2048R/874529A9 2014-06-04

如果你还没有安装密钥，可以使用 gpg --gen-key 生成一个。

$ gpg --gen-key

一旦你拥有了用于签署的私钥，就可以通过设置 user.signingkey 配置项来告知 Git 使用它进行签署。

$ git config --global user.signingkey 0A46826A!

现在，如果你愿意，Git 将默认使用你的密钥来签署标签和提交。

签署标签

如果你设置了 GPG 私钥，现在就可以用它来签署新标签。你所要做的就是使用 -s 而不是 -a。

$ git tag -s v1.5 -m 'my signed 1.5 tag'

You need a passphrase to unlock the secret key for
user: "Ben Straub <ben@straub.cc>"
2048-bit RSA key, ID 800430EB, created 2014-05-04

如果你在该标签上运行 git show，就可以看到附加在其上的 GPG 签名。

$ git show v1.5
tag v1.5
Tagger: Ben Straub <ben@straub.cc>
Date:   Sat May 3 20:29:41 2014 -0700

my signed 1.5 tag
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAABAgAGBQJTZbQlAAoJEF0+sviABDDrZbQH/09PfE51KPVPlanr6q1v4/Ut
LQxfojUWiLQdg2ESJItkcuweYg+kc3HCyFejeDIBw9dpXt00rY26p05qrpnG+85b
hM1/PswpPLuBSr+oCIDj5GMC2r2iEKsfv2fJbNW8iWAXVLoWZRF8B0MfqX/YTMbm
ecorc4iXzQu7tupRihslbNkfvfciMnSDeSvzCpWAHl7h8Wj6hhqePmLm9lAYqnKp
8S5B/1SSQuEAjRZgI4IexpZoeKGVDptPHxLLS38fozsyi0QyDyzEgJxcJQVMXxVi
RUysgqjcpT8+iQM1PblGfHR4XAhuOqN5Fx06PSaFZhqvWFezJ28/CLyX5q+oIVk=
=EFTF
-----END PGP SIGNATURE-----

commit ca82a6dff817ec66f44342007202690a93763949
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Mon Mar 17 21:52:11 2008 -0700

    Change version number

验证标签

要验证已签署的标签，可以使用 git tag -v <tag-name>。该命令使用 GPG 来验证签名。要使其正常工作，你的密钥环中必须拥有签署者的公钥。

$ git tag -v v1.4.2.1
object 883653babd8ee7ea23e6a5c392bb739348b1eb61
type commit
tag v1.4.2.1
tagger Junio C Hamano <junkio@cox.net> 1158138501 -0700

GIT 1.4.2.1

Minor fixes since 1.4.2, including git-mv and git-http with alternates.
gpg: Signature made Wed Sep 13 02:08:25 2006 PDT using DSA key ID F3119B9A
gpg: Good signature from "Junio C Hamano <junkio@cox.net>"
gpg:                 aka "[jpeg image of size 1513]"
Primary key fingerprint: 3565 2A26 2040 E066 C9A7  4A7D C0C6 D9A4 F311 9B9A

如果你没有签署者的公钥，你将会看到类似这样的提示。

gpg: Signature made Wed Sep 13 02:08:25 2006 PDT using DSA key ID F3119B9A
gpg: Can't check signature: public key not found
error: could not verify the tag 'v1.4.2.1'

签署提交

在较新版本的 Git（v1.7.9 及以上）中，你现在也可以签署单个提交。如果你不仅想签署标签，还想直接签署提交，只需在 git commit 命令中添加 -S 参数即可。

$ git commit -a -S -m 'Signed commit'

You need a passphrase to unlock the secret key for
user: "Scott Chacon (Git signing key) <schacon@gmail.com>"
2048-bit RSA key, ID 0A46826A, created 2014-06-04

[master 5c3386c] Signed commit
 4 files changed, 4 insertions(+), 24 deletions(-)
 rewrite Rakefile (100%)
 create mode 100644 lib/git.rb

要查看并验证这些签名，git log 也有一个 --show-signature 选项。

$ git log --show-signature -1
commit 5c3386cf54bba0a33a32da706aa52bc0155503c2
gpg: Signature made Wed Jun  4 19:49:17 2014 PDT using RSA key ID 0A46826A
gpg: Good signature from "Scott Chacon (Git signing key) <schacon@gmail.com>"
Author: Scott Chacon <schacon@gmail.com>
Date:   Wed Jun 4 19:49:17 2014 -0700

    Signed commit

此外，你可以配置 git log 使用 %G? 格式来检查它找到的任何签名并将其列在输出中。

$ git log --pretty="format:%h %G? %aN  %s"

5c3386c G Scott Chacon  Signed commit
ca82a6d N Scott Chacon  Change the version number
085bb3b N Scott Chacon  Remove unnecessary test code
a11bef0 N Scott Chacon  Initial commit

在这里我们可以看到，只有最新的提交是已签署且有效的，而之前的提交则不是。

在 Git 1.8.3 及更高版本中，可以通过 --verify-signatures 命令告诉 git merge 和 git pull 在合并未携带受信任 GPG 签名的提交时进行检查并拒绝合并。

如果你在合并分支时使用了此选项，且分支中包含未签署或无效的提交，合并将无法执行。

$ git merge --verify-signatures non-verify
fatal: Commit ab06180 does not have a GPG signature.

如果合并仅包含有效的已签署提交，合并命令将向你显示它已检查过的所有签名，然后继续执行合并。

$ git merge --verify-signatures signed-branch
Commit 13ad65e has a good GPG signature by Scott Chacon (Git signing key) <schacon@gmail.com>
Updating 5c3386c..13ad65e
Fast-forward
 README | 2 ++
 1 file changed, 2 insertions(+)

你也可以在 git merge 命令中使用 -S 选项来签署生成的合并提交本身。下面的示例既验证了要合并的分支中的每个提交都已签署，同时也签署了生成的合并提交。

$ git merge --verify-signatures -S  signed-branch
Commit 13ad65e has a good GPG signature by Scott Chacon (Git signing key) <schacon@gmail.com>

You need a passphrase to unlock the secret key for
user: "Scott Chacon (Git signing key) <schacon@gmail.com>"
2048-bit RSA key, ID 0A46826A, created 2014-06-04

Merge made by the 'recursive' strategy.
 README | 2 ++
 1 file changed, 2 insertions(+)

人人必须签署

签署标签和提交非常好，但如果你决定在日常工作流中使用它，就必须确保团队中的每个人都了解如何操作。这可以通过要求每个与仓库协作的人运行 git config --local commit.gpgsign true 来实现，这样他们的所有提交都会默认自动签署。如果你不这样做，你最终将花费大量时间帮助他人弄清楚如何使用已签署的版本来重写他们的提交。在将其作为标准工作流的一部分之前，请确保你了解 GPG 以及签署带来的好处。