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).
49
import ivle.pulldown_subj
31
from ivle.database import ProjectGroup, User
51
from ivle.database import ProjectGroup
33
53
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.
55
Chowns a file so the web server user owns it.
56
(This is useful in setting up Subversion conf files).
39
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
60
os.system("chown -R www-data:www-data %s" % filename)
41
64
def make_svn_repo(path, throw_on_error=True):
42
"""Create a Subversion repository at the given path."""
65
"""Create a Subversion repository at the given path.
44
res = subprocess.call(['svnadmin', 'create', path])
68
res = os.system("svnadmin create '%s'" % path)
45
69
if res != 0 and throw_on_error:
46
70
raise Exception("Cannot create repository: %s" % path)
47
71
except Exception, exc:
52
76
chown_to_webserver(path)
54
def rebuild_svn_config(store, config):
78
def rebuild_svn_config(store):
55
79
"""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})
81
users = store.find(ivle.database.User)
85
if role not in groups:
87
groups[role].append(u.login)
88
f = open(ivle.conf.svn_conf + ".new", "w")
89
f.write("# IVLE SVN Repositories Configuration\n")
90
f.write("# Auto-generated on %s\n" % time.asctime())
93
for (g,ls) in groups.iteritems():
94
f.write("%s = %s\n" % (g, ",".join(ls)))
97
f.write("[%s:/]\n" % u.login)
98
f.write("%s = rw\n" % u.login)
99
#f.write("@tutor = r\n")
100
#f.write("@lecturer = rw\n")
101
#f.write("@admin = rw\n")
75
os.rename(temp_name, conf_name)
76
chown_to_webserver(conf_name)
104
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
105
chown_to_webserver(ivle.conf.svn_conf)
78
def rebuild_svn_group_config(store, config):
107
def rebuild_svn_group_config(store):
79
108
"""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()})
110
f = open(ivle.conf.svn_group_conf + ".new", "w")
111
f.write("# IVLE SVN Group Repositories Configuration\n")
112
f.write("# Auto-generated on %s\n" % time.asctime())
93
114
for group in store.find(ProjectGroup):
94
115
offering = group.project_set.offering
95
116
reponame = "_".join([offering.subject.short_name,
96
117
offering.semester.year,
97
118
offering.semester.semester,
100
f.write("[%s:/]\n" % reponame)
120
f.write("[%s:/]\n"%reponame)
101
121
for user in group.members:
102
122
f.write("%s = rw\n" % user.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.
125
os.rename(ivle.conf.svn_group_conf + ".new", ivle.conf.svn_group_conf)
126
chown_to_webserver(ivle.conf.svn_group_conf)
128
def make_svn_auth(store, login, throw_on_error=True):
129
"""Setup svn authentication for the given user.
130
Uses the given DB store object. Does not commit to the db.
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):
132
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
133
if os.path.exists(ivle.conf.svn_auth_ivle):
123
user = User.get_by_login(store, login)
138
user = ivle.database.User.get_by_login(store, login)
124
139
user.svn_pass = unicode(passwd)
126
res = subprocess.call(['htpasswd', '-%smb' % create,
127
filename, login, passwd])
141
res = os.system("htpasswd -%smb %s %s %s" % (create,
142
ivle.conf.svn_auth_ivle,
128
144
if res != 0 and throw_on_error:
129
145
raise Exception("Unable to create ivle-auth for %s" % login)
131
147
# Make sure the file is owned by the web server
132
148
if create == "c":
133
chown_to_webserver(filename)
149
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.
153
def generate_manifest(basedir, targetdir, parent=''):
154
""" From a basedir and a targetdir work out which files are missing or out
155
of date and need to be added/updated and which files are redundant and need
158
parent: This is used for the recursive call to track the relative paths
159
that we have decended.
162
cmp = filecmp.dircmp(basedir, targetdir)
164
# Add all new files and files that have changed
165
to_add = [os.path.join(parent,x) for x in (cmp.left_only + cmp.diff_files)]
167
# Remove files that are redundant
168
to_remove = [os.path.join(parent,x) for x in cmp.right_only]
171
for d in cmp.common_dirs:
172
newbasedir = os.path.join(basedir, d)
173
newtargetdir = os.path.join(targetdir, d)
174
newparent = os.path.join(parent, d)
175
(sadd,sremove) = generate_manifest(newbasedir, newtargetdir, newparent)
179
return (to_add, to_remove)
182
def make_jail(user, force=True):
183
"""Creates a new user's jail space, in the jail directory as configured in
186
This only creates things within /home - everything else is expected to be
187
part of another UnionFS branch.
143
189
Returns the path to the user's home directory.
145
191
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.
193
force: If false, exception if jail already exists for this user.
194
If true (default), overwrites it, but preserves home directory.
150
196
# MUST run as root or some of this may fail
151
197
if os.getuid() != 0:
152
198
raise Exception("Must run make_jail as root")
154
200
# tempdir is for putting backup homes in
155
jail_src_base = config['paths']['jails']['src']
156
tempdir = os.path.join(jail_src_base, '__temp__')
201
tempdir = os.path.join(ivle.conf.jail_base, '__temp__')
157
202
if not os.path.exists(tempdir):
158
203
os.makedirs(tempdir)
159
204
elif not os.path.isdir(tempdir):
160
205
os.unlink(tempdir)
161
206
os.mkdir(tempdir)
162
userdir = os.path.join(jail_src_base, user.login)
207
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
163
208
homedir = os.path.join(userdir, 'home')
164
209
userhomedir = os.path.join(homedir, user.login) # Return value
173
218
warnings.simplefilter('ignore')
174
219
homebackup = os.tempnam(tempdir)
175
220
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.
221
# Note: shutil.move does not behave like "mv" - it does not put a file
222
# into a directory if it already exists, just fails. Therefore it is
223
# not susceptible to tmpnam symlink attack.
181
224
shutil.move(homedir, homebackup)
182
225
shutil.rmtree(userdir)
184
227
shutil.move(homebackup, homedir)
185
228
# Change the ownership of all the files to the right unixid
186
229
logging.debug("chown %s's home directory files to uid %d"
187
230
%(user.login, user.unixid))
188
os.spawnvp(os.P_WAIT, 'chown', ['chown', '-R', '%d:%d' % (user.unixid,
189
user.unixid), userhomedir])
231
os.chown(userhomedir, user.unixid, user.unixid)
232
for root, dirs, files in os.walk(userhomedir):
233
for fsobj in dirs + files:
234
os.chown(os.path.join(root, fsobj), user.unixid, user.unixid)
191
236
# No user jail exists
192
237
# Set up the user's home directory
196
241
# Chmod to rwxr-xr-x (755)
197
242
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'],
244
make_conf_py(user.login, userdir, ivle.conf.jail_system, user.svn_pass)
245
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
203
247
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.
249
def make_conf_py(username, user_jail_dir, staging_dir, svn_pass):
208
251
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).
252
file ${python_site_packages}/ivle/conf/conf.py in a given user's jail.
254
user_jail_dir: User's jail dir, ie. ivle.conf.jail_base + username
255
staging_dir: The dir with the staging copy of the jail. (With the
256
template conf.py file).
257
svn_pass: As with make_jail. User's SVN password, but if not supplied,
258
will look up in the DB.
216
conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
260
template_conf_path = os.path.join(staging_dir,
261
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
262
conf_path = os.path.join(user_jail_dir,
263
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
217
264
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
266
# Read the contents of the template conf file
268
template_conf_file = open(template_conf_path, "r")
269
template_conf_data = template_conf_file.read()
270
template_conf_file.close()
272
# Couldn't open template conf.py for some reason
273
# Just treat it as empty file
274
template_conf_data = ("# Warning: Problem building config script.\n"
275
"# Could not find template conf.py file.\n")
277
conf_file = open(conf_path, "w")
278
conf_file.write(template_conf_data)
279
conf_file.write("\n# The login name for the owner of the jail\n")
280
conf_file.write("login = %s\n" % repr(username))
281
conf_file.write("\n")
282
conf_file.write("# The subversion-only password for the owner of "
284
conf_file.write("svn_pass = %s\n" % repr(svn_pass))
231
287
# Make this file world-readable
232
288
# (chmod 644 conf_path)
249
304
passwd_file.write('%s:x:%d:%d::/home/%s:/bin/bash'
250
305
% (username, unixid, unixid, username))
251
306
passwd_file.close()
308
def make_user_db(throw_on_error = True, **kwargs):
309
"""Creates a user's entry in the database, filling in all the fields.
310
All arguments must be keyword args. They are the fields in the table.
311
However, instead of supplying a "passhash", you must supply a
312
"password" argument, which will be hashed internally.
313
Also do not supply a state. All users are created in the "no_agreement"
315
Also pulls the user's subjects using the configured subject pulldown
316
module, and adds enrolments to the DB.
317
Throws an exception if the user already exists.
319
dbconn = ivle.db.DB()
320
dbconn.create_user(**kwargs)
323
# Pulldown subjects and add enrolments
324
ivle.pulldown_subj.enrol_user(kwargs['login'])
326
def mount_jail(login):
327
# This is where we'll mount to...
328
destdir = os.path.join(ivle.conf.jail_base, login)
329
# ... and this is where we'll get the user bits.
330
srcdir = os.path.join(ivle.conf.jail_src_base, login)
332
if not os.path.exists(destdir):
334
if os.system('/bin/mount -t aufs -o dirs=%s:%s=ro none %s'
335
% (srcdir, ivle.conf.jail_system, destdir)) == 0:
336
logging.info("mounted user %s's jail." % login)
338
logging.error("failed to mount user %s's jail!" % login)
339
except Exception, message:
340
logging.warning(str(message))
added
removed
ivle/makeuser.py
