Docs for page AuthPlugins.php

## /AuthPlugins.php

Description

The authentication handling plugins can be used by the Session class to provide authentication.

Each authenticate hook needs to:

- Accept a username / password
- Confirm the username / password are correct
- Create (or update) a 'usr' record in our database
- Return the 'usr' record as an object
- Return === false when authentication fails

It can expect that:

- Configuration data will be in $c->authenticate_hook['config'], which might be an array, or whatever is needed.

In order to be called:

- This file should be included
- $c->authenticate_hook['call'] should be set to the name of the plugin
- $c->authenticate_hook['config'] should be set up with any configuration data for the plugin

- author: Andrew McMillan <andrew@mcmillan.net.nz>
- copyright: Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
- license: GNU GPL v2 or later

Includes
require_once ('AWLUtilities.php') (line 28)
require_once ('DataUpdate.php') (line 29)
Functions
auth_external (line 97)

Authentication has already happened. We know the username, we just need to do the authorisation / access control. The password is ignored.

void auth_external ( $username, $password)

- $username
- $password

auth_other_awl (line 37)

Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.

void auth_other_awl ( $username, $password)

- $username
- $password

Documentation generated on Fri, 13 Jan 2012 23:40:12 +1300 by phpDocumentor 1.4.3