gnu-social/plugins/CasAuthentication
Craig Andrews 176e0fdab7 Add missing required line so this plugin works if it's the first (or only) Authentication Plugin in use 2009-12-30 19:18:06 -05:00
..
extlib First version of a CAS authentication plugin 2009-12-22 17:53:24 -05:00
CasAuthenticationPlugin.php Add missing required line so this plugin works if it's the first (or only) Authentication Plugin in use 2009-12-30 19:18:06 -05:00
README First version of a CAS authentication plugin 2009-12-22 17:53:24 -05:00
caslogin.php First version of a CAS authentication plugin 2009-12-22 17:53:24 -05:00

README

The CAS Authentication plugin allows for StatusNet to handle authentication
through CAS (Central Authentication Service).

Installation
============
add "addPlugin('casAuthentication',
    array('setting'=>'value', 'setting2'=>'value2', ...);"
to the bottom of your config.php

Settings
========
provider_name*: a unique name for this authentication provider.
authoritative (false): Set to true if CAS's responses are authoritative
    (if authorative and CAS fails, no other password checking will be done).
autoregistration (false): Set to true if users should be automatically created
    when they attempt to login.
email_changeable (true): Are users allowed to change their email address?
    (true or false)
password_changeable*: must be set to false. This plugin does not support changing passwords.

server*: CAS server to authentication against
port (443): Port the CAS server listens on. Almost always 443
path (): Path on the server to CAS. Usually blank.

* required
default values are in (parenthesis)

Example
=======
addPlugin('casAuthentication', array(
    'provider_name'=>'Example',
    'authoritative'=>true,
    'autoregistration'=>true,
    'server'=>'sso-cas.univ-rennes1.fr',
    'port'=>443,
    'path'=>''
));