3 * The authentication handling plugins can be used by the Session class to
4 * provide authentication.
6 * Each authenticate hook needs to:
7 * - Accept a username / password
8 * - Confirm the username / password are correct
9 * - Create (or update) a 'usr' record in our database
10 * - Return the 'usr' record as an object
11 * - Return === false when authentication fails
14 * - Configuration data will be in $c->authenticate_hook['config'], which might be an array, or whatever is needed.
16 * In order to be called:
17 * - This file should be included
18 * - $c->authenticate_hook['call'] should be set to the name of the plugin
19 * - $c->authenticate_hook['config'] should be set up with any configuration data for the plugin
22 * @subpackage AuthPlugin
23 * @author Andrew McMillan <andrew@mcmillan.net.nz>
24 * @copyright Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
25 * @license http://gnu.org/copyleft/gpl.html GNU GPL v2 or later
28 require_once('AWLUtilities.php');
29 require_once('DataUpdate.php');
32 * Authenticate against a different PostgreSQL database which contains a usr table in
37 function auth_other_awl( $username, $password ) {
40 $authconn = pg_Connect($c->authenticate_hook
['config']['connection']);
43 <html><head><title>Database Connection Failure</title></head><body>
44 <h1>Database Error</h1>
45 <h3>Could not connect to PostgreSQL database</h3>
52 if ( isset($c->authenticate_hook
['config']['columns']) )
53 $cols = $c->authenticate_hook
['config']['columns'];
57 if ( isset($c->authenticate_hook
['config']['where']) )
58 $andwhere = " AND ".$c->authenticate_hook
['config']['where'];
62 $qry = new AwlQuery("SELECT $cols FROM usr WHERE lower(username) = text(?) $andwhere", strtolower($username) );
63 $qry->SetConnection($authconn);
64 if ( $qry->Exec('Login',__LINE
,__FILE__
) && $qry->rows() == 1 ) {
66 if ( session_validate_password( $password, $usr->password
) ) {
68 $qry = new AwlQuery("SELECT * FROM usr WHERE user_no = $usr->user_no;" );
69 if ( $qry->Exec('Login',__LINE
,__FILE__
) && $qry->rows() == 1 )
74 $qry = new AwlQuery( sql_from_object( $usr, $type, 'usr', "WHERE user_no=$usr->user_no" ) );
75 $qry->Exec('Login',__LINE__
,__FILE__
);
78 * We disallow login by inactive users _after_ we have updated the local copy
80 if ( isset($usr->active
) && $usr->active
== 'f' ) return false;
92 * Authentication has already happened. We know the username, we just need
93 * to do the authorisation / access control. The password is ignored.
97 function auth_external( $username, $password ) {
100 $qry = new AwlQuery("SELECT * FROM usr WHERE active AND lower(username) = text(?) ", strtolower($username) );
101 if ( $qry->Exec('Login',__LINE__
,__FILE__
) && $qry->rows() == 1 ) {
102 $usr = $qry->Fetch();