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*: a unique name for this authentication provider.
  13 authoritative (false): Set to true if LDAP's responses are authoritative
  14     (if authorative and LDAP fails, no other password checking will be done).
  15 autoregistration (false): Set to true if users should be automatically created
  16     when they attempt to login.
  17 email_changeable (true): Are users allowed to change their email address?
  18     (true or false)
  19 password_changeable (true): Are users allowed to change their passwords?
  20     (true or false)
  21 password_encoding: required if users are to be able to change their passwords
  22     Possible values are: crypt, ext_des, md5crypt, blowfish, md5, sha, ssha,
  23         smd5, ad, clear
  24
  25 host*: LDAP server name to connect to. You can provide several hosts in an
  26     array in which case the hosts are tried from left to right.
  27     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  28 port: Port on the server.
  29     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  30 version: LDAP version.
  31     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  32 starttls: TLS is started after connecting.
  33     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  34 binddn: The distinguished name to bind as (username).
  35     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  36 bindpw: Password for the binddn.
  37     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  38 basedn*: LDAP base name (root directory).
  39     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  40 options: See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  41 filter: Default search filter.
  42     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  43 scope: Default search scope.
  44     See http://pear.php.net/manual/en/package.networking.net-ldap2.connecting.php
  45
  46 attributes: an array that relates StatusNet user attributes to LDAP ones
  47     username*: LDAP attribute value entered when authenticating to StatusNet
  48     nickname*: LDAP attribute value shown as the user's nickname
  49     email
  50     fullname
  51     homepage
  52     location
  53     password: required if users are to be able to change their passwords
  54
  55 * required
  56 default values are in (parenthesis)
  57
  58 For most LDAP installations, the "nickname" and "username" attributes should
  59     be the same.
  60
  61 Example
  62 =======
  63 Here's an example of an LDAP plugin configuration that connects to
  64     Microsoft Active Directory.
  65
  66 addPlugin('ldapAuthentication', array(
  67     'provider_name'=>'Example',
  68     'authoritative'=>true,
  69     'autoregistration'=>true,
  70     'binddn'=>'username',
  71     'bindpw'=>'password',
  72     'basedn'=>'OU=Users,OU=StatusNet,OU=US,DC=americas,DC=global,DC=loc',
  73     'host'=>array('server1', 'server2'),
  74     'password_encoding'=>'ad',
  75     'attributes'=>array(
  76         'username'=>'sAMAccountName',
  77         'nickname'=>'sAMAccountName',
  78         'email'=>'mail',
  79         'fullname'=>'displayName',
  80         'password'=>'unicodePwd')
  81 ));
  82