Wiki source code of User Authentication

Version 117.1 by Thomas Mortagne on 2023/04/12

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

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