Wiki source code of User Authentication

Version 65.1 by tshah12 on 2013/09/16

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

Get Connected