← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to bin/ivle-buildjail

  • Committer: David Coles
  • Date: 2009-12-10 01:18:36 UTC
  • Revision ID: coles.david@gmail.com-20091210011836-6kk2omcmr9hvphj0
Correct documentation's system diagram (console communication goes via Application Slaves)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bin/ivle-buildjail
 
1
#!/usr/bin/python
 
2
# IVLE - Informatics Virtual Learning Environment
 
3
# Copyright (C) 2009 The University of Melbourne
 
4
#
 
5
# This program is free software; you can redistribute it and/or modify
 
6
# it under the terms of the GNU General Public License as published by
 
7
# the Free Software Foundation; either version 2 of the License, or
 
8
# (at your option) any later version.
 
9
#
 
10
# This program is distributed in the hope that it will be useful,
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
# GNU General Public License for more details.
 
14
#
 
15
# You should have received a copy of the GNU General Public License
 
16
# along with this program; if not, write to the Free Software
 
17
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 
 
19
import optparse
 
20
import os
 
21
import stat
 
22
import sys
 
23
import shutil
 
24
 
 
25
import ivle.config
 
26
import ivle.jailbuilder.debian
 
27
 
 
28
class UnsafeJail(Exception):
 
29
    pass
 
30
 
 
31
usage = """usage: %prog [options]
 
32
(requires root)
 
33
Builds or updates the base IVLE jail."""
 
34
 
 
35
# Requires root
 
36
if os.getuid() != 0:
 
37
    print >> sys.stderr, "This script requires root privlages to run"
 
38
    sys.exit(1)
 
39
 
 
40
conf = ivle.config.Config()
 
41
build_path = conf['paths']['jails']['template_build']
 
42
 
 
43
# Parse arguments
 
44
parser = optparse.OptionParser(usage)
 
45
parser.add_option("-r", "--recreate",
 
46
    action="store_true", dest="recreate",
 
47
    help='''Completely recreate the jail - don't just update its IVLE code.
 
48
Be warned, this may download hundreds of megabytes!''')
 
49
parser.add_option("-u", "--upgrade",
 
50
    action="store_true", dest="upgrade",
 
51
    help='''Apply any package updates in the jail.''')
 
52
parser.add_option("-m", "--mirror",
 
53
    action="store", dest="apt_mirror",
 
54
    help="Sets the apt mirror.", default=conf['jail']['mirror'])
 
55
parser.add_option("--python-site-packages",
 
56
    action="store", dest="python_site_packages",
 
57
    help="Path to Python site packages directory inside the jail.",
 
58
    default=None)
 
59
(options, args) = parser.parse_args(sys.argv)
 
60
 
 
61
if os.geteuid() != 0:
 
62
    print >> sys.stderr, "Must be root to run buildjail."
 
63
    sys.exit(1)
 
64
 
 
65
if not options.recreate and not os.path.exists(build_path):
 
66
    print >> sys.stderr, "No jail exists -- please rerun with -r."
 
67
    sys.exit(1)
 
68
 
 
69
if (options.python_site_packages is not None and
 
70
    options.python_site_packages[:1] not in (os.path.sep, os.path.altsep)):
 
71
    print >> sys.stderr, "python-site-packages must be an absolute path."
 
72
    sys.exit(1)
 
73
 
 
74
if options.recreate:
 
75
    options.upgrade = True
 
76
 
 
77
    # Create the jail and its subdirectories
 
78
    # Note: Other subdirs will be made by copying files
 
79
    if options.apt_mirror is not None:
 
80
        os.environ['MIRROR'] = options.apt_mirror
 
81
 
 
82
    os.system('rm -rf --one-file-system ' + build_path)
 
83
    ivle.jailbuilder.debian.debootstrap_create_jail(conf['jail']['suite'],
 
84
              build_path, mirror=options.apt_mirror)
 
85
 
 
86
    ivle.jailbuilder.debian.apt_update_cache(build_path)
 
87
    ivle.jailbuilder.debian.apt_install(build_path,
 
88
                        ['python2.5', 'python-cjson', 'python-svn'])
 
89
 
 
90
    ivle.jailbuilder.debian.apt_clean(build_path)
 
91
 
 
92
if options.upgrade:
 
93
    # Run apt-get update, apt-get upgrade and apt-get clean.
 
94
    ivle.jailbuilder.debian.mangle_sources_list(build_path, clobber=True)
 
95
    ivle.jailbuilder.debian.mangle_sources_list(build_path, lines=[
 
96
            'deb %s %s%s %s' % (options.apt_mirror, conf['jail']['suite'],
 
97
                                pocket, ' '.join(['main', 'universe']))
 
98
            for pocket in ('', '-updates', '-security')])
 
99
 
 
100
    # Add any extra site apt sources.
 
101
    if conf['jail']['extra_sources']:
 
102
        ivle.jailbuilder.debian.mangle_sources_list(build_path,
 
103
                  conf['jail']['extra_sources'])
 
104
 
 
105
    # Add any extra site apt keys.
 
106
    if conf['jail']['extra_keys']:
 
107
        ivle.jailbuilder.debian.apt_add_key(build_path,
 
108
                                            conf['jail']['extra_keys'])
 
109
 
 
110
    ivle.jailbuilder.debian.apt_update_cache(build_path)
 
111
    ivle.jailbuilder.debian.apt_upgrade(build_path)
 
112
 
 
113
    # Install any extra site packages.
 
114
    if conf['jail']['extra_packages']:
 
115
        ivle.jailbuilder.debian.apt_install(build_path,
 
116
                  conf['jail']['extra_packages'])
 
117
 
 
118
    ivle.jailbuilder.debian.apt_clean(build_path)
 
119
 
 
120
if conf['jail']['devmode']:
 
121
    # Copy all console and operating system files into the jail
 
122
    services_path = os.path.join(conf['paths']['share'], 'services')
 
123
    jail_services_path = os.path.join(build_path, services_path[1:])
 
124
    if os.path.exists(jail_services_path):
 
125
        shutil.rmtree(jail_services_path)
 
126
    shutil.copytree(services_path, jail_services_path)
 
127
 
 
128
    # Also copy the IVLE lib directory into the jail
 
129
    # This is necessary for running certain services
 
130
 
 
131
    # ivle_site_packages is the IVLE install location outside the jail
 
132
    ivle_site_packages = os.path.dirname(ivle.__file__)
 
133
 
 
134
    if options.python_site_packages is None:
 
135
        # Get the site packages from the IVLE install location *OUTSIDE* the
 
136
        # jail. Warning! This only works if you have the same Python site
 
137
        # packages directory inside and out (ie. same Python version).
 
138
        # If not, you should use --python-site-packages.
 
139
        jail_site_packages = os.path.join(build_path, ivle_site_packages[1:])
 
140
    else:
 
141
        # User-specified site packages
 
142
        jail_site_packages = os.path.join(build_path,
 
143
                                options.python_site_packages[1:], "ivle")
 
144
    if os.path.exists(jail_site_packages):
 
145
        shutil.rmtree(jail_site_packages)
 
146
    shutil.copytree(ivle_site_packages, jail_site_packages)
 
147
 
 
148
# Make /tmp and /var/lock un-world-writable. /tmp will be mounted over,
 
149
# and /var/{lock,tmp} should die.
 
150
for path in ('tmp', 'var/lock', 'var/tmp'):
 
151
    path = os.path.join(build_path, path)
 
152
    os.chmod(path, os.stat(path).st_mode & ~stat.S_IWOTH)
 
153
 
 
154
# Verify that nothing in the jail is world-writable.
 
155
# We don't want students to write into places that others can see.
 
156
try:
 
157
    for path, dirs, files in os.walk(build_path):
 
158
        for dname in dirs:
 
159
            d = os.path.join(path, dname)
 
160
            if os.path.islink(d):
 
161
                continue
 
162
            if os.stat(d).st_mode & stat.S_IWOTH:
 
163
                raise UnsafeJail(d)
 
164
 
 
165
        for fname in files:
 
166
            f = os.path.join(path, fname)
 
167
            if os.path.islink(f):
 
168
                continue
 
169
            if os.stat(f).st_mode & stat.S_IWOTH:
 
170
                if (os.path.dirname(f) == os.path.join(build_path, 'dev') and
 
171
                    os.path.basename(f) in ('ptmx', 'null', 'tty', 'full', 'zero',
 
172
                                            'random', 'urandom')
 
173
                    ):
 
174
                    continue
 
175
                raise UnsafeJail(f)
 
176
except UnsafeJail, e:
 
177
    print >> sys.stderr,"""Error: Jail contains world writable path: '%s'.
 
178
This is a security vulnerability as jail template contents are shared between 
 
179
users. Please either make this path world unwriteable or remove it from the 
 
180
jail."""%str(e)
 
181
    sys.exit(1)
 
182
 
 
183
# Copy jail template build to actual jail template
 
184
template_path = conf['paths']['jails']['template']
 
185
if os.spawnvp(os.P_WAIT, 'rsync', ['rsync', '-a', '--delete',
 
186
              build_path + '/', template_path]) != 0:
 
187
    print >> sys.stderr, "Jail copying failed."
 
188
    sys.exit(1)
 
189
 
 
190
# Now mangle things a bit, so we can bind-mount the user bits in.
 
191
# /etc/passwd and /etc/ivle/ivle.conf need to be symlinks to somewhere in /home
 
192
 
 
193
os.rename(os.path.join(template_path, 'etc/passwd'),
 
194
          os.path.join(template_path, 'home/.passwd')
 
195
          )
 
196
os.symlink('../home/.passwd', os.path.join(template_path, 'etc/passwd'))
 
197
 
 
198
os.makedirs(os.path.join(template_path, "etc/ivle"))
 
199
os.symlink('../../home/.ivle.conf',
 
200
           os.path.join(template_path, "etc/ivle/ivle.conf"))