Wiki source code of User Authentication

Version 78.1 by Thomas Mortagne on 2015/08/24

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

Get Connected