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

Get Connected