Wiki source code of User Authentication

Version 52.1 by Thomas Mortagne on 2012/05/15

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

Get Connected