Skip to Content

Wiki source code of User Authentication

Version 120.1 by Thomas Mortagne on 2023/04/12
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 XWiki supports several different authentication mechanisms for authenticating users.
6
7 {{info}}
8 XWiki currently allows only one method of authentication to be enabled at a time. This will probably be improved in the future.
9 {{/info}}
10
11 Also note that XWiki requires cookies to be enabled in order to track your session and to keep you logged in between pages.
12
13 = Choose the authenticator
14
15 Historically, the authenticator to use in XWiki is controlled by the property ##xwiki.authentication.authclass## in the ##xwiki.properties## file.
16
17 {{version since="15.3"}}
18 For authenticators which supports it, it's possible to choose the authenticator to use in the wiki administration.
19
20 {{image reference="authserviceadmin.png"/}}
21 {{/version}}
22
23 = Authentication Types =
24
25 == Form Authentication ==
26
27 Form authentication is the default way to get authenticated within a Wiki. It requires a user and a password.
28
29 == Basic Authentication ==
30
31 XWiki supports [[basic access authentication>>https://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:
32
33 {{code}}
34 https://username:password@mywiki.xwiki.com/xwiki/bin/view/Main/WebHome?basicauth=1
35 {{/code}}
36
37 {{warning}}
38 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##.
39 {{/warning}}
40
41 == Container Authentication ==
42
43 Delegates authentication to the Servlet Container. If it fails it falls back to the standard XWiki authentication.
44
45 To configure XWiki to use it, specify:
46
47 {{code language="properties"}}
48 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedAuthServiceImpl
49 {{/code}}
50
51 For users to be actually created and not just set as context user you must set in ##xwiki.cfg## configuration file (if the property does not already exist, create it):
52
53 {{code language="properties"}}
54 xwiki.authentication.createuser=empty
55 {{/code}}
56
57 == Social Login ==
58
59 See the [[Social Login Application>>extensions:Extension.Social Login Application]].
60
61 == OpenId Connect Authentication ==
62
63 See the [[OpenId Connect Authenticator Extension>>extensions:Extension.OpenID Connect.OpenID Connect Authenticator.WebHome]].
64
65 == Active Directory ==
66
67 If you're looking to connect XWiki to an Active Directory server, you currently have 2 options:
68
69 * Using the manual and generic approach using the [[LDAP Authenticator extension>>extensions:Extension.LDAP.Authenticator]]
70 * Using the dedicated [[Active Directory Application>>https://store.xwiki.com/xwiki/bin/view/Extension/ActiveDirectoryApplication]] which is a paying application dedicated to simplifying the integration of Active Directory with XWiki. The Active Directory Application allows you to easily connect your Active Directory server to XWiki using a **visual editor**, update **advanced configuration** settings without restarting the application server, **technical support** provided by [[XWiki SAS>>https://xwiki.com/]], etc.
71
72 == LDAP ==
73
74 See the [[LDAP Authenticator extension>>extensions:Extension.LDAP.Authenticator]].
75
76 The deprecated LDAP core authenticator (for XWiki < 7.4) can be found on [[OldLDAPAuthenticator]].
77
78 == Custom Authentication ==
79
80 You can create your custom authentication by following [[Create a Custom Authenticator>>Documentation.DevGuide.Tutorials.Create a Custom Authenticator.WebHome]] tutorial.
81
82 Note that it's also possible to customize the right management system, see [[Security Module>>extensions:Extension.Security Module]] for more details.
83
84 === Custom Authentication using a Groovy script in a wiki page ===
85
86 Start by specifying you want to use the Groovy Authenticator:
87
88 {{code language="properties"}}
89 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
90 {{/code}}
91
92 Then add another configuration parameter to specify in which wiki page the authenticator is:
93
94 {{code language="properties"}}
95 xwiki.authentication.groovy.pagename = MySpace.MyPage
96 {{/code}}
97
98 Then put some Groovy code in a wiki page that returns a XWikiAuthService object.
99
100
101 = Configuration =
102
103 == Authentication parameters ==
104
105 You can set each of these parameters by setting:
106
107 {{code}}
108 xwiki.authentication.<param_name>=<param_value>
109 {{/code}}
110
111 |=Name|=Optional|=Allowed values|=Default value|=Description
112 |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.
113 |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.
114 |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
115 |cookielife|Yes|Number|14|Number of days cookies take to expire
116 |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//
117 |default_page|Yes|String|/bin/view/ Main/WebHome|Page to redirect to if xredirect parameter is not set
118 |encryptionalgorithm|Yes|?|?|Set the Encryption Algorithm used to encrypt and decrypt cookies
119 |encryptionmode|Yes|?|?|Set the Encryption Mode used to encrypt and decrypt cookies
120 |encryptionpadding|Yes|?|?|Set the Encryption Padding used to encrypt and decrypt cookies
121 |errorpage|Yes|String|/bin/loginerror/ XWiki/XWikiLogin|Page to redirect to if there is an error logging in
122 |loginpage|Yes|String|/bin/login/ XWiki/XWikiLogin|Page to redirect to when not logged in
123 |loginsubmitpage|Yes|String|/loginsubmit/ XWiki/XWikiLogin|The URL where the username and password are posted to when logging in.
124 |logoutpage|Yes|String|/bin/logout/ XWiki/XWikiLogout|Page to redirect to after logged out
125 |realmname|Yes|String|XWiki|Sets the realm name
126 |protection|Yes|all, validation, encryption, none|all|Protection level for the "remember me" cookie functionality
127 |unauthorized_code|Yes|Number|403|The HTTP status code to return when the login has failed.
128 |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.
129
130 1. Only required if protection = encryption or all (default)
131 1. Only required if protection = validation or all (default)
132
133 == Security ==
134
135 Starting with {{code}}XWiki 11.6RC1{{/code}} we provide some authentication strategies that are triggered if a user fails several time in a row to login.
136 You can configure those strategies and when they should be triggered in the Administration > Authentication page.
137
138 {{gallery}}
139 image:authentication-security-administration.png
140 {{/gallery}}
141
142
143 For more information see the [[Authencation Security Module documentation>>extensions:Extension.Authentication Security Module]].
144
145
146 = Kerberos SSO Authentication =
147
148 {{warning}}
149 This implementation of SSO is currently under review see: https://jira.xwiki.org/browse/XWIKI-2496 . The class which is described in this segment of documentation, AppServerTrustedKerberosAuthServiceImpl, is not part of the default XWiki distribution!
150 {{/warning}}
151
152 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.
153
154 First of all you need to create a principal and keytab for the webserver:
155
156 {{code}}
157 # kadmin
158 kadmin> addprinc -randkey HTTP/wiki.example.com
159 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
160 kadmin> quit
161 {{/code}}
162
163 Make sure the keytab has the right permissions and ownership:
164
165 {{code}}
166 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
167 chmod 400 /etc/apache2/ssl/wiki.keytab
168 {{/code}}
169
170 Install **mod_auth_kerb** in your linux installation. On Debian or Ubuntu this would be achieved by running:
171
172 {{code}}
173 aptitude install libapache2-mod-auth-kerb
174 {{/code}}
175
176 Of course the installation procedure varies per Linux distribution.
177
178 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
179
180 {{code}}
181 <Location "/xwiki">
182 AuthType Kerberos
183 AuthName "Kerberos Login"
184 KrbAuthRealms EXAMPLE.COM
185 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
186 KrbMethodK5Passwd off
187 KrbMethodNegotiate on
188 KrbSaveCredentials on
189 require valid-user
190 </Location>
191 {{/code}}
192
193 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):
194
195 {{code}}
196 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" ></Connector>
197 {{/code}}
198
199 Place the **authkerb.jar** jar in the ##WEB-INF/lib## directory of XWiki in Apache Tomcat.
200
201 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in the ##WEB-INF/lib/xwiki.cfg## file.
202
203 {{code}}
204 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
205 {{/code}}
206
207 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.
208
209 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.
210
211 The configuration of ldap:
212
213 {{code}}
214 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
215 xwiki.authentication.ldap=1
216 xwiki.authentication.ldap.server=<ad-server>
217 xwiki.authentication.ldap.port=389
218 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
219 #use a fixed user to attach to the ldap database,
220 #the password is not provided with the SSOLdapAuthenicationImpl
221 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
222 xwiki.authentication.ldap.bind_pass=<password>
223 #Microsoft AD configuration
224 xwiki.authentication.ldap.UID_attr=sAMAccountName
225 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
226 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
227 #LDAP group mapping
228 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
229 XWiki.XWikiAllGroup=CN=WIKI_User,...........
230 {{/code}}
231
232 The java code:
233
234 {{code}}
235 package com.wiki.sso;
236
237
238 import org.apache.commons.logging.Log;
239 import org.apache.commons.logging.LogFactory;
240
241 import com.xpn.xwiki.XWikiContext;
242 import com.xpn.xwiki.XWikiException;
243 import com.xpn.xwiki.user.api.XWikiUser;
244 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
245
246 import java.security.Principal;
247
248 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
249 /**
250 * Logging tool.
251 */
252 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
253
254
255 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
256 String user = getRemoteUser(context);
257 if ((user != null) || !user.equals("")) {
258 if (LOG.isInfoEnabled())
259 LOG.info("Launching create user for " + user);
260 if ( authenticate(user, context) != null ) {
261 if (LOG.isInfoEnabled())
262 LOG.info("Create user done for " + user);
263 user = "XWiki." + user;
264 context.setUser(user);
265 System.out.println("User is set to:" + user);
266 return new XWikiUser(user);
267 } else {
268 LOG.error( "User " + user + " can't be authenticated against ldap" );
269 }
270 }
271 return super.checkAuth(context);
272 }
273
274 /**
275 * We cannot authenticate locally since we need to trust the app server for
276 * authentication
277 *
278 * @param username
279 * @param password
280 * @param context
281 * @return
282 * @throws XWikiException
283 */
284 public XWikiUser checkAuth(String username, String password,
285 String rememberme, XWikiContext context) throws XWikiException {
286 String user = getRemoteUser(context);
287 if ((user == null) || user.equals("")) {
288 return super.checkAuth(username, password, rememberme, context);
289 }
290 return checkAuth(context);
291 }
292
293 private String getRemoteUser(XWikiContext context) {
294 String userName = context.getRequest().getHttpServletRequest()
295 .getRemoteUser();
296 if (userName != null) {
297 // only take the front of the username@domain
298 String[] elements = userName.split("@", 2);
299 userName = elements[0];
300 }
301 return userName;
302 }
303
304 public Principal authenticate(String login, XWikiContext context) throws XWikiException
305 {
306 if (LOG.isTraceEnabled()) {
307 LOG.trace("Starting LDAP authentication");
308 }
309
310 /*
311 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
312 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
313 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
314 */
315
316 if (login == null) {
317 // If we can't find the username field then we are probably on the login screen
318
319 if (LOG.isDebugEnabled()) {
320 LOG.debug("The provided user is null."
321 + " We don't try to authenticate, it probably means the user is in non logged mode.");
322 }
323
324 return null;
325 }
326
327 // Check for empty usernames
328 if (login.equals("")) {
329 context.put("message", "nousername");
330
331 if (LOG.isDebugEnabled()) {
332 LOG.debug("LDAP authentication failed: login empty");
333 }
334
335 return null;
336 }
337
338 // If we have the context then we are using direct mode
339 // then we should specify the database
340 // This is needed for virtual mode to work
341 Principal principal = null;
342
343 // Try authentication against ldap
344 principal = ldapAuthenticate(login, "", context);
345
346 if (LOG.isDebugEnabled()) {
347 if (principal != null) {
348 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
349 } else {
350 LOG.debug("LDAP authentication failed for user [" + login + "]");
351 }
352 }
353
354 return principal;
355 }
356 }
357 {{/code}}
358
359 = Mail Templates =
360
361 When [[logging in>>Documentation.UserGuide.Features.Authentication#HLoggingin]], you have the option of resetting your user's password if you forgot it, or to find your username based on your email address. When choosing these options, you'll be sent an email. It's possible to control the templates used for these emails and to customize them by editing the following pages in object mode:
362 * ##XWiki.ResetPasswordMailContent##
363 * ##XWiki.ForgotUsernameMailContent##

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected