Wiki source code of User Authentication

Version 53.1 by Thomas Mortagne on 2012/05/21

Hide last authors
jmcettrick 1.18 1 XWiki supports several different authentication mechanisms for authenticating users:
Vincent Massol 1.1 2
Silvia Macovei 34.2 3 {{toc/}}
Silvia Macovei 34.1 4
Vincent Massol 1.1 5 The form authentication is the default mechanism.
6
Silvia Macovei 34.1 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}}
Vincent Massol 1.1 10
Silvia Macovei 34.2 11 = Form Authentication =
Vincent Massol 1.1 12
Sorin Burjan 38.2 13 Form authentication is the default way to get authenticated within a Wiki. It requires a user and a password.
Vincent Massol 1.1 14
Vincent Massol 46.1 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: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
Silvia Macovei 34.2 27 = LDAP Authentication =
Vincent Massol 1.1 28
Silvia Macovei 34.1 29 {{warning}}
30 New LDAP implementation since XWiki Platform 1.3M2, see [[previous LDAP authentication service documentation>>AuthenticationLdapOld]]
31 {{/warning}}
Vincent Massol 17.3 32
Silvia Macovei 34.2 33 == Generic LDAP configuration ==
Vincent Massol 1.1 34
Silvia Macovei 34.1 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}}
Thomas Mortagne 50.1 38 #-# LDAP authentication service
39 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
Thomas Mortagne 7.1 40
Thomas Mortagne 50.1 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
Silvia Macovei 34.1 46 {{/code}}
Thomas Mortagne 18.1 47
Silvia Macovei 34.1 48 You can setup the LDAP configuration in the //xwiki.cfg// file by filling the following properties:
Vincent Massol 1.2 49
Silvia Macovei 34.1 50 {{code language="none"}}
Thomas Mortagne 36.1 51 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
52 xwiki.authentication.ldap.server=127.0.0.1
Vincent Massol 1.1 53 xwiki.authentication.ldap.port=389
Thomas Mortagne 6.1 54
Thomas Mortagne 36.1 55 #-# LDAP login, empty = anonymous access, otherwise specify full dn
Thomas Mortagne 50.1 56 #-# {0} is replaced with the user name, {1} with the password
Vincent Massol 1.1 57 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
58 xwiki.authentication.ldap.bind_pass={1}
Thomas Mortagne 6.1 59
Thomas Mortagne 50.1 60 #-# The Base DN used in LDAP searches
61 xwiki.authentication.ldap.base_DN=
Thomas Mortagne 12.1 62
Thomas Mortagne 50.1 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
Thomas Mortagne 36.1 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
Thomas Mortagne 6.1 72
Thomas Mortagne 50.1 73 #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
74 #-# Only users not member of the following group can autheticate
Thomas Mortagne 36.1 75 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
Thomas Mortagne 22.1 76
Thomas Mortagne 50.1 77 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name
78 #-# The default is cn
Thomas Mortagne 36.1 79 # xwiki.authentication.ldap.UID_attr=cn
Thomas Mortagne 6.1 80
Thomas Mortagne 50.1 81 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 82 #-# The potential LDAP groups classes. Separated by commas.
83 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
84
Thomas Mortagne 50.1 85 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 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
Thomas Mortagne 50.1 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
Thomas Mortagne 6.1 99
Thomas Mortagne 50.1 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)
Thomas Mortagne 6.1 111
Thomas Mortagne 50.1 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
Thomas Mortagne 6.1 116
Thomas Mortagne 50.1 117 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 118 #-# - create : synchronize group membership only when the user is first created
119 #-# - always: synchronize on every login
Thomas Mortagne 50.1 120 #-# The default is always
Thomas Mortagne 36.1 121 # xwiki.authentication.ldap.mode_group_sync=always
Thomas Mortagne 6.1 122
Thomas Mortagne 50.1 123 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 124 #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
Thomas Mortagne 50.1 125 #-# The default is 1
Thomas Mortagne 6.1 126 xwiki.authentication.ldap.trylocal=1
Thomas Mortagne 8.1 127
Thomas Mortagne 50.1 128 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 129 #-# SSL connection to LDAP server
Thomas Mortagne 50.1 130 #-# - 0: normal
131 #-# - 1: SSL
132 #-# The default is 0
Thomas Mortagne 36.1 133 # xwiki.authentication.ldap.ssl=0
Thomas Mortagne 8.1 134
Thomas Mortagne 50.1 135 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 136 #-# The keystore file to use in SSL connection
137 # xwiki.authentication.ldap.ssl.keystore=
138
Thomas Mortagne 50.1 139 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
Thomas Mortagne 36.1 140 #-# The java secure provider used in SSL connection
Thomas Mortagne 50.1 141 #-# The default is com.sun.net.ssl.internal.ssl.Provider
Thomas Mortagne 36.1 142 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
Thomas Mortagne 50.1 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
Silvia Macovei 34.1 155 {{/code}}
Vincent Massol 3.1 156
Silvia Macovei 34.1 157 {{info}}
Thomas Mortagne 48.1 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##.
Silvia Macovei 34.1 159 {{/info}}
Thomas Mortagne 9.1 160
jmcettrick 1.19 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
Thomas Mortagne 31.1 163 Here are some LDAP client for checking your configuration:
jmcettrick 1.19 164
Thomas Mortagne 52.1 165 Java based and Open Source:
Silvia Macovei 34.1 166 * [[Apache Directory Studio>>http://directory.apache.org/studio/]]
Thomas Mortagne 51.1 167 * [[JXplorer>>http://jxplorer.org]]
jmcettrick 1.19 168
Thomas Mortagne 52.1 169 Windows only:
170 * [[Softerra LDAP Browser>>http://www.ldapbrowser.com/download.htm]]
171
Silvia Macovei 34.2 172 == Detailed use cases ==
Thomas Mortagne 12.1 173
Silvia Macovei 34.1 174 See [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
Thomas Mortagne 25.1 175
Silvia Macovei 34.2 176 == Enable LDAP debug log ==
Silvia Macovei 34.1 177
Thomas Mortagne 42.1 178 See [[AdminGuide.Logging]].
Silvia Macovei 34.1 179
Thomas Mortagne 45.1 180 The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ##com.xpn.xwiki.user.impl.LDAP##.
Thomas Mortagne 27.1 181
AdrianFita 49.1 182 In XWiki 3.4 you need to add the following in ##WEB-INF/classes/logback.xml##:
183
184 {{code}}
185 <!-- LDAP debugging -->
186 <logger name="com.xpn.xwiki.plugin.ldap" level="trace"/>
187 <logger name="com.xpn.xwiki.user.impl.LDAP" level="trace"/>
188 {{/code}}
189
Thomas Mortagne 42.1 190 Before 3.1, add the following to the log4j configuration file:
191
Thomas Mortagne 44.1 192 {{code}}
193 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
194 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
195 {{/code}}
196
Silvia Macovei 34.2 197 = eXo Authentication =
hexC0DE 30.1 198
Silvia Macovei 34.1 199 The eXo authentication is used automatically by adding/editing the //xwiki.exo=1// property in //WEB-INF/xwiki.cfg//.
Vincent Massol 1.1 200
Silvia Macovei 34.2 201 = Custom Authentication =
Vincent Massol 1.1 202
203 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
204
Sergiu Dumitriu 47.2 205 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
Silvia Macovei 34.1 206 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
207
208 {{code}}
Vincent Massol 1.1 209 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
Silvia Macovei 34.1 210 {{/code}}
Vincent Massol 1.1 211
Silvia Macovei 34.1 212 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/]].
Vincent Massol 27.2 213
Sergiu Dumitriu 47.2 214 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:
Silvia Macovei 34.1 215
216 {{code}}
rssh 5.1 217 xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
Silvia Macovei 34.1 218 {{/code}}
rssh 4.1 219
Sergiu Dumitriu 47.2 220 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}}:
rssh 4.1 221
Silvia Macovei 34.1 222 {{code}}
Vincent Massol 27.3 223 xwiki.authentication.groupclass = com.acme.MyCustomGroupService
Silvia Macovei 34.1 224 {{/code}}
rssh 4.1 225
Silvia Macovei 34.2 226 == Custom Authentication using a Groovy script in a wiki page ==
Vincent Massol 28.1 227
228 Start by specifying you want to use the Groovy Authenticator:
229
Silvia Macovei 34.1 230 {{code}}
Vincent Massol 28.1 231 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
Silvia Macovei 34.1 232 {{/code}}
Vincent Massol 28.1 233
234 Then add another configuration parameter to specify in which wiki page the authenticator is:
235
Silvia Macovei 34.1 236 {{code}}
Vincent Massol 28.1 237 xwiki.authentication.groovy.pagename = MySpace.MyPage
Silvia Macovei 34.1 238 {{/code}}
Vincent Massol 28.1 239
240 Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
241
Thomas Mortagne 37.1 242 = Authentication parameters =
ShawnLauzon 1.14 243
244 You can set each of these parameters by setting:
245
Silvia Macovei 34.1 246 {{code}}
ShawnLauzon 1.14 247 xwiki.authentication.~~param_name~~=~~param_value~~
Silvia Macovei 34.1 248 {{/code}}
ShawnLauzon 1.14 249
Silvia Macovei 34.1 250 |=Name|=Optional|=Allowed values|=Default value|=Description
251 |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.
252 |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.
253 |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
254 |cookielife|Yes|Number|14|Number of days cookies take to expire
255 |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//
256 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
257 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
258 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
259 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
260 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
261 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
Caleb James DeLisle 35.1 262 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
Silvia Macovei 34.1 263 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
264 |realmname|Yes|String|XWiki|Sets the realm name
265 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
Caleb James DeLisle 35.1 266 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
Silvia Macovei 34.1 267 |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.
ShawnLauzon 1.16 268
Silvia Macovei 34.1 269 1. Only required if protection = encryption or all (default)
270 1. Only required if protection = validation or all (default)
ShawnLauzon 1.17 271
Silvia Macovei 34.2 272 = Kerberos SSO Authentication =
JasperSiepkes 21.1 273
Silvia Macovei 34.1 274 {{warning}}
275 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!
276 {{/warning}}
277
JasperSiepkes 20.1 278 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.
jmcettrick 1.18 279
JasperSiepkes 20.1 280 First of all you need to create a principal and keytab for the webserver:
Silvia Macovei 34.1 281
282 {{code}}
JasperSiepkes 20.1 283 # kadmin
284 kadmin> addprinc -randkey HTTP/wiki.example.com
285 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
286 kadmin> quit
Silvia Macovei 34.1 287 {{/code}}
Thomas Mortagne 10.1 288
JasperSiepkes 20.1 289 Make sure the keytab has the right permissions and ownership:
Silvia Macovei 34.1 290
291 {{code}}
JasperSiepkes 20.1 292 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
293 chmod 400 /etc/apache2/ssl/wiki.keytab
Silvia Macovei 34.1 294 {{/code}}
Thomas Mortagne 11.1 295
JasperSiepkes 20.1 296 Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
Silvia Macovei 34.1 297
298 {{code}}
JasperSiepkes 20.1 299 aptitude install libapache2-mod-auth-kerb
Silvia Macovei 34.1 300 {{/code}}
301
JasperSiepkes 20.1 302 Of course the installation procedure varies per Linux distribution.
303
304 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
Silvia Macovei 34.1 305
306 {{code}}
JasperSiepkes 20.1 307 <Location /xwiki/>
308 AuthType Kerberos
309 AuthName "Kerberos Login"
310 KrbAuthRealms EXAMPLE.COM
311 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
312 KrbMethodK5Passwd off
313 KrbMethodNegotiate on
314 KrbSaveCredentials on
315 require valid-user
316 </Location>
Silvia Macovei 34.1 317 {{/code}}
JasperSiepkes 20.1 318
319 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):
Silvia Macovei 34.1 320
321 {{code}}
JasperSiepkes 20.1 322 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
Silvia Macovei 34.1 323 {{/code}}
JasperSiepkes 20.1 324
325 Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
326
327 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
Silvia Macovei 34.1 328
329 {{code}}
JasperSiepkes 20.1 330 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
Silvia Macovei 34.1 331 {{/code}}
JasperSiepkes 20.1 332
Silvia Macovei 34.1 333 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.
JasperSiepkes 20.1 334
Silvia Macovei 34.1 335 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.
jek 29.1 336
Silvia Macovei 34.2 337 The configuration of ldap:
jek 29.1 338
Silvia Macovei 34.1 339 {{code}}
jek 29.1 340 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
341 xwiki.authentication.ldap=1
342 xwiki.authentication.ldap.server=<ad-server>
343 xwiki.authentication.ldap.port=389
344 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
345 #use a fixed user to attach to the ldap database,
346 #the password is not provided with the SSOLdapAuthenicationImpl
347 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
348 xwiki.authentication.ldap.bind_pass=<password>
349 #Microsoft AD configuration
350 xwiki.authentication.ldap.UID_attr=sAMAccountName
351 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
352 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
353 #LDAP group mapping
354 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
355 XWiki.XWikiAllGroup=CN=WIKI_User,...........
Silvia Macovei 34.1 356 {{/code}}
jek 29.1 357
358 The java code
Silvia Macovei 34.1 359
360 {{code}}
jek 29.1 361 package com.wiki.sso;
362
363
364 import org.apache.commons.logging.Log;
365 import org.apache.commons.logging.LogFactory;
366
367 import com.xpn.xwiki.XWikiContext;
368 import com.xpn.xwiki.XWikiException;
369 import com.xpn.xwiki.user.api.XWikiUser;
370 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
371
372 import java.security.Principal;
373
374 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
375 /**
376 * Logging tool.
377 */
378 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
379
380
381 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
382 String user = getRemoteUser(context);
383 if ((user != null) || !user.equals("")) {
384 if (LOG.isInfoEnabled())
385 LOG.info("Launching create user for " + user);
386 if ( authenticate(user, context) != null ) {
387 if (LOG.isInfoEnabled())
388 LOG.info("Create user done for " + user);
389 user = "XWiki." + user;
390 context.setUser(user);
391 System.out.println("User is set to:" + user);
392 return new XWikiUser(user);
393 } else {
394 LOG.error( "User " + user + " can't be authenticated against ldap" );
395 }
396 }
397 return super.checkAuth(context);
398 }
399
400 /**
401 * We cannot authenticate locally since we need to trust the app server for
402 * authentication
403 *
404 * @param username
405 * @param password
406 * @param context
407 * @return
408 * @throws XWikiException
409 */
410 public XWikiUser checkAuth(String username, String password,
411 String rememberme, XWikiContext context) throws XWikiException {
412 String user = getRemoteUser(context);
413 if ((user == null) || user.equals("")) {
414 return super.checkAuth(username, password, rememberme, context);
415 }
416 return checkAuth(context);
417 }
418
419 private String getRemoteUser(XWikiContext context) {
420 String userName = context.getRequest().getHttpServletRequest()
421 .getRemoteUser();
422 if (userName != null) {
423 // only take the front of the username@domain
424 String[] elements = userName.split("@", 2);
425 userName = elements[0];
426 }
427 return userName;
428 }
429
430 public Principal authenticate(String login, XWikiContext context) throws XWikiException
431 {
432 if (LOG.isTraceEnabled()) {
433 LOG.trace("Starting LDAP authentication");
434 }
435
436 /*
437 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
438 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
439 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
440 */
441
442 if (login == null) {
443 // If we can't find the username field then we are probably on the login screen
444
445 if (LOG.isDebugEnabled()) {
446 LOG.debug("The provided user is null."
447 + " We don't try to authenticate, it probably means the user is in non logged mode.");
448 }
449
450 return null;
451 }
452
453 // Check for empty usernames
454 if (login.equals("")) {
455 context.put("message", "nousername");
456
457 if (LOG.isDebugEnabled()) {
458 LOG.debug("LDAP authentication failed: login empty");
459 }
460
461 return null;
462 }
463
464 // If we have the context then we are using direct mode
465 // then we should specify the database
466 // This is needed for virtual mode to work
467 Principal principal = null;
468
469 // Try authentication against ldap
470 principal = ldapAuthenticate(login, "", context);
471
472 if (LOG.isDebugEnabled()) {
473 if (principal != null) {
474 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
475 } else {
476 LOG.debug("LDAP authentication failed for user [" + login + "]");
477 }
478 }
479
480 return principal;
481 }
482 }
Silvia Macovei 34.1 483 {{/code}}

Get Connected