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).
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():
77
"""Build the complete SVN configuration file.
80
users = conn.get_users()
84
if role not in groups:
86
groups[role].append(u.login)
87
f = open(conf.svn_conf + ".new", "w")
88
f.write("# IVLE SVN Repositories Configuration\n")
89
f.write("# Auto-generated on %s\n" % time.asctime())
92
for (g,ls) in groups.iteritems():
93
f.write("%s = %s\n" % (g, ",".join(ls)))
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")
103
os.rename(conf.svn_conf + ".new", conf.svn_conf)
104
chown_to_webserver(conf.svn_conf)
106
def rebuild_svn_group_config():
107
"""Build the complete SVN configuration file for groups
110
groups = conn.get_all('project_group',
111
['groupid', 'groupnm', 'projectsetid'])
112
f = open(conf.svn_group_conf + ".new", "w")
113
f.write("# IVLE SVN Group Repositories Configuration\n")
114
f.write("# Auto-generated on %s\n" % time.asctime())
117
projectsetid = g['projectsetid']
118
offeringinfo = conn.get_offering_info(projectsetid)
119
subj_short_name = offeringinfo['subj_short_name']
120
year = offeringinfo['year']
121
semester = offeringinfo['semester']
122
reponame = "_".join([subj_short_name, year, semester, g['groupnm']])
123
f.write("[%s:/]\n"%reponame)
124
users = conn.get_projectgroup_members(g['groupid'])
126
f.write("%s = rw\n"%u['login'])
129
os.rename(conf.svn_group_conf + ".new", conf.svn_group_conf)
130
chown_to_webserver(conf.svn_group_conf)
132
def make_svn_auth(login, throw_on_error=True):
133
"""Setup svn authentication for the given user.
134
FIXME: create local.auth entry
136
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
137
if os.path.exists(conf.svn_auth_ivle):
142
db.DB().update_user(login, svn_pass=passwd)
144
res = os.system("htpasswd -%smb %s %s %s" % (create,
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(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(username, uid, force=True, svn_pass=None):
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
Note: This takes separate username and uid arguments. The UID need not
197
*necessarily* correspond to a Unix username at all, if all you are
198
planning to do is setuid to it. This allows the caller the freedom of
199
deciding the binding between username and uid, if any.
201
force: If false, exception if jail already exists for this user.
202
If true (default), overwrites it, but preserves home directory.
204
svn_pass: If provided this will be a string, the randomly-generated
205
Subversion password for this user (if you happen to already have it).
206
If not provided, it will be read from the database.
208
# MUST run as root or some of this may fail
210
raise Exception("Must run make_jail as root")
212
# tempdir is for putting backup homes in
213
tempdir = os.path.join(conf.jail_base, '__temp__')
214
if not os.path.exists(tempdir):
216
elif not os.path.isdir(tempdir):
219
userdir = os.path.join(conf.jail_src_base, username)
220
homedir = os.path.join(userdir, 'home')
221
userhomedir = os.path.join(homedir, username) # Return value
223
if os.path.exists(userdir):
225
raise Exception("User's jail already exists")
226
# User jail already exists. Blow it away but preserve their home
227
# directory. It should be all that is there anyway, but you never
229
# Ignore warnings about the use of tmpnam
230
warnings.simplefilter('ignore')
231
homebackup = os.tempnam(tempdir)
232
warnings.resetwarnings()
233
# Note: shutil.move does not behave like "mv" - it does not put a file
234
# into a directory if it already exists, just fails. Therefore it is
235
# not susceptible to tmpnam symlink attack.
236
shutil.move(homedir, homebackup)
237
shutil.rmtree(userdir)
239
shutil.move(homebackup, homedir)
240
# Change the ownership of all the files to the right unixid
241
logging.debug("chown %s's home directory files to uid %d"
243
os.chown(userhomedir, uid, uid)
244
for root, dirs, files in os.walk(userhomedir):
245
for fsobj in dirs + files:
246
os.chown(os.path.join(root, fsobj), uid, uid)
248
# No user jail exists
249
# Set up the user's home directory
250
os.makedirs(userhomedir)
251
# Chown (and set the GID to the same as the UID).
252
os.chown(userhomedir, uid, uid)
253
# Chmod to rwxr-xr-x (755)
254
os.chmod(userhomedir, 0755)
256
# There are 2 special files which need to be generated specific to this
257
# user: /opt/ivle/lib/conf/conf.py and /etc/passwd.
258
# "__" username "__" users are exempt (special)
259
if not (username.startswith("__") and username.endswith("__")):
260
make_conf_py(username, userdir, conf.jail_system, svn_pass)
261
make_etc_passwd(username, userdir, conf.jail_system, uid)
265
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass=None):
267
Creates (overwriting any existing file, and creating directories) a
268
file /opt/ivle/lib/conf/conf.py in a given user's jail.
270
user_jail_dir: User's jail dir, ie. conf.jail_base + username
271
staging_dir: The dir with the staging copy of the jail. (With the
272
template conf.py file).
273
svn_pass: As with make_jail. User's SVN password, but if not supplied,
274
will look up in the DB.
276
template_conf_path = os.path.join(staging_dir,"opt/ivle/lib/conf/conf.py")
277
conf_path = os.path.join(user_jail_dir, "opt/ivle/lib/conf/conf.py")
278
os.makedirs(os.path.dirname(conf_path))
280
# If svn_pass isn't supplied, grab it from the DB
283
svn_pass = dbconn.get_user(username).svn_pass
286
# Read the contents of the template conf file
288
template_conf_file = open(template_conf_path, "r")
289
template_conf_data = template_conf_file.read()
290
template_conf_file.close()
292
# Couldn't open template conf.py for some reason
293
# Just treat it as empty file
294
template_conf_data = ("# Warning: Problem building config script.\n"
295
"# Could not find template conf.py file.\n")
297
conf_file = open(conf_path, "w")
298
conf_file.write(template_conf_data)
299
conf_file.write("\n# The login name for the owner of the jail\n")
300
conf_file.write("login = %s\n" % repr(username))
301
conf_file.write("\n")
302
conf_file.write("# The subversion-only password for the owner of "
304
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
307
# Make this file world-readable
308
# (chmod 644 conf_path)
309
os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
312
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
314
Creates /etc/passwd in the given user's jail. This will be identical to
315
that in the template jail, except for the added entry for this user.
317
template_passwd_path = os.path.join(template_dir, "etc/passwd")
318
passwd_path = os.path.join(user_jail_dir, "etc/passwd")
319
passwd_dir = os.path.dirname(passwd_path)
320
if not os.path.exists(passwd_dir):
321
os.makedirs(passwd_dir)
322
shutil.copy(template_passwd_path, passwd_path)
323
passwd_file = open(passwd_path, 'a')
324
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
325
% (username, unixid, unixid, username))
328
def linktree(src, dst):
329
"""Recursively hard-link a directory tree using os.link().
331
The destination directory must not already exist.
332
If exception(s) occur, an Error is raised with a list of reasons.
334
Symlinks are preserved (in fact, hard links are created which point to the
337
Code heavily based upon shutil.copytree from Python 2.5 library.
339
names = os.listdir(src)
343
srcname = os.path.join(src, name)
344
dstname = os.path.join(dst, name)
346
if os.path.isdir(srcname):
347
linktree(srcname, dstname)
349
os.link(srcname, dstname)
350
# XXX What about devices, sockets etc.?
351
except (IOError, os.error), why:
352
errors.append((srcname, dstname, str(why)))
353
# catch the Error from the recursive copytree so that we can
354
# continue with other files
355
except Exception, err:
356
errors.append(err.args[0])
358
shutil.copystat(src, dst)
360
# can't copy file access times on Windows
363
errors.extend((src, dst, str(why)))
365
raise Exception, errors
367
def make_user_db(throw_on_error = True, **kwargs):
368
"""Creates a user's entry in the database, filling in all the fields.
369
All arguments must be keyword args. They are the fields in the table.
370
However, instead of supplying a "passhash", you must supply a
371
"password" argument, which will be hashed internally.
372
Also do not supply a state. All users are created in the "no_agreement"
374
Also pulls the user's subjects using the configured subject pulldown
375
module, and adds enrolments to the DB.
376
Throws an exception if the user already exists.
379
dbconn.create_user(**kwargs)
382
if kwargs['password']:
383
if os.path.exists(conf.svn_auth_local):
387
res = os.system("htpasswd -%smb %s %s %s" % (create,
391
if res != 0 and throw_on_error:
392
raise Exception("Unable to create local-auth for %s" % kwargs['login'])
394
# Make sure the file is owned by the web server
396
chown_to_webserver(conf.svn_auth_local)
398
# Pulldown subjects and add enrolments
399
pulldown_subj.enrol_user(kwargs['login'])
401
def mount_jail(login):
402
# This is where we'll mount to...
403
destdir = os.path.join(conf.jail_base, login)
404
# ... and this is where we'll get the user bits.
405
srcdir = os.path.join(conf.jail_src_base, login)
407
if not os.path.exists(destdir):
409
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
410
% (srcdir, conf.jail_system, destdir)) == 0:
411
logging.info("mounted user %s's jail." % login)
413
logging.error("failed to mount user %s's jail!" % login)
414
except Exception, message:
415
logging.warning(str(message))
added
removed
lib/common/makeuser.py
