Wiki source code of User Authentication

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

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected