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).
48
import ivle.pulldown_subj
50
from ivle.database import ProjectGroup
52
def chown_to_webserver(filename):
54
Chowns a file so the web server user owns it.
55
(This is useful in setting up Subversion conf files).
59
os.system("chown -R www-data:www-data %s" % filename)
63
def make_svn_repo(path, throw_on_error=True):
64
"""Create a Subversion repository at the given path.
67
res = os.system("svnadmin create '%s'" % path)
68
if res != 0 and throw_on_error:
69
raise Exception("Cannot create repository: %s" % path)
70
except Exception, exc:
75
chown_to_webserver(path)
77
def rebuild_svn_config(store):
78
"""Build the complete SVN configuration file.
80
users = store.find(ivle.database.User)
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(store):
107
"""Build the complete SVN configuration file for groups
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())
113
for group in store.find(ProjectGroup):
114
offering = group.project_set.offering
115
reponame = "_".join([offering.subject.short_name,
116
offering.semester.year,
117
offering.semester.semester,
119
f.write("[%s:/]\n"%reponame)
120
for user in group.members:
121
f.write("%s = rw\n" % user.login)
124
os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
125
chown_to_webserver(ivle.conf.svn_group_conf)
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.
131
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
132
if os.path.exists(ivle.conf.svn_auth_ivle):
137
user = ivle.database.User.get_by_login(store, login)
138
user.svn_pass = unicode(passwd)
140
res = os.system("htpasswd -%smb %s %s %s" % (create,
141
ivle.conf.svn_auth_ivle,
143
if res != 0 and throw_on_error:
144
raise Exception("Unable to create ivle-auth for %s" % login)
146
# Make sure the file is owned by the web server
148
chown_to_webserver(ivle.conf.svn_auth_ivle)
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
157
parent: This is used for the recursive call to track the relative paths
158
that we have decended.
161
cmp = filecmp.dircmp(basedir, targetdir)
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)]
166
# Remove files that are redundant
167
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
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)
178
return (to_add, to_remove)
181
def make_jail(user, force=True):
182
"""Creates a new user's jail space, in the jail directory as configured in
185
This only creates things within /home - everything else is expected to be
186
part of another UnionFS branch.
188
Returns the path to the user's home directory.
190
Chowns the user's directory within the jail to the given UID.
192
force: If false, exception if jail already exists for this user.
193
If true (default), overwrites it, but preserves home directory.
195
# MUST run as root or some of this may fail
197
raise Exception("Must run make_jail as root")
199
# tempdir is for putting backup homes in
200
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
201
if not os.path.exists(tempdir):
203
elif not os.path.isdir(tempdir):
206
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
207
homedir = os.path.join(userdir, 'home')
208
userhomedir = os.path.join(homedir, user.login) # Return value
210
if os.path.exists(userdir):
212
raise Exception("User's jail already exists")
213
# User jail already exists. Blow it away but preserve their home
214
# directory. It should be all that is there anyway, but you never
216
# Ignore warnings about the use of tmpnam
217
warnings.simplefilter('ignore')
218
homebackup = os.tempnam(tempdir)
219
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.
223
shutil.move(homedir, homebackup)
224
shutil.rmtree(userdir)
226
shutil.move(homebackup, homedir)
227
# Change the ownership of all the files to the right unixid
228
logging.debug("chown %s's home directory files to uid %d"
229
%(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)
235
# No user jail exists
236
# Set up the user's home directory
237
os.makedirs(userhomedir)
238
# Chown (and set the GID to the same as the UID).
239
os.chown(userhomedir, user.unixid, user.unixid)
240
# Chmod to rwxr-xr-x (755)
241
os.chmod(userhomedir, 0755)
243
make_conf_py(user.login, userdir, user.svn_pass)
244
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
248
def make_conf_py(username, user_jail_dir, svn_pass):
250
Creates (overwriting any existing file, and creating directories) a
251
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
253
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
254
svn_pass: User's SVN password.
256
conf_path = os.path.join(user_jail_dir,
257
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
258
os.makedirs(os.path.dirname(conf_path))
260
# In the "in-jail" version of conf, we don't need MOST of the details
261
# (it would be a security risk to have them here).
262
# So we just write root_dir, and jail_base is "/".
263
# (jail_base being "/" means "jail-relative" paths are relative to "/"
264
# when inside the jail.)
266
# XXX: jail_base is wrong and shouldn't be here. Unfortunately, jail code
267
# uses ivle.studpath.url_to_{local,jailpaths}, both of which use
268
# jail_base. Note that they don't use the bits of the return value
269
# that depend on jail_base, so it can be any string.
270
conf_file = open(conf_path, "w")
271
conf_file.write("""# IVLE jail configuration
273
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
275
# eg. "/" or "/ivle".
276
root_dir = %(root_dir)r
278
# This value is not relevant inside the jail, but must remain for now. See
279
# the XXX in ivle.makeuser.make_conf_py.
282
# The hostname for serving publicly accessible pages
283
public_host = %(public_host)r
285
# The URL under which the Subversion repositories are located.
286
svn_addr = %(svn_addr)r
288
# The login name for the owner of the jail
291
# The subversion-only password for the owner of the jail
292
svn_pass = %(svn_pass)r
293
""" % {'root_dir': ivle.conf.root_dir,
294
'public_host': ivle.conf.public_host,
295
'svn_addr': ivle.conf.svn_addr,
296
'username': username,
297
'svn_pass': svn_pass,
301
# Make this file world-readable
302
# (chmod 644 conf_path)
303
os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
306
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
308
Creates /etc/passwd in the given user's jail. This will be identical to
309
that in the template jail, except for the added entry for this user.
311
template_passwd_path = os.path.join(template_dir, "etc/passwd")
312
passwd_path = os.path.join(user_jail_dir, "etc/passwd")
313
passwd_dir = os.path.dirname(passwd_path)
314
if not os.path.exists(passwd_dir):
315
os.makedirs(passwd_dir)
316
shutil.copy(template_passwd_path, passwd_path)
317
passwd_file = open(passwd_path, 'a')
318
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
319
% (username, unixid, unixid, username))
322
def mount_jail(login):
323
# This is where we'll mount to...
324
destdir = os.path.join(ivle.conf.jail_base, login)
325
# ... and this is where we'll get the user bits.
326
srcdir = os.path.join(ivle.conf.jail_src_base, login)
328
if not os.path.exists(destdir):
330
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
331
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
332
logging.info("mounted user %s's jail." % login)
334
logging.error("failed to mount user %s's jail!" % login)
335
except Exception, message:
336
logging.warning(str(message))
added
removed
ivle/makeuser.py
