章節 ▾ 第二版

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 mergegit 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(+)

你還可以將 -S 選項與 git merge 命令一起使用,以簽署生成的合併提交本身。以下示例既驗證了要合併的分支中的每個提交都已簽名,還簽署了生成的合併提交。

$ 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 以及簽署的好處。

scroll-to-top