1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
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
29
# TODO: Sanitize login name and other fields.
30
# Users must not be called "temp" or "template".
32
# TODO: When creating a new home directory, chown it to its owner
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).
49
import ivle.pulldown_subj
51
def chown_to_webserver(filename):
53
Chowns a file so the web server user owns it.
54
(This is useful in setting up Subversion conf files).
58
os.system("chown -R www-data:www-data %s" % filename)
62
def make_svn_repo(path, throw_on_error=True):
63
"""Create a Subversion repository at the given path.
66
res = os.system("svnadmin create '%s'" % path)
67
if res != 0 and throw_on_error:
68
raise Exception("Cannot create repository: %s" % path)
69
except Exception, exc:
74
chown_to_webserver(path)
76
def rebuild_svn_config(store):
77
"""Build the complete SVN configuration file.
79
users = store.find(ivle.database.User)
83
if role not in groups:
85
groups[role].append(u.login)
86
f = open(ivle.conf.svn_conf + ".new", "w")
87
f.write("# IVLE SVN Repositories Configuration\n")
88
f.write("# Auto-generated on %s\n" % time.asctime())
91
for (g,ls) in groups.iteritems():
92
f.write("%s = %s\n" % (g, ",".join(ls)))
95
f.write("[%s:/]\n" % u.login)
96
f.write("%s = rw\n" % u.login)
97
#f.write("@tutor = r\n")
98
#f.write("@lecturer = rw\n")
99
#f.write("@admin = rw\n")
102
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
103
chown_to_webserver(ivle.conf.svn_conf)
105
def rebuild_svn_group_config(store):
106
"""Build the complete SVN configuration file for groups
109
groups = conn.get_all('project_group',
110
['groupid', 'groupnm', 'projectsetid'])
111
f = open(ivle.conf.svn_group_conf + ".new", "w")
112
f.write("# IVLE SVN Group Repositories Configuration\n")
113
f.write("# Auto-generated on %s\n" % time.asctime())
116
projectsetid = g['projectsetid']
117
offeringinfo = conn.get_offering_info(projectsetid)
118
subj_short_name = offeringinfo['subj_short_name']
119
year = offeringinfo['year']
120
semester = offeringinfo['semester']
121
reponame = "_".join([subj_short_name, year, semester, g['groupnm']])
122
f.write("[%s:/]\n"%reponame)
123
users = conn.get_projectgroup_members(g['groupid'])
125
f.write("%s = rw\n"%u['login'])
128
os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
129
chown_to_webserver(ivle.conf.svn_group_conf)
131
def make_svn_auth(store, login, throw_on_error=True):
132
"""Setup svn authentication for the given user.
133
Uses the given DB store object. Does not commit to the db.
135
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
136
if os.path.exists(ivle.conf.svn_auth_ivle):
141
user = ivle.database.User.get_by_login(store, login)
142
user.svn_pass = unicode(passwd)
144
res = os.system("htpasswd -%smb %s %s %s" % (create,
145
ivle.conf.svn_auth_ivle,
147
if res != 0 and throw_on_error:
148
raise Exception("Unable to create ivle-auth for %s" % login)
150
# Make sure the file is owned by the web server
152
chown_to_webserver(ivle.conf.svn_auth_ivle)
156
def generate_manifest(basedir, targetdir, parent=''):
157
""" From a basedir and a targetdir work out which files are missing or out
158
of date and need to be added/updated and which files are redundant and need
161
parent: This is used for the recursive call to track the relative paths
162
that we have decended.
165
cmp = filecmp.dircmp(basedir, targetdir)
167
# Add all new files and files that have changed
168
to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
170
# Remove files that are redundant
171
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
174
for d in cmp.common_dirs:
175
newbasedir = os.path.join(basedir, d)
176
newtargetdir = os.path.join(targetdir, d)
177
newparent = os.path.join(parent, d)
178
(sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
182
return (to_add, to_remove)
185
def make_jail(user, force=True):
186
"""Creates a new user's jail space, in the jail directory as configured in
189
This only creates things within /home - everything else is expected to be
190
part of another UnionFS branch.
192
Returns the path to the user's home directory.
194
Chowns the user's directory within the jail to the given UID.
196
force: If false, exception if jail already exists for this user.
197
If true (default), overwrites it, but preserves home directory.
199
# MUST run as root or some of this may fail
201
raise Exception("Must run make_jail as root")
203
# tempdir is for putting backup homes in
204
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
205
if not os.path.exists(tempdir):
207
elif not os.path.isdir(tempdir):
210
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
211
homedir = os.path.join(userdir, 'home')
212
userhomedir = os.path.join(homedir, user.login) # Return value
214
if os.path.exists(userdir):
216
raise Exception("User's jail already exists")
217
# User jail already exists. Blow it away but preserve their home
218
# directory. It should be all that is there anyway, but you never
220
# Ignore warnings about the use of tmpnam
221
warnings.simplefilter('ignore')
222
homebackup = os.tempnam(tempdir)
223
warnings.resetwarnings()
224
# Note: shutil.move does not behave like "mv" - it does not put a file
225
# into a directory if it already exists, just fails. Therefore it is
226
# not susceptible to tmpnam symlink attack.
227
shutil.move(homedir, homebackup)
228
shutil.rmtree(userdir)
230
shutil.move(homebackup, homedir)
231
# Change the ownership of all the files to the right unixid
232
logging.debug("chown %s's home directory files to uid %d"
233
%(user.login, user.unixid))
234
os.chown(userhomedir, user.unixid, user.unixid)
235
for root, dirs, files in os.walk(userhomedir):
236
for fsobj in dirs + files:
237
os.chown(os.path.join(root, fsobj), user.unixid, user.unixid)
239
# No user jail exists
240
# Set up the user's home directory
241
os.makedirs(userhomedir)
242
# Chown (and set the GID to the same as the UID).
243
os.chown(userhomedir, user.unixid, user.unixid)
244
# Chmod to rwxr-xr-x (755)
245
os.chmod(userhomedir, 0755)
247
make_conf_py(user.login, userdir, ivle.conf.jail_system, user.svn_pass)
248
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
252
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass):
254
Creates (overwriting any existing file, and creating directories) a
255
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
257
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
258
staging_dir: The dir with the staging copy of the jail. (With the
259
template conf.py file).
260
svn_pass: As with make_jail. User's SVN password, but if not supplied,
261
will look up in the DB.
263
template_conf_path = os.path.join(staging_dir,
264
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
265
conf_path = os.path.join(user_jail_dir,
266
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
267
os.makedirs(os.path.dirname(conf_path))
269
# Read the contents of the template conf file
271
template_conf_file = open(template_conf_path, "r")
272
template_conf_data = template_conf_file.read()
273
template_conf_file.close()
275
# Couldn't open template conf.py for some reason
276
# Just treat it as empty file
277
template_conf_data = ("# Warning: Problem building config script.\n"
278
"# Could not find template conf.py file.\n")
280
conf_file = open(conf_path, "w")
281
conf_file.write(template_conf_data)
282
conf_file.write("\n# The login name for the owner of the jail\n")
283
conf_file.write("login = %s\n" % repr(username))
284
conf_file.write("\n")
285
conf_file.write("# The subversion-only password for the owner of "
287
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
290
# Make this file world-readable
291
# (chmod 644 conf_path)
292
os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
295
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
297
Creates /etc/passwd in the given user's jail. This will be identical to
298
that in the template jail, except for the added entry for this user.
300
template_passwd_path = os.path.join(template_dir, "etc/passwd")
301
passwd_path = os.path.join(user_jail_dir, "etc/passwd")
302
passwd_dir = os.path.dirname(passwd_path)
303
if not os.path.exists(passwd_dir):
304
os.makedirs(passwd_dir)
305
shutil.copy(template_passwd_path, passwd_path)
306
passwd_file = open(passwd_path, 'a')
307
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
308
% (username, unixid, unixid, username))
311
def make_user_db(throw_on_error = True, **kwargs):
312
"""Creates a user's entry in the database, filling in all the fields.
313
All arguments must be keyword args. They are the fields in the table.
314
However, instead of supplying a "passhash", you must supply a
315
"password" argument, which will be hashed internally.
316
Also do not supply a state. All users are created in the "no_agreement"
318
Also pulls the user's subjects using the configured subject pulldown
319
module, and adds enrolments to the DB.
320
Throws an exception if the user already exists.
322
dbconn = ivle.db.DB()
323
dbconn.create_user(**kwargs)
326
# Pulldown subjects and add enrolments
327
ivle.pulldown_subj.enrol_user(kwargs['login'])
329
def mount_jail(login):
330
# This is where we'll mount to...
331
destdir = os.path.join(ivle.conf.jail_base, login)
332
# ... and this is where we'll get the user bits.
333
srcdir = os.path.join(ivle.conf.jail_src_base, login)
335
if not os.path.exists(destdir):
337
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
338
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
339
logging.info("mounted user %s's jail." % login)
341
logging.error("failed to mount user %s's jail!" % login)
342
except Exception, message:
343
logging.warning(str(message))
added
removed
ivle/makeuser.py
