====== authradius Plugin ======

---- plugin ----
description: Authentication using radius servers
author     : Todd Switzer
email      : toddswitzer@gmail.com 
type       : auth
lastupdate : 2013-12-11
compatible : Weatherwax
depends    : 
conflicts  : 
similar    : 
tags       : authentication, radius

downloadurl: http://toddswitzer.ca/authradius/authradius-plugin.zip
bugtracker : 
sourcerepo : 
donationurl: 

screenshot_img : 
----

===== Installation =====


:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * The [[http://pecl.php.net/package/radius|pecl/radius php package]] must be installed and the extension needs to be enabled.

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Configuration and Settings =====

Authentication is performed against a list of radius servers. A group can be provided to the user by setting the ''Class'' attribute in the radius authentication response.

The following options need to be set in the //Configuration Manager//:
  * **host** : A comma separated list of IPs or hostnames of radius servers.
  * **port** : The port to use for radius. Must be the same for all servers.
  * **timeout** : The radius timeout.
  * **tries** : The number of tries for radius to authenticate.
  * **secret** : The shared secret for the radius servers. Must be the same for all servers.
  * **mailhost** : The host to append to email addresses. User email addresses will be set to ''<username>''@''<mailhost>''.
  * **defaultgroup** : The group to give to the user if none is provided by the ''Class'' radius attribute.
  * **auth type** : Change the type of RADIUS Authentication.  Currently supported are PAP, MSCHAPV2.  Default is PAP.

Then to switch to the radius authentication set the ''Authentication backend'' to ''authradius''.

If you find yourself locked out edit the ''conf/local.php'' and change the ''authtype'' back to ''authplain''.

=== Change Log ===

  * **2013-05-27**
    * Initial release
  * **2013-05-28**
    * Added English configuration settings explanations.
  * **2013-12-11**
    * Added support for MSCHAPv2. Changes contributed by Benjamin J. Higgins.
  * **2015-10-13**
    * Added support for multiple groups. Add the list of groups for the user to the ''Class'' parameter of the RADIUS response separated by '';'' or '',''. Changes contributed by Patrick F. Marques.

=== Notes ===

  * Based on this code: https://www.dokuwiki.org/auth:radius