Skip to Content

Wiki source code of User Authentication

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