15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
"""User and group filesystem management helpers."""
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).
30
from storm.expr import Select, Max
33
from ivle.database import (User, ProjectGroup, Assessed, ProjectSubmission,
34
Project, ProjectSet, Offering, Enrolment)
49
import ivle.pulldown_subj
36
51
def chown_to_webserver(filename):
37
"""chown a directory and its contents to the web server.
39
Recursively chowns a file or directory so the web server user owns it.
53
Chowns a file so the web server user owns it.
54
(This is useful in setting up Subversion conf files).
42
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
58
os.system("chown -R www-data:www-data %s" % filename)
44
62
def make_svn_repo(path, throw_on_error=True):
45
"""Create a Subversion repository at the given path."""
63
"""Create a Subversion repository at the given path.
47
res = subprocess.call(['svnadmin', 'create', path])
66
res = os.system("svnadmin create '%s'" % path)
48
67
if res != 0 and throw_on_error:
49
68
raise Exception("Cannot create repository: %s" % path)
50
69
except Exception, exc:
55
74
chown_to_webserver(path)
57
def rebuild_svn_config(store, config):
76
def rebuild_svn_config():
58
77
"""Build the complete SVN configuration file.
60
@param config: An ivle.config.Config object.
62
users = store.find(User)
63
conf_name = config['paths']['svn']['conf']
64
temp_name = conf_name + ".new"
65
f = open(temp_name, "w")
67
# IVLE SVN repository authorisation configuration
69
""" % {'time': time.asctime()})
75
""" % {'login': u.login})
77
# Now we need to grant offering tutors and lecturers access to the latest
78
# submissions in their offerings. There are much prettier ways to do this,
79
# but a lot of browser requests call this function, so it needs to be
80
# fast. We can grab all of the paths needing authorisation directives with
81
# a single query, and we cache the list of viewers for each offering.
82
offering_viewers_cache = {}
83
for (login, psid, pspath, offeringid) in store.find(
84
(User.login, ProjectSubmission.id, ProjectSubmission.path,
86
Assessed.id == ProjectSubmission.assessed_id,
87
User.id == Assessed.user_id,
88
Project.id == Assessed.project_id,
89
ProjectSet.id == Project.project_set_id,
90
Offering.id == ProjectSet.id,
91
ProjectSubmission.date_submitted == Select(
92
Max(ProjectSubmission.date_submitted),
93
ProjectSubmission.assessed_id == Assessed.id,
94
tables=ProjectSubmission
98
# Do we already have the list of logins authorised for this offering
99
# cached? If not, get it.
100
if offeringid not in offering_viewers_cache:
101
offering_viewers_cache[offeringid] = list(store.find(
103
User.id == Enrolment.user_id,
104
Enrolment.offering_id == offeringid,
105
Enrolment.role.is_in((u'tutor', u'lecturer'))
112
""" % {'login': login, 'id': psid, 'path': pspath})
114
for viewer_login in offering_viewers_cache[offeringid]:
115
# We don't want to override the owner's write privilege,
116
# so we don't add them to the read-only ACL.
117
if login != viewer_login:
118
f.write("%s = r\n" % viewer_login)
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")
121
os.rename(temp_name, conf_name)
122
chown_to_webserver(conf_name)
103
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
104
chown_to_webserver(ivle.conf.svn_conf)
124
def rebuild_svn_group_config(store, config):
106
def rebuild_svn_group_config():
125
107
"""Build the complete SVN configuration file for groups
127
@param config: An ivle.config.Config object.
129
conf_name = config['paths']['svn']['group_conf']
130
temp_name = conf_name + ".new"
131
f = open(temp_name, "w")
134
# IVLE SVN group repository authorisation configuration
135
# Generated: %(time)s
137
""" % {'time': time.asctime()})
139
for group in store.find(ProjectGroup):
140
offering = group.project_set.offering
141
reponame = "_".join([offering.subject.short_name,
142
offering.semester.year,
143
offering.semester.semester,
146
f.write("[%s:/]\n" % reponame)
147
for user in group.members:
148
f.write("%s = rw\n" % user.login)
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'])
152
os.rename(temp_name, conf_name)
153
chown_to_webserver(conf_name)
155
def make_svn_auth(store, login, config, throw_on_error=True):
156
"""Create a Subversion password for a user.
158
Generates a new random Subversion password, and assigns it to the user.
159
The password is added to Apache's Subversion authentication file.
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(login, throw_on_error=True):
133
"""Setup svn authentication for the given user.
134
FIXME: create local.auth entry
161
# filename is, eg, /var/lib/ivle/svn/ivle.auth
162
filename = config['paths']['svn']['auth_ivle']
163
passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
164
if os.path.exists(filename):
136
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
137
if os.path.exists(ivle.conf.svn_auth_ivle):
169
user = User.get_by_login(store, login)
170
user.svn_pass = unicode(passwd)
142
ivle.db.DB().update_user(login, svn_pass=passwd)
172
res = subprocess.call(['htpasswd', '-%smb' % create,
173
filename, login, passwd])
144
res = os.system("htpasswd -%smb %s %s %s" % (create,
145
ivle.conf.svn_auth_ivle,
174
147
if res != 0 and throw_on_error:
175
148
raise Exception("Unable to create ivle-auth for %s" % login)
177
150
# Make sure the file is owned by the web server
178
151
if create == "c":
179
chown_to_webserver(filename)
152
chown_to_webserver(ivle.conf.svn_auth_ivle)
183
def make_jail(user, config, force=True):
184
"""Create or update a user's jail.
186
Only the user-specific parts of the jail are created here - everything
187
else is expected to be part of another aufs branch.
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.
189
192
Returns the path to the user's home directory.
191
194
Chowns the user's directory within the jail to the given UID.
193
@param force: If False, raise an exception if the user already has a jail.
194
If True (default), rebuild the jail preserving /home.
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.
196
208
# MUST run as root or some of this may fail
197
209
if os.getuid() != 0:
198
210
raise Exception("Must run make_jail as root")
200
212
# tempdir is for putting backup homes in
201
jail_src_base = config['paths']['jails']['src']
202
tempdir = os.path.join(jail_src_base, '__temp__')
213
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
203
214
if not os.path.exists(tempdir):
204
215
os.makedirs(tempdir)
205
216
elif not os.path.isdir(tempdir):
206
217
os.unlink(tempdir)
207
218
os.mkdir(tempdir)
208
userdir = os.path.join(jail_src_base, user.login)
219
userdir = os.path.join(ivle.conf.jail_src_base, username)
209
220
homedir = os.path.join(userdir, 'home')
210
userhomedir = os.path.join(homedir, user.login) # Return value
221
userhomedir = os.path.join(homedir, username) # Return value
212
223
if os.path.exists(userdir):
219
230
warnings.simplefilter('ignore')
220
231
homebackup = os.tempnam(tempdir)
221
232
warnings.resetwarnings()
222
# Back up the /home directory, delete the entire jail, recreate the
223
# jail directory tree, then copy the /home back
224
# NOTE that shutil.move changed in Python 2.6, it now moves a
225
# directory INTO the target (like `mv`), which it didn't use to do.
226
# This code works regardless.
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.
227
236
shutil.move(homedir, homebackup)
228
237
shutil.rmtree(userdir)
230
239
shutil.move(homebackup, homedir)
231
240
# Change the ownership of all the files to the right unixid
232
241
logging.debug("chown %s's home directory files to uid %d"
233
%(user.login, user.unixid))
234
os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
235
user.unixid), userhomedir])
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)
237
248
# No user jail exists
238
249
# Set up the user's home directory
239
250
os.makedirs(userhomedir)
240
251
# Chown (and set the GID to the same as the UID).
241
os.chown(userhomedir, user.unixid, user.unixid)
252
os.chown(userhomedir, uid, uid)
242
253
# Chmod to rwxr-xr-x (755)
243
254
os.chmod(userhomedir, 0755)
245
make_ivle_conf(user.login, userdir, user.svn_pass, config)
246
make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
256
# There are 2 special files which need to be generated specific to this
257
# user: ${python_site_packages}/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, ivle.conf.jail_system, svn_pass)
261
make_etc_passwd(username, userdir, ivle.conf.jail_system, uid)
249
263
return userhomedir
251
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
252
"""Generate an ivle.conf for a user's jail.
265
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass=None):
254
267
Creates (overwriting any existing file, and creating directories) a
255
file /etc/ivle/ivle.conf in a given user's jail.
257
@param username: Username.
258
@param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
259
@param svn_pass: User's SVN password.
260
@param sys_config: An ivle.config.Config object (the system-wide config).
268
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
270
user_jail_dir: User's jail dir, ie. ivle.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.
262
conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
276
template_conf_path = os.path.join(staging_dir,
277
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
278
conf_path = os.path.join(user_jail_dir,
279
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
263
280
os.makedirs(os.path.dirname(conf_path))
265
# In the "in-jail" version of conf, we don't need MOST of the details
266
# (it would be a security risk to have them here).
267
# So we just write root_dir.
268
conf_obj = ivle.config.Config(blank=True)
269
conf_obj.filename = conf_path
270
conf_obj['urls']['root'] = sys_config['urls']['root']
271
conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
272
conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
273
conf_obj['user_info']['login'] = username
274
conf_obj['user_info']['svn_pass'] = svn_pass
282
# If svn_pass isn't supplied, grab it from the DB
284
dbconn = ivle.db.DB()
285
svn_pass = dbconn.get_user(username).svn_pass
288
# Read the contents of the template conf file
290
template_conf_file = open(template_conf_path, "r")
291
template_conf_data = template_conf_file.read()
292
template_conf_file.close()
294
# Couldn't open template conf.py for some reason
295
# Just treat it as empty file
296
template_conf_data = ("# Warning: Problem building config script.\n"
297
"# Could not find template conf.py file.\n")
299
conf_file = open(conf_path, "w")
300
conf_file.write(template_conf_data)
301
conf_file.write("\n# The login name for the owner of the jail\n")
302
conf_file.write("login = %s\n" % repr(username))
303
conf_file.write("\n")
304
conf_file.write("# The subversion-only password for the owner of "
306
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
277
309
# Make this file world-readable
278
310
# (chmod 644 conf_path)
295
326
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
296
327
% (username, unixid, unixid, username))
297
328
passwd_file.close()
330
def make_user_db(throw_on_error = True, **kwargs):
331
"""Creates a user's entry in the database, filling in all the fields.
332
All arguments must be keyword args. They are the fields in the table.
333
However, instead of supplying a "passhash", you must supply a
334
"password" argument, which will be hashed internally.
335
Also do not supply a state. All users are created in the "no_agreement"
337
Also pulls the user's subjects using the configured subject pulldown
338
module, and adds enrolments to the DB.
339
Throws an exception if the user already exists.
341
dbconn = ivle.db.DB()
342
dbconn.create_user(**kwargs)
345
if kwargs['password']:
346
if os.path.exists(ivle.conf.svn_auth_local):
350
res = os.system("htpasswd -%smb %s %s %s" % (create,
351
ivle.conf.svn_auth_local,
354
if res != 0 and throw_on_error:
355
raise Exception("Unable to create local-auth for %s" % kwargs['login'])
357
# Make sure the file is owned by the web server
359
chown_to_webserver(ivle.conf.svn_auth_local)
361
# Pulldown subjects and add enrolments
362
ivle.pulldown_subj.enrol_user(kwargs['login'])
364
def mount_jail(login):
365
# This is where we'll mount to...
366
destdir = os.path.join(ivle.conf.jail_base, login)
367
# ... and this is where we'll get the user bits.
368
srcdir = os.path.join(ivle.conf.jail_src_base, login)
370
if not os.path.exists(destdir):
372
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
373
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
374
logging.info("mounted user %s's jail." % login)
376
logging.error("failed to mount user %s's jail!" % login)
377
except Exception, message:
378
logging.warning(str(message))
added
removed
ivle/makeuser.py
