This is a module for Jelix, providing a plugin for jAuth allowing to authenticate with an ldap server, and register them in the app database, using a dao. This module is for Jelix 1.6.x and higher. Installation ============ Configuration with Jelix 1.7 ---------------------------- You should use Composer to install the module. Run this commands in a shell: ``` composer require "jelix/ldapdao-module" ``` Launch the configurator for your application to enable the module ```bash php yourapp/dev.php module:configure ldapdao ``` Configuration with Jelix 1.6 ----------------------------- Copy the `ldapdao` directory into the modules/ directory of your application. Next you must say to Jelix that you want to use the module. Declare it into the `var/config/mainconfig.ini.php` file. In the `[modules]` section, add: ```ini ldapdao.access=1 ``` Following modules are required: jacl2, jauth, jauthdb. In this same section verify that they are activated: ```ini jacl2.access=1 jauth.access=2 jauthdb.access=1 ``` If you are using the jCommunity module, you must not activate jauth and jauthdb, so keep `jauth.access=0` and `jauthdb.access=0`. Launch the installer -------------------- In the command line, launch: ``` php yourapp/install/installer.php ``` Install other languages ----------------------- The module is provided with english and french content. If you want other languages, you should retrieve them from https://download.jelix.org/jelix/langpacks/ldapdao/. Unzip the archives into `app/locales/` or `var/locales/`. Configuration ============= This module provides two things: 1. a plugin, ```ldapdao```, for jAuth 2. a configuration file for the ```auth``` plugin for jCoordinator. The ```ldapdao``` plugin replaces the `db` or `ldap` plugin for jAuth. The installer of the module deactivates some jAcl2 rights, and copy an example of the configuration file `authldap.coord.ini.php` into the configuration directory (`var/config` in Jelix 1.6, `app/system` in Jelix 1.7). You should edit the new file `authldap.coord.ini.php`. Many properties should be changed to match your ldap structure. Second, you should indicate this new configuration file into the mainconfig.ini.php file, in the `coordplugins` section: ``` [coordplugins] auth="authldap.coord.ini.php" ``` General configuration properties --------------------------------- First you should set the `dao`, `profile`, `ldapprofile` and `form` properties in the `ldapdao` section of `authldap.coord.ini.php`, to indicate the dao (for the table), the form (for the administration module) and profiles to access to the database and the ldap. Here is an example: ``` [ldapdao] ; name of the dao to get user data. It may differ depending ; to the application dao = "jauthdb~jelixuser" ; name of the form for the jauthdb_admin module. It may differ depending ; to the application form = "jauthdb_admin~jelixuser" ; profile to use for jDb profile = "myldapdao" ; profile to use for ldap ldapprofile = "ldapdao" ``` For profiles, you should set connections parameters into the `var/config/profiles.ini.php` file. Example of a profile for the dao: ``` [jdb:myldapdao] driver="mysqli" host= "localhost" database="userdb" user= "admin" password="jelix" persistent= on force_encoding = on ``` Here the profile is named `myldapdao` so you should set `profile=myldapdao` into `authldap.coord.ini.php`. Connection configuration ------------------------ You should create an ldap profile, with the name indicated into the `ldapprofile` parameter. The ldap profile should be into the `var/config/profiles.ini.php` file. For example, if the profile is named `myldap` (like in the following example), so you should set `ldapprofile=myldap` into `authldap.coord.ini.php`. Example of a profile for the ldap connection: ``` [ldap:ldapdao] hostname=localhost port=389 tlsMode=starttls ; empty, "starttls" or "ldaps" (ldaps by default if port 636) adminUserDn="cn=admin,ou=admins,dc=acme" adminPassword="Sup3rP4ssw0rd" searchUserBaseDN="dc=XY,dc=fr" searchUserFilter="(&(objectClass=posixAccount)(uid=%%LOGIN%%))" bindUserDN="uid=%?%,ou=users,dc=XY,dc=fr" searchAttributes="uid:login,givenName:firstname,sn:lastname,mail:email" searchGroupFilter="(&(objectClass=posixGroup)(cn=XYZ*)(memberUid=%%LOGIN%%))" searchGroupProperty="cn" searchGroupBaseDN="" ``` First, you should set `hostname`, `port`, which are the name and the port of the ldap server. You must also indicate how the connexion should be made. You should indicate if you are using the ldap protocol without encryption (`tlsmode=`), the ldap protocol with STARTTLS, (`tlsMode=starttls`) or if you are using the ldaps protocol (`tlsMode=ldaps`). If you use the standard port 389, you have the choice between no encryption (empty value) or `starttls`, for the `tlsMode` setting. If you are using the port 636, it automatically uses the ldaps protocol. In this case, setting `tlsMode` to `ldaps` is optional. Since ldaps is deprecated in OpenLdap, the best solution is to use the port 389 with `tlsMode=starttls`. Configuration properties for the admin -------------------------------------- The plugin needs to query the directory with a user having some rights allowing to search a user, to get his attributes, his groups etc... He's called the "admin" in the plugin. You must indicate in `adminUserDn` and `adminPassword`, the DN (Distinguished Name) and the password of this user. Configuration properties for user data -------------------------------------- To verify password, or to register the user into the Jelix application the first time he authenticate himself, the plugin needs some data about the user. You should indicate to it which ldap attributes it can retrieve, and which database fields that will receive the ldap attributes values. You indicate such informations into the `searchAttributes` property. It is a pair of names, `:`, separated by a comma. In this example, `searchAttributes="uid:login,givenName,sn:lastname,mail:email,dn:"`: - the value of the `uid` ldap attribute will be stored into the `login` field - the value of the `sn` ldap attribute will be stored into the `lastname` field - the value of the `givenName` ldap attribute will be stored into a field that have the same name, as there is no field name nor `:`. - there will not be mapping for the `dn` property. There is a `:` without field name. It will be readed from ldap, and can be used into the `bindUserDN` DN template. (see below). The possible list of possible fields is indicated into the dao file, whose name is indicated into the `dao` configuration property. Configuration properties for authentication ------------------------------------------- Starting from 2.0.0, the login process has changed, to take care of various ldap structure and server configuration. Before to try to authenticate the user against the ldap, the plugin retrieves user properties. It uses two configuration parameters : `searchUserFilter` and `searchAttributes`. The `searchUserFilter` should contain the ldap query, and a `%%LOGIN%%` placeholder that will be replaced by the login given by the user. Example: `searchUserFilter="(&(objectClass=posixAccount)(uid=%%LOGIN%%))"` You may also indicate the base DN for the search, into `searchUserBaseDN`. Example: `searchUserBaseDN="ou=ADAM users,o=Microsoft,c=US"`. Note that you can indicate several search filters, if you have complex ldap structure. Use `[]` to indicate an item list: ``` searchUserFilter[]="(&(objectClass=posixAccount)(uid=%%LOGIN%%))" searchUserFilter[]="(&(objectClass=posixAccount)(cn=%%LOGIN%%))" ``` To verify the password, the plugin needs the DN (Distinguished Name) corresponding to the user. It builds the DN from a "template" indicated into the `bindUserDN` property, and from various data. These data can be the given login or one of the ldap attributes of the user. - Building the DN from the login given by the user: bindUserDN should contain a DN, with a `%%LOGIN%%` placeholder that will be replaced by the login. Example: `bindUserDN="uid=%%LOGIN%%,ou=users,dc=XY,dc=fr"`. If the user give `john.smith` as a login, the authentication will be made with the DN `bindUserDN="uid=john.smith,ou=users,dc=XY,dc=fr"`. For some LDAP, the DN could be a simple string, for example an email. You could then set `bindUserDN="%%LOGIN%%@company.local"`. Or even `bindUserDN="%%LOGIN%%"` if the user can type the full value of the DN or an email or else.. (Probably it's not recommended to allow a user to type himself its full DN, it can be a security issue) - Building the DN from one of the ldap attributes of the user. In this case, the plugin will first query the ldap directory with the `searchUserFilter` filter, to retrieve the user's ldap attributes. Then, in bindUserDN, you can indicate a DN where some values will be replaced by some attributes values, or you can indicate a single attribute name, corresponding to an attribute that contain the full DN of the user. For the first case, bindUserDn should contain a DN, with some `%?%` placeholders that will be replaced by corresponding attributes value. Example: `bindUserDN="uid=%?%,ou=users,dc=XY,dc=fr"`. Here it replaces the `%?%` by the value of the `uid` attribute readed from the user's attributes. The attribute name should be present into the `searchAttributes` configuration property, even with no field mapping. Ex: `...,uid,...`. See above. For the second case, just indicate the attribute name, prefixed with a `$`. Example: `bindUserDN="$dn"`. Here it takes the `dn` attribute readed from the search, and use its full value as the DN to login against the ldap server. It is useful for some LDAP server like sometimes Active Directory that need a full DN specific for each user. The attribute name should be present into the `searchAttributes` configuration property, even with no field mapping. Ex: `...,dn:,...`. See above. Note that you can indicate several dn templates, if you have complex ldap structure. Use `[]` to indicate an item list: ``` bindUserDN[]="uid=%?%,ou=users,dc=XY,dc=fr" bindUserDN[]="cn=%?%,ou=users,dc=XY,dc=fr" ``` Configuration properties for user rights ---------------------------------------- If you have configured groups rights into your application, and if these groups match your ldap groups, you can indicate to the plugin to automatically put the user into the application groups, according to the user ldap groups. You should then indicate into `searchGroupFilter` the ldap query that will retrieve the groups of the user. Example: `searchGroupFilter="(&(objectClass=posixGroup)(member=%%USERDN%%))"` `%%USERDN%%` is replaced by the user dn.`%%LOGIN%%` is replaced by the login. You can also use any ldap attributes you indicate into `searchAttributes`, between `%%`. Example: `searchGroupFilter="(&(objectClass=posixGroup)(member=%%givenName%%))"` Warning : setting `searchGroupFilter` will remove the user from any other application groups that don't match the ldap group, except default groups of user into the application, when `searchGroupKeepUserInDefaultGroups` is set to `on`. If you don't want a groups synchronization, leave `searchGroupFilter` empty. With `searchGroupProperty`, you must indicate the ldap attribute that contains the group name. Ex: `searchGroupProperty="cn"`. You may also indicate the base DN for the search, into `searchGroupBaseDN`. Example: `searchGroupBaseDN="ou=Groups,dc=Acme,dc=pt"`.