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).
31
from ivle.database import ProjectGroup, User
49
import ivle.pulldown_subj
33
51
def chown_to_webserver(filename):
34
"""chown a directory and its contents to the web server.
36
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).
39
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
58
os.system("chown -R www-data:www-data %s" % filename)
41
62
def make_svn_repo(path, throw_on_error=True):
42
"""Create a Subversion repository at the given path."""
63
"""Create a Subversion repository at the given path.
44
res = subprocess.call(['svnadmin', 'create', path])
66
res = os.system("svnadmin create '%s'" % path)
45
67
if res != 0 and throw_on_error:
46
68
raise Exception("Cannot create repository: %s" % path)
47
69
except Exception, exc:
52
74
chown_to_webserver(path)
54
def rebuild_svn_config(store, config):
76
def rebuild_svn_config():
55
77
"""Build the complete SVN configuration file.
57
@param config: An ivle.config.Config object.
59
users = store.find(User)
60
conf_name = config['paths']['svn']['conf']
61
temp_name = conf_name + ".new"
62
f = open(temp_name, "w")
64
# IVLE SVN repository authorisation configuration
66
""" % {'time': time.asctime()})
72
""" % {'login': u.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")
75
os.rename(temp_name, conf_name)
76
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)
78
def rebuild_svn_group_config(store, config):
106
def rebuild_svn_group_config():
79
107
"""Build the complete SVN configuration file for groups
81
@param config: An ivle.config.Config object.
83
conf_name = config['paths']['svn']['group_conf']
84
temp_name = conf_name + ".new"
85
f = open(temp_name, "w")
88
# IVLE SVN group repository authorisation configuration
91
""" % {'time': time.asctime()})
93
for group in store.find(ProjectGroup):
94
offering = group.project_set.offering
95
reponame = "_".join([offering.subject.short_name,
96
offering.semester.year,
97
offering.semester.semester,
100
f.write("[%s:/]\n" % reponame)
101
for user in group.members:
102
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'])
106
os.rename(temp_name, conf_name)
107
chown_to_webserver(conf_name)
109
def make_svn_auth(store, login, config, throw_on_error=True):
110
"""Create a Subversion password for a user.
112
Generates a new random Subversion password, and assigns it to the user.
113
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(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
115
# filename is, eg, /var/lib/ivle/svn/ivle.auth
116
filename = config['paths']['svn']['auth_ivle']
117
passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
118
if os.path.exists(filename):
137
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
138
if os.path.exists(ivle.conf.svn_auth_ivle):
123
user = User.get_by_login(store, login)
143
user = ivle.database.User.get_by_login(store, login)
124
144
user.svn_pass = unicode(passwd)
126
res = subprocess.call(['htpasswd', '-%smb' % create,
127
filename, login, passwd])
146
res = os.system("htpasswd -%smb %s %s %s" % (create,
147
ivle.conf.svn_auth_ivle,
128
149
if res != 0 and throw_on_error:
129
150
raise Exception("Unable to create ivle-auth for %s" % login)
131
152
# Make sure the file is owned by the web server
132
153
if create == "c":
133
chown_to_webserver(filename)
154
chown_to_webserver(ivle.conf.svn_auth_ivle)
137
def make_jail(user, config, force=True):
138
"""Create or update a user's jail.
140
Only the user-specific parts of the jail are created here - everything
141
else is expected to be part of another aufs branch.
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.
143
194
Returns the path to the user's home directory.
145
196
Chowns the user's directory within the jail to the given UID.
147
@param force: If False, raise an exception if the user already has a jail.
148
If True (default), rebuild the jail preserving /home.
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.
150
210
# MUST run as root or some of this may fail
151
211
if os.getuid() != 0:
152
212
raise Exception("Must run make_jail as root")
154
214
# tempdir is for putting backup homes in
155
jail_src_base = config['paths']['jails']['src']
156
tempdir = os.path.join(jail_src_base, '__temp__')
215
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
157
216
if not os.path.exists(tempdir):
158
217
os.makedirs(tempdir)
159
218
elif not os.path.isdir(tempdir):
160
219
os.unlink(tempdir)
161
220
os.mkdir(tempdir)
162
userdir = os.path.join(jail_src_base, user.login)
221
userdir = os.path.join(ivle.conf.jail_src_base, username)
163
222
homedir = os.path.join(userdir, 'home')
164
userhomedir = os.path.join(homedir, user.login) # Return value
223
userhomedir = os.path.join(homedir, username) # Return value
166
225
if os.path.exists(userdir):
173
232
warnings.simplefilter('ignore')
174
233
homebackup = os.tempnam(tempdir)
175
234
warnings.resetwarnings()
176
# Back up the /home directory, delete the entire jail, recreate the
177
# jail directory tree, then copy the /home back
178
# NOTE that shutil.move changed in Python 2.6, it now moves a
179
# directory INTO the target (like `mv`), which it didn't use to do.
180
# This code works regardless.
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.
181
238
shutil.move(homedir, homebackup)
182
239
shutil.rmtree(userdir)
184
241
shutil.move(homebackup, homedir)
185
242
# Change the ownership of all the files to the right unixid
186
243
logging.debug("chown %s's home directory files to uid %d"
187
%(user.login, user.unixid))
188
os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
189
user.unixid), userhomedir])
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)
191
250
# No user jail exists
192
251
# Set up the user's home directory
193
252
os.makedirs(userhomedir)
194
253
# Chown (and set the GID to the same as the UID).
195
os.chown(userhomedir, user.unixid, user.unixid)
254
os.chown(userhomedir, uid, uid)
196
255
# Chmod to rwxr-xr-x (755)
197
256
os.chmod(userhomedir, 0755)
199
make_ivle_conf(user.login, userdir, user.svn_pass, config)
200
make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
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)
203
265
return userhomedir
205
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
206
"""Generate an ivle.conf for a user's jail.
267
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass=None):
208
269
Creates (overwriting any existing file, and creating directories) a
209
file /etc/ivle/ivle.conf in a given user's jail.
211
@param username: Username.
212
@param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
213
@param svn_pass: User's SVN password.
214
@param sys_config: An ivle.config.Config object (the system-wide config).
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.
216
conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
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")
217
282
os.makedirs(os.path.dirname(conf_path))
219
# In the "in-jail" version of conf, we don't need MOST of the details
220
# (it would be a security risk to have them here).
221
# So we just write root_dir.
222
conf_obj = ivle.config.Config(blank=True)
223
conf_obj.filename = conf_path
224
conf_obj['urls']['root'] = sys_config['urls']['root']
225
conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
226
conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
227
conf_obj['user_info']['login'] = username
228
conf_obj['user_info']['svn_pass'] = svn_pass
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))
231
311
# Make this file world-readable
232
312
# (chmod 644 conf_path)
249
328
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
250
329
% (username, unixid, unixid, username))
251
330
passwd_file.close()
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
