← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Jelmer Vernooij
  • Date: 2011-01-19 06:13:58 UTC
  • mfrom: (5619 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5620.
  • Revision ID: jelmer@samba.org-20110119061358-qm58pzvcp2l9cdx4
merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Testament - a summary of a revision for signing.
 
18
 
 
19
A testament can be defined as "something that serves as tangible
 
20
proof or evidence."  In bzr we use them to allow people to certify
 
21
particular revisions as authentic.
 
22
 
 
23
The goal is that if two revisions are semantically equal, then they will
 
24
have a byte-for-byte equal testament.  We can define different versions of
 
25
"semantically equal" by using different testament classes; e.g. one that
 
26
includes or ignores file-ids.
 
27
 
 
28
We sign a testament rather than the revision XML itself for several reasons.
 
29
The most important is that the form in which the revision is stored
 
30
internally is designed for that purpose, and contains information which need
 
31
not be attested to by the signer.  For example the inventory contains the
 
32
last-changed revision for a file, but this is not necessarily something the
 
33
user cares to sign.
 
34
 
 
35
Having unnecessary fields signed makes the signatures brittle when the same
 
36
revision is stored in different branches or when the format is upgraded.
 
37
 
 
38
Handling upgrades is another motivation for using testaments separate from
 
39
the stored revision.  We would like to be able to compare a signature
 
40
generated from an old-format tree to newer tree, or vice versa.  This could
 
41
be done by comparing the revisions but that makes it unclear about exactly
 
42
what is being compared or not.
 
43
 
 
44
Different signing keys might indicate different levels of trust; we can in
 
45
the future extend this to allow signatures indicating not just that a
 
46
particular version is authentic but that it has other properties.
 
47
 
 
48
The signature can be applied to either the full testament or to just a
 
49
hash of it.
 
50
 
 
51
Testament format 1
 
52
~~~~~~~~~~~~~~~~~~
 
53
 
 
54
* timestamps are given as integers to avoid rounding errors
 
55
* parents given in lexicographical order
 
56
* indented-text form similar to log; intended to be human readable
 
57
* paths are given with forward slashes
 
58
* files are named using paths for ease of comparison/debugging
 
59
* the testament uses unix line-endings (\n)
 
60
"""
 
61
 
 
62
# XXX: At the moment, clients trust that the graph described in a weave
 
63
# is accurate, but that's not covered by the testament.  Perhaps the best
 
64
# fix is when verifying a revision to make sure that every file mentioned
 
65
# in the revision has compatible ancestry links.
 
66
 
 
67
# TODO: perhaps write timestamp in a more readable form
 
68
 
 
69
# TODO: Perhaps these should just be different formats in which inventories/
 
70
# revisions can be serialized.
 
71
 
 
72
from copy import copy
 
73
 
 
74
from bzrlib.osutils import (
 
75
    contains_whitespace,
 
76
    contains_linebreaks,
 
77
    sha,
 
78
    )
 
79
 
 
80
 
 
81
class Testament(object):
 
82
    """Reduced summary of a revision.
 
83
 
 
84
    Testaments can be
 
85
 
 
86
      - produced from a revision
 
87
      - written to a stream
 
88
      - loaded from a stream
 
89
      - compared to a revision
 
90
    """
 
91
 
 
92
    long_header = 'bazaar-ng testament version 1\n'
 
93
    short_header = 'bazaar-ng testament short form 1\n'
 
94
 
 
95
    @classmethod
 
96
    def from_revision(cls, repository, revision_id):
 
97
        """Produce a new testament from a historical revision"""
 
98
        rev = repository.get_revision(revision_id)
 
99
        inventory = repository.get_inventory(revision_id)
 
100
        return cls(rev, inventory)
 
101
 
 
102
    def __init__(self, rev, inventory):
 
103
        """Create a new testament for rev using inventory."""
 
104
        self.revision_id = rev.revision_id
 
105
        self.committer = rev.committer
 
106
        self.timezone = rev.timezone or 0
 
107
        self.timestamp = rev.timestamp
 
108
        self.message = rev.message
 
109
        self.parent_ids = rev.parent_ids[:]
 
110
        self.inventory = inventory
 
111
        self.revprops = copy(rev.properties)
 
112
        if contains_whitespace(self.revision_id):
 
113
            raise ValueError(self.revision_id)
 
114
        if contains_linebreaks(self.committer):
 
115
            raise ValueError(self.committer)
 
116
 
 
117
    def as_text_lines(self):
 
118
        """Yield text form as a sequence of lines.
 
119
 
 
120
        The result is returned in utf-8, because it should be signed or
 
121
        hashed in that encoding.
 
122
        """
 
123
        r = []
 
124
        a = r.append
 
125
        a(self.long_header)
 
126
        a('revision-id: %s\n' % self.revision_id)
 
127
        a('committer: %s\n' % self.committer)
 
128
        a('timestamp: %d\n' % self.timestamp)
 
129
        a('timezone: %d\n' % self.timezone)
 
130
        # inventory length contains the root, which is not shown here
 
131
        a('parents:\n')
 
132
        for parent_id in sorted(self.parent_ids):
 
133
            if contains_whitespace(parent_id):
 
134
                raise ValueError(parent_id)
 
135
            a('  %s\n' % parent_id)
 
136
        a('message:\n')
 
137
        for l in self.message.splitlines():
 
138
            a('  %s\n' % l)
 
139
        a('inventory:\n')
 
140
        for path, ie in self._get_entries():
 
141
            a(self._entry_to_line(path, ie))
 
142
        r.extend(self._revprops_to_lines())
 
143
        return [line.encode('utf-8') for line in r]
 
144
 
 
145
    def _get_entries(self):
 
146
        entries = self.inventory.iter_entries()
 
147
        entries.next()
 
148
        return entries
 
149
 
 
150
    def _escape_path(self, path):
 
151
        if contains_linebreaks(path):
 
152
            raise ValueError(path)
 
153
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
 
154
 
 
155
    def _entry_to_line(self, path, ie):
 
156
        """Turn an inventory entry into a testament line"""
 
157
        if contains_whitespace(ie.file_id):
 
158
            raise ValueError(ie.file_id)
 
159
        content = ''
 
160
        content_spacer=''
 
161
        if ie.kind == 'file':
 
162
            # TODO: avoid switching on kind
 
163
            if not ie.text_sha1:
 
164
                raise AssertionError()
 
165
            content = ie.text_sha1
 
166
            content_spacer = ' '
 
167
        elif ie.kind == 'symlink':
 
168
            if not ie.symlink_target:
 
169
                raise AssertionError()
 
170
            content = self._escape_path(ie.symlink_target)
 
171
            content_spacer = ' '
 
172
 
 
173
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
 
174
                                   ie.file_id.decode('utf8'),
 
175
                                   content_spacer, content)
 
176
        return l
 
177
 
 
178
    def as_text(self):
 
179
        return ''.join(self.as_text_lines())
 
180
 
 
181
    def as_short_text(self):
 
182
        """Return short digest-based testament."""
 
183
        return (self.short_header +
 
184
                'revision-id: %s\n'
 
185
                'sha1: %s\n'
 
186
                % (self.revision_id, self.as_sha1()))
 
187
 
 
188
    def _revprops_to_lines(self):
 
189
        """Pack up revision properties."""
 
190
        if not self.revprops:
 
191
            return []
 
192
        r = ['properties:\n']
 
193
        for name, value in sorted(self.revprops.items()):
 
194
            if contains_whitespace(name):
 
195
                raise ValueError(name)
 
196
            r.append('  %s:\n' % name)
 
197
            for line in value.splitlines():
 
198
                r.append(u'    %s\n' % line)
 
199
        return r
 
200
 
 
201
    def as_sha1(self):
 
202
        s = sha()
 
203
        map(s.update, self.as_text_lines())
 
204
        return s.hexdigest()
 
205
 
 
206
 
 
207
class StrictTestament(Testament):
 
208
    """This testament format is for use as a checksum in bundle format 0.8"""
 
209
 
 
210
    long_header = 'bazaar-ng testament version 2.1\n'
 
211
    short_header = 'bazaar-ng testament short form 2.1\n'
 
212
    def _entry_to_line(self, path, ie):
 
213
        l = Testament._entry_to_line(self, path, ie)[:-1]
 
214
        l += ' ' + ie.revision
 
215
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
 
216
        return l
 
217
 
 
218
 
 
219
class StrictTestament3(StrictTestament):
 
220
    """This testament format is for use as a checksum in bundle format 0.9+
 
221
 
 
222
    It differs from StrictTestament by including data about the tree root.
 
223
    """
 
224
 
 
225
    long_header = 'bazaar testament version 3 strict\n'
 
226
    short_header = 'bazaar testament short form 3 strict\n'
 
227
    def _get_entries(self):
 
228
        return self.inventory.iter_entries()
 
229
 
 
230
    def _escape_path(self, path):
 
231
        if contains_linebreaks(path):
 
232
            raise ValueError(path)
 
233
        if path == '':
 
234
            path = '.'
 
235
        return unicode(path.replace('\\', '/').replace(' ', '\ '))