Skip to Content

Wiki source code of User Authentication

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