← 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: me at id
  • Date: 2009-01-15 00:37:10 UTC
  • mto: This revision was merged to the branch mainline in revision 1090.
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:branches%2Fstorm:1141
ivle.database.User: Add an authenticate() method, and a hash_password()
     staticmethod to replace the auth functions in ivle.db.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/auth/authenticate.py
25
25
# Has a plugin interface for authentication modules.
26
26
# An authentication module is a Python module with an "auth" function,
27
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.
 
28
# plugin_module.auth(dbconn, login, password, user)
 
29
# dbconn is an open connection to the IVLE database.
30
30
# login and password are required strings, password is cleartext.
31
31
# user is a User object or None.
32
32
# If it's a User object, it must return the same object if it returns a user.
44
44
import os
45
45
 
46
46
from ivle.auth import AuthError
47
 
import ivle.database
 
47
import ivle.conf
 
48
import ivle.db
 
49
import ivle.user
48
50
 
49
 
def authenticate(config, store, login, password):
 
51
def authenticate(login, password):
50
52
    """Determines whether a particular login/password combination is
51
 
    valid for the given database. The password is in cleartext.
 
53
    valid. The password is in cleartext.
52
54
 
53
55
    Returns a User object containing the user's details on success.
54
56
    Raises an AuthError containing an appropriate error message on failure.
55
57
 
56
 
    'store' is expected to be a storm.store.Store connected to the IVLE
57
 
    database to which we should authenticate.
58
 
 
59
58
    The User returned is guaranteed to be in the IVLE database.
60
59
    This could be from reading or writing to the DB. If authenticate can't
61
60
    find the user in the DB, it may get user data from some other source
69
68
    # Spawn a DB object just for making this call.
70
69
    # (This should not spawn a DB connection on each page reload, only when
71
70
    # there is no session object to begin with).
72
 
 
73
 
    user = ivle.database.User.get_by_login(store, login)
74
 
 
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
80
 
            pass
81
 
        elif auth_result == False:
82
 
            return None
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
 
71
    dbconn = ivle.db.DB()
 
72
 
 
73
    try:
 
74
        user = dbconn.get_user(login)
 
75
    except ivle.db.DBException:
 
76
        # If our attempt to get the named user from the db fails,
 
77
        # then set user to None.
 
78
        # We may still auth (eg. by pulling details from elsewhere and writing
 
79
        # to DB).
 
80
        user = None
 
81
    try:
 
82
        for modname, m in auth_modules:
 
83
            # May raise an AuthError - allow to propagate
 
84
            auth_result = m(dbconn, login, password, user)
 
85
            if auth_result is None:
 
86
                # Can't auth with this module; try another
 
87
                pass
 
88
            elif auth_result == False:
 
89
                return None
 
90
            elif isinstance(auth_result, ivle.user.User):
 
91
                if user is not None and auth_result is not user:
 
92
                    # If user is not None, then it must return the same user
 
93
                    raise AuthError("Internal error: "
 
94
                        "Bad authentication module %s (changed user)"
 
95
                        % repr(modname))
 
96
                elif user is None:
 
97
                    # We just got ourselves some user details from an external
 
98
                    # source. Put them in the DB.
 
99
                    dbconn.create_user(auth_result)
 
100
                    pass
 
101
                return auth_result
 
102
            else:
86
103
                raise AuthError("Internal error: "
87
 
                    "Bad authentication module %s (changed user)"
 
104
                    "Bad authentication module %s (bad return type)"
88
105
                    % repr(modname))
89
 
            elif user is None:
90
 
                # We just got ourselves some user details from an external
91
 
                # source. Put them in the DB.
92
 
                store.add(auth_result)
93
 
 
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(
97
 
                    "Your account is disabled. Please contact an "
98
 
                    "administrator if you believe this to be in error.")
99
 
 
100
 
            return auth_result
101
 
        else:
102
 
            raise AuthError("Internal error: "
103
 
                "Bad authentication module %s (bad return type)"
104
 
                % repr(modname))
105
 
    # No auths checked out; fail.
106
 
    raise AuthError()
107
 
 
108
 
def simple_db_auth(store, login, password, user):
 
106
        # No auths checked out; fail.
 
107
        raise AuthError()
 
108
    finally:
 
109
        dbconn.close()
 
110
 
 
111
def simple_db_auth(dbconn, login, password, user):
109
112
    """
110
113
    A plugin auth function, as described above.
111
114
    This one just authenticates against the local database.
117
120
        # The login doesn't exist. Therefore return None so we can try other
118
121
        # means of authentication.
119
122
        return None
120
 
 
121
 
    # They should always match, but it's best to be sure!
122
 
    assert(user.login == login)
123
 
 
124
 
    auth_result = user.authenticate(password)
 
123
    auth_result = dbconn.user_authenticate(login, password)
125
124
    # auth_result is either True, False (fail) or None (try another)
126
125
    if auth_result is None:
127
126
        return None
130
129
    else:
131
130
        raise AuthError()
132
131
 
133
 
def get_auth_modules(config):
134
 
    """Get the auth modules defined in the configuration.
135
 
 
136
 
    Returns a list of (name, function object)s. This list consists of
137
 
    simple_db_auth, plus the "auth" functions of all the plugin auth modules.
138
 
    """
139
 
 
140
 
    oldpath = sys.path
141
 
    # Allow imports to get files from this directory.
142
 
    # Get the directory that this module (authenticate) is in
143
 
    authpath = os.path.split(sys.modules[__name__].__file__)[0]
144
 
    # Add it to sys.path
145
 
    sys.path.append(authpath)
146
 
 
147
 
    auth_modules = [("simple_db_auth", simple_db_auth)]
148
 
    for modname in config['auth']['modules']:
149
 
        try:
150
 
            mod = __import__(modname)
151
 
        except ImportError:
152
 
            raise AuthError("Internal error: Can't import auth module %s"
153
 
                % repr(modname))
154
 
        except ValueError:
155
 
            # If auth_modules is "", we may get an empty string - ignore
156
 
            continue
157
 
        try:
158
 
            authfunc = mod.auth
159
 
        except AttributeError:
160
 
            raise AuthError("Internal error: Auth module %s has no 'auth' "
161
 
                "function" % repr(modname))
162
 
        auth_modules.append((modname, authfunc))
163
 
 
164
 
    # Restore the old path, without this directory in it.
165
 
    sys.path = oldpath
166
 
    return auth_modules
 
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))