• *driver** option must be assigned your driver name of choice. Use the same name to locate or create a section containing the driver parameters.

   driver=XXX
   
   [XXX]
   foo=bar

An example with Db driver (user infos are stored in a database):

 driver=Db
   
 [Db]
 dao = "my_dao"
 password_crypt_function = md5

To have in-depth view of each existing drivers, or even to create one, read jAuth drivers documentation.

• *timeout option indicates inactivity duration to invalid authentication. Its unit is minutes. If you set it to 0**, there is no timeout. And the authentication session will live throughout the browser session.

Each action can declare if it needs an authentication. It is done through authentication plugin api. If all actions needs an authentication then just set auth_required to on in auth.config.ini.php file. Whereas an off specifies the contrary.

auth_required=on

In any case, you'll certainly have to deal with exceptions. Imagine you have an home page which doesn't need authentication but every other page requires one. Those exceptions are declared in controllers using auth plugin parameters.

Example:

class xxxCtrl extends jController {

    public $pluginParams = array(
        '*'=>array('auth.required'=>true),
        'index'=>array('auth.required'=>false)
    );

}

Here the auth plugin is configured to check for authentication in every action of this controller (* rule) except for index action (possibly your home page).

On the contrary, you can tell auth plugin to check for authentication only for some actions such as index and secret. See below:

class xxxCtrl extends jController {

    public $pluginParams = array(
        '*'=>array('auth.required'=>false),
        'index'=>array('auth.required'=>true),
        'secret'=>array('auth.required'=>true),
     );
}

See coordinator plugins documentation for an in-depth view of $pluginParams usage (remember that auth plugin is a coordinator plugin).

If authentication does not succeed and current action needs it, auth plugin reacts regarding to on_error option value.

If on_error=1, auth plugin will generate an error message configured by error_message option.

If on_error=2, auth plugin will execute action selected by on_error_action option. it can a controller action of auth module (default case) or any action of any other module. Basically this action will ask for login/password couple but you can imagine other scenario.

jAuth offers a way to create authentication persistence. In other words, a user will authenticate once and on every other visits, he will be automatically authenticated. This is done by a cookie which stores some user information. Even a part of them are encrypted.

To configure persistence use the parameters below:

• persistant_enable : set it to on to activate authentication persistence
• persistant_crypt_key : this one is mandatory. You must replace its default value ! It is a string composed of arbitrary chars (its length should over 10). It will be used as an encrypt key for cookie datas. If you change key value, be aware that all users will have to re-authenticate to benefit of persistence.

Other less important parameters:

• persistant_cookie_name : cookie name. Default : "jelixAuthentificationCookie".
• persistant_duration : validity time (in days) of persistence. Default is one day.
• persistant_cookie_path : cookie path. Default empty : cookie will be stored with basePath general config value.