Skip to Content

Wiki source code of User Authentication

Version 97.1 by Thomas Mortagne on 2018/02/09
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>>http://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 http://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 = LDAP Authentication =
50
51 == Active Directory ==
52
53 If you're looking to connect XWiki to an Active Directory server, you currently have 2 options:
54
55 * Using the manual and generic approach using the [[LDAP Authenticator extension>>extensions:Extension.LDAP.Authenticator]]
56 * 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.
57
58 The deprecated LDAP core LDAP authenticator (for XWiki < 7.4) can be found on [[OldLDAPAuthenticator]].
59
60 = Custom Authentication =
61
62 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
63
64 1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
65 1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
66
67 {{code language="properties"}}
68 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
69 {{/code}}
70
71 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]].
72
73 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/]].
74
75 Note that it's also possible to customize the right management system, see [[extensions:Extension.Security Module]] for more details.
76
77 == Custom Authentication using a Groovy script in a wiki page ==
78
79 Start by specifying you want to use the Groovy Authenticator:
80
81 {{code language="properties"}}
82 xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
83 {{/code}}
84
85 Then add another configuration parameter to specify in which wiki page the authenticator is:
86
87 {{code language="properties"}}
88 xwiki.authentication.groovy.pagename = MySpace.MyPage
89 {{/code}}
90
91 Then put some Groovy code in a wiki page that returns a XWikiAuthService object.
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|401|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 = Kerberos SSO Authentication =
124
125 {{warning}}
126 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!
127 {{/warning}}
128
129 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.
130
131 First of all you need to create a principal and keytab for the webserver:
132
133 {{code}}
134 # kadmin
135 kadmin> addprinc -randkey HTTP/wiki.example.com
136 kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
137 kadmin> quit
138 {{/code}}
139
140 Make sure the keytab has the right permissions and ownership:
141
142 {{code}}
143 chown www-data:www-data /etc/apache2/ssl/wiki.keytab
144 chmod 400 /etc/apache2/ssl/wiki.keytab
145 {{/code}}
146
147 Install **mod_auth_kerb** in your linux installation. On Debian or Ubuntu this would be achieved by running:
148
149 {{code}}
150 aptitude install libapache2-mod-auth-kerb
151 {{/code}}
152
153 Of course the installation procedure varies per Linux distribution.
154
155 If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
156
157 {{code}}
158 <Location /xwiki/>
159 AuthType Kerberos
160 AuthName "Kerberos Login"
161 KrbAuthRealms EXAMPLE.COM
162 Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
163 KrbMethodK5Passwd off
164 KrbMethodNegotiate on
165 KrbSaveCredentials on
166 require valid-user
167 </Location>
168 {{/code}}
169
170 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):
171
172 {{code}}
173 <Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
174 {{/code}}
175
176 Place the **authkerb.jar** jar in the ##WEB-INF/lib## directory of XWiki in Apache Tomcat.
177
178 Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in the ##WEB-INF/lib/xwiki.cfg## file.
179
180 {{code}}
181 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
182 {{/code}}
183
184 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.
185
186 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.
187
188 The configuration of ldap:
189
190 {{code}}
191 xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
192 xwiki.authentication.ldap=1
193 xwiki.authentication.ldap.server=<ad-server>
194 xwiki.authentication.ldap.port=389
195 xwiki.authentication.ldap.base_DN=<OU=Users,...............>
196 #use a fixed user to attach to the ldap database,
197 #the password is not provided with the SSOLdapAuthenicationImpl
198 xwiki.authentication.ldap.bind_DN=<domain>\\<user>
199 xwiki.authentication.ldap.bind_pass=<password>
200 #Microsoft AD configuration
201 xwiki.authentication.ldap.UID_attr=sAMAccountName
202 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
203 xwiki.authentication.ldap.group_memberfields=member,uniqueMember
204 #LDAP group mapping
205 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
206 XWiki.XWikiAllGroup=CN=WIKI_User,...........
207 {{/code}}
208
209 The java code:
210
211 {{code}}
212 package com.wiki.sso;
213
214
215 import org.apache.commons.logging.Log;
216 import org.apache.commons.logging.LogFactory;
217
218 import com.xpn.xwiki.XWikiContext;
219 import com.xpn.xwiki.XWikiException;
220 import com.xpn.xwiki.user.api.XWikiUser;
221 import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
222
223 import java.security.Principal;
224
225 public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
226 /**
227 * Logging tool.
228 */
229 private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
230
231
232 public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
233 String user = getRemoteUser(context);
234 if ((user != null) || !user.equals("")) {
235 if (LOG.isInfoEnabled())
236 LOG.info("Launching create user for " + user);
237 if ( authenticate(user, context) != null ) {
238 if (LOG.isInfoEnabled())
239 LOG.info("Create user done for " + user);
240 user = "XWiki." + user;
241 context.setUser(user);
242 System.out.println("User is set to:" + user);
243 return new XWikiUser(user);
244 } else {
245 LOG.error( "User " + user + " can't be authenticated against ldap" );
246 }
247 }
248 return super.checkAuth(context);
249 }
250
251 /**
252 * We cannot authenticate locally since we need to trust the app server for
253 * authentication
254 *
255 * @param username
256 * @param password
257 * @param context
258 * @return
259 * @throws XWikiException
260 */
261 public XWikiUser checkAuth(String username, String password,
262 String rememberme, XWikiContext context) throws XWikiException {
263 String user = getRemoteUser(context);
264 if ((user == null) || user.equals("")) {
265 return super.checkAuth(username, password, rememberme, context);
266 }
267 return checkAuth(context);
268 }
269
270 private String getRemoteUser(XWikiContext context) {
271 String userName = context.getRequest().getHttpServletRequest()
272 .getRemoteUser();
273 if (userName != null) {
274 // only take the front of the username@domain
275 String[] elements = userName.split("@", 2);
276 userName = elements[0];
277 }
278 return userName;
279 }
280
281 public Principal authenticate(String login, XWikiContext context) throws XWikiException
282 {
283 if (LOG.isTraceEnabled()) {
284 LOG.trace("Starting LDAP authentication");
285 }
286
287 /*
288 * TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
289 * returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
290 * given as argument. However, the right way to do this would probably be to throw XWikiException-s.
291 */
292
293 if (login == null) {
294 // If we can't find the username field then we are probably on the login screen
295
296 if (LOG.isDebugEnabled()) {
297 LOG.debug("The provided user is null."
298 + " We don't try to authenticate, it probably means the user is in non logged mode.");
299 }
300
301 return null;
302 }
303
304 // Check for empty usernames
305 if (login.equals("")) {
306 context.put("message", "nousername");
307
308 if (LOG.isDebugEnabled()) {
309 LOG.debug("LDAP authentication failed: login empty");
310 }
311
312 return null;
313 }
314
315 // If we have the context then we are using direct mode
316 // then we should specify the database
317 // This is needed for virtual mode to work
318 Principal principal = null;
319
320 // Try authentication against ldap
321 principal = ldapAuthenticate(login, "", context);
322
323 if (LOG.isDebugEnabled()) {
324 if (principal != null) {
325 LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
326 } else {
327 LOG.debug("LDAP authentication failed for user [" + login + "]");
328 }
329 }
330
331 return principal;
332 }
333 }
334 {{/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