← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-07 07:52:50 UTC
  • mfrom: (3340.1.1 208418-1.4)
  • Revision ID: pqm@pqm.ubuntu.com-20080407075250-phs53xnslo8boaeo
Return the correct knit serialisation method in _StreamAccess.
        (Andrew Bennetts, Martin Pool, Robert Collins)

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
from sha import sha
 
74
 
 
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
 
76
 
 
77
 
 
78
class Testament(object):
 
79
    """Reduced summary of a revision.
 
80
 
 
81
    Testaments can be 
 
82
 
 
83
      - produced from a revision
 
84
      - written to a stream
 
85
      - loaded from a stream
 
86
      - compared to a revision
 
87
    """
 
88
 
 
89
    long_header = 'bazaar-ng testament version 1\n'
 
90
    short_header = 'bazaar-ng testament short form 1\n'
 
91
 
 
92
    @classmethod
 
93
    def from_revision(cls, repository, revision_id):
 
94
        """Produce a new testament from a historical revision"""
 
95
        rev = repository.get_revision(revision_id)
 
96
        inventory = repository.get_inventory(revision_id)
 
97
        return cls(rev, inventory)
 
98
 
 
99
    def __init__(self, rev, inventory):
 
100
        """Create a new testament for rev using inventory."""
 
101
        self.revision_id = rev.revision_id
 
102
        self.committer = rev.committer
 
103
        self.timezone = rev.timezone or 0
 
104
        self.timestamp = rev.timestamp
 
105
        self.message = rev.message
 
106
        self.parent_ids = rev.parent_ids[:]
 
107
        self.inventory = inventory
 
108
        self.revprops = copy(rev.properties)
 
109
        assert not contains_whitespace(self.revision_id)
 
110
        assert not contains_linebreaks(self.committer)
 
111
 
 
112
    def as_text_lines(self):
 
113
        """Yield text form as a sequence of lines.
 
114
 
 
115
        The result is returned in utf-8, because it should be signed or
 
116
        hashed in that encoding.
 
117
        """
 
118
        r = []
 
119
        a = r.append
 
120
        a(self.long_header)
 
121
        a('revision-id: %s\n' % self.revision_id)
 
122
        a('committer: %s\n' % self.committer)
 
123
        a('timestamp: %d\n' % self.timestamp)
 
124
        a('timezone: %d\n' % self.timezone)
 
125
        # inventory length contains the root, which is not shown here
 
126
        a('parents:\n')
 
127
        for parent_id in sorted(self.parent_ids):
 
128
            assert not contains_whitespace(parent_id)
 
129
            a('  %s\n' % parent_id)
 
130
        a('message:\n')
 
131
        for l in self.message.splitlines():
 
132
            a('  %s\n' % l)
 
133
        a('inventory:\n')
 
134
        for path, ie in self._get_entries():
 
135
            a(self._entry_to_line(path, ie))
 
136
        r.extend(self._revprops_to_lines())
 
137
        if __debug__:
 
138
            for l in r:
 
139
                assert isinstance(l, basestring), \
 
140
                    '%r of type %s is not a plain string' % (l, type(l))
 
141
        return [line.encode('utf-8') for line in r]
 
142
 
 
143
    def _get_entries(self):
 
144
        entries = self.inventory.iter_entries()
 
145
        entries.next()
 
146
        return entries
 
147
 
 
148
    def _escape_path(self, path):
 
149
        assert not contains_linebreaks(path)
 
150
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
 
151
 
 
152
    def _entry_to_line(self, path, ie):
 
153
        """Turn an inventory entry into a testament line"""
 
154
        assert not contains_whitespace(ie.file_id)
 
155
 
 
156
        content = ''
 
157
        content_spacer=''
 
158
        if ie.kind == 'file':
 
159
            # TODO: avoid switching on kind
 
160
            assert ie.text_sha1
 
161
            content = ie.text_sha1
 
162
            content_spacer = ' '
 
163
        elif ie.kind == 'symlink':
 
164
            assert ie.symlink_target
 
165
            content = self._escape_path(ie.symlink_target)
 
166
            content_spacer = ' '
 
167
 
 
168
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
 
169
                                   ie.file_id.decode('utf8'),
 
170
                                   content_spacer, content)
 
171
        return l
 
172
 
 
173
    def as_text(self):
 
174
        return ''.join(self.as_text_lines())
 
175
 
 
176
    def as_short_text(self):
 
177
        """Return short digest-based testament."""
 
178
        return (self.short_header + 
 
179
                'revision-id: %s\n'
 
180
                'sha1: %s\n'
 
181
                % (self.revision_id, self.as_sha1()))
 
182
 
 
183
    def _revprops_to_lines(self):
 
184
        """Pack up revision properties."""
 
185
        if not self.revprops:
 
186
            return []
 
187
        r = ['properties:\n']
 
188
        for name, value in sorted(self.revprops.items()):
 
189
            assert isinstance(name, str)
 
190
            assert not contains_whitespace(name)
 
191
            r.append('  %s:\n' % name)
 
192
            for line in value.splitlines():
 
193
                r.append(u'    %s\n' % line)
 
194
        return r
 
195
 
 
196
    def as_sha1(self):
 
197
        s = sha()
 
198
        map(s.update, self.as_text_lines())
 
199
        return s.hexdigest()
 
200
 
 
201
 
 
202
class StrictTestament(Testament):
 
203
    """This testament format is for use as a checksum in bundle format 0.8"""
 
204
 
 
205
    long_header = 'bazaar-ng testament version 2.1\n'
 
206
    short_header = 'bazaar-ng testament short form 2.1\n'
 
207
    def _entry_to_line(self, path, ie):
 
208
        l = Testament._entry_to_line(self, path, ie)[:-1]
 
209
        l += ' ' + ie.revision
 
210
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
 
211
        return l
 
212
 
 
213
 
 
214
class StrictTestament3(StrictTestament):
 
215
    """This testament format is for use as a checksum in bundle format 0.9+
 
216
    
 
217
    It differs from StrictTestament by including data about the tree root.
 
218
    """
 
219
 
 
220
    long_header = 'bazaar testament version 3 strict\n'
 
221
    short_header = 'bazaar testament short form 3 strict\n'
 
222
    def _get_entries(self):
 
223
        return self.inventory.iter_entries()
 
224
 
 
225
    def _escape_path(self, path):
 
226
        assert not contains_linebreaks(path)
 
227
        if path == '':
 
228
            path = '.'
 
229
        return unicode(path.replace('\\', '/').replace(' ', '\ '))