Skip to Content

Wiki source code of User Authentication

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