/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 bzrlib/transport/chroot.py

  • Committer: Robert Collins
  • Date: 2007-03-28 03:02:32 UTC
  • mto: (2018.5.110 hpss)
  • mto: This revision was merged to the branch mainline in revision 2381.
  • Revision ID: robertc@robertcollins.net-20070328030232-uunyt91y60b584j9
Rewritten chroot transport that prevents accidental chroot escapes when
using urlutils against the transport's url.
(Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
"""Implementation of Transport that prevents access to locations above a set
18
18
root.
19
19
"""
 
20
from urlparse import urlparse
20
21
 
21
22
from bzrlib import errors, urlutils
 
23
from bzrlib.transport import (
 
24
    get_transport,
 
25
    register_transport,
 
26
    Server,
 
27
    Transport,
 
28
    unregister_transport,
 
29
    )
22
30
from bzrlib.transport.decorator import TransportDecorator, DecoratorServer
23
 
 
24
 
 
25
 
class ChrootTransportDecorator(TransportDecorator):
26
 
    """A decorator that can convert any transport to be chrooted.
27
 
 
28
 
    This is requested via the 'chrooted+' prefix to get_transport().
29
 
    """
30
 
 
31
 
    def __init__(self, url, _decorated=None, chroot=None):
32
 
        super(ChrootTransportDecorator, self).__init__(url,
33
 
                _decorated=_decorated)
34
 
        if chroot is None:
35
 
            self.chroot_url = self._decorated.base
36
 
        else:
37
 
            self.chroot_url = chroot
38
 
 
39
 
    @classmethod
40
 
    def _get_url_prefix(self):
41
 
        """Chroot transport decorators are invoked via 'chroot+'"""
42
 
        return 'chroot+'
43
 
 
44
 
    def _ensure_relpath_is_child(self, relpath):
45
 
        abspath = self.abspath(relpath)
46
 
        chroot_base = self._get_url_prefix() + self.chroot_url
47
 
        real_relpath = urlutils.relative_url(chroot_base, abspath)
48
 
        if real_relpath == '..' or real_relpath.startswith('../'):
49
 
            raise errors.PathNotChild(relpath, self.chroot_url)
50
 
 
51
 
    # decorated methods
 
31
from bzrlib.transport.memory import MemoryTransport
 
32
 
 
33
 
 
34
class ChrootServer(Server):
 
35
    """Server for chroot transports."""
 
36
 
 
37
    def __init__(self, backing_transport):
 
38
        self.backing_transport = backing_transport
 
39
 
 
40
    def _factory(self, url):
 
41
        assert url.startswith(self.scheme)
 
42
        return ChrootTransport(self, url)
 
43
 
 
44
    def get_url(self):
 
45
        return self.scheme
 
46
 
 
47
    def setUp(self):
 
48
        self.scheme = 'chroot-%d:///' % id(self)
 
49
        register_transport(self.scheme, self._factory)
 
50
 
 
51
    def tearDown(self):
 
52
        unregister_transport(self.scheme, self._factory)
 
53
 
 
54
 
 
55
class ChrootTransport(Transport):
 
56
 
 
57
    def __init__(self, server, base):
 
58
        self.server = server
 
59
        if not base.endswith('/'):
 
60
            base += '/'
 
61
        Transport.__init__(self, base)
 
62
        self.base_path = self.base[len(self.server.scheme)-1:]
 
63
        self.scheme = self.server.scheme
 
64
 
 
65
    def _call(self, methodname, relpath, *args):
 
66
        method = getattr(self.server.backing_transport, methodname)
 
67
        return method(self._safe_relpath(relpath), *args)
 
68
 
 
69
    def _safe_relpath(self, relpath):
 
70
        safe_relpath = self._combine_paths(self.base_path, relpath)
 
71
        assert safe_relpath.startswith('/')
 
72
        return safe_relpath[1:]
 
73
 
 
74
    # Transport methods
 
75
    def abspath(self, relpath):
 
76
        return self.scheme + self._safe_relpath(relpath)
 
77
 
52
78
    def append_file(self, relpath, f, mode=None):
53
 
        self._ensure_relpath_is_child(relpath)
54
 
        return TransportDecorator.append_file(self, relpath, f, mode=mode)
55
 
 
56
 
    def append_bytes(self, relpath, bytes, mode=None):
57
 
        self._ensure_relpath_is_child(relpath)
58
 
        return TransportDecorator.append_bytes(self, relpath, bytes, mode=mode)
59
 
 
60
 
    def clone(self, offset=None):
61
 
        self._ensure_relpath_is_child(offset)
62
 
        return TransportDecorator.clone(self, offset)
 
79
        return self._call('append_file', relpath, f, mode)
 
80
 
 
81
    def clone(self, relpath):
 
82
        return ChrootTransport(self.server, self.abspath(relpath))
63
83
 
64
84
    def delete(self, relpath):
65
 
        self._ensure_relpath_is_child(relpath)
66
 
        return TransportDecorator.delete(self, relpath)
 
85
        return self._call('delete', relpath)
67
86
 
68
87
    def delete_tree(self, relpath):
69
 
        self._ensure_relpath_is_child(relpath)
70
 
        return TransportDecorator.delete_tree(self, relpath)
 
88
        return self._call('delete_tree', relpath)
71
89
 
72
90
    def get(self, relpath):
73
 
        self._ensure_relpath_is_child(relpath)
74
 
        return TransportDecorator.get(self, relpath)
75
 
 
76
 
    def get_bytes(self, relpath):
77
 
        self._ensure_relpath_is_child(relpath)
78
 
        return TransportDecorator.get_bytes(self, relpath)
 
91
        return self._call('get', relpath)
79
92
 
80
93
    def has(self, relpath):
81
 
        self._ensure_relpath_is_child(relpath)
82
 
        return TransportDecorator.has(self, relpath)
 
94
        return self._call('has', relpath)
 
95
 
 
96
    def iter_files_recursive(self):
 
97
        backing_transport = self.server.backing_transport.clone(
 
98
            self._safe_relpath('.'))
 
99
        return backing_transport.iter_files_recursive()
 
100
 
 
101
    def listable(self):
 
102
        return self.server.backing_transport.listable()
83
103
 
84
104
    def list_dir(self, relpath):
85
 
        self._ensure_relpath_is_child(relpath)
86
 
        return TransportDecorator.list_dir(self, relpath)
 
105
        return self._call('list_dir', relpath)
87
106
 
88
107
    def lock_read(self, relpath):
89
 
        self._ensure_relpath_is_child(relpath)
90
 
        return TransportDecorator.lock_read(self, relpath)
 
108
        return self._call('lock_read', relpath)
91
109
 
92
110
    def lock_write(self, relpath):
93
 
        self._ensure_relpath_is_child(relpath)
94
 
        return TransportDecorator.lock_write(self, relpath)
 
111
        return self._call('lock_write', relpath)
95
112
 
96
113
    def mkdir(self, relpath, mode=None):
97
 
        self._ensure_relpath_is_child(relpath)
98
 
        return TransportDecorator.mkdir(self, relpath, mode=mode)
99
 
 
100
 
    def put_bytes(self, relpath, bytes, mode=None):
101
 
        self._ensure_relpath_is_child(relpath)
102
 
        return TransportDecorator.put_bytes(self, relpath, bytes, mode=mode)
 
114
        return self._call('mkdir', relpath, mode)
103
115
 
104
116
    def put_file(self, relpath, f, mode=None):
105
 
        self._ensure_relpath_is_child(relpath)
106
 
        return TransportDecorator.put_file(self, relpath, f, mode=mode)
 
117
        return self._call('put_file', relpath, f, mode)
107
118
 
108
119
    def rename(self, rel_from, rel_to):
109
 
        self._ensure_relpath_is_child(rel_from)
110
 
        self._ensure_relpath_is_child(rel_to)
111
 
        return TransportDecorator.rename(self, rel_from, rel_to)
 
120
        return self._call('rename', rel_from, self._safe_relpath(rel_to))
112
121
 
113
122
    def rmdir(self, relpath):
114
 
        self._ensure_relpath_is_child(relpath)
115
 
        return TransportDecorator.rmdir(self, relpath)
 
123
        return self._call('rmdir', relpath)
116
124
 
117
125
    def stat(self, relpath):
118
 
        self._ensure_relpath_is_child(relpath)
119
 
        return TransportDecorator.stat(self, relpath)
120
 
 
121
 
 
122
 
class ChrootServer(DecoratorServer):
123
 
    """Server for the ReadonlyTransportDecorator for testing with."""
124
 
 
125
 
    def get_decorator_class(self):
126
 
        return ChrootTransportDecorator
 
126
        return self._call('stat', relpath)
 
127
 
 
128
 
 
129
class TestingChrootServer(ChrootServer):
 
130
 
 
131
    def __init__(self):
 
132
        ChrootServer.__init__(self, get_transport('.'))
127
133
 
128
134
 
129
135
def get_test_permutations():
130
136
    """Return the permutations to be used in testing."""
131
 
    return [(ChrootTransportDecorator, ChrootServer),
 
137
    return [(ChrootTransport, TestingChrootServer),
132
138
            ]