← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

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