Skip to Content

Wiki source code of User Authentication

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