====== authplaincas Plugin ======

---- plugin ----
description: CAS authentication plugin without LDAP but with CAS attributes
author     : Fabian Bircher
email      : fabian at esn dot org
type       : Auth
lastupdate : 2016-07-22
compatible : Frusterick Manners, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor Of Tsort
depends    : 
conflicts  : 
similar    : 
tags       : authentication, CAS, plain

downloadurl: https://github.com/esn-org/authplaincas/zipball/master
bugtracker : https://github.com/esn-org/authplaincas/issues
sourcerepo : https://github.com/esn-org/authplaincas/
donationurl: 

screenshot_img : 
----


===== Installation =====


:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[https://wiki.jasig.org/display/CASC/phpCAS|phpCAS library]]
  * [[https://github.com/Jasig/phpCAS/archive/master.zip|or from github]]

PHP needs to be configured with curl and xml support for phpCAS to work see [[https://wiki.jasig.org/display/CASC/phpCAS+requirements|phpCAS requirements]]

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

:!: You have to download the [[https://wiki.jasig.org/display/CASC/phpCAS|phpCAS library]] and place it in the folder of the plugin so that the file ''lib/plugins/authplaincas/phpCAS/CAS.php'' exists.


===== Configuration and Settings =====
=== settings file ===

To really use this authentication plugin some customization is necessary next to the settings available in the plugin settings interface.

You should copy the file ''plaincas.settings.php'' to your ''conf'' folder and do the modifications there.
(alternatively you can move it wherever you want and specify the path in the ''conf/local.protected.php'' file (create when not existing) with ''$conf['plugin']['authplaincas']['settings_file']'')

The four functions in ''plaincas.settings.php'' are slightly documented.

In general the procedure is as follows:
  - The CAS attributes are fetched through the phpCAS library
  - The CAS attributes are passed to the functions in the ''plaincas.settings.php'' file
  - The mail and name are returned based on the attributes in ''plaincas_user_attributes''
  - The attributes for the groups are assembled and returned in ''plaincas_pattern_attributes''
  - All elements of the array returned in ''plaincas_pattern_attributes'' are checked against the regular expressions returned from ''plaincas_group_patterns''
  - The keys of the expressions which match will be assigned as groups of the user.

=== minimal users ===
Maybe you don't want everybody from the CAS server to log in on your dokuwiki?

No problem! specify a comma separated list of groups of which at least one has to be assigned in order for the user to be saved.

=== custom groups ===
You want to assign groups to certain usernames rather than the CAS attributes?

No problem! in the ''plaincas.settings.php'' file you can return an array with the function ''plaincas_custom_groups'' with the groups as keys and an array with the usernames as values.


==== ToDo/Wish List ====

In the future the plugin could also support the local users list that [[plugin:authplain|authplain]] uses.

==== Debugging ====

Make sure the newest version of the plugin is installed.  If using the plugin manager make sure the current version is installed.  If you continue to have problems put this in conf/local.php
''$conf['plugin']['authplaincas']['debug'] = TRUE;''


===== FAQ =====

//[discussions should ideally be deleted and turned into FAQ entries along the way]//

===== Discussion =====

//Could be placed on an external page (e.g. plugin:pluginname:discussion) to have a distinction between user comments and author docs//