Wiki source code of User Authentication

Version 70.1 by Vincent Massol on 2013/09/20

version	line-number	content
1.18	1	XWiki supports several different authentication mechanisms for authenticating users:
1.1	2
34.2	3	{{toc/}}
34.1	4
	5	{{info}}
64.2	6	XWiki currently allows only one method of authentication to be enabled at a time. This will probably be improved in the future.
34.1	7	{{/info}}
1.1	8
34.2	9	= Form Authentication =
1.1	10
38.2	11	Form authentication is the default way to get authenticated within a Wiki. It requires a user and a password.
1.1	12
46.1	13	= Basic Authentication =
	14
64.2	15	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:
46.1	16
	17	{{code}}
	18	http://username:password@mywiki.xwiki.com/xwiki/bin/view/Main/WebHome?basicauth=1
	19	{{/code}}
	20
	21	{{warning}}
64.2	22	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	23	{{/warning}}
	24
70.1	25	= Container Authentication =
	26
	27	Delegates authentication to the Servlet Container. If it fails it falls back to the standard XWiki authentication.
	28
	29	To configure XWiki to use it, specify:
	30
	31	{{code}}
	32	xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedAuthServiceImpl
	33	{{/code}}
	34
62.1	35	= Social Login =
58.1	36
64.2	37	See the [[Social Login Application>>extensions:Extension.Social Login Application]].
58.1	38
34.2	39	= LDAP Authentication =
1.1	40
67.1	41	If you are going to use the [[LDAP Admin Extension>>http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP+Application#HPrerequisites26InstallationInstructions]], which makes it easier to configure LDAP, then you only need to uncomment xwiki.authentication.authclass property and //nothing// else. Unlike editing xwiki.cfg, which requires you to redeploy xWiki app, LDAP Extension allows you to make changes without restarting.
65.1	42
34.2	43	== Generic LDAP configuration ==
1.1	44
34.1	45	In order to enable the LDAP support you have to change the authentication method in //WEB-INF/xwiki.cfg// as follows:
	46
54.1	47	{{code language="properties"}}
50.1	48	#-# LDAP authentication service
	49	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
7.1	50
50.1	51	#-# Turn LDAP authentication on - otherwise only XWiki authentication
	52	#-# - 0: disable
	53	#-# - 1: enable
	54	#-# The default is 1
	55	# xwiki.authentication.ldap=1
34.1	56	{{/code}}
18.1	57
64.2	58	You can setup the LDAP configuration in the xwiki.cfg file by filling the following properties:
1.2	59
54.1	60	{{code language="properties"}}
36.1	61	#-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
	62	xwiki.authentication.ldap.server=127.0.0.1
1.1	63	xwiki.authentication.ldap.port=389
6.1	64
36.1	65	#-# LDAP login, empty = anonymous access, otherwise specify full dn
50.1	66	#-# {0} is replaced with the user name, {1} with the password
1.1	67	xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
	68	xwiki.authentication.ldap.bind_pass={1}
6.1	69
50.1	70	#-# The Base DN used in LDAP searches
	71	xwiki.authentication.ldap.base_DN=
12.1	72
50.1	73	#-# LDAP query to search the user in the LDAP database (in case a static admin user is provided in
	74	#-# xwiki.authentication.ldap.bind_DN)
	75	#-# {0} is replaced with the user uid field name and {1} with the user name
	76	#-# The default is ({0}={1})
55.1	77	# xwiki.authentication.ldap.user_search_fmt=({0}={1})
50.1	78
	79	#-# Only members of the following group will be verified in the LDAP
36.1	80	#-# otherwise only users that are found after searching starting from the base_DN
	81	# xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
6.1	82
50.1	83	#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
	84	#-# Only users not member of the following group can autheticate
36.1	85	# xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
22.1	86
50.1	87	#-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name
	88	#-# The default is cn
36.1	89	# xwiki.authentication.ldap.UID_attr=cn
6.1	90
50.1	91	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
36.1	92	#-# The potential LDAP groups classes. Separated by commas.
	93	# xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
	94
50.1	95	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
55.1	96	#-# The potential names of the LDAP groups fields containings the members. Separated by commas.
36.1	97	# xwiki.authentication.ldap.group_memberfields=member,uniqueMember
	98
	99	#-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
	100	xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
	101
50.1	102	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	103	#-# On every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki
	104	#-# account is created.
	105	#-# - 0: only when creating user
	106	#-# - 1: at each authentication
54.1	107	#-# The default is 0
	108	xwiki.authentication.ldap.update_user=1
6.1	109
50.1	110	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	111	#-# Maps XWiki groups to LDAP groups, separator is "\|". The following kind of groups are supported:
	112	#-# * LDAP static groups (users/subgroups are listed statically in the group object)
	113	#-# * [Since 3.3M1] LDAP organization units (users/subgroups are sub object of the provided organization unit)
	114	#-# * [Since 3.3M1] LDAP filter (users/groups are object found in a search with the provided filter),
55.1	115	#-# \| character in the filter need to be escaped with backslash (\).
50.1	116	#-#
	117	#-# Here is an example:
	118	# xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=domain,c=com\|\
55.1	119	# XWiki.LDAPUsers=ou=groups,o=domain,c=com\|\
	120	# XWiki.Organisation=(cn=testers)
6.1	121
50.1	122	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	123	#-# Time in s after which the list of members in a group is refreshed from LDAP
	124	#-# The default is 21600 (6 hours)
	125	# xwiki.authentication.ldap.groupcache_expiration=21600
6.1	126
50.1	127	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
36.1	128	#-# - create : synchronize group membership only when the user is first created
	129	#-# - always: synchronize on every login
50.1	130	#-# The default is always
36.1	131	# xwiki.authentication.ldap.mode_group_sync=always
6.1	132
50.1	133	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
54.1	134	#-# If ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
	135	#-# - 0: disable
	136	#-# - 1: enable
	137	#-# The default is 0
6.1	138	xwiki.authentication.ldap.trylocal=1
8.1	139
50.1	140	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
36.1	141	#-# SSL connection to LDAP server
50.1	142	#-# - 0: normal
	143	#-# - 1: SSL
	144	#-# The default is 0
36.1	145	# xwiki.authentication.ldap.ssl=0
8.1	146
50.1	147	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
36.1	148	#-# The keystore file to use in SSL connection
	149	# xwiki.authentication.ldap.ssl.keystore=
	150
50.1	151	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
36.1	152	#-# The java secure provider used in SSL connection
50.1	153	#-# The default is com.sun.net.ssl.internal.ssl.Provider
36.1	154	# xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
50.1	155
	156	#-# Bypass standard LDAP bind validation by doing a direct password comparison.
	157	#-# If you don't know what you do, don't use that. It's covering very rare and bad use cases.
	158	#-# - 0: disable
	159	#-# - 1: enable
	160	#-# The default is 0
	161	# xwiki.authentication.ldap.validate_password=0
	162
	163	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	164	#-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password"
	165	#-# is set to 1
	166	# xwiki.authentication.ldap.password_field=userPassword
55.1	167
	168	#-# [Since 4.3M1, XWikiLDAPAuthServiceImpl]
	169	#-# The maximum number of milliseconds the client waits for any operation under these constraints to complete.
	170	#-# The default is 1000
	171	# xwiki.authentication.ldap.timeout=1000
34.1	172	{{/code}}
3.1	173
34.1	174	{{info}}
64.2	175	You can also setup the LDAP configuration in the XWiki.XWikiPreferences page by going to the object editor. Simply replace xwiki.authentication.ldap. with ldap_. For example ##xwiki.authentication.ldap.base_DN## becomes ##ldap_base_DN##.
34.1	176	{{/info}}
9.1	177
1.19	178	For testing purposes, you may wish to omit the "ldap.fields_mapping" field, to test the authentication first, and then add it later to get the mappings right.
	179
64.2	180	Here are some LDAP clients for checking your configuration:
1.19	181
52.1	182	Java based and Open Source:
56.1	183
34.1	184	* [[Apache Directory Studio>>http://directory.apache.org/studio/]]
64.2	185	* [[JXplorer>>http://jxplorer.org/]]
1.19	186
52.1	187	Windows only:
56.1	188
64.2	189	* [[Softerra LDAP Browser>>http://www.ldapbrowser.com/info_softerra-ldap-browser.htm]]
52.1	190
34.2	191	== Detailed use cases ==
12.1	192
64.2	193	See the [[LDAP configuration uses cases>>LDAPAuthenticationUseCases]] for some detailed use cases.
25.1	194
34.2	195	== Enable LDAP debug log ==
34.1	196
42.1	197	See [[AdminGuide.Logging]].
34.1	198
45.1	199	The specific packages to track for LDAP are ##com.xpn.xwiki.plugin.ldap## and ##com.xpn.xwiki.user.impl.LDAP##.
27.1	200
64.4	201	Starting with XWiki 4.2 we added a new [[Logging UI>>extensions:Extension.Logging Application]] from the Administration section, which allows logging to be enabled at runtime, directly from the UI, without the need to restart the wiki.
64.3	202
49.1	203	In XWiki 3.4 you need to add the following in ##WEB-INF/classes/logback.xml##:
	204
	205	{{code}}
	206	<!-- LDAP debugging -->
	207	<logger name="com.xpn.xwiki.plugin.ldap" level="trace"/>
	208	<logger name="com.xpn.xwiki.user.impl.LDAP" level="trace"/>
	209	{{/code}}
	210
42.1	211	Before 3.1, add the following to the log4j configuration file:
	212
44.1	213	{{code}}
	214	log4j.logger.com.xpn.xwiki.plugin.ldap=trace
	215	log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
	216	{{/code}}
	217
34.2	218	= Custom Authentication =
1.1	219
	220	This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
	221
47.2	222	1. Implement the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiAuthService.java"}}XWikiAuthService{{/scm}} interface.
34.1	223	1. Edit the //WEB-INF/xwiki.cfg// file and add a //xwiki.authentication.authclass// property pointing to your class. For example:
	224
56.1	225	{{code language="properties"}}
1.1	226	xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
34.1	227	{{/code}}
1.1	228
64.2	229	You can find various [[authenticators examples>>https://github.com/xwiki-contrib/sandbox/tree/master/authenticators]].
56.1	230
34.1	231	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/]].
27.2	232
64.2	233	Note, that you can also implement own right management service by implementing the {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiRightService.java"}}XWikiRightService{{/scm}} interface:
34.1	234
57.1	235	{{code language="properties"}}
5.1	236	xwiki.authentication.rightsclass = com.acme.MyCustomRightsService
34.1	237	{{/code}}
4.1	238
47.2	239	and Group Service by implementing {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java"}}XWikiGroupService{{/scm}}:
4.1	240
57.1	241	{{code language="properties"}}
27.3	242	xwiki.authentication.groupclass = com.acme.MyCustomGroupService
34.1	243	{{/code}}
4.1	244
34.2	245	== Custom Authentication using a Groovy script in a wiki page ==
28.1	246
	247	Start by specifying you want to use the Groovy Authenticator:
	248
57.1	249	{{code language="properties"}}
28.1	250	xwiki.authentication.authclass = com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
34.1	251	{{/code}}
28.1	252
	253	Then add another configuration parameter to specify in which wiki page the authenticator is:
	254
57.1	255	{{code language="properties"}}
28.1	256	xwiki.authentication.groovy.pagename = MySpace.MyPage
34.1	257	{{/code}}
28.1	258
64.2	259	Then put some Groovy code in a wiki page that returns a XWikiAuthService object.
28.1	260
37.1	261	= Authentication parameters =
1.14	262
	263	You can set each of these parameters by setting:
	264
34.1	265	{{code}}
1.14	266	xwiki.authentication.~~param_name~~=~~param_value~~
34.1	267	{{/code}}
1.14	268
34.1	269	\|=Name\|=Optional\|=Allowed values\|=Default value\|=Description
	270	\|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.
	271	\|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.
	272	\|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
	273	\|cookielife\|Yes\|Number\|14\|Number of days cookies take to expire
	274	\|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//
	275	\|default_page\|Yes\|String\|/bin/view/ Main/WebHome\|Page to redirect to if xredirect parameter is not set
	276	\|encryptionalgorithm\|Yes\|?\|?\|Set the Encryption Algorithm used to encrypt and decrypt cookies
	277	\|encryptionmode\|Yes\|?\|?\|Set the Encryption Mode used to encrypt and decrypt cookies
	278	\|encryptionpadding\|Yes\|?\|?\|Set the Encryption Padding used to encrypt and decrypt cookies
	279	\|errorpage\|Yes\|String\|/bin/loginerror/ XWiki/XWikiLogin\|Page to redirect to if there is an error logging in
	280	\|loginpage\|Yes\|String\|/bin/login/ XWiki/XWikiLogin\|Page to redirect to when not logged in
35.1	281	\|loginsubmitpage\|Yes\|String\|/loginsubmit/ XWiki/XWikiLogin\|The URL where the username and password are posted to when logging in.
34.1	282	\|logoutpage\|Yes\|String\|/bin/logout/ XWiki/XWikiLogout\|Page to redirect to after logged out
	283	\|realmname\|Yes\|String\|XWiki\|Sets the realm name
	284	\|protection\|Yes\|all, validation, encryption, none\|all\|Protection level for the "remember me" cookie functionality
35.1	285	\|unauthorized_code\|Yes\|Number\|401\|The HTTP status code to return when the login has failed.
34.1	286	\|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	287
34.1	288	1. Only required if protection = encryption or all (default)
	289	1. Only required if protection = validation or all (default)
1.17	290
34.2	291	= Kerberos SSO Authentication =
21.1	292
34.1	293	{{warning}}
	294	This implementation of SSO is currently under review see: http://jira.xwiki.org/jira/browse/XWIKI-2496 . The class which is described in this segment of documentation, AppServerTrustedKerberosAuthServiceImpl, is not part of the default XWiki distribution!
	295	{{/warning}}
	296
64.2	297	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	298
20.1	299	First of all you need to create a principal and keytab for the webserver:
34.1	300
	301	{{code}}
20.1	302	# kadmin
	303	kadmin> addprinc -randkey HTTP/wiki.example.com
	304	kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
	305	kadmin> quit
34.1	306	{{/code}}
10.1	307
20.1	308	Make sure the keytab has the right permissions and ownership:
34.1	309
	310	{{code}}
20.1	311	chown www-data:www-data /etc/apache2/ssl/wiki.keytab
	312	chmod 400 /etc/apache2/ssl/wiki.keytab
34.1	313	{{/code}}
11.1	314
64.2	315	Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
34.1	316
	317	{{code}}
20.1	318	aptitude install libapache2-mod-auth-kerb
34.1	319	{{/code}}
	320
20.1	321	Of course the installation procedure varies per Linux distribution.
	322
	323	If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
34.1	324
	325	{{code}}
20.1	326	<Location /xwiki/>
	327	AuthType Kerberos
	328	AuthName "Kerberos Login"
	329	KrbAuthRealms EXAMPLE.COM
	330	Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
	331	KrbMethodK5Passwd off
	332	KrbMethodNegotiate on
	333	KrbSaveCredentials on
	334	require valid-user
	335	</Location>
34.1	336	{{/code}}
20.1	337
64.2	338	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	339
	340	{{code}}
20.1	341	<Connector port="8009" address="127.0.0.1" enableLookups="false" tomcatAuthentication="false" redirectPort="8443" protocol="AJP/1.3" />
34.1	342	{{/code}}
20.1	343
64.2	344	Place the authkerb.jar jar in the ##WEB-INF/lib## directory of XWiki in Apache Tomcat.
20.1	345
64.2	346	Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in the ##WEB-INF/lib/xwiki.cfg## file.
34.1	347
	348	{{code}}
20.1	349	xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.AppServerTrustedKerberosAuthServiceImpl
34.1	350	{{/code}}
20.1	351
64.2	352	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	353
64.2	354	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	355
34.2	356	The configuration of ldap:
29.1	357
34.1	358	{{code}}
29.1	359	xwiki.authentication.authclass=com.wiki.sso.SSOLdapAuthenicationImpl
	360	xwiki.authentication.ldap=1
	361	xwiki.authentication.ldap.server=<ad-server>
	362	xwiki.authentication.ldap.port=389
	363	xwiki.authentication.ldap.base_DN=<OU=Users,...............>
	364	#use a fixed user to attach to the ldap database,
	365	#the password is not provided with the SSOLdapAuthenicationImpl
	366	xwiki.authentication.ldap.bind_DN=<domain>\\<user>
	367	xwiki.authentication.ldap.bind_pass=<password>
	368	#Microsoft AD configuration
	369	xwiki.authentication.ldap.UID_attr=sAMAccountName
	370	xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
	371	xwiki.authentication.ldap.group_memberfields=member,uniqueMember
	372	#LDAP group mapping
	373	xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............\|\
	374	XWiki.XWikiAllGroup=CN=WIKI_User,...........
34.1	375	{{/code}}
29.1	376
64.2	377	The java code:
34.1	378
	379	{{code}}
29.1	380	package com.wiki.sso;
	381
	382
	383	import org.apache.commons.logging.Log;
	384	import org.apache.commons.logging.LogFactory;
	385
	386	import com.xpn.xwiki.XWikiContext;
	387	import com.xpn.xwiki.XWikiException;
	388	import com.xpn.xwiki.user.api.XWikiUser;
	389	import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
	390
	391	import java.security.Principal;
	392
	393	public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
	394	/**
	395	* Logging tool.
	396	*/
	397	private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
	398
	399
64.3	400	public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
	401	String user = getRemoteUser(context);
	402	if ((user != null) \|\| !user.equals("")) {
	403	if (LOG.isInfoEnabled())
	404	LOG.info("Launching create user for " + user);
	405	if ( authenticate(user, context) != null ) {
	406	if (LOG.isInfoEnabled())
	407	LOG.info("Create user done for " + user);
	408	user = "XWiki." + user;
	409	context.setUser(user);
	410	System.out.println("User is set to:" + user);
	411	return new XWikiUser(user);
	412	} else {
	413	LOG.error( "User " + user + " can't be authenticated against ldap" );
	414	}
	415	}
	416	return super.checkAuth(context);
	417	}
29.1	418
64.3	419	/**
	420	* We cannot authenticate locally since we need to trust the app server for
	421	* authentication
	422	*
	423	* @param username
	424	* @param password
	425	* @param context
	426	* @return
	427	* @throws XWikiException
	428	*/
	429	public XWikiUser checkAuth(String username, String password,
	430	String rememberme, XWikiContext context) throws XWikiException {
	431	String user = getRemoteUser(context);
	432	if ((user == null) \|\| user.equals("")) {
	433	return super.checkAuth(username, password, rememberme, context);
	434	}
	435	return checkAuth(context);
	436	}
29.1	437
64.3	438	private String getRemoteUser(XWikiContext context) {
	439	String userName = context.getRequest().getHttpServletRequest()
	440	.getRemoteUser();
	441	if (userName != null) {
	442	// only take the front of the username@domain
	443	String[] elements = userName.split("@", 2);
	444	userName = elements[0];
	445	}
	446	return userName;
	447	}
29.1	448
	449	public Principal authenticate(String login, XWikiContext context) throws XWikiException
	450	{
	451	if (LOG.isTraceEnabled()) {
	452	LOG.trace("Starting LDAP authentication");
	453	}
	454
	455	/*
	456	* TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
	457	* returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
	458	* given as argument. However, the right way to do this would probably be to throw XWikiException-s.
	459	*/
	460
	461	if (login == null) {
	462	// If we can't find the username field then we are probably on the login screen
	463
	464	if (LOG.isDebugEnabled()) {
	465	LOG.debug("The provided user is null."
	466	+ " We don't try to authenticate, it probably means the user is in non logged mode.");
	467	}
	468
	469	return null;
	470	}
	471
	472	// Check for empty usernames
	473	if (login.equals("")) {
	474	context.put("message", "nousername");
	475
	476	if (LOG.isDebugEnabled()) {
	477	LOG.debug("LDAP authentication failed: login empty");
	478	}
	479
	480	return null;
	481	}
	482
	483	// If we have the context then we are using direct mode
	484	// then we should specify the database
	485	// This is needed for virtual mode to work
	486	Principal principal = null;
	487
	488	// Try authentication against ldap
	489	principal = ldapAuthenticate(login, "", context);
	490
	491	if (LOG.isDebugEnabled()) {
	492	if (principal != null) {
	493	LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
	494	} else {
	495	LOG.debug("LDAP authentication failed for user [" + login + "]");
	496	}
	497	}
	498
	499	return principal;
	500	}
	501	}
34.1	502	{{/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