Skip to Content

Wiki source code of User Authentication

Version 49.1 by AdrianFita on 2012/02/20
Show last authors
1 XWiki supports several different authentication mechanisms for authenticating users:
2
3 {{toc/}}
4
5 The form authentication is the default mechanism.
6
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}}
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 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
27 = LDAP Authentication =
28
29 {{warning}}
30 New LDAP implementation since XWiki Platform 1.3M2, see [[previous LDAP authentication service documentation>>AuthenticationLdapOld]]
31 {{/warning}}
32
33 == Generic LDAP configuration ==
34
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}}
38 ## Turn LDAP authentication on - otherwise only XWiki authentication
39 ## 0 : disable
40 ## 1 : enable
41 xwiki.authentication.ldap=1
42
43 ## set LDAP as authentication service
44 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
45 {{/code}}
46
47 You can setup the LDAP configuration in the //xwiki.cfg// file by filling the following properties:
48
49 {{code language="none"}}
50 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
51 xwiki.authentication.ldap.server=127.0.0.1
52 xwiki.authentication.ldap.port=389
53
54 #-# LDAP login, empty = anonymous access, otherwise specify full dn
55 #-# {0} is replaced with the username, {1} with the password
56 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
57 xwiki.authentication.ldap.bind_pass={1}
58
59 #-# Force to check password after LDAP connection
60 #-# 0: disable
61 #-# 1: enable
62 xwiki.authentication.ldap.validate_password=0
63
64 #-# only members of the following group will be verified in the LDAP
65 #-# otherwise only users that are found after searching starting from the base_DN
66 # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
67
68 #-# only users not member of the following group can autheticate
69 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
70
71 #-# base DN for searches
72 xwiki.authentication.ldap.base_DN=
73
74 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
75 # xwiki.authentication.ldap.UID_attr=cn
76
77 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
78 # xwiki.authentication.ldap.password_field=userPassword
79
80 #-# The potential LDAP groups classes. Separated by commas.
81 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
82
83 #-# The potential names of the LDAP groups fields containings the members. Separated by commas.
84 # xwiki.authentication.ldap.group_memberfields=member,uniqueMember
85
86 #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
87 xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
88
89 #-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
90 xwiki.authentication.ldap.update_user=1
91
92 #-# mapps XWiki groups to LDAP groups, separator is "|"
93 # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\
94 # XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
95
96 #-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
97 # xwiki.authentication.ldap.groupcache_expiration=21800
98
99 #-# - create : synchronize group membership only when the user is first created
100 #-# - always: synchronize on every login
101 # xwiki.authentication.ldap.mode_group_sync=always
102
103 #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
104 xwiki.authentication.ldap.trylocal=1
105
106 #-# SSL connection to LDAP server
107 #-# 0: normal
108 #-# 1: SSL
109 # xwiki.authentication.ldap.ssl=0
110
111 #-# The keystore file to use in SSL connection
112 # xwiki.authentication.ldap.ssl.keystore=
113
114 #-# The java secure provider used in SSL connection
115 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
116 {{/code}}
117
118 {{info}}
119 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##.
120 {{/info}}
121
122 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.
123
124 Here are some LDAP client for checking your configuration:
125
126 * [[Apache Directory Studio>>http://directory.apache.org/studio/]]
127 * [[LDAPExplorerTool>>http://ldaptool.sourceforge.net/]]
128
129 == Detailed use cases ==
130
131 See [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
132
133 == Enable LDAP debug log ==
134
135 See [[AdminGuide.Logging]].
136
137 The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ##com.xpn.xwiki.user.impl.LDAP##.
138
139 In XWiki 3.4 you need to add the following in ##WEB-INF/classes/logback.xml##:
140
141 {{code}}
142 <!-- LDAP debugging -->
143 <logger name="com.xpn.xwiki.plugin.ldap" level="trace"/>
144 <logger name="com.xpn.xwiki.user.impl.LDAP" level="trace"/>
145 {{/code}}
146
147 Before 3.1, add the following to the log4j configuration file:
148
149 {{code}}
150 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
151 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
152 {{/code}}
153
154 = eXo Authentication =
155
156 The eXo authentication is used automatically by adding/editing the //xwiki.exo=1// property in //WEB-INF/xwiki.cfg//.
157
158 = Custom Authentication =
159
160 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
161
162 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
163 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
164
165 {{code}}
166 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
167 {{/code}}
168
169 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/]].
170
171 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:
172
173 {{code}}
174 xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
175 {{/code}}
176
177 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}}:
178
179 {{code}}
180 xwiki.authentication.groupclass = com.acme.MyCustomGroupService
181 {{/code}}
182
183 == Custom Authentication using a Groovy script in a wiki page ==
184
185 Start by specifying you want to use the Groovy Authenticator:
186
187 {{code}}
188 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
189 {{/code}}
190
191 Then add another configuration parameter to specify in which wiki page the authenticator is:
192
193 {{code}}
194 xwiki.authentication.groovy.pagename = MySpace.MyPage
195 {{/code}}
196
197 Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
198
199 = Authentication parameters =
200
201 You can set each of these parameters by setting:
202
203 {{code}}
204 xwiki.authentication.~~param_name~~=~~param_value~~
205 {{/code}}
206
207 |=Name|=Optional|=Allowed values|=Default value|=Description
208 |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.
209 |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.
210 |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
211 |cookielife|Yes|Number|14|Number of days cookies take to expire
212 |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//
213 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
214 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
215 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
216 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
217 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
218 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
219 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
220 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
221 |realmname|Yes|String|XWiki|Sets the realm name
222 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
223 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
224 |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.
225
226 1. Only required if protection = encryption or all (default)
227 1. Only required if protection = validation or all (default)
228
229 = Kerberos SSO Authentication =
230
231 {{warning}}
232 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!
233 {{/warning}}
234
235 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.
236
237 First of all you need to create a principal and keytab for the webserver:
238
239 {{code}}
240 # kadmin
241 kadmin> addprinc -randkey HTTP/wiki.example.com
242 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
243 kadmin> quit
244 {{/code}}
245
246 Make sure the keytab has the right permissions and ownership:
247
248 {{code}}
249 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
250 chmod 400 /etc/apache2/ssl/wiki.keytab
251 {{/code}}
252
253 Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
254
255 {{code}}
256 aptitude install libapache2-mod-auth-kerb
257 {{/code}}
258
259 Of course the installation procedure varies per Linux distribution.
260
261 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
262
263 {{code}}
264 <Location /xwiki/>
265 AuthType Kerberos
266 AuthName "Kerberos Login"
267 KrbAuthRealms EXAMPLE.COM
268 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
269 KrbMethodK5Passwd off
270 KrbMethodNegotiate on
271 KrbSaveCredentials on
272 require valid-user
273 </Location>
274 {{/code}}
275
276 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):
277
278 {{code}}
279 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
280 {{/code}}
281
282 Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
283
284 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
285
286 {{code}}
287 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
288 {{/code}}
289
290 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.
291
292 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.
293
294 The configuration of ldap:
295
296 {{code}}
297 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
298 xwiki.authentication.ldap=1
299 xwiki.authentication.ldap.server=<ad-server>
300 xwiki.authentication.ldap.port=389
301 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
302 #use a fixed user to attach to the ldap database,
303 #the password is not provided with the SSOLdapAuthenicationImpl
304 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
305 xwiki.authentication.ldap.bind_pass=<password>
306 #Microsoft AD configuration
307 xwiki.authentication.ldap.UID_attr=sAMAccountName
308 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
309 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
310 #LDAP group mapping
311 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
312 XWiki.XWikiAllGroup=CN=WIKI_User,...........
313 {{/code}}
314
315 The java code
316
317 {{code}}
318 package com.wiki.sso;
319
320
321 import org.apache.commons.logging.Log;
322 import org.apache.commons.logging.LogFactory;
323
324 import com.xpn.xwiki.XWikiContext;
325 import com.xpn.xwiki.XWikiException;
326 import com.xpn.xwiki.user.api.XWikiUser;
327 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
328
329 import java.security.Principal;
330
331 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
332 /**
333 * Logging tool.
334 */
335 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
336
337
338 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
339 String user = getRemoteUser(context);
340 if ((user != null) || !user.equals("")) {
341 if (LOG.isInfoEnabled())
342 LOG.info("Launching create user for " + user);
343 if ( authenticate(user, context) != null ) {
344 if (LOG.isInfoEnabled())
345 LOG.info("Create user done for " + user);
346 user = "XWiki." + user;
347 context.setUser(user);
348 System.out.println("User is set to:" + user);
349 return new XWikiUser(user);
350 } else {
351 LOG.error( "User " + user + " can't be authenticated against ldap" );
352 }
353 }
354 return super.checkAuth(context);
355 }
356
357 /**
358 * We cannot authenticate locally since we need to trust the app server for
359 * authentication
360 *
361 * @param username
362 * @param password
363 * @param context
364 * @return
365 * @throws XWikiException
366 */
367 public XWikiUser checkAuth(String username, String password,
368 String rememberme, XWikiContext context) throws XWikiException {
369 String user = getRemoteUser(context);
370 if ((user == null) || user.equals("")) {
371 return super.checkAuth(username, password, rememberme, context);
372 }
373 return checkAuth(context);
374 }
375
376 private String getRemoteUser(XWikiContext context) {
377 String userName = context.getRequest().getHttpServletRequest()
378 .getRemoteUser();
379 if (userName != null) {
380 // only take the front of the username@domain
381 String[] elements = userName.split("@", 2);
382 userName = elements[0];
383 }
384 return userName;
385 }
386
387 public Principal authenticate(String login, XWikiContext context) throws XWikiException
388 {
389 if (LOG.isTraceEnabled()) {
390 LOG.trace("Starting LDAP authentication");
391 }
392
393 /*
394 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
395 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
396 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
397 */
398
399 if (login == null) {
400 // If we can't find the username field then we are probably on the login screen
401
402 if (LOG.isDebugEnabled()) {
403 LOG.debug("The provided user is null."
404 + " We don't try to authenticate, it probably means the user is in non logged mode.");
405 }
406
407 return null;
408 }
409
410 // Check for empty usernames
411 if (login.equals("")) {
412 context.put("message", "nousername");
413
414 if (LOG.isDebugEnabled()) {
415 LOG.debug("LDAP authentication failed: login empty");
416 }
417
418 return null;
419 }
420
421 // If we have the context then we are using direct mode
422 // then we should specify the database
423 // This is needed for virtual mode to work
424 Principal principal = null;
425
426 // Try authentication against ldap
427 principal = ldapAuthenticate(login, "", context);
428
429 if (LOG.isDebugEnabled()) {
430 if (principal != null) {
431 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
432 } else {
433 LOG.debug("LDAP authentication failed for user [" + login + "]");
434 }
435 }
436
437 return principal;
438 }
439 }
440 {{/code}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected