← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/makeuser.py

  • Committer: Matt Giuca
  • Date: 2009-05-11 04:42:18 UTC
  • Revision ID: matt.giuca@gmail.com-20090511044218-w1ax2v6sxbijxs0k
ivle.marks: No longer loads all of the plugins via config.Config.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/makeuser.py
1
1
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
2
# Copyright (C) 2007-2009 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
17
 
18
 
# Module: MakeUser
19
 
# Author: Matt Giuca
20
 
# Date:   1/2/2008
21
 
 
22
 
# Allows creation of users. This sets up the following:
23
 
# * User's jail and home directory within the jail.
24
 
# * Subversion repository (TODO)
25
 
# * Check out Subversion workspace into jail (TODO)
26
 
# * Database details for user
27
 
# * Unix user account
28
 
 
29
 
# TODO: Sanitize login name and other fields.
30
 
# Users must not be called "temp" or "template".
31
 
 
32
 
# TODO: When creating a new home directory, chown it to its owner
33
 
 
34
 
# TODO: In chown_to_webserver:
35
 
# Do not call os.system("chown www-data") - use Python lib
36
 
# and use the web server uid given in conf. (Several places).
37
 
 
38
 
import md5
 
18
"""User and group filesystem management helpers."""
 
19
 
 
20
import hashlib
39
21
import os
40
22
import stat
41
23
import shutil
42
24
import time
43
25
import uuid
44
26
import warnings
45
 
import filecmp
46
27
import logging
47
 
import ivle.conf
48
 
import ivle.pulldown_subj
 
28
import subprocess
49
29
 
50
 
from ivle.database import ProjectGroup
 
30
import ivle.config
 
31
from ivle.database import ProjectGroup, User
51
32
 
52
33
def chown_to_webserver(filename):
53
 
    """
54
 
    Chowns a file so the web server user owns it.
55
 
    (This is useful in setting up Subversion conf files).
 
34
    """chown a directory and its contents to the web server.
 
35
 
 
36
    Recursively chowns a file or directory so the web server user owns it.
56
37
    Assumes root.
57
38
    """
58
 
    try:
59
 
        os.system("chown -R www-data:www-data %s" % filename)
60
 
    except:
61
 
        pass
 
39
    subprocess.call(['chown', '-R', 'www-data:www-data', filename])
62
40
 
63
41
def make_svn_repo(path, throw_on_error=True):
64
 
    """Create a Subversion repository at the given path.
65
 
    """
 
42
    """Create a Subversion repository at the given path."""
66
43
    try:
67
 
        res = os.system("svnadmin create '%s'" % path)
 
44
        res = subprocess.call(['svnadmin', 'create', path])
68
45
        if res != 0 and throw_on_error:
69
46
            raise Exception("Cannot create repository: %s" % path)
70
47
    except Exception, exc:
74
51
 
75
52
    chown_to_webserver(path)
76
53
 
77
 
def rebuild_svn_config(store):
 
54
def rebuild_svn_config(store, config):
78
55
    """Build the complete SVN configuration file.
 
56
 
 
57
    @param config: An ivle.config.Config object.
79
58
    """
80
 
    users = store.find(ivle.database.User)
81
 
    groups = {}
82
 
    for u in users:
83
 
        role = str(u.role)
84
 
        if role not in groups:
85
 
            groups[role] = []
86
 
        groups[role].append(u.login)
87
 
    f = open(ivle.conf.svn_conf + ".new", "w")
88
 
    f.write("# IVLE SVN Repositories Configuration\n")
89
 
    f.write("# Auto-generated on %s\n" % time.asctime())
90
 
    f.write("\n")
91
 
    f.write("[groups]\n")
92
 
    for (g,ls) in groups.iteritems():
93
 
        f.write("%s = %s\n" % (g, ",".join(ls)))
94
 
    f.write("\n")
95
 
    for u in users:
96
 
        f.write("[%s:/]\n" % u.login)
97
 
        f.write("%s = rw\n" % u.login)
98
 
        #f.write("@tutor = r\n")
99
 
        #f.write("@lecturer = rw\n")
100
 
        #f.write("@admin = rw\n")
101
 
        f.write("\n")
 
59
    users = store.find(User)
 
60
    conf_name = config['paths']['svn']['conf']
 
61
    temp_name = conf_name + ".new"
 
62
    f = open(temp_name, "w")
 
63
    f.write("""\
 
64
# IVLE SVN repository authorisation configuration
 
65
# Generated: %(time)s
 
66
""" % {'time': time.asctime()})
 
67
 
 
68
    for u in users:
 
69
        f.write("""
 
70
[%(login)s:/]
 
71
%(login)s = rw
 
72
""" % {'login': u.login})
 
73
 
102
74
    f.close()
103
 
    os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
104
 
    chown_to_webserver(ivle.conf.svn_conf)
 
75
    os.rename(temp_name, conf_name)
 
76
    chown_to_webserver(conf_name)
105
77
 
106
 
def rebuild_svn_group_config(store):
 
78
def rebuild_svn_group_config(store, config):
107
79
    """Build the complete SVN configuration file for groups
 
80
 
 
81
    @param config: An ivle.config.Config object.
108
82
    """
109
 
    f = open(ivle.conf.svn_group_conf + ".new", "w")
110
 
    f.write("# IVLE SVN Group Repositories Configuration\n")
111
 
    f.write("# Auto-generated on %s\n" % time.asctime())
112
 
    f.write("\n")
 
83
    conf_name = config['paths']['svn']['group_conf']
 
84
    temp_name = conf_name + ".new"
 
85
    f = open(temp_name, "w")
 
86
 
 
87
    f.write("""\
 
88
# IVLE SVN group repository authorisation configuration
 
89
# Generated: %(time)s
 
90
 
 
91
""" % {'time': time.asctime()})
 
92
 
113
93
    for group in store.find(ProjectGroup):
114
94
        offering = group.project_set.offering
115
95
        reponame = "_".join([offering.subject.short_name,
116
96
                             offering.semester.year,
117
97
                             offering.semester.semester,
118
98
                             group.name])
119
 
        f.write("[%s:/]\n"%reponame)
 
99
 
 
100
        f.write("[%s:/]\n" % reponame)
120
101
        for user in group.members:
121
102
            f.write("%s = rw\n" % user.login)
122
103
        f.write("\n")
 
104
 
123
105
    f.close()
124
 
    os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
125
 
    chown_to_webserver(ivle.conf.svn_group_conf)
126
 
 
127
 
def make_svn_auth(store, login, throw_on_error=True):
128
 
    """Setup svn authentication for the given user.
129
 
       Uses the given DB store object. Does not commit to the db.
 
106
    os.rename(temp_name, conf_name)
 
107
    chown_to_webserver(conf_name)
 
108
 
 
109
def make_svn_auth(store, login, config, throw_on_error=True):
 
110
    """Create a Subversion password for a user.
 
111
 
 
112
    Generates a new random Subversion password, and assigns it to the user.
 
113
    The password is added to Apache's Subversion authentication file.
130
114
    """
131
 
    passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
132
 
    if os.path.exists(ivle.conf.svn_auth_ivle):
 
115
    # filename is, eg, /var/lib/ivle/svn/ivle.auth
 
116
    filename = config['paths']['svn']['auth_ivle']
 
117
    passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
118
    if os.path.exists(filename):
133
119
        create = ""
134
120
    else:
135
121
        create = "c"
136
122
 
137
 
    user = ivle.database.User.get_by_login(store, login)
 
123
    user = User.get_by_login(store, login)
138
124
    user.svn_pass = unicode(passwd)
139
125
 
140
 
    res = os.system("htpasswd -%smb %s %s %s" % (create,
141
 
                                              ivle.conf.svn_auth_ivle,
142
 
                                              login, passwd))
 
126
    res = subprocess.call(['htpasswd', '-%smb' % create,
 
127
                           filename, login, passwd])
143
128
    if res != 0 and throw_on_error:
144
129
        raise Exception("Unable to create ivle-auth for %s" % login)
145
130
 
146
131
    # Make sure the file is owned by the web server
147
132
    if create == "c":
148
 
        chown_to_webserver(ivle.conf.svn_auth_ivle)
 
133
        chown_to_webserver(filename)
149
134
 
150
135
    return passwd
151
136
 
152
 
def generate_manifest(basedir, targetdir, parent=''):
153
 
    """ From a basedir and a targetdir work out which files are missing or out 
154
 
    of date and need to be added/updated and which files are redundant and need 
155
 
    to be removed.
156
 
    
157
 
    parent: This is used for the recursive call to track the relative paths 
158
 
    that we have decended.
159
 
    """
160
 
    
161
 
    cmp = filecmp.dircmp(basedir, targetdir)
162
 
 
163
 
    # Add all new files and files that have changed
164
 
    to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
165
 
 
166
 
    # Remove files that are redundant
167
 
    to_remove = [os.path.join(parent,x) for x in cmp.right_only]
168
 
    
169
 
    # Recurse
170
 
    for d in cmp.common_dirs:
171
 
        newbasedir = os.path.join(basedir, d)
172
 
        newtargetdir = os.path.join(targetdir, d)
173
 
        newparent = os.path.join(parent, d)
174
 
        (sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
175
 
        to_add += sadd
176
 
        to_remove += sremove
177
 
 
178
 
    return (to_add, to_remove)
179
 
 
180
 
 
181
 
def make_jail(user, force=True):
182
 
    """Creates a new user's jail space, in the jail directory as configured in
183
 
    conf.py.
184
 
 
185
 
    This only creates things within /home - everything else is expected to be
186
 
    part of another UnionFS branch.
 
137
def make_jail(user, config, force=True):
 
138
    """Create or update a user's jail.
 
139
 
 
140
    Only the user-specific parts of the jail are created here - everything
 
141
    else is expected to be part of another aufs branch.
187
142
 
188
143
    Returns the path to the user's home directory.
189
144
 
190
145
    Chowns the user's directory within the jail to the given UID.
191
146
 
192
 
    force: If false, exception if jail already exists for this user.
193
 
    If true (default), overwrites it, but preserves home directory.
 
147
    @param force: If False, raise an exception if the user already has a jail.
 
148
                  If True (default), rebuild the jail preserving /home.
194
149
    """
195
150
    # MUST run as root or some of this may fail
196
151
    if os.getuid() != 0:
197
152
        raise Exception("Must run make_jail as root")
198
153
    
199
154
    # tempdir is for putting backup homes in
200
 
    tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
 
155
    jail_src_base = config['paths']['jails']['src']
 
156
    tempdir = os.path.join(jail_src_base, '__temp__')
201
157
    if not os.path.exists(tempdir):
202
158
        os.makedirs(tempdir)
203
159
    elif not os.path.isdir(tempdir):
204
160
        os.unlink(tempdir)
205
161
        os.mkdir(tempdir)
206
 
    userdir = os.path.join(ivle.conf.jail_src_base, user.login)
 
162
    userdir = os.path.join(jail_src_base, user.login)
207
163
    homedir = os.path.join(userdir, 'home')
208
164
    userhomedir = os.path.join(homedir, user.login)   # Return value
209
165
 
217
173
        warnings.simplefilter('ignore')
218
174
        homebackup = os.tempnam(tempdir)
219
175
        warnings.resetwarnings()
220
 
        # Note: shutil.move does not behave like "mv" - it does not put a file
221
 
        # into a directory if it already exists, just fails. Therefore it is
222
 
        # not susceptible to tmpnam symlink attack.
 
176
        # Back up the /home directory, delete the entire jail, recreate the
 
177
        # jail directory tree, then copy the /home back
 
178
        # NOTE that shutil.move changed in Python 2.6, it now moves a
 
179
        # directory INTO the target (like `mv`), which it didn't use to do.
 
180
        # This code works regardless.
223
181
        shutil.move(homedir, homebackup)
224
182
        shutil.rmtree(userdir)
225
 
        os.makedirs(homedir)
 
183
        os.makedirs(userdir)
226
184
        shutil.move(homebackup, homedir)
227
185
        # Change the ownership of all the files to the right unixid
228
186
        logging.debug("chown %s's home directory files to uid %d"
229
187
            %(user.login, user.unixid))
230
 
        os.chown(userhomedir, user.unixid, user.unixid)
231
 
        for root, dirs, files in os.walk(userhomedir):
232
 
            for fsobj in dirs + files:
233
 
                os.chown(os.path.join(root, fsobj), user.unixid, user.unixid)
 
188
        os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
 
189
                                        user.unixid), userhomedir])
234
190
    else:
235
191
        # No user jail exists
236
192
        # Set up the user's home directory
240
196
        # Chmod to rwxr-xr-x (755)
241
197
        os.chmod(userhomedir, 0755)
242
198
 
243
 
    make_conf_py(user.login, userdir, ivle.conf.jail_system, user.svn_pass)
244
 
    make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
 
199
    make_ivle_conf(user.login, userdir, user.svn_pass, config)
 
200
    make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
 
201
                    user.unixid)
245
202
 
246
203
    return userhomedir
247
204
 
248
 
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass):
249
 
    """
 
205
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
 
206
    """Generate an ivle.conf for a user's jail.
 
207
 
250
208
    Creates (overwriting any existing file, and creating directories) a
251
 
    file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
252
 
    username: Username.
253
 
    user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
254
 
    staging_dir: The dir with the staging copy of the jail. (With the
255
 
        template conf.py file).
256
 
    svn_pass: As with make_jail. User's SVN password, but if not supplied,
257
 
        will look up in the DB.
 
209
    file /etc/ivle/ivle.conf in a given user's jail.
 
210
 
 
211
    @param username: Username.
 
212
    @param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
 
213
    @param svn_pass: User's SVN password.
 
214
    @param sys_config: An ivle.config.Config object (the system-wide config).
258
215
    """
259
 
    template_conf_path = os.path.join(staging_dir,
260
 
            ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
261
 
    conf_path = os.path.join(user_jail_dir,
262
 
            ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
 
216
    conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
263
217
    os.makedirs(os.path.dirname(conf_path))
264
218
 
265
 
    # Read the contents of the template conf file
266
 
    try:
267
 
        template_conf_file = open(template_conf_path, "r")
268
 
        template_conf_data = template_conf_file.read()
269
 
        template_conf_file.close()
270
 
    except:
271
 
        # Couldn't open template conf.py for some reason
272
 
        # Just treat it as empty file
273
 
        template_conf_data = ("# Warning: Problem building config script.\n"
274
 
                              "# Could not find template conf.py file.\n")
275
 
 
276
 
    conf_file = open(conf_path, "w")
277
 
    conf_file.write(template_conf_data)
278
 
    conf_file.write("\n# The login name for the owner of the jail\n")
279
 
    conf_file.write("login = %s\n" % repr(username))
280
 
    conf_file.write("\n")
281
 
    conf_file.write("# The subversion-only password for the owner of "
282
 
        "the jail\n")
283
 
    conf_file.write("svn_pass = %s\n" % repr(svn_pass))
284
 
    conf_file.close()
 
219
    # In the "in-jail" version of conf, we don't need MOST of the details
 
220
    # (it would be a security risk to have them here).
 
221
    # So we just write root_dir.
 
222
    conf_obj = ivle.config.Config(blank=True)
 
223
    conf_obj.filename = conf_path
 
224
    conf_obj['urls']['root'] = sys_config['urls']['root']
 
225
    conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
 
226
    conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
 
227
    conf_obj['user_info']['login'] = username
 
228
    conf_obj['user_info']['svn_pass'] = svn_pass
 
229
    conf_obj.write()
285
230
 
286
231
    # Make this file world-readable
287
232
    # (chmod 644 conf_path)
289
234
                        | stat.S_IROTH)
290
235
 
291
236
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
292
 
    """
 
237
    """Create a passwd file for a user's jail.
 
238
 
293
239
    Creates /etc/passwd in the given user's jail. This will be identical to
294
240
    that in the template jail, except for the added entry for this user.
295
241
    """
303
249
    passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
304
250
                      % (username, unixid, unixid, username))
305
251
    passwd_file.close()
306
 
 
307
 
def mount_jail(login):
308
 
    # This is where we'll mount to...
309
 
    destdir = os.path.join(ivle.conf.jail_base, login)
310
 
    # ... and this is where we'll get the user bits.
311
 
    srcdir = os.path.join(ivle.conf.jail_src_base, login)
312
 
    try:
313
 
        if not os.path.exists(destdir):
314
 
            os.mkdir(destdir)
315
 
        if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
316
 
                     % (srcdir, ivle.conf.jail_system, destdir)) == 0:
317
 
            logging.info("mounted user %s's jail." % login)
318
 
        else:
319
 
            logging.error("failed to mount user %s's jail!" % login)
320
 
    except Exception, message:
321
 
        logging.warning(str(message))