~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Jonathan Riddell
  • Date: 2011-06-16 14:21:52 UTC
  • mto: (5971.2.3 bzr-gpgme)
  • mto: This revision was merged to the branch mainline in revision 6003.
  • Revision ID: jriddell@canonical.com-20110616142152-oacqldot0lxciq0e
tidying

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
Verifying Commits
57
 
-----------------
58
 
 
59
 
Unfortunately there is currently no command for verifying signatures.  This can
60
 
be done manually using bzrlib and Python::
61
 
 
62
 
  >>> from bzrlib.branch import Branch
63
 
  >>> b = Branch.open('/home/amy/src/daleks')
64
 
  >>> b.last_revision()
65
 
  'amy@example.com-20110527185938-hluafawphszb8dl1'
66
 
  >>> print b.repository.get_signature_text(b.last_revision())
67
 
  -----BEGIN PGP SIGNED MESSAGE-----
68
 
  Hash: SHA1
69
 
 
70
 
  bazaar-ng testament short form 1
71
 
  revision-id: amy@example.com-20110527185938-hluafawphszb8dl1
72
 
  sha1: 6411f9bdf6571200357140c9ce7c0f50106ac9a4
73
 
  -----BEGIN PGP SIGNATURE-----
74
 
  Version: GnuPG v1.4.11 (GNU/Linux)
75
 
 
76
 
  iEYEARECAAYFAk32HFcACgkQpQbm1N1NUIiBXACg6ILsyvJp4+Twq190qk1I4v9K
77
 
  PAAAoI8pg9s7uuqldqOwz6/uwH3ezdSX
78
 
  =+NcB
79
 
  -----END PGP SIGNATURE-----
80
 
 
81
 
The signature can be saved to a file and verified with ``gpg --verify
82
 
signature.txt``.
83
 
 
84
 
The signed SHA1 checksum is made from the ``bzr testament --long`` command
85
 
which includes information on the committer and a list of all files in that
86
 
commit along with their checksums.  So if the signature is valid you can be
87
 
sure you are looking at the same code as the person who made the signature.
88
 
 
89
 
Work in Progress
90
 
----------------
91
 
 
92
 
There is still a number of digital signature related features which are hoped
93
 
to be added to Bazaar soon.  These include easy verificiation, qbzr
94
 
integration, signing with different keys and setting branches to require
95
 
signatures.