Skip to Content

Wiki source code of User Authentication

Version 55.1 by Thomas Mortagne on 2012/10/02
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 language="properties"}}
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="properties"}}
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.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 0
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 #-# - 0: disable
126 #-# - 1: enable
127 #-# The default is 0
128 xwiki.authentication.ldap.trylocal=1
129
130 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
131 #-# SSL connection to LDAP server
132 #-# - 0: normal
133 #-# - 1: SSL
134 #-# The default is 0
135 # xwiki.authentication.ldap.ssl=0
136
137 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
138 #-# The keystore file to use in SSL connection
139 # xwiki.authentication.ldap.ssl.keystore=
140
141 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
142 #-# The java secure provider used in SSL connection
143 #-# The default is com.sun.net.ssl.internal.ssl.Provider
144 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
145
146 #-# Bypass standard LDAP bind validation by doing a direct password comparison.
147 #-# If you don't know what you do, don't use that. It's covering very rare and bad use cases.
148 #-# - 0: disable
149 #-# - 1: enable
150 #-# The default is 0
151 # xwiki.authentication.ldap.validate_password=0
152
153 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
154 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password"
155 #-# is set to 1
156 # xwiki.authentication.ldap.password_field=userPassword
157
158 #-# [Since 4.3M1, XWikiLDAPAuthServiceImpl]
159 #-# The maximum number of milliseconds the client waits for any operation under these constraints to complete.
160 #-# The default is 1000
161 # xwiki.authentication.ldap.timeout=1000
162 {{/code}}
163
164 {{info}}
165 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##.
166 {{/info}}
167
168 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.
169
170 Here are some LDAP client for checking your configuration:
171
172 Java based and Open Source:
173 * [[Apache Directory Studio>>http://directory.apache.org/studio/]]
174 * [[JXplorer>>http://jxplorer.org]]
175
176 Windows only:
177 * [[Softerra LDAP Browser>>http://www.ldapbrowser.com/download.htm]]
178
179 == Detailed use cases ==
180
181 See [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
182
183 == Enable LDAP debug log ==
184
185 See [[AdminGuide.Logging]].
186
187 The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ##com.xpn.xwiki.user.impl.LDAP##.
188
189 In XWiki 3.4 you need to add the following in ##WEB-INF/classes/logback.xml##:
190
191 {{code}}
192 <!-- LDAP debugging -->
193 <logger name="com.xpn.xwiki.plugin.ldap" level="trace"/>
194 <logger name="com.xpn.xwiki.user.impl.LDAP" level="trace"/>
195 {{/code}}
196
197 Before 3.1, add the following to the log4j configuration file:
198
199 {{code}}
200 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
201 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
202 {{/code}}
203
204 = eXo Authentication =
205
206 The eXo authentication is used automatically by adding/editing the //xwiki.exo=1// property in //WEB-INF/xwiki.cfg//.
207
208 = Custom Authentication =
209
210 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
211
212 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
213 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
214
215 {{code}}
216 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
217 {{/code}}
218
219 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/]].
220
221 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:
222
223 {{code}}
224 xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
225 {{/code}}
226
227 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}}:
228
229 {{code}}
230 xwiki.authentication.groupclass = com.acme.MyCustomGroupService
231 {{/code}}
232
233 == Custom Authentication using a Groovy script in a wiki page ==
234
235 Start by specifying you want to use the Groovy Authenticator:
236
237 {{code}}
238 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
239 {{/code}}
240
241 Then add another configuration parameter to specify in which wiki page the authenticator is:
242
243 {{code}}
244 xwiki.authentication.groovy.pagename = MySpace.MyPage
245 {{/code}}
246
247 Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
248
249 = Authentication parameters =
250
251 You can set each of these parameters by setting:
252
253 {{code}}
254 xwiki.authentication.~~param_name~~=~~param_value~~
255 {{/code}}
256
257 |=Name|=Optional|=Allowed values|=Default value|=Description
258 |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.
259 |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.
260 |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
261 |cookielife|Yes|Number|14|Number of days cookies take to expire
262 |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//
263 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
264 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
265 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
266 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
267 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
268 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
269 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
270 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
271 |realmname|Yes|String|XWiki|Sets the realm name
272 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
273 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
274 |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.
275
276 1. Only required if protection = encryption or all (default)
277 1. Only required if protection = validation or all (default)
278
279 = Kerberos SSO Authentication =
280
281 {{warning}}
282 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!
283 {{/warning}}
284
285 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.
286
287 First of all you need to create a principal and keytab for the webserver:
288
289 {{code}}
290 # kadmin
291 kadmin> addprinc -randkey HTTP/wiki.example.com
292 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
293 kadmin> quit
294 {{/code}}
295
296 Make sure the keytab has the right permissions and ownership:
297
298 {{code}}
299 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
300 chmod 400 /etc/apache2/ssl/wiki.keytab
301 {{/code}}
302
303 Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
304
305 {{code}}
306 aptitude install libapache2-mod-auth-kerb
307 {{/code}}
308
309 Of course the installation procedure varies per Linux distribution.
310
311 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
312
313 {{code}}
314 <Location /xwiki/>
315 AuthType Kerberos
316 AuthName "Kerberos Login"
317 KrbAuthRealms EXAMPLE.COM
318 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
319 KrbMethodK5Passwd off
320 KrbMethodNegotiate on
321 KrbSaveCredentials on
322 require valid-user
323 </Location>
324 {{/code}}
325
326 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):
327
328 {{code}}
329 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
330 {{/code}}
331
332 Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
333
334 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
335
336 {{code}}
337 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
338 {{/code}}
339
340 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.
341
342 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.
343
344 The configuration of ldap:
345
346 {{code}}
347 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
348 xwiki.authentication.ldap=1
349 xwiki.authentication.ldap.server=<ad-server>
350 xwiki.authentication.ldap.port=389
351 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
352 #use a fixed user to attach to the ldap database,
353 #the password is not provided with the SSOLdapAuthenicationImpl
354 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
355 xwiki.authentication.ldap.bind_pass=<password>
356 #Microsoft AD configuration
357 xwiki.authentication.ldap.UID_attr=sAMAccountName
358 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
359 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
360 #LDAP group mapping
361 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
362 XWiki.XWikiAllGroup=CN=WIKI_User,...........
363 {{/code}}
364
365 The java code
366
367 {{code}}
368 package com.wiki.sso;
369
370
371 import org.apache.commons.logging.Log;
372 import org.apache.commons.logging.LogFactory;
373
374 import com.xpn.xwiki.XWikiContext;
375 import com.xpn.xwiki.XWikiException;
376 import com.xpn.xwiki.user.api.XWikiUser;
377 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
378
379 import java.security.Principal;
380
381 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
382 /**
383 * Logging tool.
384 */
385 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
386
387
388 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
389 String user = getRemoteUser(context);
390 if ((user != null) || !user.equals("")) {
391 if (LOG.isInfoEnabled())
392 LOG.info("Launching create user for " + user);
393 if ( authenticate(user, context) != null ) {
394 if (LOG.isInfoEnabled())
395 LOG.info("Create user done for " + user);
396 user = "XWiki." + user;
397 context.setUser(user);
398 System.out.println("User is set to:" + user);
399 return new XWikiUser(user);
400 } else {
401 LOG.error( "User " + user + " can't be authenticated against ldap" );
402 }
403 }
404 return super.checkAuth(context);
405 }
406
407 /**
408 * We cannot authenticate locally since we need to trust the app server for
409 * authentication
410 *
411 * @param username
412 * @param password
413 * @param context
414 * @return
415 * @throws XWikiException
416 */
417 public XWikiUser checkAuth(String username, String password,
418 String rememberme, XWikiContext context) throws XWikiException {
419 String user = getRemoteUser(context);
420 if ((user == null) || user.equals("")) {
421 return super.checkAuth(username, password, rememberme, context);
422 }
423 return checkAuth(context);
424 }
425
426 private String getRemoteUser(XWikiContext context) {
427 String userName = context.getRequest().getHttpServletRequest()
428 .getRemoteUser();
429 if (userName != null) {
430 // only take the front of the username@domain
431 String[] elements = userName.split("@", 2);
432 userName = elements[0];
433 }
434 return userName;
435 }
436
437 public Principal authenticate(String login, XWikiContext context) throws XWikiException
438 {
439 if (LOG.isTraceEnabled()) {
440 LOG.trace("Starting LDAP authentication");
441 }
442
443 /*
444 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
445 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
446 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
447 */
448
449 if (login == null) {
450 // If we can't find the username field then we are probably on the login screen
451
452 if (LOG.isDebugEnabled()) {
453 LOG.debug("The provided user is null."
454 + " We don't try to authenticate, it probably means the user is in non logged mode.");
455 }
456
457 return null;
458 }
459
460 // Check for empty usernames
461 if (login.equals("")) {
462 context.put("message", "nousername");
463
464 if (LOG.isDebugEnabled()) {
465 LOG.debug("LDAP authentication failed: login empty");
466 }
467
468 return null;
469 }
470
471 // If we have the context then we are using direct mode
472 // then we should specify the database
473 // This is needed for virtual mode to work
474 Principal principal = null;
475
476 // Try authentication against ldap
477 principal = ldapAuthenticate(login, "", context);
478
479 if (LOG.isDebugEnabled()) {
480 if (principal != null) {
481 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
482 } else {
483 LOG.debug("LDAP authentication failed for user [" + login + "]");
484 }
485 }
486
487 return principal;
488 }
489 }
490 {{/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