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.
136
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
137
if os.path.exists(ivle.conf.svn_auth_ivle):
142
user = ivle.database.User.get_by_login(store, login)
143
user.svn_pass = unicode(passwd)
145
res = os.system("htpasswd -%smb %s %s %s" % (create,
146
ivle.conf.svn_auth_ivle,
148
if res != 0 and throw_on_error:
149
raise Exception("Unable to create ivle-auth for %s" % login)
151
# Make sure the file is owned by the web server
153
chown_to_webserver(ivle.conf.svn_auth_ivle)
157
def generate_manifest(basedir, targetdir, parent=''):
158
""" From a basedir and a targetdir work out which files are missing or out
159
of date and need to be added/updated and which files are redundant and need
162
parent: This is used for the recursive call to track the relative paths
163
that we have decended.
166
cmp = filecmp.dircmp(basedir, targetdir)
168
# Add all new files and files that have changed
169
to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
171
# Remove files that are redundant
172
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
175
for d in cmp.common_dirs:
176
newbasedir = os.path.join(basedir, d)
177
newtargetdir = os.path.join(targetdir, d)
178
newparent = os.path.join(parent, d)
179
(sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
183
return (to_add, to_remove)
186
def make_jail(username, uid, force=True, svn_pass=None):
187
"""Creates a new user's jail space, in the jail directory as configured in
190
This only creates things within /home - everything else is expected to be
191
part of another UnionFS branch.
193
Returns the path to the user's home directory.
195
Chowns the user's directory within the jail to the given UID.
197
Note: This takes separate username and uid arguments. The UID need not
198
*necessarily* correspond to a Unix username at all, if all you are
199
planning to do is setuid to it. This allows the caller the freedom of
200
deciding the binding between username and uid, if any.
202
force: If false, exception if jail already exists for this user.
203
If true (default), overwrites it, but preserves home directory.
205
svn_pass: If provided this will be a string, the randomly-generated
206
Subversion password for this user (if you happen to already have it).
207
If not provided, it will be read from the database.
209
# MUST run as root or some of this may fail
211
raise Exception("Must run make_jail as root")
213
# tempdir is for putting backup homes in
214
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
215
if not os.path.exists(tempdir):
217
elif not os.path.isdir(tempdir):
220
userdir = os.path.join(ivle.conf.jail_src_base, username)
221
homedir = os.path.join(userdir, 'home')
222
userhomedir = os.path.join(homedir, username) # Return value
224
if os.path.exists(userdir):
226
raise Exception("User's jail already exists")
227
# User jail already exists. Blow it away but preserve their home
228
# directory. It should be all that is there anyway, but you never
230
# Ignore warnings about the use of tmpnam
231
warnings.simplefilter('ignore')
232
homebackup = os.tempnam(tempdir)
233
warnings.resetwarnings()
234
# Note: shutil.move does not behave like "mv" - it does not put a file
235
# into a directory if it already exists, just fails. Therefore it is
236
# not susceptible to tmpnam symlink attack.
237
shutil.move(homedir, homebackup)
238
shutil.rmtree(userdir)
240
shutil.move(homebackup, homedir)
241
# Change the ownership of all the files to the right unixid
242
logging.debug("chown %s's home directory files to uid %d"
244
os.chown(userhomedir, uid, uid)
245
for root, dirs, files in os.walk(userhomedir):
246
for fsobj in dirs + files:
247
os.chown(os.path.join(root, fsobj), uid, uid)
249
# No user jail exists
250
# Set up the user's home directory
251
os.makedirs(userhomedir)
252
# Chown (and set the GID to the same as the UID).
253
os.chown(userhomedir, uid, uid)
254
# Chmod to rwxr-xr-x (755)
255
os.chmod(userhomedir, 0755)
257
# There are 2 special files which need to be generated specific to this
258
# user: ${python_site_packages}/lib/conf/conf.py and /etc/passwd.
259
# "__" username "__" users are exempt (special)
260
if not (username.startswith("__") and username.endswith("__")):
261
make_conf_py(username, userdir, ivle.conf.jail_system, svn_pass)
262
make_etc_passwd(username, userdir, ivle.conf.jail_system, uid)
266
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass=None):
268
Creates (overwriting any existing file, and creating directories) a
269
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
271
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
272
staging_dir: The dir with the staging copy of the jail. (With the
273
template conf.py file).
274
svn_pass: As with make_jail. User's SVN password, but if not supplied,
275
will look up in the DB.
277
template_conf_path = os.path.join(staging_dir,
278
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
279
conf_path = os.path.join(user_jail_dir,
280
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
281
os.makedirs(os.path.dirname(conf_path))
283
# If svn_pass isn't supplied, grab it from the DB
285
dbconn = ivle.db.DB()
286
svn_pass = dbconn.get_user(username).svn_pass
289
# Read the contents of the template conf file
291
template_conf_file = open(template_conf_path, "r")
292
template_conf_data = template_conf_file.read()
293
template_conf_file.close()
295
# Couldn't open template conf.py for some reason
296
# Just treat it as empty file
297
template_conf_data = ("# Warning: Problem building config script.\n"
298
"# Could not find template conf.py file.\n")
300
conf_file = open(conf_path, "w")
301
conf_file.write(template_conf_data)
302
conf_file.write("\n# The login name for the owner of the jail\n")
303
conf_file.write("login = %s\n" % repr(username))
304
conf_file.write("\n")
305
conf_file.write("# The subversion-only password for the owner of "
307
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
310
# Make this file world-readable
311
# (chmod 644 conf_path)
312
os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
315
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
317
Creates /etc/passwd in the given user's jail. This will be identical to
318
that in the template jail, except for the added entry for this user.
320
template_passwd_path = os.path.join(template_dir, "etc/passwd")
321
passwd_path = os.path.join(user_jail_dir, "etc/passwd")
322
passwd_dir = os.path.dirname(passwd_path)
323
if not os.path.exists(passwd_dir):
324
os.makedirs(passwd_dir)
325
shutil.copy(template_passwd_path, passwd_path)
326
passwd_file = open(passwd_path, 'a')
327
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
328
% (username, unixid, unixid, username))
331
def make_user_db(throw_on_error = True, **kwargs):
332
"""Creates a user's entry in the database, filling in all the fields.
333
All arguments must be keyword args. They are the fields in the table.
334
However, instead of supplying a "passhash", you must supply a
335
"password" argument, which will be hashed internally.
336
Also do not supply a state. All users are created in the "no_agreement"
338
Also pulls the user's subjects using the configured subject pulldown
339
module, and adds enrolments to the DB.
340
Throws an exception if the user already exists.
342
dbconn = ivle.db.DB()
343
dbconn.create_user(**kwargs)
346
# Pulldown subjects and add enrolments
347
ivle.pulldown_subj.enrol_user(kwargs['login'])
349
def mount_jail(login):
350
# This is where we'll mount to...
351
destdir = os.path.join(ivle.conf.jail_base, login)
352
# ... and this is where we'll get the user bits.
353
srcdir = os.path.join(ivle.conf.jail_src_base, login)
355
if not os.path.exists(destdir):
357
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
358
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
359
logging.info("mounted user %s's jail." % login)
361
logging.error("failed to mount user %s's jail!" % login)
362
except Exception, message:
363
logging.warning(str(message))
added
removed
ivle/makeuser.py
