Wiki source code of User Authentication

Last modified by Thomas Mortagne on 2024/12/10

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

Wiki source code of User Authentication

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected