← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/chroot.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-12 16:32:06 UTC
  • mfrom: (5031.2.2 checkouts-help)
  • Revision ID: pqm@pqm.ubuntu.com-20100212163206-uvs9ck67uqw2901y
(Matthew Fuller) Update docs for using 'switch' with a checkout

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/chroot.py
 
1
# Copyright (C) 2006-2009 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
"""Implementation of Transport that prevents access to locations above a set
 
18
root.
 
19
"""
 
20
 
 
21
from bzrlib.transport import (
 
22
    get_transport,
 
23
    pathfilter,
 
24
    register_transport,
 
25
    Server,
 
26
    Transport,
 
27
    unregister_transport,
 
28
    )
 
29
 
 
30
 
 
31
class ChrootServer(pathfilter.PathFilteringServer):
 
32
    """User space 'chroot' facility.
 
33
 
 
34
    The server's get_url returns the url for a chroot transport mapped to the
 
35
    backing transport. The url is of the form chroot-xxx:/// so parent
 
36
    directories of the backing transport are not visible. The chroot url will
 
37
    not allow '..' sequences to result in requests to the chroot affecting
 
38
    directories outside the backing transport.
 
39
 
 
40
    PathFilteringServer does all the path sanitation needed to enforce a
 
41
    chroot, so this is a simple subclass of PathFilteringServer that ignores
 
42
    filter_func.
 
43
    """
 
44
 
 
45
    def __init__(self, backing_transport):
 
46
        pathfilter.PathFilteringServer.__init__(self, backing_transport, None)
 
47
 
 
48
    def _factory(self, url):
 
49
        return ChrootTransport(self, url)
 
50
 
 
51
    def start_server(self):
 
52
        self.scheme = 'chroot-%d:///' % id(self)
 
53
        register_transport(self.scheme, self._factory)
 
54
 
 
55
 
 
56
class ChrootTransport(pathfilter.PathFilteringTransport):
 
57
    """A ChrootTransport.
 
58
 
 
59
    Please see ChrootServer for details.
 
60
    """
 
61
 
 
62
    def _filter(self, relpath):
 
63
        # A simplified version of PathFilteringTransport's _filter that omits
 
64
        # the call to self.server.filter_func.
 
65
        return self._relpath_from_server_root(relpath)
 
66
 
 
67
 
 
68
def get_test_permutations():
 
69
    """Return the permutations to be used in testing."""
 
70
    from bzrlib.tests import test_server
 
71
    return [(ChrootTransport, test_server.TestingChrootServer)]