RedmineLDAP » History » Version 19

Axel Pospischil, 2013-11-02 11:06

1 16 Perico Os Palotes
{{>toc}}
2 16 Perico Os Palotes
3 1 Jean-Philippe Lang
h1. LDAP Authentication
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
Redmine natively supports LDAP authentication using one or multiple LDAP directories.
6 1 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. Declaring the LDAP
8 1 Jean-Philippe Lang
9 5 Eric Davis
Go to Administration and click *LDAP authentication* in the menu.
10 1 Jean-Philippe Lang
11 1 Jean-Philippe Lang
Enter the following:
12 1 Jean-Philippe Lang
13 1 Jean-Philippe Lang
* *Name*: an arbitrary name for the directory
14 1 Jean-Philippe Lang
* *Host*: the LDAP host name
15 1 Jean-Philippe Lang
* *Port*: the LDAP port (default is 389)
16 1 Jean-Philippe Lang
* *LDAPS*: check this if you want or need to use LDAPS to access the directory
17 9 T. Hauptman
* *Account*: enter a username that has read access to the LDAP , otherwise leave this field empty if your LDAP can be read anonymously (Active Directory servers generally do not allow anonymous access)
18 1 Jean-Philippe Lang
* *Password*: password for the account
19 1 Jean-Philippe Lang
* *Base DN*: the top level DN of your LDAP directory tree
20 1 Jean-Philippe Lang
* *Login attribute*: enter the name of the LDAP attribute that will be used as the Redmine username
21 1 Jean-Philippe Lang
22 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.
23 3 Jean-Philippe Lang
24 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.
25 1 Jean-Philippe Lang
26 1 Jean-Philippe Lang
h2. On the fly user creation
27 1 Jean-Philippe Lang
28 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.
29 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.
30 1 Jean-Philippe Lang
31 1 Jean-Philippe Lang
Here is an typical example using Active Directory:
32 1 Jean-Philippe Lang
33 1 Jean-Philippe Lang
<pre>
34 1 Jean-Philippe Lang
Name     = My Directory
35 1 Jean-Philippe Lang
Host     = host.domain.org
36 1 Jean-Philippe Lang
Port     = 389
37 1 Jean-Philippe Lang
LDAPS    = no
38 7 John Dell
Account  = MyDomain\UserName (or UserName@MyDomain depending on AD server)
39 1 Jean-Philippe Lang
Password = <password>
40 1 Jean-Philippe Lang
Base DN  = CN=users,DC=host,DC=domain,DC=org
41 9 T. Hauptman
42 9 T. Hauptman
On-the-fly user creation = yes
43 9 T. Hauptman
Attributes
44 9 T. Hauptman
  Login     = sAMAccountName
45 9 T. Hauptman
  Firstname = givenName
46 9 T. Hauptman
  Lastname  = sN
47 9 T. Hauptman
  Email     = mail
48 9 T. Hauptman
</pre>
49 9 T. Hauptman
50 9 T. Hauptman
Here is another example for Active Directory with a compartmentalized intranet:
51 9 T. Hauptman
52 9 T. Hauptman
<pre>
53 9 T. Hauptman
Name     = Just a description for the auth modes page
54 9 T. Hauptman
Host     = DepartmentName.OrganizationName.local
55 9 T. Hauptman
Port     = 389
56 9 T. Hauptman
LDAPS    = no
57 13 mouson chen
Account  = DepartmentName\UserName (or UserName@MyDomain depending on AD server or bind DN uid=Manager,cn=users,dc=MyDomain,dc=com)
58 9 T. Hauptman
Password = <password>
59 9 T. Hauptman
Base DN  = DC=DepartmentName,DC=OrganizationName,DC=local
60 1 Jean-Philippe Lang
61 1 Jean-Philippe Lang
On-the-fly user creation = yes
62 1 Jean-Philippe Lang
Attributes
63 1 Jean-Philippe Lang
  Login     = sAMAccountName
64 1 Jean-Philippe Lang
  Firstname = givenName
65 1 Jean-Philippe Lang
  Lastname  = sN
66 1 Jean-Philippe Lang
  Email     = mail
67 1 Jean-Philippe Lang
</pre>
68 1 Jean-Philippe Lang
69 1 Jean-Philippe Lang
Note that LDAP attribute names are *case sensitive*.
70 1 Jean-Philippe Lang
71 14 Alexander Menk
h3. Dynamic Bind Account 
72 14 Alexander Menk
73 14 Alexander Menk
The above setup would need a special account on the directory server which Redmine uses to pre-authenticate.
74 14 Alexander Menk
It is possible to use the code @$login$@ in the account field which then would be replaced by the current login.
75 14 Alexander Menk
The password can be left empty in this case.
76 14 Alexander Menk
77 14 Alexander Menk
Issue: http://www.redmine.org/issues/1913
78 14 Alexander Menk
Example Test: http://www.redmine.org/projects/redmine/repository/revisions/9241/diff/
79 14 Alexander Menk
80 6 Chris Rose
h3. Base DN variants
81 6 Chris Rose
82 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.
83 1 Jean-Philippe Lang
84 16 Perico Os Palotes
h2. Group based LDAP login
85 16 Perico Os Palotes
86 16 Perico Os Palotes
If you want to just allow logins to users that belongs to a particular LDAP group you should follow below instructions. They are based on OpenLDAP LDAP server and redmine 2.3.0.
87 16 Perico Os Palotes
88 16 Perico Os Palotes
1. (OpenLDAP server) Enable memberof overlay
89 16 Perico Os Palotes
90 16 Perico Os Palotes
1.1. Create a file:
91 16 Perico Os Palotes
92 16 Perico Os Palotes
>vim ~/memberof_add.ldif
93 16 Perico Os Palotes
94 16 Perico Os Palotes
With below content:
95 16 Perico Os Palotes
96 16 Perico Os Palotes
>dn: cn=module,cn=config
97 16 Perico Os Palotes
>objectClass: olcModuleList
98 16 Perico Os Palotes
>cn: module
99 16 Perico Os Palotes
>olcModulePath: /usr/lib/ldap
100 16 Perico Os Palotes
>olcModuleLoad: memberof
101 16 Perico Os Palotes
102 16 Perico Os Palotes
1.2. Create a file:
103 16 Perico Os Palotes
104 16 Perico Os Palotes
>vim ~/memberof_config.ldif
105 16 Perico Os Palotes
106 16 Perico Os Palotes
With below content:
107 16 Perico Os Palotes
108 16 Perico Os Palotes
>dn: olcOverlay=memberof,olcDatabase={1}hdb,cn=config
109 16 Perico Os Palotes
>objectClass: olcMemberOf
110 16 Perico Os Palotes
>objectClass: olcOverlayConfig
111 16 Perico Os Palotes
>objectClass: olcConfig
112 16 Perico Os Palotes
>objectClass: top
113 16 Perico Os Palotes
>olcOverlay: memberof
114 16 Perico Os Palotes
>olcMemberOfDangling: ignore
115 16 Perico Os Palotes
>olcMemberOfRefInt: TRUE
116 16 Perico Os Palotes
>olcMemberOfGroupOC: groupOfNames
117 16 Perico Os Palotes
>olcMemberOfMemberAD: member
118 16 Perico Os Palotes
>olcMemberOfMemberOfAD: memberOf
119 16 Perico Os Palotes
120 16 Perico Os Palotes
1.3. Load them. It will depend on your OpenLDAP configuration, so we will propose some possibilities:
121 16 Perico Os Palotes
122 16 Perico Os Palotes
>sudo ldapadd -c -Y EXTERNAL -H ldapi:/// -f memberof_add.ldif
123 16 Perico Os Palotes
>sudo ldapadd -c -Y EXTERNAL -H ldapi:/// -f memberof_config.ldif
124 16 Perico Os Palotes
125 16 Perico Os Palotes
Or:
126 16 Perico Os Palotes
127 16 Perico Os Palotes
>ldapadd -D cn=admin,cn=config -w "password" -H ldapi:/// -f memberof_add.ldif
128 16 Perico Os Palotes
>ldapadd -D cn=admin,cn=config -w "password" -H ldapi:/// -f memberof_config.ldif
129 16 Perico Os Palotes
130 16 Perico Os Palotes
A restart is NOT needed if you use dynamic runtime configuration engine (slapd-config).
131 16 Perico Os Palotes
132 16 Perico Os Palotes
1.4. (Optional) Test it:
133 16 Perico Os Palotes
134 16 Perico Os Palotes
>ldapsearch -D cn=admin,dc=example,dc=com -x -W -b 'dc=example,dc=com' -H 'ldap://127.0.0.1:389/' '(&(objectClass=posixAccount)(memberOf=cn=ldapredmine,ou=groups,dc=example,dc=com))'
135 16 Perico Os Palotes
136 16 Perico Os Palotes
2. (OpenLDAP server) Create the group. In this example the user is "ldap_user_1" and the group is "ldapredmine":
137 16 Perico Os Palotes
138 16 Perico Os Palotes
>dn: cn=ldapredmine,ou=groups,dc=example,dc=com
139 16 Perico Os Palotes
>cn: ldapredmine
140 16 Perico Os Palotes
>description: Staff members allowed to login to redmine ticketing system
141 16 Perico Os Palotes
>member: cn=ldap_user_1,ou=people,dc=example,dc=com
142 16 Perico Os Palotes
>objectclass: groupOfNames
143 16 Perico Os Palotes
>objectclass: top
144 16 Perico Os Palotes
145 16 Perico Os Palotes
Adjust "dn" and "cn"s to fit to your DIT structure
146 16 Perico Os Palotes
147 16 Perico Os Palotes
3. (Redmine) Edit the LDAP authentication mode. In my case "ldap_user_1" is a "posixAccount" objectclass:
148 16 Perico Os Palotes
149 16 Perico Os Palotes
>Base DN: dc=example,dc=com
150 16 Perico Os Palotes
>Filter: (&(objectClass=posixAccount)(memberOf=cn=ldapredmine,ou=groups,dc=example,dc=com))
151 6 Chris Rose
152 1 Jean-Philippe Lang
h2. Troubleshooting
153 1 Jean-Philippe Lang
154 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.
155 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).
156 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.)
157 4 Jean-Philippe Lang
158 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.
159 6 Chris Rose
160 1 Jean-Philippe Lang
Errors in the login system are not reported with any real information in the Redmine logs, which makes troubleshooting difficult.  However, you can found most of the information you need using ??Wireshark?? between your Redmine host and the LDAP server. Note that this only works if you have permissions to read network traffic between those two hosts.
161 15 Wiebe Cazemier
162 15 Wiebe Cazemier
You can also use the tool 'ldapsearch' to test if your settings are correct. Log into the Linux machine hosting your redmine (and possibly install ldaputils) and run this:
163 15 Wiebe Cazemier
164 15 Wiebe Cazemier
    ldapsearch -x -b  "dc=example,dc=com" -H ldap://hostname/ -D "DOMAIN\USER" -w mypassword [searchterm]
165 15 Wiebe Cazemier
166 15 Wiebe Cazemier
If succesful, you will get a listing of the contents of the AD, matching your search query. Then, you will know what how to fill out the fields in the LDAP config in Redmine.
167 12 Etienne Massip
168 12 Etienne Massip
169 12 Etienne Massip
h3. ??Account?? value format
170 12 Etienne Massip
171 12 Etienne Massip
The username for the bind credentials might need to be specified as a DN(i.e. CN=user,OU=optional,DC=domain,DC=com) rather than as a UPN(user@domain.com) or as ??domain\user??, as pointed out by this comment in source:trunk/vendor/plugins/ruby-net-ldap-0.0.4/lib/net/ldap.rb:
172 11 John Lewin
<pre>
173 11 John Lewin
  # As described under #bind, most LDAP servers require that you supply a complete DN
174 11 John Lewin
  # as a binding-credential, along with an authenticator such as a password.
175 6 Chris Rose
</pre>
176 8 Oli Kessler
177 8 Oli Kessler
h3. OpenDS 
178 8 Oli Kessler
179 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.
180 8 Oli Kessler
181 8 Oli Kessler
Add a global ACI like this
182 8 Oli Kessler
<pre>
183 8 Oli Kessler
./dsconfig -h SERVER_IP -p 4444 -D cn="Directory Manager" -w PASSWORD -n set-access-control-handler-prop --trustAll 
184 8 Oli Kessler
--add global-aci:\(targetcontrol=\"1.2.840.113556.1.4.319\"\)\ \(version\ 3.0\;\ acl\ 
185 8 Oli Kessler
\"Anonymous\ control\ access\ to\ 1.2.840.113556.1.4.319\"\;\ allow\ \(read\)\ userdn=\"ldap:///anyone\"\;\)
186 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).
187 17 Axel Pospischil
188 17 Axel Pospischil
h2.  Solutions:
189 17 Axel Pospischil
190 17 Axel Pospischil
h3. Zentyal 3.2, Redmine 2.3.x
191 17 Axel Pospischil
192 17 Axel Pospischil
I successfully updated and (re)setup my Zentyal 3.2 on an Ubuntu 12.04 LTS server.
193 17 Axel Pospischil
194 17 Axel Pospischil
Because this really drove me nuts after an update to Zentyal 3.2 and Redmine 2.3, I like to make the story short and share this simple solution with you:
195 17 Axel Pospischil
196 17 Axel Pospischil
* https://wiki.blue-it.org/Zentyal#LDAP
197 18 Axel Pospischil
198 18 Axel Pospischil
Using zentyals readonly credentials:
199 19 Axel Pospischil
<pre>> Basedomain (Base DN):  dc=your_domain,dc=your_tld
200 19 Axel Pospischil
  Rootdomain (Root DN):  cn=zentyal,dc=your_domain,dc=your_tld
201 19 Axel Pospischil
  Password:              <admin_secret_pass>
202 19 Axel Pospischil
> Read-only root DN:     cn=zentyalro,dc=your_domain,dc=your_tld
203 19 Axel Pospischil
> Read-only password:    <ro_secret_pass>
204 19 Axel Pospischil
  Default Users DN:      ou=Users,dc=your_domain,dc=your_tld
205 19 Axel Pospischil
  Default Groups DN:     ou=Groups,dc=your_domain,dc=your_tld
206 18 Axel Pospischil
</pre> 
207 18 Axel Pospischil
208 18 Axel Pospischil
And in Redmine (use the credentials above, without <>) and be aware of the changed LDAP port 390 (read the article above):
209 18 Axel Pospischil
<pre>
210 18 Axel Pospischil
Name     = Just a description for the auth modes page
211 19 Axel Pospischil
> Host     = <IP of the host>
212 19 Axel Pospischil
> Port     = <390>
213 19 Axel Pospischil
  LDAPS    = no
214 19 Axel Pospischil
> Account  = <Read-only root DN>
215 19 Axel Pospischil
> Password = <ro_secret_pass>
216 19 Axel Pospischil
> Base DN  = <Basedomain (Base DN)>
217 18 Axel Pospischil
218 18 Axel Pospischil
On-the-fly user creation = yes
219 18 Axel Pospischil
Attributes
220 19 Axel Pospischil
>  Login     = uid
221 19 Axel Pospischil
   Firstname = givenName
222 19 Axel Pospischil
>  Lastname  = sN
223 18 Axel Pospischil
  Email     = mail
224 18 Axel Pospischil
</pre>