/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/bzr/testament.py

  • Committer: Vincent Ladeuil
  • Date: 2019-11-19 18:10:28 UTC
  • mfrom: (7290.1.43 work)
  • mto: This revision was merged to the branch mainline in revision 7414.
  • Revision ID: v.ladeuil+brz@free.fr-20191119181028-rgajksejntz3vwil
Merge lp:brz/3.0

Show diffs side-by-side

added added

removed removed

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