← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/auth/authenticate.py

  • Committer: William Grant
  • Date: 2009-04-28 05:06:00 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428050600-hogd9d6wo7ksyqy8
ivle.database.get_store() now takes a configuration object.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/auth/authenticate.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
 
17
 
 
18
# Module: authenticate
 
19
# Author: Matt Giuca
 
20
# Date:   19/2/2008
 
21
 
 
22
# Provides a mechanism for authenticating a username and password, and
 
23
# returning a yes/no response.
 
24
 
 
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
 
39
# be found.
 
40
# Raising an AuthError implies a hard failure, with an appropriate error
 
41
# message. No more auth will be done.
 
42
 
 
43
import sys
 
44
import os
 
45
 
 
46
from ivle.auth import AuthError
 
47
import ivle.conf
 
48
import ivle.database
 
49
 
 
50
def authenticate(store, login, password):
 
51
    """Determines whether a particular login/password combination is
 
52
    valid for the given database. The password is in cleartext.
 
53
 
 
54
    Returns a User object containing the user's details on success.
 
55
    Raises an AuthError containing an appropriate error message on failure.
 
56
 
 
57
    'store' is expected to be a storm.store.Store connected to the IVLE
 
58
    database to which we should authenticate.
 
59
 
 
60
    The User returned is guaranteed to be in the IVLE database.
 
61
    This could be from reading or writing to the DB. If authenticate can't
 
62
    find the user in the DB, it may get user data from some other source
 
63
    (such as LDAP) and actually write it to the DB before returning.
 
64
    """
 
65
    # WARNING: Both username and password may contain any characters, and must
 
66
    # be sanitized within this function.
 
67
    # (Not SQL-sanitized, just sanitized to our particular constraints).
 
68
    # TODO Sanitize username
 
69
 
 
70
    # Spawn a DB object just for making this call.
 
71
    # (This should not spawn a DB connection on each page reload, only when
 
72
    # there is no session object to begin with).
 
73
 
 
74
    user = ivle.database.User.get_by_login(store, login)
 
75
 
 
76
    for modname, m in auth_modules:
 
77
        # May raise an AuthError - allow to propagate
 
78
        auth_result = m(store, login, password, user)
 
79
        if auth_result is None:
 
80
            # Can't auth with this module; try another
 
81
            pass
 
82
        elif auth_result == False:
 
83
            return None
 
84
        elif isinstance(auth_result, ivle.database.User):
 
85
            if user is not None and auth_result is not user:
 
86
                # If user is not None, then it must return the same user
 
87
                raise AuthError("Internal error: "
 
88
                    "Bad authentication module %s (changed user)"
 
89
                    % repr(modname))
 
90
            elif user is None:
 
91
                # We just got ourselves some user details from an external
 
92
                # source. Put them in the DB.
 
93
                store.add(auth_result)
 
94
 
 
95
            # Don't allow login if it is expired or disabled.
 
96
            if auth_result.state == 'disabled' or auth_result.account_expired:
 
97
                raise AuthError("Account is not valid.")
 
98
 
 
99
            return auth_result
 
100
        else:
 
101
            raise AuthError("Internal error: "
 
102
                "Bad authentication module %s (bad return type)"
 
103
                % repr(modname))
 
104
    # No auths checked out; fail.
 
105
    raise AuthError()
 
106
 
 
107
def simple_db_auth(store, login, password, user):
 
108
    """
 
109
    A plugin auth function, as described above.
 
110
    This one just authenticates against the local database.
 
111
    Returns None if the password in the DB is NULL, indicating that another
 
112
    auth method should be used.
 
113
    Raises an AuthError if mismatched, indicating failure to auth.
 
114
    """
 
115
    if user is None:
 
116
        # The login doesn't exist. Therefore return None so we can try other
 
117
        # means of authentication.
 
118
        return None
 
119
 
 
120
    # They should always match, but it's best to be sure!
 
121
    assert(user.login == login)
 
122
 
 
123
    auth_result = user.authenticate(password)
 
124
    # auth_result is either True, False (fail) or None (try another)
 
125
    if auth_result is None:
 
126
        return None
 
127
    elif auth_result:
 
128
        return user
 
129
    else:
 
130
        raise AuthError()
 
131
 
 
132
# Allow imports to get files from this directory.
 
133
# Get the directory that this module (authenticate) is in
 
134
authpath = os.path.split(sys.modules[__name__].__file__)[0]
 
135
# Add it to sys.path
 
136
sys.path.append(authpath)
 
137
 
 
138
# Create a global variable "auth_modules", a list of (name, function object)s.
 
139
# This list consists of simple_db_auth, plus the "auth" functions of all the
 
140
# plugin auth modules.
 
141
 
 
142
auth_modules = [("simple_db_auth", simple_db_auth)]
 
143
for modname in ivle.conf.auth_modules.split(','):
 
144
    try:
 
145
        mod = __import__(modname)
 
146
    except ImportError:
 
147
        raise AuthError("Internal error: Can't import auth module %s"
 
148
            % repr(modname))
 
149
    except ValueError:
 
150
        # If auth_modules is "", we may get an empty string - ignore
 
151
        continue
 
152
    try:
 
153
        authfunc = mod.auth
 
154
    except AttributeError:
 
155
        raise AuthError("Internal error: Auth module %s has no 'auth' "
 
156
            "function" % repr(modname))
 
157
    auth_modules.append((modname, authfunc))