Wiki source code of User Authentication

Version 114.1 by gcoquard on 2021/04/19

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
112.1	13	= Authentication Types =
1.1	14
112.1	15	== Form Authentication ==
	16
38.2	17	Form authentication is the default way to get authenticated within a Wiki. It requires a user and a password.
1.1	18
112.1	19	== Basic Authentication ==
46.1	20
107.2	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:
46.1	22
	23	{{code}}
107.2	24	https://username:password@mywiki.xwiki.com/xwiki/bin/view/Main/WebHome?basicauth=1
46.1	25	{{/code}}
	26
	27	{{warning}}
64.2	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##.
46.1	29	{{/warning}}
	30
112.1	31	== Container Authentication ==
70.1	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
79.1	37	{{code language="properties"}}
70.1	38	xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedAuthServiceImpl
	39	{{/code}}
	40
79.1	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
112.1	47	== Social Login ==
58.1	48
64.2	49	See the [[Social Login Application>>extensions:Extension.Social Login Application]].
58.1	50
112.1	51	== OpenId Connect Authentication ==
107.1	52
	53	See the [[OpenId Connect Authenticator Extension>>extensions:Extension.OpenID Connect.OpenID Connect Authenticator.WebHome]].
	54
112.1	55	== Active Directory ==
87.1	56
97.1	57	If you're looking to connect XWiki to an Active Directory server, you currently have 2 options:
95.1	58
97.1	59	* Using the manual and generic approach using the [[LDAP Authenticator extension>>extensions:Extension.LDAP.Authenticator]]
107.2	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.
96.1	61
112.1	62	== LDAP ==
96.1	63
100.1	64	See the [[LDAP Authenticator extension>>extensions:Extension.LDAP.Authenticator]].
98.1	65
	66	The deprecated LDAP core authenticator (for XWiki < 7.4) can be found on [[OldLDAPAuthenticator]].
	67
112.1	68	== Custom Authentication ==
1.1	69
114.1	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#]] tutorial.
1.1	71
89.1	72	Note that it's also possible to customize the right management system, see [[extensions:Extension.Security Module]] for more details.
34.1	73
112.1	74	=== Custom Authentication using a Groovy script in a wiki page ===
28.1	75
	76	Start by specifying you want to use the Groovy Authenticator:
	77
57.1	78	{{code language="properties"}}
28.1	79	xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
34.1	80	{{/code}}
28.1	81
	82	Then add another configuration parameter to specify in which wiki page the authenticator is:
	83
57.1	84	{{code language="properties"}}
28.1	85	xwiki.authentication.groovy.pagename = MySpace.MyPage
34.1	86	{{/code}}
28.1	87
64.2	88	Then put some Groovy code in a wiki page that returns a XWikiAuthService object.
28.1	89
1.14	90
112.1	91	= Configuration =
	92
	93	== Authentication parameters ==
	94
1.14	95	You can set each of these parameters by setting:
	96
34.1	97	{{code}}
89.2	98	xwiki.authentication.<param_name>=<param_value>
34.1	99	{{/code}}
1.14	100
34.1	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
35.1	113	\|loginsubmitpage\|Yes\|String\|/loginsubmit/ XWiki/XWikiLogin\|The URL where the username and password are posted to when logging in.
34.1	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
101.1	117	\|unauthorized_code\|Yes\|Number\|403\|The HTTP status code to return when the login has failed.
34.1	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.
1.16	119
34.1	120	1. Only required if protection = encryption or all (default)
	121	1. Only required if protection = validation or all (default)
1.17	122
112.1	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
34.2	136	= Kerberos SSO Authentication =
21.1	137
34.1	138	{{warning}}
94.1	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!
34.1	140	{{/warning}}
	141
64.2	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.
1.18	143
20.1	144	First of all you need to create a principal and keytab for the webserver:
34.1	145
	146	{{code}}
20.1	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
34.1	151	{{/code}}
10.1	152
20.1	153	Make sure the keytab has the right permissions and ownership:
34.1	154
	155	{{code}}
20.1	156	chown www-data:www-data /etc/apache2/ssl/wiki.keytab
	157	chmod 400 /etc/apache2/ssl/wiki.keytab
34.1	158	{{/code}}
11.1	159
64.2	160	Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
34.1	161
	162	{{code}}
20.1	163	aptitude install libapache2-mod-auth-kerb
34.1	164	{{/code}}
	165
20.1	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:
34.1	169
	170	{{code}}
108.1	171	<Location /xwiki></Location>
20.1	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>
34.1	181	{{/code}}
20.1	182
64.2	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):
34.1	184
	185	{{code}}
108.1	186	<Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" ></Connector>
34.1	187	{{/code}}
20.1	188
64.2	189	Place the authkerb.jar jar in the ##WEB-INF/lib## directory of XWiki in Apache Tomcat.
20.1	190
64.2	191	Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in the ##WEB-INF/lib/xwiki.cfg## file.
34.1	192
	193	{{code}}
20.1	194	xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
34.1	195	{{/code}}
20.1	196
64.2	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.
20.1	198
64.2	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.
29.1	200
34.2	201	The configuration of ldap:
29.1	202
34.1	203	{{code}}
29.1	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,...........
34.1	220	{{/code}}
29.1	221
64.2	222	The java code:
34.1	223
	224	{{code}}
29.1	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
64.3	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	}
29.1	263
64.3	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	}
29.1	282
64.3	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	}
29.1	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	}
34.1	347	{{/code}}

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