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