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).
48
import ivle.pulldown_subj
31
from ivle.database import ProjectGroup, User
50
from ivle.database import ProjectGroup
33
52
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.
54
Chowns a file so the web server user owns it.
55
(This is useful in setting up Subversion conf files).
39
subprocess.call(['chown', '-R', 'www-data:www-data', filename])
59
os.system("chown -R www-data:www-data %s" % filename)
41
63
def make_svn_repo(path, throw_on_error=True):
42
"""Create a Subversion repository at the given path."""
64
"""Create a Subversion repository at the given path.
44
res = subprocess.call(['svnadmin', 'create', path])
67
res = os.system("svnadmin create '%s'" % path)
45
68
if res != 0 and throw_on_error:
46
69
raise Exception("Cannot create repository: %s" % path)
47
70
except Exception, exc:
52
75
chown_to_webserver(path)
54
def rebuild_svn_config(store, config):
77
def rebuild_svn_config(store):
55
78
"""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()})
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)))
72
""" % {'login': u.login})
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")
75
os.rename(temp_name, conf_name)
76
chown_to_webserver(conf_name)
99
os.rename(ivle.conf.svn_conf + ".new", ivle.conf.svn_conf)
100
chown_to_webserver(ivle.conf.svn_conf)
78
def rebuild_svn_group_config(store, config):
102
def rebuild_svn_group_config(store):
79
103
"""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()})
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())
93
109
for group in store.find(ProjectGroup):
94
110
offering = group.project_set.offering
95
111
reponame = "_".join([offering.subject.short_name,
96
112
offering.semester.year,
97
113
offering.semester.semester,
100
f.write("[%s:/]\n" % reponame)
115
f.write("[%s:/]\n"%reponame)
101
116
for user in group.members:
102
117
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.
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.
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):
127
passwd = md5.new(uuid.uuid4().bytes).digest().encode('hex')
128
if os.path.exists(ivle.conf.svn_auth_ivle):
123
user = User.get_by_login(store, login)
133
user = ivle.database.User.get_by_login(store, login)
124
134
user.svn_pass = unicode(passwd)
126
res = subprocess.call(['htpasswd', '-%smb' % create,
127
filename, login, passwd])
136
res = os.system("htpasswd -%smb %s %s %s" % (create,
137
ivle.conf.svn_auth_ivle,
128
139
if res != 0 and throw_on_error:
129
140
raise Exception("Unable to create ivle-auth for %s" % login)
131
142
# Make sure the file is owned by the web server
132
143
if create == "c":
133
chown_to_webserver(filename)
144
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.
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.
143
184
Returns the path to the user's home directory.
145
186
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.
188
force: If false, exception if jail already exists for this user.
189
If true (default), overwrites it, but preserves home directory.
150
191
# MUST run as root or some of this may fail
151
192
if os.getuid() != 0:
152
193
raise Exception("Must run make_jail as root")
154
195
# tempdir is for putting backup homes in
155
jail_src_base = config['paths']['jails']['src']
156
tempdir = os.path.join(jail_src_base, '__temp__')
196
tempdir = os.path.join(ivle.conf.jail_src_base, '__temp__')
157
197
if not os.path.exists(tempdir):
158
198
os.makedirs(tempdir)
159
199
elif not os.path.isdir(tempdir):
160
200
os.unlink(tempdir)
161
201
os.mkdir(tempdir)
162
userdir = os.path.join(jail_src_base, user.login)
202
userdir = os.path.join(ivle.conf.jail_src_base, user.login)
163
203
homedir = os.path.join(userdir, 'home')
164
204
userhomedir = os.path.join(homedir, user.login) # Return value
196
234
# Chmod to rwxr-xr-x (755)
197
235
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'],
237
make_conf_py(user.login, userdir, user.svn_pass)
238
make_etc_passwd(user.login, userdir, ivle.conf.jail_system, user.unixid)
203
240
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.
242
def make_conf_py(username, user_jail_dir, svn_pass):
208
244
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).
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.
216
conf_path = os.path.join(user_jail_dir, "etc/ivle/ivle.conf")
250
conf_path = os.path.join(user_jail_dir,
251
ivle.conf.python_site_packages[1:], "ivle/conf/conf.py")
217
252
os.makedirs(os.path.dirname(conf_path))
219
254
# In the "in-jail" version of conf, we don't need MOST of the details
220
255
# (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
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,
231
295
# Make this file world-readable
232
296
# (chmod 644 conf_path)
added
removed
ivle/makeuser.py
