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
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).
18
"""User and group filesystem management helpers."""
48
import ivle.pulldown_subj
50
30
from ivle.database import ProjectGroup
52
32
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).
33
"""chown a directory and its contents to the web server.
35
Recursively chowns a file or directory so the web server user owns it.
59
os.system("chown -R www-data:www-data %s" % filename)
38
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
63
40
def make_svn_repo(path, throw_on_error=True):
64
"""Create a Subversion repository at the given path.
41
"""Create a Subversion repository at the given path."""
67
res = os.system("svnadmin create '%s'" % path)
43
res = subprocess.call(['svnadmin', 'create', path])
68
44
if res != 0 and throw_on_error:
69
45
raise Exception("Cannot create repository: %s" % path)
70
46
except Exception, exc:
75
51
chown_to_webserver(path)
77
def rebuild_svn_config(store):
53
def rebuild_svn_config(store, config):
78
54
"""Build the complete SVN configuration file.
56
@param config: An ivle.config.Config object.
80
58
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")
60
# TODO: Populate groups with per-offering tutors/lecturers/etc.
61
conf_name = config['paths']['svn']['conf']
62
temp_name = conf_name + ".new"
63
f = open(temp_name, "w")
88
64
f.write("# IVLE SVN Repositories Configuration\n")
89
65
f.write("# Auto-generated on %s\n" % time.asctime())
100
76
#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)
79
os.rename(temp_name, conf_name)
80
chown_to_webserver(conf_name)
106
def rebuild_svn_group_config(store):
82
def rebuild_svn_group_config(store, config):
107
83
"""Build the complete SVN configuration file for groups
85
@param config: An ivle.config.Config object.
109
f = open(ivle.conf.svn_group_conf + ".new", "w")
87
conf_name = config['paths']['svn']['group_conf']
88
temp_name = conf_name + ".new"
89
f = open(temp_name, "w")
110
90
f.write("# IVLE SVN Group Repositories Configuration\n")
111
91
f.write("# Auto-generated on %s\n" % time.asctime())
121
101
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.
104
os.rename(temp_name, conf_name)
105
chown_to_webserver(conf_name)
107
def make_svn_auth(store, login, config, throw_on_error=True):
108
"""Create a Subversion password for a user.
110
Generates a new random Subversion password, and assigns it to the user.
111
The password is added to Apache's Subversion authentication file.
131
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
132
if os.path.exists(ivle.conf.svn_auth_ivle):
113
# filename is, eg, /var/lib/ivle/svn/ivle.auth
114
filename = config['paths']['svn']['auth_ivle']
115
passwd = hashlib.md5(uuid.uuid4().bytes).hexdigest()
116
if os.path.exists(filename):
137
121
user = ivle.database.User.get_by_login(store, login)
138
122
user.svn_pass = unicode(passwd)
140
res = os.system("htpasswd -%smb %s %s %s" % (create,
141
ivle.conf.svn_auth_ivle,
124
res = subprocess.call(['htpasswd', '-%smb' % create,
125
filename, login, passwd])
143
126
if res != 0 and throw_on_error:
144
127
raise Exception("Unable to create ivle-auth for %s" % login)
146
129
# Make sure the file is owned by the web server
147
130
if create == "c":
148
chown_to_webserver(ivle.conf.svn_auth_ivle)
131
chown_to_webserver(filename)
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.
135
def make_jail(user, config, force=True):
136
"""Create or update a user's jail.
138
Only the user-specific parts of the jail are created here - everything
139
else is expected to be part of another aufs branch.
188
141
Returns the path to the user's home directory.
190
143
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.
145
@param force: If False, raise an exception if the user already has a jail.
146
If True (default), rebuild the jail preserving /home.
195
148
# MUST run as root or some of this may fail
196
149
if os.getuid() != 0:
197
150
raise Exception("Must run make_jail as root")
199
152
# tempdir is for putting backup homes in
200
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
153
jail_src_base = config['paths']['jails']['src']
154
tempdir = os.path.join(jail_src_base, '__temp__')
201
155
if not os.path.exists(tempdir):
202
156
os.makedirs(tempdir)
203
157
elif not os.path.isdir(tempdir):
204
158
os.unlink(tempdir)
205
159
os.mkdir(tempdir)
206
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
160
userdir = os.path.join(jail_src_base, user.login)
207
161
homedir = os.path.join(userdir, 'home')
208
162
userhomedir = os.path.join(homedir, user.login) # Return value
217
171
warnings.simplefilter('ignore')
218
172
homebackup = os.tempnam(tempdir)
219
173
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.
174
# Back up the /home directory, delete the entire jail, recreate the
175
# jail directory tree, then copy the /home back
176
# NOTE that shutil.move changed in Python 2.6, it now moves a
177
# directory INTO the target (like `mv`), which it didn't use to do.
178
# This code works regardless.
223
179
shutil.move(homedir, homebackup)
224
180
shutil.rmtree(userdir)
226
182
shutil.move(homebackup, homedir)
227
183
# Change the ownership of all the files to the right unixid
228
184
logging.debug("chown %s's home directory files to uid %d"
229
185
%(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)
186
os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
187
user.unixid), userhomedir])
235
189
# No user jail exists
236
190
# Set up the user's home directory
240
194
# Chmod to rwxr-xr-x (755)
241
195
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)
197
make_ivle_conf(user.login, userdir, user.svn_pass, config)
198
make_etc_passwd(user.login, userdir, config['paths']['jails']['template'],
246
201
return userhomedir
248
def make_conf_py(username, user_jail_dir, svn_pass):
203
def make_ivle_conf(username, user_jail_dir, svn_pass, sys_config):
204
"""Generate an ivle.conf for a user's jail.
250
206
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.
207
file /etc/ivle/ivle.conf in a given user's jail.
209
@param username: Username.
210
@param user_jail_dir: User's jail dir, ie. ['jails']['src'] + username
211
@param svn_pass: User's SVN password.
212
@param sys_config: An ivle.config.Config object (the system-wide config).
256
conf_path = os.path.join(user_jail_dir,
257
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
214
conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
258
215
os.makedirs(os.path.dirname(conf_path))
260
217
# In the "in-jail" version of conf, we don't need MOST of the details
261
218
# (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,
219
# So we just write root_dir.
220
conf_obj = ivle.config.Config(blank=True)
221
conf_obj.filename = conf_path
222
conf_obj['urls']['root'] = sys_config['urls']['root']
223
conf_obj['urls']['public_host'] = sys_config['urls']['public_host']
224
conf_obj['urls']['svn_addr'] = sys_config['urls']['svn_addr']
225
conf_obj['user_info']['login'] = username
226
conf_obj['user_info']['svn_pass'] = svn_pass
301
229
# Make this file world-readable
302
230
# (chmod 644 conf_path)
318
247
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
319
248
% (username, unixid, unixid, username))
320
249
passwd_file.close()
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
