Skip to Content

Wiki source code of User Authentication

Version 51.1 by Thomas Mortagne on 2012/05/10
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 = Basic Authentication =
16
17 XWiki supports [basic access authentication>http://en.wikipedia.org/wiki/Basic_access_authentication], a method designed to allow a Web browser, or other client program, to provide credentials - in the form of a user name and password - when making a request. You can get authenticated against an XWiki server with the basic authentication protocol using the following URL scheme:
18
19 {{code}}
20 http://username:password@mywiki.xwiki.com/xwiki/bin/view/Main/WebHome?basicauth=1
21 {{/code}}
22
23 {{warning}}
24 Be careful that if you use the ##HTTP## protocol your password will be sent in clear over the network and is thus very unsafe. When using Basic Authentication you should make sure your wiki is configured to use ##HTTPS##.
25 {{/warning}}
26
27 = LDAP Authentication =
28
29 {{warning}}
30 New LDAP implementation since XWiki Platform 1.3M2, see [[previous LDAP authentication service documentation>>AuthenticationLdapOld]]
31 {{/warning}}
32
33 == Generic LDAP configuration ==
34
35 In order to enable the LDAP support you have to change the authentication method in //WEB-INF/xwiki.cfg// as follows:
36
37 {{code}}
38 #-# LDAP authentication service
39 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
40
41 #-# Turn LDAP authentication on - otherwise only XWiki authentication
42 #-# - 0: disable
43 #-# - 1: enable
44 #-# The default is 1
45 # xwiki.authentication.ldap=1
46 {{/code}}
47
48 You can setup the LDAP configuration in the //xwiki.cfg// file by filling the following properties:
49
50 {{code language="none"}}
51 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
52 xwiki.authentication.ldap.server=127.0.0.1
53 xwiki.authentication.ldap.port=389
54
55 #-# LDAP login, empty = anonymous access, otherwise specify full dn
56 #-# {0} is replaced with the user name, {1} with the password
57 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
58 xwiki.authentication.ldap.bind_pass={1}
59
60 #-# The Base DN used in LDAP searches
61 xwiki.authentication.ldap.base_DN=
62
63 #-# LDAP query to search the user in the LDAP database (in case a static admin user is provided in
64 #-# xwiki.authentication.ldap.bind_DN)
65 #-# {0} is replaced with the user uid field name and {1} with the user name
66 #-# The default is ({0}={1})
67 # xwiki.authentication.ldap.ldap_user_search_fmt=({0}={1})
68
69 #-# Only members of the following group will be verified in the LDAP
70 #-# otherwise only users that are found after searching starting from the base_DN
71 # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
72
73 #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
74 #-# Only users not member of the following group can autheticate
75 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
76
77 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name
78 #-# The default is cn
79 # xwiki.authentication.ldap.UID_attr=cn
80
81 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
82 #-# The potential LDAP groups classes. Separated by commas.
83 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
84
85 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
86 #-# The potential names of the LDAP groups fields containings the members. Separated by commas.
87 # xwiki.authentication.ldap.group_memberfields=member,uniqueMember
88
89 #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
90 xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
91
92 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
93 #-# On every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki
94 #-# account is created.
95 #-# - 0: only when creating user
96 #-# - 1: at each authentication
97 #-# The default is 1
98 # xwiki.authentication.ldap.update_user=1
99
100 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
101 #-# Maps XWiki groups to LDAP groups, separator is "|". The following kind of groups are supported:
102 #-# * LDAP static groups (users/subgroups are listed statically in the group object)
103 #-# * [Since 3.3M1] LDAP organization units (users/subgroups are sub object of the provided organization unit)
104 #-# * [Since 3.3M1] LDAP filter (users/groups are object found in a search with the provided filter),
105 #-# | character in the filter need to be escaped with backslash (\).
106 #-#
107 #-# Here is an example:
108 # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=domain,c=com|\
109 # XWiki.LDAPUsers=ou=groups,o=domain,c=com|\
110 # XWiki.Organisation=(cn=testers)
111
112 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
113 #-# Time in s after which the list of members in a group is refreshed from LDAP
114 #-# The default is 21600 (6 hours)
115 # xwiki.authentication.ldap.groupcache_expiration=21600
116
117 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
118 #-# - create : synchronize group membership only when the user is first created
119 #-# - always: synchronize on every login
120 #-# The default is always
121 # xwiki.authentication.ldap.mode_group_sync=always
122
123 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
124 #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
125 #-# The default is 1
126 xwiki.authentication.ldap.trylocal=1
127
128 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
129 #-# SSL connection to LDAP server
130 #-# - 0: normal
131 #-# - 1: SSL
132 #-# The default is 0
133 # xwiki.authentication.ldap.ssl=0
134
135 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
136 #-# The keystore file to use in SSL connection
137 # xwiki.authentication.ldap.ssl.keystore=
138
139 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
140 #-# The java secure provider used in SSL connection
141 #-# The default is com.sun.net.ssl.internal.ssl.Provider
142 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
143
144 #-# Bypass standard LDAP bind validation by doing a direct password comparison.
145 #-# If you don't know what you do, don't use that. It's covering very rare and bad use cases.
146 #-# - 0: disable
147 #-# - 1: enable
148 #-# The default is 0
149 # xwiki.authentication.ldap.validate_password=0
150
151 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
152 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password"
153 #-# is set to 1
154 # xwiki.authentication.ldap.password_field=userPassword
155 {{/code}}
156
157 {{info}}
158 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##.
159 {{/info}}
160
161 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.
162
163 Here are some LDAP client for checking your configuration:
164
165 * [[Apache Directory Studio>>http://directory.apache.org/studio/]]
166 * [[LDAPExplorerTool>>http://ldaptool.sourceforge.net/]]
167 * [[JXplorer>>http://jxplorer.org]]
168
169 == Detailed use cases ==
170
171 See [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
172
173 == Enable LDAP debug log ==
174
175 See [[AdminGuide.Logging]].
176
177 The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ##com.xpn.xwiki.user.impl.LDAP##.
178
179 In XWiki 3.4 you need to add the following in ##WEB-INF/classes/logback.xml##:
180
181 {{code}}
182 <!-- LDAP debugging -->
183 <logger name="com.xpn.xwiki.plugin.ldap" level="trace"/>
184 <logger name="com.xpn.xwiki.user.impl.LDAP" level="trace"/>
185 {{/code}}
186
187 Before 3.1, add the following to the log4j configuration file:
188
189 {{code}}
190 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
191 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
192 {{/code}}
193
194 = eXo Authentication =
195
196 The eXo authentication is used automatically by adding/editing the //xwiki.exo=1// property in //WEB-INF/xwiki.cfg//.
197
198 = Custom Authentication =
199
200 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
201
202 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
203 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
204
205 {{code}}
206 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
207 {{/code}}
208
209 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/]].
210
211 Note, that you also can implement own right management service by implementing {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiRightService.java"}}XWikiRightService{{/scm}} interface:
212
213 {{code}}
214 xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
215 {{/code}}
216
217 and Group Service by implementing {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java"}}XWikiGroupService{{/scm}}:
218
219 {{code}}
220 xwiki.authentication.groupclass = com.acme.MyCustomGroupService
221 {{/code}}
222
223 == Custom Authentication using a Groovy script in a wiki page ==
224
225 Start by specifying you want to use the Groovy Authenticator:
226
227 {{code}}
228 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
229 {{/code}}
230
231 Then add another configuration parameter to specify in which wiki page the authenticator is:
232
233 {{code}}
234 xwiki.authentication.groovy.pagename = MySpace.MyPage
235 {{/code}}
236
237 Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
238
239 = Authentication parameters =
240
241 You can set each of these parameters by setting:
242
243 {{code}}
244 xwiki.authentication.~~param_name~~=~~param_value~~
245 {{/code}}
246
247 |=Name|=Optional|=Allowed values|=Default value|=Description
248 |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.
249 |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.
250 |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
251 |cookielife|Yes|Number|14|Number of days cookies take to expire
252 |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//
253 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
254 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
255 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
256 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
257 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
258 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
259 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
260 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
261 |realmname|Yes|String|XWiki|Sets the realm name
262 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
263 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
264 |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.
265
266 1. Only required if protection = encryption or all (default)
267 1. Only required if protection = validation or all (default)
268
269 = Kerberos SSO Authentication =
270
271 {{warning}}
272 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!
273 {{/warning}}
274
275 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.
276
277 First of all you need to create a principal and keytab for the webserver:
278
279 {{code}}
280 # kadmin
281 kadmin> addprinc -randkey HTTP/wiki.example.com
282 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
283 kadmin> quit
284 {{/code}}
285
286 Make sure the keytab has the right permissions and ownership:
287
288 {{code}}
289 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
290 chmod 400 /etc/apache2/ssl/wiki.keytab
291 {{/code}}
292
293 Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
294
295 {{code}}
296 aptitude install libapache2-mod-auth-kerb
297 {{/code}}
298
299 Of course the installation procedure varies per Linux distribution.
300
301 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
302
303 {{code}}
304 <Location /xwiki/>
305 AuthType Kerberos
306 AuthName "Kerberos Login"
307 KrbAuthRealms EXAMPLE.COM
308 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
309 KrbMethodK5Passwd off
310 KrbMethodNegotiate on
311 KrbSaveCredentials on
312 require valid-user
313 </Location>
314 {{/code}}
315
316 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):
317
318 {{code}}
319 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
320 {{/code}}
321
322 Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
323
324 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
325
326 {{code}}
327 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
328 {{/code}}
329
330 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.
331
332 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.
333
334 The configuration of ldap:
335
336 {{code}}
337 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
338 xwiki.authentication.ldap=1
339 xwiki.authentication.ldap.server=<ad-server>
340 xwiki.authentication.ldap.port=389
341 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
342 #use a fixed user to attach to the ldap database,
343 #the password is not provided with the SSOLdapAuthenicationImpl
344 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
345 xwiki.authentication.ldap.bind_pass=<password>
346 #Microsoft AD configuration
347 xwiki.authentication.ldap.UID_attr=sAMAccountName
348 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
349 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
350 #LDAP group mapping
351 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
352 XWiki.XWikiAllGroup=CN=WIKI_User,...........
353 {{/code}}
354
355 The java code
356
357 {{code}}
358 package com.wiki.sso;
359
360
361 import org.apache.commons.logging.Log;
362 import org.apache.commons.logging.LogFactory;
363
364 import com.xpn.xwiki.XWikiContext;
365 import com.xpn.xwiki.XWikiException;
366 import com.xpn.xwiki.user.api.XWikiUser;
367 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
368
369 import java.security.Principal;
370
371 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
372 /**
373 * Logging tool.
374 */
375 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
376
377
378 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
379 String user = getRemoteUser(context);
380 if ((user != null) || !user.equals("")) {
381 if (LOG.isInfoEnabled())
382 LOG.info("Launching create user for " + user);
383 if ( authenticate(user, context) != null ) {
384 if (LOG.isInfoEnabled())
385 LOG.info("Create user done for " + user);
386 user = "XWiki." + user;
387 context.setUser(user);
388 System.out.println("User is set to:" + user);
389 return new XWikiUser(user);
390 } else {
391 LOG.error( "User " + user + " can't be authenticated against ldap" );
392 }
393 }
394 return super.checkAuth(context);
395 }
396
397 /**
398 * We cannot authenticate locally since we need to trust the app server for
399 * authentication
400 *
401 * @param username
402 * @param password
403 * @param context
404 * @return
405 * @throws XWikiException
406 */
407 public XWikiUser checkAuth(String username, String password,
408 String rememberme, XWikiContext context) throws XWikiException {
409 String user = getRemoteUser(context);
410 if ((user == null) || user.equals("")) {
411 return super.checkAuth(username, password, rememberme, context);
412 }
413 return checkAuth(context);
414 }
415
416 private String getRemoteUser(XWikiContext context) {
417 String userName = context.getRequest().getHttpServletRequest()
418 .getRemoteUser();
419 if (userName != null) {
420 // only take the front of the username@domain
421 String[] elements = userName.split("@", 2);
422 userName = elements[0];
423 }
424 return userName;
425 }
426
427 public Principal authenticate(String login, XWikiContext context) throws XWikiException
428 {
429 if (LOG.isTraceEnabled()) {
430 LOG.trace("Starting LDAP authentication");
431 }
432
433 /*
434 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
435 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
436 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
437 */
438
439 if (login == null) {
440 // If we can't find the username field then we are probably on the login screen
441
442 if (LOG.isDebugEnabled()) {
443 LOG.debug("The provided user is null."
444 + " We don't try to authenticate, it probably means the user is in non logged mode.");
445 }
446
447 return null;
448 }
449
450 // Check for empty usernames
451 if (login.equals("")) {
452 context.put("message", "nousername");
453
454 if (LOG.isDebugEnabled()) {
455 LOG.debug("LDAP authentication failed: login empty");
456 }
457
458 return null;
459 }
460
461 // If we have the context then we are using direct mode
462 // then we should specify the database
463 // This is needed for virtual mode to work
464 Principal principal = null;
465
466 // Try authentication against ldap
467 principal = ldapAuthenticate(login, "", context);
468
469 if (LOG.isDebugEnabled()) {
470 if (principal != null) {
471 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
472 } else {
473 LOG.debug("LDAP authentication failed for user [" + login + "]");
474 }
475 }
476
477 return principal;
478 }
479 }
480 {{/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