← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/gpg_signatures.txt

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/gpg_signatures.txt
 
1
GnuPG Signatures
 
2
=============================
 
3
 
 
4
Reasons to Sign Your Repository
 
5
--------------------------------
 
6
 
 
7
Bazaar can sign revisions using GnuPG, a Free Software implementation of the
 
8
OpenPGP digital signature format.  By signing commits a person wanting to
 
9
make use of a branch can be confident where the code came from, assuming the
 
10
GnuPG keys used can be verified.  This could for example prevent worry about
 
11
compromised code in the case where a server hosting Bazaar branches has been
 
12
hacked into.  It could also be used to verify that all code is written by a
 
13
select group of people, such as if contributor agreements are needed.
 
14
 
 
15
Signatures are passed around with commits during branch, push, merge and other
 
16
operations.
 
17
 
 
18
Setting up GnuPG
 
19
----------------
 
20
 
 
21
There are many guides to creating a digital signature key with GnuPG.  See
 
22
for example the `GnuPG Handbook
 
23
<http://www.gnupg.org/gph/en/manual.html#AEN26>`_ or the `Launchpad Wiki
 
24
<https://help.launchpad.net/YourAccount/ImportingYourPGPKey>`_.
 
25
 
 
26
 
 
27
Signing Commits
 
28
---------------
 
29
 
 
30
To sign commits as they are made turn on the ``create_signatures``
 
31
configuration option in your ``bazaar.conf`` or ``locations.conf`` file::
 
32
 
 
33
  create_signatures = always
 
34
 
 
35
When you next make a commit it will ask for the pass phrase for your GnuPG key. 
 
36
If you want GnuPG to remember your password ensure you have ``gnupg-agent``
 
37
installed.
 
38
 
 
39
To sign previous commits to a branch use ``sign-my-commits``.  This will go
 
40
through all revisions in the branch and sign any which match your
 
41
commit name.  You can also pass the name of a contributor to ``sign-my-commits``
 
42
to sign someone else's commits or if your GnuPG key does not match your Bazaar
 
43
name and e-mail::
 
44
 
 
45
  bzr sign-my-commits . "Amy Pond <amy@example.com>"
 
46
 
 
47
It will not sign commits which already have a signature.
 
48
 
 
49
To sign a single commit or a range of commits use the (hidden) command
 
50
``re-sign``::
 
51
 
 
52
  bzr re-sign -r 24
 
53
 
 
54
``re-sign`` is also useful to change an existing signature.
 
55
 
 
56
By default Bazaar will tell GnuPG to use a key with the same user
 
57
identity as the one set with ``whoami``.  To override this set
 
58
``gpg_signing_key`` in bazaar.conf or locations.conf.
 
59
 
 
60
  ``gpg_signing_key=DD4D5088``
 
61
 
 
62
  ``gpg_signing_key=amy@example.com``
 
63
 
 
64
Verifying Commits
 
65
-----------------
 
66
 
 
67
Signatures can be verified with the ``bzr verify-signatures`` command.  By
 
68
default this will check all commits in the branch and notify that all commits
 
69
are signed by known trusted signatures.  If not all commits have trusted
 
70
signatures it will give a summary of the number of commits which are invalid,
 
71
having missing keys or are not signed.
 
72
 
 
73
The ``verify-signatures`` command can be given a comma separated list of key
 
74
patters to specify a list of acceptable keys.  It can also take a range of
 
75
commits to verify in the current branch.  Finally using the verbose option will
 
76
list each key that is valid or authors for commits which failed::
 
77
 
 
78
  $bzr verify-signatures -kamy -v -r 1..5
 
79
  1 commit with valid signature
 
80
    Amy Pond <amy@example.com> signed 4 commits
 
81
  0 commits with unknown keys
 
82
  1 commit not valid
 
83
    1 commit by author The Doctor <doctor@example.com>
 
84
  0 commits not signed
 
85
 
 
86
Work in Progress
 
87
----------------
 
88
 
 
89
There is still a number of digital signature related features which
 
90
are hoped to be added to Bazaar soon.  These include bzr explorer
 
91
integration and setting branches to require signatures.