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():
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(ivle.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(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
104
chown_to_webserver(ivle.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(ivle.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(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
130
chown_to_webserver(ivle.conf.svn_group_conf)
132
def make_svn_auth(store, login, throw_on_error=True):
133
"""Setup svn authentication for the given user.
134
Uses the given DB store object. Does not commit to the db.
135
FIXME: create local.auth entry
137
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
138
if os.path.exists(ivle.conf.svn_auth_ivle):
143
user = ivle.database.User.get_by_login(store, login)
144
user.svn_pass = unicode(passwd)
146
res = os.system("htpasswd -%smb %s %s %s" % (create,
147
ivle.conf.svn_auth_ivle,
149
if res != 0 and throw_on_error:
150
raise Exception("Unable to create ivle-auth for %s" % login)
152
# Make sure the file is owned by the web server
154
chown_to_webserver(ivle.conf.svn_auth_ivle)
158
def generate_manifest(basedir, targetdir, parent=''):
159
""" From a basedir and a targetdir work out which files are missing or out
160
of date and need to be added/updated and which files are redundant and need
163
parent: This is used for the recursive call to track the relative paths
164
that we have decended.
167
cmp = filecmp.dircmp(basedir, targetdir)
169
# Add all new files and files that have changed
170
to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
172
# Remove files that are redundant
173
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
176
for d in cmp.common_dirs:
177
newbasedir = os.path.join(basedir, d)
178
newtargetdir = os.path.join(targetdir, d)
179
newparent = os.path.join(parent, d)
180
(sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
184
return (to_add, to_remove)
187
def make_jail(username, uid, force=True, svn_pass=None):
188
"""Creates a new user's jail space, in the jail directory as configured in
191
This only creates things within /home - everything else is expected to be
192
part of another UnionFS branch.
194
Returns the path to the user's home directory.
196
Chowns the user's directory within the jail to the given UID.
198
Note: This takes separate username and uid arguments. The UID need not
199
*necessarily* correspond to a Unix username at all, if all you are
200
planning to do is setuid to it. This allows the caller the freedom of
201
deciding the binding between username and uid, if any.
203
force: If false, exception if jail already exists for this user.
204
If true (default), overwrites it, but preserves home directory.
206
svn_pass: If provided this will be a string, the randomly-generated
207
Subversion password for this user (if you happen to already have it).
208
If not provided, it will be read from the database.
210
# MUST run as root or some of this may fail
212
raise Exception("Must run make_jail as root")
214
# tempdir is for putting backup homes in
215
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
216
if not os.path.exists(tempdir):
218
elif not os.path.isdir(tempdir):
221
userdir = os.path.join(ivle.conf.jail_src_base, username)
222
homedir = os.path.join(userdir, 'home')
223
userhomedir = os.path.join(homedir, username) # Return value
225
if os.path.exists(userdir):
227
raise Exception("User's jail already exists")
228
# User jail already exists. Blow it away but preserve their home
229
# directory. It should be all that is there anyway, but you never
231
# Ignore warnings about the use of tmpnam
232
warnings.simplefilter('ignore')
233
homebackup = os.tempnam(tempdir)
234
warnings.resetwarnings()
235
# Note: shutil.move does not behave like "mv" - it does not put a file
236
# into a directory if it already exists, just fails. Therefore it is
237
# not susceptible to tmpnam symlink attack.
238
shutil.move(homedir, homebackup)
239
shutil.rmtree(userdir)
241
shutil.move(homebackup, homedir)
242
# Change the ownership of all the files to the right unixid
243
logging.debug("chown %s's home directory files to uid %d"
245
os.chown(userhomedir, uid, uid)
246
for root, dirs, files in os.walk(userhomedir):
247
for fsobj in dirs + files:
248
os.chown(os.path.join(root, fsobj), uid, uid)
250
# No user jail exists
251
# Set up the user's home directory
252
os.makedirs(userhomedir)
253
# Chown (and set the GID to the same as the UID).
254
os.chown(userhomedir, uid, uid)
255
# Chmod to rwxr-xr-x (755)
256
os.chmod(userhomedir, 0755)
258
# There are 2 special files which need to be generated specific to this
259
# user: ${python_site_packages}/lib/conf/conf.py and /etc/passwd.
260
# "__" username "__" users are exempt (special)
261
if not (username.startswith("__") and username.endswith("__")):
262
make_conf_py(username, userdir, ivle.conf.jail_system, svn_pass)
263
make_etc_passwd(username, userdir, ivle.conf.jail_system, uid)
267
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass=None):
269
Creates (overwriting any existing file, and creating directories) a
270
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
272
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
273
staging_dir: The dir with the staging copy of the jail. (With the
274
template conf.py file).
275
svn_pass: As with make_jail. User's SVN password, but if not supplied,
276
will look up in the DB.
278
template_conf_path = os.path.join(staging_dir,
279
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
280
conf_path = os.path.join(user_jail_dir,
281
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
282
os.makedirs(os.path.dirname(conf_path))
284
# If svn_pass isn't supplied, grab it from the DB
286
dbconn = ivle.db.DB()
287
svn_pass = dbconn.get_user(username).svn_pass
290
# Read the contents of the template conf file
292
template_conf_file = open(template_conf_path, "r")
293
template_conf_data = template_conf_file.read()
294
template_conf_file.close()
296
# Couldn't open template conf.py for some reason
297
# Just treat it as empty file
298
template_conf_data = ("# Warning: Problem building config script.\n"
299
"# Could not find template conf.py file.\n")
301
conf_file = open(conf_path, "w")
302
conf_file.write(template_conf_data)
303
conf_file.write("\n# The login name for the owner of the jail\n")
304
conf_file.write("login = %s\n" % repr(username))
305
conf_file.write("\n")
306
conf_file.write("# The subversion-only password for the owner of "
308
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
311
# Make this file world-readable
312
# (chmod 644 conf_path)
313
os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
316
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
318
Creates /etc/passwd in the given user's jail. This will be identical to
319
that in the template jail, except for the added entry for this user.
321
template_passwd_path = os.path.join(template_dir, "etc/passwd")
322
passwd_path = os.path.join(user_jail_dir, "etc/passwd")
323
passwd_dir = os.path.dirname(passwd_path)
324
if not os.path.exists(passwd_dir):
325
os.makedirs(passwd_dir)
326
shutil.copy(template_passwd_path, passwd_path)
327
passwd_file = open(passwd_path, 'a')
328
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
329
% (username, unixid, unixid, username))
332
def make_user_db(throw_on_error = True, **kwargs):
333
"""Creates a user's entry in the database, filling in all the fields.
334
All arguments must be keyword args. They are the fields in the table.
335
However, instead of supplying a "passhash", you must supply a
336
"password" argument, which will be hashed internally.
337
Also do not supply a state. All users are created in the "no_agreement"
339
Also pulls the user's subjects using the configured subject pulldown
340
module, and adds enrolments to the DB.
341
Throws an exception if the user already exists.
343
dbconn = ivle.db.DB()
344
dbconn.create_user(**kwargs)
347
if kwargs['password']:
348
if os.path.exists(ivle.conf.svn_auth_local):
352
res = os.system("htpasswd -%smb %s %s %s" % (create,
353
ivle.conf.svn_auth_local,
356
if res != 0 and throw_on_error:
357
raise Exception("Unable to create local-auth for %s" % kwargs['login'])
359
# Make sure the file is owned by the web server
361
chown_to_webserver(ivle.conf.svn_auth_local)
363
# Pulldown subjects and add enrolments
364
ivle.pulldown_subj.enrol_user(kwargs['login'])
366
def mount_jail(login):
367
# This is where we'll mount to...
368
destdir = os.path.join(ivle.conf.jail_base, login)
369
# ... and this is where we'll get the user bits.
370
srcdir = os.path.join(ivle.conf.jail_src_base, login)
372
if not os.path.exists(destdir):
374
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
375
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
376
logging.info("mounted user %s's jail." % login)
378
logging.error("failed to mount user %s's jail!" % login)
379
except Exception, message:
380
logging.warning(str(message))
added
removed
ivle/makeuser.py
