Storage drivers

Overview

PEAR::Auth uses a number of so called storage containers to store the login data. The following passages describe all of them. If the containers that come with the package don't fit your needs, it is easy to create custom ones, also.

Database

PEAR::Auth uses the PEAR::DB abstraction layer for database access. That means that you can use all databases that are supported by the DB abstraction layer to store the login data.

The storage-specific argument for the Auth constructor() is an array.

File

The storage-specific argument for the Auth constructor() is the file name of the passwd-style file.

SMBPasswd

This storage container provides authentication against SAMBA smbpasswd files. The storage-specific argument for the Auth constructor() is the file name of the SAMBA passwd-style file.

IMAP

This storage container connects to the specified IMAP server and tries to login there with the specified username/password.

The storage-specific argument for the Auth constructor() is an array.

LDAP

The storage-specific argument for the Auth constructor() is an array.

POP3

This storage container connects to the specified POP3 server and tries to login there with the specified username/password.

The storage-specific argument for the Auth constructor() is a string of the form server:port or just server.

RADIUS

You need Auth_RADIUS and the PECL radius in order to get this container to work.

The storage-specific argument for the Auth constructor() is an array.

SOAP

The storage-specific argument for the Auth constructor() is an array.

vpopmail

This container uses an existing vpopmail service to validate the username and the password.

It does not require any storage-specific argument.

Custom Storage Containers

Example for using your own storage container

Here is a skeleton for a custom Auth storage container

include_once 'Auth/Container.php';

class CustomAuthContainer extends Auth_Container
{
    /**
     * Constructor
     */
    function CustomAuthContainer($params)
    {
      // Init Here
    }

    function fetchData($username, $password)
    {
        // Check If valid etc
        if($isvalid) {
            // Perform Some Actions
            return true;
        }
        return false;
    }
}

And here is how to use it.

include_once 'CustomAuthContainer.php';
include_once 'Auth/Auth.php';

$auth_container = new CustomAuthContainer($params);
$myauth = new Auth($auth_container);

$myauth->start();