1
# Copyright (C) 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Implementation of Transport that prevents access to locations above a set
20
from urlparse import urlparse
22
from bzrlib import errors, urlutils
23
from bzrlib.transport import (
30
from bzrlib.transport.decorator import TransportDecorator, DecoratorServer
31
from bzrlib.transport.memory import MemoryTransport
34
class ChrootServer(Server):
35
"""User space 'chroot' facility.
37
The server's get_url returns the url for a chroot transport mapped to the
38
backing transport. The url is of the form chroot-xxx:/// so parent
39
directories of the backing transport are not visible. The chroot url will
40
not allow '..' sequences to result in requests to the chroot affecting
41
directories outside the backing transport.
44
def __init__(self, backing_transport):
45
self.backing_transport = backing_transport
47
def _factory(self, url):
48
assert url.startswith(self.scheme)
49
return ChrootTransport(self, url)
55
self.scheme = 'chroot-%d:///' % id(self)
56
register_transport(self.scheme, self._factory)
59
unregister_transport(self.scheme, self._factory)
62
class ChrootTransport(Transport):
65
Please see ChrootServer for details.
68
def __init__(self, server, base):
70
if not base.endswith('/'):
72
Transport.__init__(self, base)
73
self.base_path = self.base[len(self.server.scheme)-1:]
74
self.scheme = self.server.scheme
76
def _call(self, methodname, relpath, *args):
77
method = getattr(self.server.backing_transport, methodname)
78
return method(self._safe_relpath(relpath), *args)
80
def _safe_relpath(self, relpath):
81
safe_relpath = self._combine_paths(self.base_path, relpath)
82
assert safe_relpath.startswith('/')
83
return safe_relpath[1:]
86
def abspath(self, relpath):
87
return self.scheme + self._safe_relpath(relpath)
89
def append_file(self, relpath, f, mode=None):
90
return self._call('append_file', relpath, f, mode)
92
def clone(self, relpath):
93
return ChrootTransport(self.server, self.abspath(relpath))
95
def delete(self, relpath):
96
return self._call('delete', relpath)
98
def delete_tree(self, relpath):
99
return self._call('delete_tree', relpath)
101
def external_url(self):
102
"""See bzrlib.transport.Transport.external_url."""
103
# Chroots, like MemoryTransport depend on in-process
104
# state and thus the base cannot simply be handed out.
105
# See the base class docstring for more details and
106
# possible directions. For now we return the chrooted
108
return self.server.backing_transport.external_url()
110
def get(self, relpath):
111
return self._call('get', relpath)
113
def has(self, relpath):
114
return self._call('has', relpath)
116
def iter_files_recursive(self):
117
backing_transport = self.server.backing_transport.clone(
118
self._safe_relpath('.'))
119
return backing_transport.iter_files_recursive()
122
return self.server.backing_transport.listable()
124
def list_dir(self, relpath):
125
return self._call('list_dir', relpath)
127
def lock_read(self, relpath):
128
return self._call('lock_read', relpath)
130
def lock_write(self, relpath):
131
return self._call('lock_write', relpath)
133
def mkdir(self, relpath, mode=None):
134
return self._call('mkdir', relpath, mode)
136
def put_file(self, relpath, f, mode=None):
137
return self._call('put_file', relpath, f, mode)
139
def rename(self, rel_from, rel_to):
140
return self._call('rename', rel_from, self._safe_relpath(rel_to))
142
def rmdir(self, relpath):
143
return self._call('rmdir', relpath)
145
def stat(self, relpath):
146
return self._call('stat', relpath)
149
class TestingChrootServer(ChrootServer):
152
"""TestingChrootServer is not usable until setUp is called."""
154
def setUp(self, backing_server=None):
155
"""Setup the Chroot on backing_server."""
156
if backing_server is not None:
157
self.backing_transport = get_transport(backing_server.get_url())
159
self.backing_transport = get_transport('.')
160
ChrootServer.setUp(self)
163
def get_test_permutations():
164
"""Return the permutations to be used in testing."""
165
return [(ChrootTransport, TestingChrootServer),
added
removed
bzrlib/transport/chroot.py
