← 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-19 08:26:11 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:509
common.db: Rewrote user_authenticate to return 3 values (True, false, None)
    Now returns False if the password did not match, None if the password
    field is NULL (None implying a soft failure, with the possibility of
    validating against LDAP or something else).

auth.authenticate: Rewrote this module with a new plugin interface
    (as discussed with Tom Conway). Allows successive modules to try to
    authenticate the user.
    Changed the authenticate function interface: Now raises an AuthError
    when auth fails, instead of returning None.

dispatch.login: Handle new auth interface (exception catch).
    Auth is now able to provide an error message, in the exception.
    The exception message is displayed as an error to the user.

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:   1/2/2008
 
20
# Date:   19/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 callable object which accepts 3 positional
 
27
# arguments.
 
28
# plugin_auth_func(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
 
25
43
import common.db
26
 
 
27
 
def authenticate(username, password):
28
 
    """Determines whether a particular username/password combination is
 
44
import common.user
 
45
 
 
46
class AuthError(Exception):
 
47
    def __init__(self, message="Invalid username or password."):
 
48
        self.message = message
 
49
        self.args = (message,)
 
50
 
 
51
def authenticate(login, password):
 
52
    """Determines whether a particular login/password combination is
29
53
    valid. The password is in cleartext.
30
54
 
31
 
    Returns None if failed to authenticate.
32
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.
33
62
    """
34
 
 
35
 
    # TODO.
36
 
    # Just authenticate against the DB at the moment.
37
 
    # Later we will provide other auth options such as LDAP.
38
 
 
39
63
    # WARNING: Both username and password may contain any characters, and must
40
64
    # be sanitized within this function.
41
65
    # (Not SQL-sanitized, just sanitized to our particular constraints).
 
66
    # TODO Sanitize username
42
67
 
43
68
    # Spawn a DB object just for making this call.
44
69
    # (This should not spawn a DB connection on each page reload, only when
45
70
    # there is no session object to begin with).
46
71
    dbconn = common.db.DB()
 
72
    user = dbconn.get_user(login)
47
73
    try:
48
 
        if not dbconn.user_authenticate(username, password):
49
 
            return None
50
 
        return dbconn.get_user(username)
 
74
        for m in auth_modules:
 
75
            # May raise an AuthError - allow to propagate
 
76
            auth_result = m(dbconn, login, password, user)
 
77
            if auth_result is None:
 
78
                # Can't auth with this module; try another
 
79
                pass
 
80
            elif auth_result == False:
 
81
                return None
 
82
            elif isinstance(auth_result, common.user.User):
 
83
                if user is not None and auth_result is not user:
 
84
                    # If user is not None, then it must return the same user
 
85
                    raise AuthError("Internal error: "
 
86
                        "Bad authentication module (changed user)")
 
87
                if user is None:
 
88
                    # We just got ourselves some user details from an external
 
89
                    # source. Put them in the DB.
 
90
                    # TODO: Write user to DB
 
91
                    pass
 
92
                return auth_result
 
93
            else:
 
94
                raise AuthError("Internal error: "
 
95
                    "Bad authentication module (bad return type)")
 
96
        # No auths checked out; fail.
 
97
        raise AuthError()
51
98
    finally:
52
99
        dbconn.close()
 
100
 
 
101
def simple_db_auth(dbconn, login, password, user):
 
102
    """
 
103
    A plugin auth function, as described above.
 
104
    This one just authenticates against the local database.
 
105
    Returns None if the password in the DB is NULL, indicating that another
 
106
    auth method should be used.
 
107
    Raises an AuthError if mismatched, indicating failure to auth.
 
108
    """
 
109
    auth_result = dbconn.user_authenticate(login, password)
 
110
    # auth_result is either True, False (fail) or None (try another)
 
111
    if auth_result is None:
 
112
        return None
 
113
    elif auth_result:
 
114
        return user
 
115
    else:
 
116
        raise AuthError()
 
117
 
 
118
# List of auth plugin modules, in the order to try them
 
119
auth_modules = [
 
120
    simple_db_auth,
 
121
]