← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Robert Collins
  • Date: 2005-10-14 02:17:36 UTC
  • mfrom: (1185.16.34)
  • Revision ID: robertc@lifelesslap.robertcollins.net-20051014021736-7230e59066856096
Merge from Martin.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
 
1
# Copyright (C) 2005 by 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 cStringIO import StringIO
 
73
import string
 
74
from sha import sha
 
75
 
 
76
 
 
77
def contains_whitespace(s):
 
78
    """True if there are any whitespace characters in s."""
 
79
    for ch in string.whitespace:
 
80
        if ch in s:
 
81
            return True
 
82
    else:
 
83
        return False
 
84
 
 
85
 
 
86
def contains_linebreaks(s):
 
87
    """True if there is any vertical whitespace in s."""
 
88
    for ch in '\f\n\r':
 
89
        if ch in s:
 
90
            return True
 
91
    else:
 
92
        return False
 
93
 
 
94
    
 
95
class Testament(object):
 
96
    """Reduced summary of a revision.
 
97
 
 
98
    Testaments can be 
 
99
 
 
100
      - produced from a revision
 
101
      - writen to a stream
 
102
      - loaded from a stream
 
103
      - compared to a revision
 
104
    """
 
105
 
 
106
    @classmethod
 
107
    def from_revision(cls, branch, revision_id):
 
108
        """Produce a new testament from a historical revision"""
 
109
        t = cls()
 
110
        rev = branch.get_revision(revision_id)
 
111
        t.revision_id = str(revision_id)
 
112
        t.committer = rev.committer
 
113
        t.timezone = rev.timezone or 0
 
114
        t.timestamp = rev.timestamp
 
115
        t.message = rev.message
 
116
        t.parent_ids = rev.parent_ids[:]
 
117
        t.inventory = branch.get_inventory(revision_id)
 
118
        assert not contains_whitespace(t.revision_id)
 
119
        assert not contains_linebreaks(t.committer)
 
120
        return t
 
121
 
 
122
    def as_text_lines(self):
 
123
        """Yield text form as a sequence of lines.
 
124
 
 
125
        The result is returned in utf-8, because it should be signed or
 
126
        hashed in that encoding.
 
127
        """
 
128
        r = []
 
129
        def a(s):
 
130
            r.append(s)
 
131
        a('bazaar-ng testament version 1\n')
 
132
        a('revision-id: %s\n' % self.revision_id)
 
133
        a('committer: %s\n' % self.committer)
 
134
        a('timestamp: %d\n' % self.timestamp)
 
135
        a('timezone: %d\n' % self.timezone)
 
136
        # inventory length contains the root, which is not shown here
 
137
        a('parents:\n')
 
138
        for parent_id in sorted(self.parent_ids):
 
139
            assert not contains_whitespace(parent_id)
 
140
            a('  %s\n' % parent_id)
 
141
        a('message:\n')
 
142
        for l in self.message.splitlines():
 
143
            a('  %s\n' % l)
 
144
        a('inventory:\n')
 
145
        for path, ie in self.inventory.iter_entries():
 
146
            a(self._entry_to_line(path, ie))
 
147
        if __debug__:
 
148
            for l in r:
 
149
                assert isinstance(l, str), \
 
150
                    '%r of type %s is not a plain string' % (l, type(l))
 
151
        return r
 
152
 
 
153
    def _escape_path(self, path):
 
154
        assert not contains_linebreaks(path)
 
155
        return unicode(path.replace('\\', '/').replace(' ', '\ ')).encode('utf-8')
 
156
 
 
157
    def _entry_to_line(self, path, ie):
 
158
        """Turn an inventory entry into a testament line"""
 
159
        l = '  ' + str(ie.kind)
 
160
        l += ' ' + self._escape_path(path)
 
161
        assert not contains_whitespace(ie.file_id)
 
162
        l += ' ' + unicode(ie.file_id).encode('utf-8')
 
163
        if ie.kind == 'file':
 
164
            # TODO: avoid switching on kind
 
165
            assert ie.text_sha1
 
166
            l += ' ' + ie.text_sha1
 
167
        elif ie.kind == 'symlink':
 
168
            assert ie.symlink_target
 
169
            l += ' ' + self._escape_path(ie.symlink_target)
 
170
        l += '\n'
 
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
        s = sha()
 
179
        map(s.update, self.as_text_lines())
 
180
        return ('bazaar-ng testament short form 1\n'
 
181
                'revision-id: %s\n'
 
182
                'sha1: %s\n'
 
183
                % (self.revision_id, s.hexdigest()))
 
184