← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/auth/authenticate.py

  • Committer: mattgiuca
  • Date: 2008-02-18 23:59:17 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:498
apps/userservice: Now writes to req.session to avoid having to log out.
www/media/common/tos.js: Refreshes the page after receiving an accept
response.
    (This doesn't seem to wait long enough; I still need to do a manual
    refresh to get in).

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/auth/authenticate.py
17
17
 
18
18
# Module: authenticate
19
19
# Author: Matt Giuca
20
 
# Date:   19/2/2008
 
20
# Date:   1/2/2008
21
21
 
22
22
# Provides a mechanism for authenticating a username and password, and
23
23
# returning a yes/no response.
24
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(dbconn, login, password, user)
29
 
# dbconn is an open connection 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
 
from autherror import AuthError
44
 
import conf
45
25
import common.db
46
 
import common.user
47
 
 
48
 
import sys
49
 
import os
50
 
 
51
 
def authenticate(login, password):
52
 
    """Determines whether a particular login/password combination is
 
26
 
 
27
def authenticate(username, password):
 
28
    """Determines whether a particular username/password combination is
53
29
    valid. The password is in cleartext.
54
30
 
55
 
    Returns a User object containing the user's details on success.
56
 
    Raises an AuthError containing an appropriate error message on failure.
57
 
 
58
 
    The User returned is guaranteed to be in the IVLE database.
59
 
    This could be from reading or writing to the DB. If authenticate can't
60
 
    find the user in the DB, it may get user data from some other source
61
 
    (such as LDAP) and actually write it to the DB before returning.
 
31
    Returns None if failed to authenticate.
 
32
    Returns a dictionary containing the user's login fields (including
 
33
    "login", "nick" and "fullname") on success.
62
34
    """
 
35
 
 
36
    # TODO.
 
37
    # Just authenticate against the DB at the moment.
 
38
    # Later we will provide other auth options such as LDAP.
 
39
 
63
40
    # WARNING: Both username and password may contain any characters, and must
64
41
    # be sanitized within this function.
65
42
    # (Not SQL-sanitized, just sanitized to our particular constraints).
66
 
    # TODO Sanitize username
67
43
 
68
44
    # Spawn a DB object just for making this call.
69
45
    # (This should not spawn a DB connection on each page reload, only when
70
46
    # there is no session object to begin with).
71
47
    dbconn = common.db.DB()
72
 
 
73
 
    try:
74
 
        user = dbconn.get_user(login)
75
 
    except common.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, common.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:
103
 
                raise AuthError("Internal error: "
104
 
                    "Bad authentication module %s (bad return type)"
105
 
                    % repr(modname))
106
 
        # No auths checked out; fail.
107
 
        raise AuthError()
 
48
    try:
 
49
        if not dbconn.user_authenticate(username, password):
 
50
            return None
 
51
        return dbconn.get_user(username)
108
52
    finally:
109
53
        dbconn.close()
110
 
 
111
 
def simple_db_auth(dbconn, login, password, user):
112
 
    """
113
 
    A plugin auth function, as described above.
114
 
    This one just authenticates against the local database.
115
 
    Returns None if the password in the DB is NULL, indicating that another
116
 
    auth method should be used.
117
 
    Raises an AuthError if mismatched, indicating failure to auth.
118
 
    """
119
 
    if user is None:
120
 
        # The login doesn't exist. Therefore return None so we can try other
121
 
        # means of authentication.
122
 
        return None
123
 
    auth_result = dbconn.user_authenticate(login, 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 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))