Skip to Content

Wiki source code of User Authentication

Version 44.1 by Thomas Mortagne on 2011/06/22
Show last authors
1 XWiki supports several different authentication mechanisms for authenticating users:
2
3 {{toc/}}
4
5 The form authentication is the default mechanism.
6
7 {{info}}
8 Note that currently XWiki allows only one method of authentication to be enabled at a time. This will probably be improved in the future.
9 {{/info}}
10
11 = Form Authentication =
12
13 Form authentication is the default way to get authenticated within a Wiki. It requires a user and a password.
14
15 = LDAP Authentication =
16
17 {{warning}}
18 New LDAP implementation since XWiki Platform 1.3M2, see [[previous LDAP authentication service documentation>>AuthenticationLdapOld]]
19 {{/warning}}
20
21 == Generic LDAP configuration ==
22
23 In order to enable the LDAP support you have to change the authentication method in //WEB-INF/xwiki.cfg// as follows:
24
25 {{code}}
26 ## Turn LDAP authentication on - otherwise only XWiki authentication
27 ## 0 : disable
28 ## 1 : enable
29 xwiki.authentication.ldap=1
30
31 ## set LDAP as authentication service
32 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
33 {{/code}}
34
35 You can setup the LDAP configuration in the //xwiki.cfg// file by filling the following properties:
36
37 {{code language="none"}}
38 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
39 xwiki.authentication.ldap.server=127.0.0.1
40 xwiki.authentication.ldap.port=389
41
42 #-# LDAP login, empty = anonymous access, otherwise specify full dn
43 #-# {0} is replaced with the username, {1} with the password
44 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
45 xwiki.authentication.ldap.bind_pass={1}
46
47 #-# Force to check password after LDAP connection
48 #-# 0: disable
49 #-# 1: enable
50 xwiki.authentication.ldap.validate_password=0
51
52 #-# only members of the following group will be verified in the LDAP
53 #-# otherwise only users that are found after searching starting from the base_DN
54 # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
55
56 #-# only users not member of the following group can autheticate
57 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
58
59 #-# base DN for searches
60 xwiki.authentication.ldap.base_DN=
61
62 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
63 # xwiki.authentication.ldap.UID_attr=cn
64
65 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
66 # xwiki.authentication.ldap.password_field=userPassword
67
68 #-# The potential LDAP groups classes. Separated by commas.
69 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
70
71 #-# The potential names of the LDAP groups fields containings the members. Separated by commas.
72 # xwiki.authentication.ldap.group_memberfields=member,uniqueMember
73
74 #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
75 xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
76
77 #-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
78 xwiki.authentication.ldap.update_user=1
79
80 #-# mapps XWiki groups to LDAP groups, separator is "|"
81 # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\
82 # XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
83
84 #-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
85 # xwiki.authentication.ldap.groupcache_expiration=21800
86
87 #-# - create : synchronize group membership only when the user is first created
88 #-# - always: synchronize on every login
89 # xwiki.authentication.ldap.mode_group_sync=always
90
91 #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
92 xwiki.authentication.ldap.trylocal=1
93
94 #-# SSL connection to LDAP server
95 #-# 0: normal
96 #-# 1: SSL
97 # xwiki.authentication.ldap.ssl=0
98
99 #-# The keystore file to use in SSL connection
100 # xwiki.authentication.ldap.ssl.keystore=
101
102 #-# The java secure provider used in SSL connection
103 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
104 {{/code}}
105
106 {{info}}
107 You can also setup the LDAP configuration in XWiki.XWikiPreferences page by going to the object editor. Simply replace "xwiki.authentication.ldap." by "ldap_". For example ##xwiki.authentication.ldap.base_DN## becomes ##ldap_base_DN##. The contributed extension [[LDAP Tools>>extensions:Extension.LDAP Tools]] provides a administration section UI to configure LDAP from the wiki in a simpler manner.
108 {{/info}}
109
110 For testing purposes, you may wish to omit the "ldap.fields_mapping" field, to test the authentication first, and then add it later to get the mappings right.
111
112 Here are some LDAP client for checking your configuration:
113
114 * [[Apache Directory Studio>>http://directory.apache.org/studio/]]
115 * [[LDAPExplorerTool>>http://ldaptool.sourceforge.net/]]
116
117 == Detailed use cases ==
118
119 See [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
120
121 == Enable LDAP debug log ==
122
123 See [[AdminGuide.Logging]].
124
125 The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ###com.xpn.xwiki.user.impl.LDAP#.##
126
127 Before 3.1, add the following to the log4j configuration file:
128
129 {{code}}
130 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
131 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
132 {{/code}}
133
134 = eXo Authentication =
135
136 The eXo authentication is used automatically by adding/editing the //xwiki.exo=1// property in //WEB-INF/xwiki.cfg//.
137
138 = Custom Authentication =
139
140 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
141
142 1. Implement the [[XWikiAuthService>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java]] interface.
143 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
144
145 {{code}}
146 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
147 {{/code}}
148
149 Here's a [[tutorial on implementing a custom authentication class for authenticating against Oracle's SSO>>http://bodez.wordpress.com/2008/10/15/xwiki-user-authentication-with-oracle-sso/]].
150
151 Note, that you also can implement own right management service by implementing [[XWikiRightService>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiRightService.java]] interface:
152
153 {{code}}
154 xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
155 {{/code}}
156
157 and Group Service by implementing [[XWikiGroupService>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java]]:
158
159 {{code}}
160 xwiki.authentication.groupclass = com.acme.MyCustomGroupService
161 {{/code}}
162
163 == Custom Authentication using a Groovy script in a wiki page ==
164
165 Start by specifying you want to use the Groovy Authenticator:
166
167 {{code}}
168 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
169 {{/code}}
170
171 Then add another configuration parameter to specify in which wiki page the authenticator is:
172
173 {{code}}
174 xwiki.authentication.groovy.pagename = MySpace.MyPage
175 {{/code}}
176
177 Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
178
179 = Authentication parameters =
180
181 You can set each of these parameters by setting:
182
183 {{code}}
184 xwiki.authentication.~~param_name~~=~~param_value~~
185 {{/code}}
186
187 |=Name|=Optional|=Allowed values|=Default value|=Description
188 |encryptionKey|No(1)|?|n/a|Set the Encryption Key used to create a secret key, the secret key is passed to the Cipher object to be used during encryption and decryption of cookie values.
189 |validationKey|No(2)|?|n/a|Set the Validation Key used to generate hash value; the hash value is stored with the cookie and used to verify that the cookie has not been tampered with.
190 |cookiedomains|Yes|String|Server host name|Which host(s) should your cookies be sent to; use only if you want to share cookies across domains, otherwise should be commented out
191 |cookielife|Yes|Number|14|Number of days cookies take to expire
192 |cookiepath|Yes|String|/|The webapp path that XWiki cookies should be sent to; if you have anything else running on your web server, this should be set to ///xwiki//
193 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
194 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
195 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
196 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
197 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
198 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
199 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
200 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
201 |realmname|Yes|String|XWiki|Sets the realm name
202 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
203 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
204 |useip|Yes|true / false|true|Specify to use the IP address when encrypting the cookie data; if IP address changes will need to re-login.
205
206 1. Only required if protection = encryption or all (default)
207 1. Only required if protection = validation or all (default)
208
209 = Kerberos SSO Authentication =
210
211 {{warning}}
212 This implementation of SSO is currently under review see: http://jira.xwiki.org/jira/browse/XWIKI-2496 . The class which is described in this segment of documentation, AppServerTrustedKerberosAuthServiceImpl, is not part of the default XWiki distribution!
213 {{/warning}}
214
215 The following is an example of mod_auth_kerb for Apache being used to easily implement Xwiki authentication of users via by HTTP Negotiate on a linux server. This example assumes you already have a working Apache2 HTTPD and Apache Tomcat setup with mod_jk.
216
217 First of all you need to create a principal and keytab for the webserver:
218
219 {{code}}
220 # kadmin
221 kadmin> addprinc -randkey HTTP/wiki.example.com
222 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
223 kadmin> quit
224 {{/code}}
225
226 Make sure the keytab has the right permissions and ownership:
227
228 {{code}}
229 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
230 chmod 400 /etc/apache2/ssl/wiki.keytab
231 {{/code}}
232
233 Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
234
235 {{code}}
236 aptitude install libapache2-mod-auth-kerb
237 {{/code}}
238
239 Of course the installation procedure varies per Linux distribution.
240
241 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
242
243 {{code}}
244 <Location /xwiki/>
245 AuthType Kerberos
246 AuthName "Kerberos Login"
247 KrbAuthRealms EXAMPLE.COM
248 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
249 KrbMethodK5Passwd off
250 KrbMethodNegotiate on
251 KrbSaveCredentials on
252 require valid-user
253 </Location>
254 {{/code}}
255
256 Make sure Apache Tomcat uses the authentication performed by Apache HTTPD with the "tomcatAuthentication" property in the connector description (which is in the server.xml file of Apache Tomcat):
257
258 {{code}}
259 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
260 {{/code}}
261
262 Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
263
264 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
265
266 {{code}}
267 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
268 {{/code}}
269
270 If you use Firefox, do not forget to whitelist the xwiki URL for HTTP Negotiate in about:config with the "network.negotiate-auth.trusted-uris" property. possible values for this propperty include (without the quotes): "https:~/~/" for all secured connections or "example.com" for all example.com subdomains.
271
272 2 JBoss SPNEGO (Kerberos in combination with LDAP) I changed the code of the XWikiLDAPAuthServiceImpl to be able to detect the sso user. The authenication already happend by using the SPNEGO module (JAAS). After that I'm using the ldap synchronisation feature to make sure that the user is up to date. The combination leads to an automatic login in the xwiki and the user rights are controlled in the Active Directory server. I hope you can adopt this code or that you can use it for your own projects.
273
274 The configuration of ldap:
275
276 {{code}}
277 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
278 xwiki.authentication.ldap=1
279 xwiki.authentication.ldap.server=<ad-server>
280 xwiki.authentication.ldap.port=389
281 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
282 #use a fixed user to attach to the ldap database,
283 #the password is not provided with the SSOLdapAuthenicationImpl
284 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
285 xwiki.authentication.ldap.bind_pass=<password>
286 #Microsoft AD configuration
287 xwiki.authentication.ldap.UID_attr=sAMAccountName
288 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
289 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
290 #LDAP group mapping
291 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
292 XWiki.XWikiAllGroup=CN=WIKI_User,...........
293 {{/code}}
294
295 The java code
296
297 {{code}}
298 package com.wiki.sso;
299
300
301 import org.apache.commons.logging.Log;
302 import org.apache.commons.logging.LogFactory;
303
304 import com.xpn.xwiki.XWikiContext;
305 import com.xpn.xwiki.XWikiException;
306 import com.xpn.xwiki.user.api.XWikiUser;
307 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
308
309 import java.security.Principal;
310
311 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
312 /**
313 * Logging tool.
314 */
315 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
316
317
318 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
319 String user = getRemoteUser(context);
320 if ((user != null) || !user.equals("")) {
321 if (LOG.isInfoEnabled())
322 LOG.info("Launching create user for " + user);
323 if ( authenticate(user, context) != null ) {
324 if (LOG.isInfoEnabled())
325 LOG.info("Create user done for " + user);
326 user = "XWiki." + user;
327 context.setUser(user);
328 System.out.println("User is set to:" + user);
329 return new XWikiUser(user);
330 } else {
331 LOG.error( "User " + user + " can't be authenticated against ldap" );
332 }
333 }
334 return super.checkAuth(context);
335 }
336
337 /**
338 * We cannot authenticate locally since we need to trust the app server for
339 * authentication
340 *
341 * @param username
342 * @param password
343 * @param context
344 * @return
345 * @throws XWikiException
346 */
347 public XWikiUser checkAuth(String username, String password,
348 String rememberme, XWikiContext context) throws XWikiException {
349 String user = getRemoteUser(context);
350 if ((user == null) || user.equals("")) {
351 return super.checkAuth(username, password, rememberme, context);
352 }
353 return checkAuth(context);
354 }
355
356 private String getRemoteUser(XWikiContext context) {
357 String userName = context.getRequest().getHttpServletRequest()
358 .getRemoteUser();
359 if (userName != null) {
360 // only take the front of the username@domain
361 String[] elements = userName.split("@", 2);
362 userName = elements[0];
363 }
364 return userName;
365 }
366
367 public Principal authenticate(String login, XWikiContext context) throws XWikiException
368 {
369 if (LOG.isTraceEnabled()) {
370 LOG.trace("Starting LDAP authentication");
371 }
372
373 /*
374 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
375 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
376 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
377 */
378
379 if (login == null) {
380 // If we can't find the username field then we are probably on the login screen
381
382 if (LOG.isDebugEnabled()) {
383 LOG.debug("The provided user is null."
384 + " We don't try to authenticate, it probably means the user is in non logged mode.");
385 }
386
387 return null;
388 }
389
390 // Check for empty usernames
391 if (login.equals("")) {
392 context.put("message", "nousername");
393
394 if (LOG.isDebugEnabled()) {
395 LOG.debug("LDAP authentication failed: login empty");
396 }
397
398 return null;
399 }
400
401 // If we have the context then we are using direct mode
402 // then we should specify the database
403 // This is needed for virtual mode to work
404 Principal principal = null;
405
406 // Try authentication against ldap
407 principal = ldapAuthenticate(login, "", context);
408
409 if (LOG.isDebugEnabled()) {
410 if (principal != null) {
411 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
412 } else {
413 LOG.debug("LDAP authentication failed for user [" + login + "]");
414 }
415 }
416
417 return principal;
418 }
419 }
420 {{/code}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected