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

Get Connected