plugins/LdapAuthentication/README

   1 The LDAP Authentication plugin allows for StatusNet to handle authentication
   2 through LDAP.
   3
   4 Installation
   5 ============
   6 add "addPlugin('ldapAuthentication',
   7     array('setting'=>'value', 'setting2'=>'value2', ...);"
   8 to the bottom of your config.php
   9
  10 Settings
  11 ========
  12 provider_name*: This is a identifier designated to the connection.
  13     It's how StatusNet will refer to the authentication source.
  14     For the most part, any name can be used, so long as each authentication source has a different identifier.
  15     In most cases there will be only one authentication source used.
  16 authoritative (false): Set to true if LDAP's responses are authoritative
  17     (if authorative and LDAP fails, no other password checking will be done).
  18 autoregistration (false): Set to true if users should be automatically created
  19     when they attempt to login.
  20 email_changeable (true): Are users allowed to change their email address?
  21     (true or false)
  22 password_changeable (true): Are users allowed to change their passwords?
  23     (true or false)
  24 password_encoding: required if users are to be able to change their passwords
  25     Possible values are: crypt, ext_des, md5crypt, blowfish, md5, sha, ssha,
  26         smd5, ad, clear
  27
  28 host*: LDAP server name to connect to. You can provide several hosts in an
  29     array in which case the hosts are tried from left to right.
  30     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  31 port: Port on the server.
  32     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  33 version: LDAP version.
  34     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  35 starttls: TLS is started after connecting.
  36     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  37 binddn: The distinguished name to bind as (username).
  38     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  39 bindpw: Password for the binddn.
  40     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  41 basedn*: LDAP base name (root directory).
  42     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  43 options: See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  44 filter: Default search filter.
  45     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  46 scope: Default search scope.
  47     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  48 schema_cachefile: File location to store ldap schema.
  49 schema_maxage: TTL for cache file.
  50
  51 attributes: an array that relates StatusNet user attributes to LDAP ones
  52     username*: LDAP attribute value entered when authenticating to StatusNet
  53     nickname*: LDAP attribute value shown as the user's nickname
  54     email
  55     fullname
  56     homepage
  57     location
  58     password: required if users are to be able to change their passwords
  59
  60 * required
  61 default values are in (parenthesis)
  62
  63 For most LDAP installations, the "nickname" and "username" attributes should
  64     be the same.
  65
  66 Example
  67 =======
  68 Here's an example of an LDAP plugin configuration that connects to
  69     Microsoft Active Directory.
  70
  71 addPlugin('ldapAuthentication', array(
  72     'provider_name'=>'Example',
  73     'authoritative'=>true,
  74     'autoregistration'=>true,
  75     'binddn'=>'username',
  76     'bindpw'=>'password',
  77     'basedn'=>'OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
  78     'host'=>array('server1', 'server2'),
  79     'password_encoding'=>'ad',
  80     'attributes'=>array(
  81         'username'=>'sAMAccountName',
  82         'nickname'=>'sAMAccountName',
  83         'email'=>'mail',
  84         'fullname'=>'displayName',
  85         'password'=>'unicodePwd')
  86 ));
  87