← 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 07:12:38 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:506
dispatch.__init__, dispatch.request, cgirequest:
    Removed "username" attribute from Request objects altogether.
    Use req.user.login instead.
consoleservice, userservice, fileservice, debuginfo, studpath:
    Replaced use of "req.username" with "req.user.login".
Yay, refactor complete!

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/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:   1/2/2008
 
21
 
 
22
# Provides a mechanism for authenticating a username and password, and
 
23
# returning a yes/no response.
 
24
 
 
25
import common.db
 
26
 
 
27
def authenticate(username, password):
 
28
    """Determines whether a particular username/password combination is
 
29
    valid. The password is in cleartext.
 
30
 
 
31
    Returns None if failed to authenticate.
 
32
    Returns a User object containing the user's details on success.
 
33
    """
 
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
    # WARNING: Both username and password may contain any characters, and must
 
40
    # be sanitized within this function.
 
41
    # (Not SQL-sanitized, just sanitized to our particular constraints).
 
42
 
 
43
    # Spawn a DB object just for making this call.
 
44
    # (This should not spawn a DB connection on each page reload, only when
 
45
    # there is no session object to begin with).
 
46
    dbconn = common.db.DB()
 
47
    try:
 
48
        if not dbconn.user_authenticate(username, password):
 
49
            return None
 
50
        return dbconn.get_user(username)
 
51
    finally:
 
52
        dbconn.close()