Skip to Content

Wiki source code of User Authentication

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