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)
82
# TODO: Populate groups with per-offering tutors/lecturers/etc.
83
f = open(ivle.conf.svn_conf + ".new", "w")
84
f.write("# IVLE SVN Repositories Configuration\n")
85
f.write("# Auto-generated on %s\n" % time.asctime())
88
for (g,ls) in groups.iteritems():
89
f.write("%s = %s\n" % (g, ",".join(ls)))
92
f.write("[%s:/]\n" % u.login)
93
f.write("%s = rw\n" % u.login)
94
#f.write("@tutor = r\n")
95
#f.write("@lecturer = rw\n")
96
#f.write("@admin = rw\n")
99
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
100
chown_to_webserver(ivle.conf.svn_conf)
102
def rebuild_svn_group_config(store):
103
"""Build the complete SVN configuration file for groups
105
f = open(ivle.conf.svn_group_conf + ".new", "w")
106
f.write("# IVLE SVN Group Repositories Configuration\n")
107
f.write("# Auto-generated on %s\n" % time.asctime())
109
for group in store.find(ProjectGroup):
110
offering = group.project_set.offering
111
reponame = "_".join([offering.subject.short_name,
112
offering.semester.year,
113
offering.semester.semester,
115
f.write("[%s:/]\n"%reponame)
116
for user in group.members:
117
f.write("%s = rw\n" % user.login)
120
os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
121
chown_to_webserver(ivle.conf.svn_group_conf)
123
def make_svn_auth(store, login, throw_on_error=True):
124
"""Setup svn authentication for the given user.
125
Uses the given DB store object. Does not commit to the db.
127
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
128
if os.path.exists(ivle.conf.svn_auth_ivle):
133
user = ivle.database.User.get_by_login(store, login)
134
user.svn_pass = unicode(passwd)
136
res = os.system("htpasswd -%smb %s %s %s" % (create,
137
ivle.conf.svn_auth_ivle,
139
if res != 0 and throw_on_error:
140
raise Exception("Unable to create ivle-auth for %s" % login)
142
# Make sure the file is owned by the web server
144
chown_to_webserver(ivle.conf.svn_auth_ivle)
148
def generate_manifest(basedir, targetdir, parent=''):
149
""" From a basedir and a targetdir work out which files are missing or out
150
of date and need to be added/updated and which files are redundant and need
153
parent: This is used for the recursive call to track the relative paths
154
that we have decended.
157
cmp = filecmp.dircmp(basedir, targetdir)
159
# Add all new files and files that have changed
160
to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
162
# Remove files that are redundant
163
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
166
for d in cmp.common_dirs:
167
newbasedir = os.path.join(basedir, d)
168
newtargetdir = os.path.join(targetdir, d)
169
newparent = os.path.join(parent, d)
170
(sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
174
return (to_add, to_remove)
177
def make_jail(user, force=True):
178
"""Creates a new user's jail space, in the jail directory as configured in
181
This only creates things within /home - everything else is expected to be
182
part of another UnionFS branch.
184
Returns the path to the user's home directory.
186
Chowns the user's directory within the jail to the given UID.
188
force: If false, exception if jail already exists for this user.
189
If true (default), overwrites it, but preserves home directory.
191
# MUST run as root or some of this may fail
193
raise Exception("Must run make_jail as root")
195
# tempdir is for putting backup homes in
196
tempdir = os.path.join(ivle.conf.jail_src_base, '__temp__')
197
if not os.path.exists(tempdir):
199
elif not os.path.isdir(tempdir):
202
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
203
homedir = os.path.join(userdir, 'home')
204
userhomedir = os.path.join(homedir, user.login) # Return value
206
if os.path.exists(userdir):
208
raise Exception("User's jail already exists")
209
# User jail already exists. Blow it away but preserve their home
210
# directory. It should be all that is there anyway, but you never
212
# Ignore warnings about the use of tmpnam
213
warnings.simplefilter('ignore')
214
homebackup = os.tempnam(tempdir)
215
warnings.resetwarnings()
216
# Note: shutil.move does not behave like "mv" - it does not put a file
217
# into a directory if it already exists, just fails. Therefore it is
218
# not susceptible to tmpnam symlink attack.
219
shutil.move(homedir, homebackup)
220
shutil.rmtree(userdir)
222
shutil.move(homebackup, homedir)
223
# Change the ownership of all the files to the right unixid
224
logging.debug("chown %s's home directory files to uid %d"
225
%(user.login, user.unixid))
226
os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
227
user.unixid), userhomedir])
229
# No user jail exists
230
# Set up the user's home directory
231
os.makedirs(userhomedir)
232
# Chown (and set the GID to the same as the UID).
233
os.chown(userhomedir, user.unixid, user.unixid)
234
# Chmod to rwxr-xr-x (755)
235
os.chmod(userhomedir, 0755)
237
make_conf_py(user.login, userdir, user.svn_pass)
238
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
242
def make_conf_py(username, user_jail_dir, svn_pass):
244
Creates (overwriting any existing file, and creating directories) a
245
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
247
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
248
svn_pass: User's SVN password.
250
conf_path = os.path.join(user_jail_dir,
251
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
252
os.makedirs(os.path.dirname(conf_path))
254
# In the "in-jail" version of conf, we don't need MOST of the details
255
# (it would be a security risk to have them here).
256
# So we just write root_dir, and jail_base is "/".
257
# (jail_base being "/" means "jail-relative" paths are relative to "/"
258
# when inside the jail.)
260
# XXX: jail_base is wrong and shouldn't be here. Unfortunately, jail code
261
# uses ivle.studpath.url_to_{local,jailpaths}, both of which use
262
# jail_base. Note that they don't use the bits of the return value
263
# that depend on jail_base, so it can be any string.
264
conf_file = open(conf_path, "w")
265
conf_file.write("""# IVLE jail configuration
267
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
269
# eg. "/" or "/ivle".
270
root_dir = %(root_dir)r
272
# This value is not relevant inside the jail, but must remain for now. See
273
# the XXX in ivle.makeuser.make_conf_py.
276
# The hostname for serving publicly accessible pages
277
public_host = %(public_host)r
279
# The URL under which the Subversion repositories are located.
280
svn_addr = %(svn_addr)r
282
# The login name for the owner of the jail
285
# The subversion-only password for the owner of the jail
286
svn_pass = %(svn_pass)r
287
""" % {'root_dir': ivle.conf.root_dir,
288
'public_host': ivle.conf.public_host,
289
'svn_addr': ivle.conf.svn_addr,
290
'username': username,
291
'svn_pass': svn_pass,
295
# Make this file world-readable
296
# (chmod 644 conf_path)
297
os.chmod(conf_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP
300
def make_etc_passwd(username, user_jail_dir, template_dir, unixid):
302
Creates /etc/passwd in the given user's jail. This will be identical to
303
that in the template jail, except for the added entry for this user.
305
template_passwd_path = os.path.join(template_dir, "etc/passwd")
306
passwd_path = os.path.join(user_jail_dir, "etc/passwd")
307
passwd_dir = os.path.dirname(passwd_path)
308
if not os.path.exists(passwd_dir):
309
os.makedirs(passwd_dir)
310
shutil.copy(template_passwd_path, passwd_path)
311
passwd_file = open(passwd_path, 'a')
312
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
313
% (username, unixid, unixid, username))
316
def mount_jail(login):
317
# This is where we'll mount to...
318
destdir = os.path.join(ivle.conf.jail_base, login)
319
# ... and this is where we'll get the user bits.
320
srcdir = os.path.join(ivle.conf.jail_src_base, login)
322
if not os.path.exists(destdir):
324
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
325
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
326
logging.info("mounted user %s's jail." % login)
328
logging.error("failed to mount user %s's jail!" % login)
329
except Exception, message:
330
logging.warning(str(message))
added
removed
ivle/makeuser.py
