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 Also note that XWiki requires cookies to be enable in order to track your session and to keep you logged in between pages.
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 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:
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 = Container Authentication =
28
29 Delegates authentication to the Servlet Container. If it fails it falls back to the standard XWiki authentication.
30
31 To configure XWiki to use it, specify:
32
33 {{code language="properties"}}
34 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedAuthServiceImpl
35 {{/code}}
36
37 For users to be actually created and not just set as context user you must set in ##xwiki.cfg## configuration file (if the property does not already exist, create it):
38
39 {{code language="properties"}}
40 xwiki.authentication.createuser=empty
41 {{/code}}
42
43 = Social Login =
44
45 See the [[Social Login Application>>extensions:Extension.Social Login Application]].
46
47 = LDAP Authentication =
48
49 Since 7.4 it's recommended to use the new [[LDAP Authenticator extension>>extensions:Extension.LDAP.Authenticator]] instead of the core one.
50
51 The following documentation is for the core LDAP authenticator which has been removed in 8.3.
52
53 If you are going to use the [[LDAP Admin Extension>>extensions:Extension.LDAP.Application]], 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 the XWiki webapp, LDAP Extension allows you to make changes without restarting.
54
55 == Generic LDAP configuration ==
56
57 In order to enable the LDAP support you have to change the authentication method in //WEB-INF/xwiki.cfg// as follows:
58
59 {{code language="properties"}}
60 #-# LDAP authentication service
61 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
62
63 #-# Turn LDAP authentication on - otherwise only XWiki authentication
64 #-# - 0: disable
65 #-# - 1: enable
66 #-# The default is 1
67 # xwiki.authentication.ldap=1
68 {{/code}}
69
70 You can setup the LDAP configuration in the **xwiki.cfg** file by filling the following properties:
71
72 {{code language="properties"}}
73 #-# Turn LDAP authentication on - otherwise only XWiki authentication
74 #-# - 0: disable
75 #-# - 1: enable
76 #-# The default is 0
77 # xwiki.authentication.ldap=1
78
79 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
80 xwiki.authentication.ldap.server=127.0.0.1
81 xwiki.authentication.ldap.port=389
82
83 #-# LDAP login, empty = anonymous access, otherwise specify full dn
84 #-# {0} is replaced with the user name, {1} with the password
85 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
86 xwiki.authentication.ldap.bind_pass={1}
87
88 #-# The Base DN used in LDAP searches
89 xwiki.authentication.ldap.base_DN=
90
91 #-# LDAP query to search the user in the LDAP database (in case a static admin user is provided in
92 #-# xwiki.authentication.ldap.bind_DN)
93 #-# {0} is replaced with the user uid field name and {1} with the user name
94 #-# The default is ({0}={1})
95 # xwiki.authentication.ldap.user_search_fmt=({0}={1})
96
97 #-# Only members of the following group can authenticate.
98 #-# The following kind of groups are supported:
99 #-# * LDAP static groups (users/subgroups are listed statically in the group object)
100 #-# * [Since 3.3M1] LDAP organization units (users/subgroups are sub object of the provided organization unit)
101 #-# * [Since 3.3M1] LDAP filter (users/groups are object found in a search with the provided filter)
102 # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
103
104 #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
105 #-# Only users not member of the following group can authenticate.
106 #-# The following kind of groups are supported:
107 #-# * LDAP static groups (users/subgroups are listed statically in the group object)
108 #-# * [Since 3.3M1] LDAP organization units (users/subgroups are sub object of the provided organization unit)
109 #-# * [Since 3.3M1] LDAP filter (users/groups are object found in a search with the provided filter)
110 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
111
112 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name
113 #-# The default is cn
114 # xwiki.authentication.ldap.UID_attr=cn
115
116 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
117 #-# The potential LDAP groups classes. Separated by commas.
118 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList,posixGroup,apple-group
119
120 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
121 #-# The potential names of the LDAP groups fields containings the members. Separated by commas.
122 # xwiki.authentication.ldap.group_memberfields=member,uniqueMember,memberUid
123
124 #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
125 xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
126
127 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
128 #-# On every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki
129 #-# account is created.
130 #-# - 0: only when creating user
131 #-# - 1: at each authentication
132 #-# The default is 0
133 xwiki.authentication.ldap.update_user=1
134
135 #-# [Since 8.1M2, XWikiLDAPAuthServiceImpl]
136 #-# On every login update photo from LDAP to XWiki avatar otherwise photo will not be updated.
137 #-# - 0: never
138 #-# - 1: at each authentication
139 #-# The default is 0
140 # xwiki.authentication.ldap.update_photo=0
141
142 #-# [Since 8.1M2, XWikiLDAPAuthServiceImpl]
143 #-# Profile attachment name which will be used to save LDAP photo.
144 #-# The default is ldapPhoto
145 # xwiki.authentication.ldap.photo_attachment_name=ldapPhoto
146
147 #-# [Since 8.1M2, XWikiLDAPAuthServiceImpl]
148 #-# Specifies the LDAP attribute containing the binary photo
149 #-# The default is thumbnailPhoto
150 # xwiki.authentication.ldap.photo_attribute=thumbnailPhoto
151
152 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
153 #-# Maps XWiki groups to LDAP groups, separator is "|".
154 #-# The following kind of groups are supported:
155 #-# * LDAP static groups (users/subgroups are listed statically in the group object)
156 #-# * [Since 3.3M1] LDAP organization units (users/subgroups are sub object of the provided organization unit)
157 #-# * [Since 3.3M1] LDAP filter (users/groups are object found in a search with the provided filter),
158 #-# | character in the filter need to be escaped with backslash (\).
159 #-#
160 #-# Here is an example:
161 # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=domain,c=com|\
162 # XWiki.LDAPUsers=ou=groups,o=domain,c=com|\
163 # XWiki.Organisation=(cn=testers)
164
165 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
166 #-# Time in s after which the list of members in a group is refreshed from LDAP
167 #-# The default is 21600 (6 hours)
168 # xwiki.authentication.ldap.groupcache_expiration=21600
169
170 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
171 #-# - create : synchronize group membership only when the user is first created
172 #-# - always: synchronize on every login
173 #-# The default is always
174 # xwiki.authentication.ldap.mode_group_sync=always
175
176 #-# [Since 7.2M3, XWikiLDAPAuthServiceImpl]
177 #-# Indicate groups members should be resolved in case they are subgroups.
178 #-# Doing so can be very expensive so it should be disabled if you know there is no subgroups
179 #-# (or if you don't care about them).
180 #-# If the group is actually a filter it will always be resolved since it does not make sense left alone.
181 #-# - 0: disable
182 #-# - 1: enable
183 #-# The default is 1
184 # xwiki.authentication.ldap.group_sync_resolve_subgroups=0
185
186 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
187 #-# If ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
188 #-# - 0: disable
189 #-# - 1: enable
190 #-# The default is 0
191 xwiki.authentication.ldap.trylocal=1
192
193 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
194 #-# SSL connection to LDAP server
195 #-# - 0: normal
196 #-# - 1: SSL
197 #-# The default is 0
198 # xwiki.authentication.ldap.ssl=0
199
200 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
201 #-# The keystore file to use in SSL connection
202 # xwiki.authentication.ldap.ssl.keystore=
203
204 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
205 #-# The java secure provider used in SSL connection
206 #-# The default is com.sun.net.ssl.internal.ssl.Provider
207 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
208
209 #-# Bypass standard LDAP bind validation by doing a direct password comparison.
210 #-# If you don't know what you do, don't use that. It's covering very rare and bad use cases.
211 #-# - 0: disable
212 #-# - 1: enable
213 #-# The default is 0
214 # xwiki.authentication.ldap.validate_password=0
215
216 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
217 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password"
218 #-# is set to 1
219 # xwiki.authentication.ldap.password_field=userPassword
220
221 #-# [Since 4.3M1, XWikiLDAPAuthServiceImpl]
222 #-# The maximum number of milliseconds the client waits for any operation under these constraints to complete.
223 #-# The default is 1000
224 # xwiki.authentication.ldap.timeout=1000
225
226 #-# [Since 6.3M1, XWikiLDAPAuthServiceImpl]
227 #-# The maximum number of search results to be returned from a search operation.
228 #-# The default is 1000
229 # xwiki.authentication.ldap.maxresults=1000
230 {{/code}}
231
232 {{info}}
233 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##.
234 {{/info}}
235
236 == LDAP clients ==
237
238 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.
239
240 Here are some LDAP clients for checking your configuration:
241
242 Extensions:
243
244 * [[LDAP query snippet>>http://snippets.xwiki.org/xwiki/bin/view/Extension/LDAP+Query]]
245
246 Java based and Open Source:
247
248 * [[Apache Directory Studio>>http://directory.apache.org/studio/]]
249 * [[JXplorer>>http://jxplorer.org/]]
250
251 Windows only:
252
253 * [[Softerra LDAP Browser>>http://www.ldapbrowser.com/info_softerra-ldap-browser.htm]]
254
255 == Detailed use cases ==
256
257 See the [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
258
259 == Enable LDAP debug log ==
260
261 See [[AdminGuide.Logging]].
262
263 The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ##com.xpn.xwiki.user.impl.LDAP##.
264
265 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.
266
267 In XWiki 3.4 you need to add the following in ##WEB-INF/classes/logback.xml##:
268
269 {{code}}
270 <!-- LDAP debugging -->
271 <logger name="com.xpn.xwiki.plugin.ldap" level="trace"/>
272 <logger name="com.xpn.xwiki.user.impl.LDAP" level="trace"/>
273 {{/code}}
274
275 Before 3.1, add the following to the log4j configuration file:
276
277 {{code}}
278 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
279 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
280 {{/code}}
281
282 = Custom Authentication =
283
284 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
285
286 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
287 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
288
289 {{code language="properties"}}
290 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
291 {{/code}}
292
293 You can find various authenticators examples in [[sandbox>>https://github.com/xwiki-contrib/sandbox/tree/master/authenticators]] or [[extensions>>http://extensions.xwiki.org/xwiki/bin/view/Main/WebHome#|t=extensions&p=1&l=30&s=doc.creationDate&d=desc&name=authenticator]].
294
295 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/]].
296
297 Note that it's also possible to customize the right management system, see [[extensions:Extension.Security Module]] for more details.
298
299 == Custom Authentication using a Groovy script in a wiki page ==
300
301 Start by specifying you want to use the Groovy Authenticator:
302
303 {{code language="properties"}}
304 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
305 {{/code}}
306
307 Then add another configuration parameter to specify in which wiki page the authenticator is:
308
309 {{code language="properties"}}
310 xwiki.authentication.groovy.pagename = MySpace.MyPage
311 {{/code}}
312
313 Then put some Groovy code in a wiki page that returns a XWikiAuthService object.
314
315 = Authentication parameters =
316
317 You can set each of these parameters by setting:
318
319 {{code}}
320 xwiki.authentication.<param_name>=<param_value>
321 {{/code}}
322
323 |=Name|=Optional|=Allowed values|=Default value|=Description
324 |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.
325 |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.
326 |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
327 |cookielife|Yes|Number|14|Number of days cookies take to expire
328 |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//
329 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
330 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
331 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
332 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
333 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
334 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
335 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
336 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
337 |realmname|Yes|String|XWiki|Sets the realm name
338 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
339 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
340 |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.
341
342 1. Only required if protection = encryption or all (default)
343 1. Only required if protection = validation or all (default)
344
345 = Kerberos SSO Authentication =
346
347 {{warning}}
348 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!
349 {{/warning}}
350
351 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.
352
353 First of all you need to create a principal and keytab for the webserver:
354
355 {{code}}
356 # kadmin
357 kadmin> addprinc -randkey HTTP/wiki.example.com
358 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
359 kadmin> quit
360 {{/code}}
361
362 Make sure the keytab has the right permissions and ownership:
363
364 {{code}}
365 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
366 chmod 400 /etc/apache2/ssl/wiki.keytab
367 {{/code}}
368
369 Install **mod_auth_kerb** in your linux installation. On Debian or Ubuntu this would be achieved by running:
370
371 {{code}}
372 aptitude install libapache2-mod-auth-kerb
373 {{/code}}
374
375 Of course the installation procedure varies per Linux distribution.
376
377 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
378
379 {{code}}
380 <Location /xwiki/>
381 AuthType Kerberos
382 AuthName "Kerberos Login"
383 KrbAuthRealms EXAMPLE.COM
384 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
385 KrbMethodK5Passwd off
386 KrbMethodNegotiate on
387 KrbSaveCredentials on
388 require valid-user
389 </Location>
390 {{/code}}
391
392 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):
393
394 {{code}}
395 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
396 {{/code}}
397
398 Place the **authkerb.jar** jar in the ##WEB-INF/lib## directory of XWiki in Apache Tomcat.
399
400 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in the ##WEB-INF/lib/xwiki.cfg## file.
401
402 {{code}}
403 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
404 {{/code}}
405
406 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.
407
408 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.
409
410 The configuration of ldap:
411
412 {{code}}
413 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
414 xwiki.authentication.ldap=1
415 xwiki.authentication.ldap.server=<ad-server>
416 xwiki.authentication.ldap.port=389
417 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
418 #use a fixed user to attach to the ldap database,
419 #the password is not provided with the SSOLdapAuthenicationImpl
420 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
421 xwiki.authentication.ldap.bind_pass=<password>
422 #Microsoft AD configuration
423 xwiki.authentication.ldap.UID_attr=sAMAccountName
424 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
425 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
426 #LDAP group mapping
427 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
428 XWiki.XWikiAllGroup=CN=WIKI_User,...........
429 {{/code}}
430
431 The java code:
432
433 {{code}}
434 package com.wiki.sso;
435
436
437 import org.apache.commons.logging.Log;
438 import org.apache.commons.logging.LogFactory;
439
440 import com.xpn.xwiki.XWikiContext;
441 import com.xpn.xwiki.XWikiException;
442 import com.xpn.xwiki.user.api.XWikiUser;
443 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
444
445 import java.security.Principal;
446
447 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
448 /**
449 * Logging tool.
450 */
451 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
452
453
454 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
455 String user = getRemoteUser(context);
456 if ((user != null) || !user.equals("")) {
457 if (LOG.isInfoEnabled())
458 LOG.info("Launching create user for " + user);
459 if ( authenticate(user, context) != null ) {
460 if (LOG.isInfoEnabled())
461 LOG.info("Create user done for " + user);
462 user = "XWiki." + user;
463 context.setUser(user);
464 System.out.println("User is set to:" + user);
465 return new XWikiUser(user);
466 } else {
467 LOG.error( "User " + user + " can't be authenticated against ldap" );
468 }
469 }
470 return super.checkAuth(context);
471 }
472
473 /**
474 * We cannot authenticate locally since we need to trust the app server for
475 * authentication
476 *
477 * @param username
478 * @param password
479 * @param context
480 * @return
481 * @throws XWikiException
482 */
483 public XWikiUser checkAuth(String username, String password,
484 String rememberme, XWikiContext context) throws XWikiException {
485 String user = getRemoteUser(context);
486 if ((user == null) || user.equals("")) {
487 return super.checkAuth(username, password, rememberme, context);
488 }
489 return checkAuth(context);
490 }
491
492 private String getRemoteUser(XWikiContext context) {
493 String userName = context.getRequest().getHttpServletRequest()
494 .getRemoteUser();
495 if (userName != null) {
496 // only take the front of the [email protected]
497 String[] elements = userName.split("@", 2);
498 userName = elements[0];
499 }
500 return userName;
501 }
502
503 public Principal authenticate(String login, XWikiContext context) throws XWikiException
504 {
505 if (LOG.isTraceEnabled()) {
506 LOG.trace("Starting LDAP authentication");
507 }
508
509 /*
510 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
511 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
512 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
513 */
514
515 if (login == null) {
516 // If we can't find the username field then we are probably on the login screen
517
518 if (LOG.isDebugEnabled()) {
519 LOG.debug("The provided user is null."
520 + " We don't try to authenticate, it probably means the user is in non logged mode.");
521 }
522
523 return null;
524 }
525
526 // Check for empty usernames
527 if (login.equals("")) {
528 context.put("message", "nousername");
529
530 if (LOG.isDebugEnabled()) {
531 LOG.debug("LDAP authentication failed: login empty");
532 }
533
534 return null;
535 }
536
537 // If we have the context then we are using direct mode
538 // then we should specify the database
539 // This is needed for virtual mode to work
540 Principal principal = null;
541
542 // Try authentication against ldap
543 principal = ldapAuthenticate(login, "", context);
544
545 if (LOG.isDebugEnabled()) {
546 if (principal != null) {
547 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
548 } else {
549 LOG.debug("LDAP authentication failed for user [" + login + "]");
550 }
551 }
552
553 return principal;
554 }
555 }
556 {{/code}}

Get Connected