Skip to Content

Wiki source code of User Authentication

Version 47.2 by Sergiu Dumitriu on 2011/11/02
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##. The contributed extension [[LDAP Tools>>extensions:Extension.LDAP Tools]] provides a administration section UI to configure LDAP from the wiki in a simpler manner.
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 Before 3.1, add the following to the log4j configuration file:
140
141 {{code}}
142 log4j.logger.com.xpn.xwiki.plugin.ldap=trace
143 log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
144 {{/code}}
145
146 = eXo Authentication =
147
148 The eXo authentication is used automatically by adding/editing the //xwiki.exo=1// property in //WEB-INF/xwiki.cfg//.
149
150 = Custom Authentication =
151
152 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
153
154 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
155 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
156
157 {{code}}
158 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
159 {{/code}}
160
161 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/]].
162
163 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:
164
165 {{code}}
166 xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
167 {{/code}}
168
169 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}}:
170
171 {{code}}
172 xwiki.authentication.groupclass = com.acme.MyCustomGroupService
173 {{/code}}
174
175 == Custom Authentication using a Groovy script in a wiki page ==
176
177 Start by specifying you want to use the Groovy Authenticator:
178
179 {{code}}
180 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
181 {{/code}}
182
183 Then add another configuration parameter to specify in which wiki page the authenticator is:
184
185 {{code}}
186 xwiki.authentication.groovy.pagename = MySpace.MyPage
187 {{/code}}
188
189 Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
190
191 = Authentication parameters =
192
193 You can set each of these parameters by setting:
194
195 {{code}}
196 xwiki.authentication.~~param_name~~=~~param_value~~
197 {{/code}}
198
199 |=Name|=Optional|=Allowed values|=Default value|=Description
200 |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.
201 |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.
202 |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
203 |cookielife|Yes|Number|14|Number of days cookies take to expire
204 |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//
205 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
206 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
207 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
208 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
209 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
210 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
211 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
212 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
213 |realmname|Yes|String|XWiki|Sets the realm name
214 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
215 |unauthorized_code|Yes|Number|401|The HTTP status code to return when the login has failed.
216 |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.
217
218 1. Only required if protection = encryption or all (default)
219 1. Only required if protection = validation or all (default)
220
221 = Kerberos SSO Authentication =
222
223 {{warning}}
224 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!
225 {{/warning}}
226
227 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.
228
229 First of all you need to create a principal and keytab for the webserver:
230
231 {{code}}
232 # kadmin
233 kadmin> addprinc -randkey HTTP/wiki.example.com
234 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
235 kadmin> quit
236 {{/code}}
237
238 Make sure the keytab has the right permissions and ownership:
239
240 {{code}}
241 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
242 chmod 400 /etc/apache2/ssl/wiki.keytab
243 {{/code}}
244
245 Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
246
247 {{code}}
248 aptitude install libapache2-mod-auth-kerb
249 {{/code}}
250
251 Of course the installation procedure varies per Linux distribution.
252
253 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
254
255 {{code}}
256 <Location /xwiki/>
257 AuthType Kerberos
258 AuthName "Kerberos Login"
259 KrbAuthRealms EXAMPLE.COM
260 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
261 KrbMethodK5Passwd off
262 KrbMethodNegotiate on
263 KrbSaveCredentials on
264 require valid-user
265 </Location>
266 {{/code}}
267
268 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):
269
270 {{code}}
271 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
272 {{/code}}
273
274 Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
275
276 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
277
278 {{code}}
279 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
280 {{/code}}
281
282 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.
283
284 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.
285
286 The configuration of ldap:
287
288 {{code}}
289 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
290 xwiki.authentication.ldap=1
291 xwiki.authentication.ldap.server=<ad-server>
292 xwiki.authentication.ldap.port=389
293 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
294 #use a fixed user to attach to the ldap database,
295 #the password is not provided with the SSOLdapAuthenicationImpl
296 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
297 xwiki.authentication.ldap.bind_pass=<password>
298 #Microsoft AD configuration
299 xwiki.authentication.ldap.UID_attr=sAMAccountName
300 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
301 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
302 #LDAP group mapping
303 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
304 XWiki.XWikiAllGroup=CN=WIKI_User,...........
305 {{/code}}
306
307 The java code
308
309 {{code}}
310 package com.wiki.sso;
311
312
313 import org.apache.commons.logging.Log;
314 import org.apache.commons.logging.LogFactory;
315
316 import com.xpn.xwiki.XWikiContext;
317 import com.xpn.xwiki.XWikiException;
318 import com.xpn.xwiki.user.api.XWikiUser;
319 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
320
321 import java.security.Principal;
322
323 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
324 /**
325 * Logging tool.
326 */
327 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
328
329
330 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
331 String user = getRemoteUser(context);
332 if ((user != null) || !user.equals("")) {
333 if (LOG.isInfoEnabled())
334 LOG.info("Launching create user for " + user);
335 if ( authenticate(user, context) != null ) {
336 if (LOG.isInfoEnabled())
337 LOG.info("Create user done for " + user);
338 user = "XWiki." + user;
339 context.setUser(user);
340 System.out.println("User is set to:" + user);
341 return new XWikiUser(user);
342 } else {
343 LOG.error( "User " + user + " can't be authenticated against ldap" );
344 }
345 }
346 return super.checkAuth(context);
347 }
348
349 /**
350 * We cannot authenticate locally since we need to trust the app server for
351 * authentication
352 *
353 * @param username
354 * @param password
355 * @param context
356 * @return
357 * @throws XWikiException
358 */
359 public XWikiUser checkAuth(String username, String password,
360 String rememberme, XWikiContext context) throws XWikiException {
361 String user = getRemoteUser(context);
362 if ((user == null) || user.equals("")) {
363 return super.checkAuth(username, password, rememberme, context);
364 }
365 return checkAuth(context);
366 }
367
368 private String getRemoteUser(XWikiContext context) {
369 String userName = context.getRequest().getHttpServletRequest()
370 .getRemoteUser();
371 if (userName != null) {
372 // only take the front of the username@domain
373 String[] elements = userName.split("@", 2);
374 userName = elements[0];
375 }
376 return userName;
377 }
378
379 public Principal authenticate(String login, XWikiContext context) throws XWikiException
380 {
381 if (LOG.isTraceEnabled()) {
382 LOG.trace("Starting LDAP authentication");
383 }
384
385 /*
386 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
387 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
388 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
389 */
390
391 if (login == null) {
392 // If we can't find the username field then we are probably on the login screen
393
394 if (LOG.isDebugEnabled()) {
395 LOG.debug("The provided user is null."
396 + " We don't try to authenticate, it probably means the user is in non logged mode.");
397 }
398
399 return null;
400 }
401
402 // Check for empty usernames
403 if (login.equals("")) {
404 context.put("message", "nousername");
405
406 if (LOG.isDebugEnabled()) {
407 LOG.debug("LDAP authentication failed: login empty");
408 }
409
410 return null;
411 }
412
413 // If we have the context then we are using direct mode
414 // then we should specify the database
415 // This is needed for virtual mode to work
416 Principal principal = null;
417
418 // Try authentication against ldap
419 principal = ldapAuthenticate(login, "", context);
420
421 if (LOG.isDebugEnabled()) {
422 if (principal != null) {
423 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
424 } else {
425 LOG.debug("LDAP authentication failed for user [" + login + "]");
426 }
427 }
428
429 return principal;
430 }
431 }
432 {{/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