1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Module: authenticate
22
# Provides a mechanism for authenticating a username and password, and
23
# returning a yes/no response.
25
# Has a plugin interface for authentication modules.
26
# An authentication module is a Python module with an "auth" function,
27
# which accepts 3 positional arguments.
28
# plugin_module.auth(store, login, password, user)
29
# store is an open store connected to the IVLE database.
30
# login and password are required strings, password is cleartext.
31
# user is a User object or None.
32
# If it's a User object, it must return the same object if it returns a user.
33
# This object should describe the user logging in.
34
# It may be None if the user is not known to this DB.
35
# Returns either a User object or None, or raises an AuthError.
36
# Returning a User object implies success, and also gives details about the
37
# user if none were known to the DB (such details will be written to the DB).
38
# Returning None implies a soft failure, and that another auth method should
40
# Raising an AuthError implies a hard failure, with an appropriate error
41
# message. No more auth will be done.
46
from ivle.auth import AuthError
49
def authenticate(config, store, login, password):
50
"""Determines whether a particular login/password combination is
51
valid for the given database. The password is in cleartext.
53
Returns a User object containing the user's details on success.
54
Raises an AuthError containing an appropriate error message on failure.
56
'store' is expected to be a storm.store.Store connected to the IVLE
57
database to which we should authenticate.
59
The User returned is guaranteed to be in the IVLE database.
60
This could be from reading or writing to the DB. If authenticate can't
61
find the user in the DB, it may get user data from some other source
62
(such as LDAP) and actually write it to the DB before returning.
64
# WARNING: Both username and password may contain any characters, and must
65
# be sanitized within this function.
66
# (Not SQL-sanitized, just sanitized to our particular constraints).
67
# TODO Sanitize username
69
# Spawn a DB object just for making this call.
70
# (This should not spawn a DB connection on each page reload, only when
71
# there is no session object to begin with).
73
user = ivle.database.User.get_by_login(store, login)
75
for modname, m in get_auth_modules(config):
76
# May raise an AuthError - allow to propagate
77
auth_result = m(store, login, password, user)
78
if auth_result is None:
79
# Can't auth with this module; try another
81
elif auth_result == False:
83
elif isinstance(auth_result, ivle.database.User):
84
if user is not None and auth_result is not user:
85
# If user is not None, then it must return the same user
86
raise AuthError("Internal error: "
87
"Bad authentication module %s (changed user)"
90
# We just got ourselves some user details from an external
91
# source. Put them in the DB.
92
store.add(auth_result)
94
# Don't allow login if it is expired or disabled.
95
if auth_result.state == 'disabled' or auth_result.account_expired:
96
raise AuthError("Account is not valid.")
100
raise AuthError("Internal error: "
101
"Bad authentication module %s (bad return type)"
103
# No auths checked out; fail.
106
def simple_db_auth(store, login, password, user):
108
A plugin auth function, as described above.
109
This one just authenticates against the local database.
110
Returns None if the password in the DB is NULL, indicating that another
111
auth method should be used.
112
Raises an AuthError if mismatched, indicating failure to auth.
115
# The login doesn't exist. Therefore return None so we can try other
116
# means of authentication.
119
# They should always match, but it's best to be sure!
120
assert(user.login == login)
122
auth_result = user.authenticate(password)
123
# auth_result is either True, False (fail) or None (try another)
124
if auth_result is None:
131
def get_auth_modules(config):
132
"""Get the auth modules defined in the configuration.
134
Returns a list of (name, function object)s. This list consists of
135
simple_db_auth, plus the "auth" functions of all the plugin auth modules.
139
# Allow imports to get files from this directory.
140
# Get the directory that this module (authenticate) is in
141
authpath = os.path.split(sys.modules[__name__].__file__)[0]
143
sys.path.append(authpath)
145
auth_modules = [("simple_db_auth", simple_db_auth)]
146
for modname in config['auth']['modules']:
148
mod = __import__(modname)
150
raise AuthError("Internal error: Can't import auth module %s"
153
# If auth_modules is "", we may get an empty string - ignore
157
except AttributeError:
158
raise AuthError("Internal error: Auth module %s has no 'auth' "
159
"function" % repr(modname))
160
auth_modules.append((modname, authfunc))
162
# Restore the old path, without this directory in it.
added
removed
ivle/auth/authenticate.py
