RedmineLDAP » History » Version 8

Oli Kessler, 2010-08-15 23:38

1 1 Jean-Philippe Lang
h1. LDAP Authentication
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
Redmine natively supports LDAP authentication using one or multiple LDAP directories.
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
h2. Declaring the LDAP
6 1 Jean-Philippe Lang
7 5 Eric Davis
Go to Administration -> Settings -> Authentication and click *LDAP authentication*, on the bottom right of the screen.
8 5 Eric Davis
9 1 Jean-Philippe Lang
10 1 Jean-Philippe Lang
Enter the following:
11 1 Jean-Philippe Lang
12 1 Jean-Philippe Lang
* *Name*: an arbitrary name for the directory
13 1 Jean-Philippe Lang
* *Host*: the LDAP host name
14 1 Jean-Philippe Lang
* *Port*: the LDAP port (default is 389)
15 1 Jean-Philippe Lang
* *LDAPS*: check this if you want or need to use LDAPS to access the directory
16 1 Jean-Philippe Lang
* *Account*: leave this field empty if your LDAP can be read anonymously, otherwise enter a username that has read access to the LDAP
17 1 Jean-Philippe Lang
* *Password*: password for the account
18 1 Jean-Philippe Lang
* *Base DN*: the top level DN of your LDAP directory tree
19 1 Jean-Philippe Lang
* *Login attribute*: enter the name of the LDAP attribute that will be used as the Redmine username
20 1 Jean-Philippe Lang
21 2 Jean-Philippe Lang
Redmine users should now be able to authenticate using their LDAP username and password if their accounts are set to use the LDAP for authentication.
22 3 Jean-Philippe Lang
23 3 Jean-Philippe Lang
To test this, create a Redmine user with a login that matches his LDAP account, select the newly created LDAP in the *Authentication mode* drop-down list (this field is visible on the account screen only if a LDAP is declared) and leave his password empty. Try to log in into Redmine using the LDAP username and password.
24 1 Jean-Philippe Lang
25 1 Jean-Philippe Lang
h2. On the fly user creation
26 1 Jean-Philippe Lang
27 1 Jean-Philippe Lang
By checking *on-the-fly user creation*, any LDAP user will have his Redmine account automatically created the first time he logs into Redmine.
28 1 Jean-Philippe Lang
For that, you have to specify the LDAP attributes name (firstname, lastname, email) that will be used to create their Redmine accounts.
29 1 Jean-Philippe Lang
30 1 Jean-Philippe Lang
Here is an typical example using Active Directory:
31 1 Jean-Philippe Lang
32 1 Jean-Philippe Lang
33 1 Jean-Philippe Lang
Name     = My Directory
34 1 Jean-Philippe Lang
Host     =
35 1 Jean-Philippe Lang
Port     = 389
36 1 Jean-Philippe Lang
LDAPS    = no
37 7 John Dell
Account  = MyDomain\UserName (or UserName@MyDomain depending on AD server)
38 1 Jean-Philippe Lang
Password = <password>
39 1 Jean-Philippe Lang
Base DN  = CN=users,DC=host,DC=domain,DC=org
40 1 Jean-Philippe Lang
41 1 Jean-Philippe Lang
On-the-fly user creation = yes
42 1 Jean-Philippe Lang
43 1 Jean-Philippe Lang
  Login     = sAMAccountName
44 1 Jean-Philippe Lang
  Firstname = givenName
45 1 Jean-Philippe Lang
  Lastname  = sN
46 1 Jean-Philippe Lang
  Email     = mail
47 1 Jean-Philippe Lang
48 1 Jean-Philippe Lang
49 1 Jean-Philippe Lang
Note that LDAP attribute names are *case sensitive*.
50 1 Jean-Philippe Lang
51 6 Chris Rose
h3. Base DN variants
52 6 Chris Rose
53 6 Chris Rose
Although it's quite possible that the Base DN above is standard for Active Directory, the Active Directory at my employer's site does not use the Users container for standard users, so those instructions sent me down a long and painful path.  I recommend also trying just "DC=host,DC=domain,DC=org" if login fail swith the settings there.
54 6 Chris Rose
55 1 Jean-Philippe Lang
h2. Troubleshooting
56 1 Jean-Philippe Lang
57 4 Jean-Philippe Lang
If you want to use on-the-fly user creation, make sure that Redmine can fetch from your LDAP all the required information to create a valid user.
58 4 Jean-Philippe Lang
For example, on-the-fly user creation won't work if you don't have valid email adresses in your directory (you will get an 'Invalid username/password' error message when trying to log in).
59 6 Chris Rose
(This is not true with newer Redmine versions; the user creation dialog is populated with everything it can find from the LDAP server, and asks the new user to fill in the rest.)
60 4 Jean-Philippe Lang
61 4 Jean-Philippe Lang
Also, make sure you don't have any custom field marked as *required* for user accounts. These custom fields would prevent user accounts from being created on the fly.
62 6 Chris Rose
63 6 Chris Rose
Errors in the login system are not reported with any real information in the Redmine logs, which makes troubleshooting difficult.  However, I found most of the information I needed using Wireshark between my Redmine host and the LDAP server.  Note that this only works if you have permissions to read network traffic between those two hosts (which was true for me because Redmine was running locally).
64 8 Oli Kessler
65 8 Oli Kessler
h3. OpenDS 
66 8 Oli Kessler
67 8 Oli Kessler
If you are using the OpenDS server, you might have issues with the request control "Paged results" sent with the initial query searching for the user by the specified login attribute. This request control 1.2.840.113556.1.4.319 is not allowed for anonymous users by default, thus preventing redmine from finding the user in the directory even before the binding takes place.
68 8 Oli Kessler
69 8 Oli Kessler
Add a global ACI like this
70 8 Oli Kessler
71 8 Oli Kessler
./dsconfig -h SERVER_IP -p 4444 -D cn="Directory Manager" -w PASSWORD -n set-access-control-handler-prop --trustAll 
72 8 Oli Kessler
--add global-aci:\(targetcontrol=\"1.2.840.113556.1.4.319\"\)\ \(version\ 3.0\;\ acl\ 
73 8 Oli Kessler
\"Anonymous\ control\ access\ to\ 1.2.840.113556.1.4.319\"\;\ allow\ \(read\)\ userdn=\"ldap:///anyone\"\;\)
74 8 Oli Kessler
</pre>Note: Enter the command on one line, use the escaping exactly as indicated (the \ after "acl" is meant to be "\ " for a space).