1
# Copyright (C) 2005 Canonical Ltd
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.
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.
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
17
"""Testament - a summary of a revision for signing.
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.
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.
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
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.
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.
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.
48
The signature can be applied to either the full testament or to just a
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)
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.
67
# TODO: perhaps write timestamp in a more readable form
69
# TODO: Perhaps these should just be different formats in which inventories/
70
# revisions can be serialized.
74
from bzrlib.osutils import (
79
from bzrlib.tree import Tree
82
class Testament(object):
83
"""Reduced summary of a revision.
87
- produced from a revision
89
- loaded from a stream
90
- compared to a revision
93
long_header = 'bazaar-ng testament version 1\n'
94
short_header = 'bazaar-ng testament short form 1\n'
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)
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)
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.")
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)
128
def as_text_lines(self):
129
"""Yield text form as a sequence of lines.
131
The result is returned in utf-8, because it should be signed or
132
hashed in that encoding.
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
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)
148
for l in self.message.splitlines():
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]
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))
160
def _escape_path(self, path):
161
if contains_linebreaks(path):
162
raise ValueError(path)
163
return unicode(path.replace('\\', '/').replace(' ', '\ '))
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)
171
if ie.kind == 'file':
172
# TODO: avoid switching on kind
174
raise AssertionError()
175
content = ie.text_sha1
177
elif ie.kind == 'symlink':
178
if not ie.symlink_target:
179
raise AssertionError()
180
content = self._escape_path(ie.symlink_target)
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)
189
return ''.join(self.as_text_lines())
191
def as_short_text(self):
192
"""Return short digest-based testament."""
193
return (self.short_header +
196
% (self.revision_id, self.as_sha1()))
198
def _revprops_to_lines(self):
199
"""Pack up revision properties."""
200
if not self.revprops:
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)
212
return sha_strings(self.as_text_lines())
215
class StrictTestament(Testament):
216
"""This testament format is for use as a checksum in bundle format 0.8"""
218
long_header = 'bazaar-ng testament version 2.1\n'
219
short_header = 'bazaar-ng testament short form 2.1\n'
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]
228
class StrictTestament3(StrictTestament):
229
"""This testament format is for use as a checksum in bundle format 0.9+
231
It differs from StrictTestament by including data about the tree root.
234
long_header = 'bazaar testament version 3 strict\n'
235
short_header = 'bazaar testament short form 3 strict\n'
238
def _escape_path(self, path):
239
if contains_linebreaks(path):
240
raise ValueError(path)
243
return unicode(path.replace('\\', '/').replace(' ', '\ '))
added
removed
bzrlib/testament.py
