Open-Xchange servlet for external login masks - Revision history

Choeger: Redirected page to OXSessionFormLogin

2013-07-18T06:18:37Z

← Older revision		Revision as of 06:18, 18 July 2013
Line 1:		Line 1:
	~~= Open-Xchange servlet for external login masks =~~		#REDIRECT [[OXSessionFormLogin]]

	~~== Who should read this document ==~~

	This document is written for web developers who would like to create a custom login mask for the Open-Xchange server. The login mask can reside on an external server i. e., not directly located in the domain of the Open-Xchange machines. It is also intended for administrators who install and maintain Open-Xchange services.

	~~== Description ==~~

	~~The Open-Xchange [[HTTP_API~~#~~Form_Login_.28since_6.20.29\|HTTP API]] has a function to~~
	~~create a session from external.~~

	~~In order for this mechanism to work, you need to set <tt>com.openexchange.sessiond.autologin=true</tt> in <tt>/opt/open-xchange/etc/groupware/sessiond.properties</tt>~~

	~~== Example form ==~~

	~~A recent version of this sample can be found in the open-xchange package within the directory in /usr/share/doc.~~

	~~<pre>~~
	~~<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">~~
	~~<html>~~
	~~<head>~~
	~~<meta http-equiv="content-type" content="text/html; charset=UTF-8">~~
	~~<meta http-equiv="cache-control" content="no-cache">~~
	~~<title>Login</title>~~
	~~<script type="text/javascript">~~
	~~function uuid() {~~
	~~function hex(len, x) {~~
	~~if (x === undefined) x = Math.random();~~
	~~var s = new Array(len);~~
	~~for (var i = 0; i < len; i++) {~~
	~~x *= 16;~~
	~~var digit = x & 15;~~
	~~s[i] = digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10~~
	}
	~~return String.fromCharCode.apply(String, s);~~
	}
	~~return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)].join("");~~
	}
	~~</script>~~
	~~</head>~~
	~~<body>~~
	~~<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">~~
	~~<p>~~
	~~<label for="login">Username: </label>~~
	~~<input type="text" name="login" id="login"><br>~~
	~~<label for="password">Password: </label>~~
	~~<input type="password" name="password" id="password"><br>~~
	~~<input type="submit" value="Login">~~
	~~<input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml">~~
	~~<input type="hidden" name="version" value="Form Login">~~
	~~<input type="hidden" name="autologin" value="true">~~
	~~<input type="hidden" name="uiWebPath" value="/ox6/index.html">~~
	~~</p>~~
	~~</form>~~
	~~</body>~~
	~~</html>~~
	~~</pre>~~

	~~= More =~~
	~~See~~ [[OXSessionFormLogin~~]] for details on the API and find out about what every parameter does and how to handle errors.~~

	~~[[Category: OX6]]~~
	~~[[Category: v6.20]]~~
	~~[[Category: HowTo]]~~
	~~[[Category: Login~~]]

Choeger: /* Open-Xchange servlet for external login masks */

2013-07-18T06:13:54Z

Open-Xchange servlet for external login masks

← Older revision		Revision as of 06:13, 18 July 2013
Line 1:		Line 1:
	= Open-Xchange servlet for external login masks =		= Open-Xchange servlet for external login masks =

	~~'''Note: This document describes the new mechanism as introduced with 6.20. This is the [[Open-Xchange_servlet_for_external_login_masks_old\|old version]].~~
	~~'''~~

	== Who should read this document ==		== Who should read this document ==

Tierlieb: linked detail article, added categories

2011-06-21T08:36:00Z

linked detail article, added categories

← Older revision		Revision as of 08:36, 21 June 2011
Line 59:		Line 59:
	</html>		</html>
	</pre>		</pre>

			= More =
			See [[OXSessionFormLogin]] for details on the API and find out about what every parameter does and how to handle errors.

	[[Category: OX6]]		[[Category: OX6]]
			[[Category: v6.20]]
			[[Category: HowTo]]
			[[Category: Login]]

Choeger: /* Open-Xchange servlet for external login masks */

2011-05-13T11:27:47Z

Open-Xchange servlet for external login masks

← Older revision		Revision as of 11:27, 13 May 2011
Line 1:		Line 1:
	= Open-Xchange servlet for external login masks =		= Open-Xchange servlet for external login masks =

	'''Note: This document describes the new mechanism as introduced with 6.20. ~~The~~ is the [[Open-Xchange_servlet_for_external_login_masks_old\|old version]].		'''Note: This document describes the new mechanism as introduced with 6.20. This is the [[Open-Xchange_servlet_for_external_login_masks_old\|old version]].
	'''		'''

Choeger at 11:48, 14 April 2011

2011-04-14T11:48:52Z

← Older revision		Revision as of 11:48, 14 April 2011
Line 12:		Line 12:
	The Open-Xchange [[HTTP_API#Form_Login_.28since_6.20.29\|HTTP API]] has a function to		The Open-Xchange [[HTTP_API#Form_Login_.28since_6.20.29\|HTTP API]] has a function to
	create a session from external.		create a session from external.

			In order for this mechanism to work, you need to set <tt>com.openexchange.sessiond.autologin=true</tt> in <tt>/opt/open-xchange/etc/groupware/sessiond.properties</tt>

	== Example form ==		== Example form ==

Choeger at 11:46, 14 April 2011

2011-04-14T11:46:30Z

← Older revision		Revision as of 11:46, 14 April 2011
Line 1:		Line 1:
	= Open-Xchange servlet for external login masks =		= Open-Xchange servlet for external login masks =

			'''Note: This document describes the new mechanism as introduced with 6.20. The is the [[Open-Xchange_servlet_for_external_login_masks_old\|old version]].
			'''

	== Who should read this document ==		== Who should read this document ==

Choeger at 11:45, 14 April 2011

2011-04-14T11:45:10Z

← Older revision		Revision as of 11:45, 14 April 2011
Line 2:		Line 2:

	== Who should read this document ==		== Who should read this document ==

	This document is written for web developers who would like to create a custom login mask for the Open-Xchange server. The login mask can reside on an external server i. e., not directly located in the domain of the Open-Xchange machines. It is also intended for administrators who install and maintain Open-Xchange services.		This document is written for web developers who would like to create a custom login mask for the Open-Xchange server. The login mask can reside on an external server i. e., not directly located in the domain of the Open-Xchange machines. It is also intended for administrators who install and maintain Open-Xchange services.

	== Description ==		== Description ==
	The open-xchange-easylogin package provides a servlet which expects a user name and password via HTTP GET or POST. For security reasons, GET is disabled by default but can be turned on via configuration. With that information the servlet generates java code that is then executed in the user's browser so that the user gets automatically logged in to the Open-Xchange application. After the installation the servlet URL is:
	~~http://ox-server/servlet/easylogin~~

	~~{{InstallPlugin\|pluginname=open-xchange~~-~~easylogin~~\|~~sopath=stable}}~~		The Open-Xchange [[HTTP_API#Form_Login_.28since_6.20.29\|HTTP API]] has a function to
			create a session from external.

	== ~~Configuration~~ ==		== Example form ==
	~~Configuration file is:~~
	~~/opt/open-xchange/etc/groupware/easylogin.properties~~

	~~following configuration options are available (the groupware must~~ be ~~restarted to make changes effective):~~		A recent version of this sample can be found in the open-xchange package within the directory in /usr/share/doc.
	~~# easylogin configuration file~~

	~~# GET/POST variable name for~~ the ~~password~~
	~~com.openexchange.easylogin.passwordPara = password~~

	~~# GET/POST variable name for~~ the ~~login name~~
	~~com.openexchange.easylogin.loginPara = login~~

	~~# AJAX root path on the Open-Xchange server~~
	~~# do not change unless you know what you are doing~~
	~~com.openexchange.easylogin.AJAX_ROOT =~~ /~~ajax~~

	~~# the relative path to the Open-Xchange GUI~~
	~~com.openexchange.easylogin.OX_PATH_RELATIVE = ..~~/

	~~# enable GET for the servlet~~
	~~# possible parameters: true~~/~~false~~
	~~com.openexchange.easylogin.doGetEnabled = true~~

	~~== Example HTML form ==~~
	~~The examples below show how an HTML form for a custom login mask looks like. One example is for HTML POST and one for GET (for security reasons we recommend to use POST)~~. ~~When using the example for your own purposes, the ox-server string needs to be replaced by the name of the Open-Xchange server:~~

	<pre>		<pre>
	<html>		<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
	<~~body~~>		<html>
			<head>
	<h1>Login ~~via POST:~~</h1>		<meta http-equiv="content-type" content="text/html; charset=UTF-8">
	<~~form action~~="~~http~~://ox-~~server~~/~~servlet~~/~~easylogin~~" method="~~POST~~">		<meta http-equiv="cache-control" content="no-cache">
	<p>		<title>Login</title>
	<label for="login">Username: </label>		<script type="text/javascript">
	<input type="text" name="login" id="login"><br>		function uuid() {
	<label for="password">Password: </label>		function hex(len, x) {
	<input type="password" name="password" id="password"~~><br~~><br>		if (x === undefined) x = Math.random();
	<input type="submit" value="~~POST login~~">		var s = new Array(len);
	<~~/p>~~		for (var i = 0; i < len; i++) {
	~~</form>~~		x *= 16;
			var digit = x & 15;
	~~<h1>Login via GET:</h1>~~		s[i] = digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10
	~~<form action~~="~~http://ox-server/servlet/easylogin~~" ~~method~~="~~GET~~">		}
	~~<p>~~		return String.fromCharCode.apply(String, s);
	~~<label for~~="~~login~~"~~>Username: </label~~>		}
	<input type="~~text~~" name="~~login~~" id="~~login~~"~~><br~~>		return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)].join("");
	~~<label for="password">Password: </label>~~		}
	<input type="~~password~~" name="~~password~~" id="~~password~~"~~><br><br~~>		</script>
	<input type="~~submit~~" value="~~GET login~~">		</head>
	</p>		<body>
	</form>		<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">
			<p>
	</body>		<label for="login">Username: </label>
	</html>		<input type="text" name="login" id="login"><br>
			<label for="password">Password: </label>
			<input type="password" name="password" id="password"><br>
			<input type="submit" value="Login">
			<input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml">
			<input type="hidden" name="version" value="Form Login">
			<input type="hidden" name="autologin" value="true">
			<input type="hidden" name="uiWebPath" value="/ox6/index.html">
			</p>
			</form>
			</body>
			</html>
	</pre>		</pre>

	[[Category: OX6]]		[[Category: OX6]]

Choeger at 12:56, 3 August 2009

2009-08-03T12:56:28Z

← Older revision		Revision as of 12:56, 3 August 2009
Line 8:		Line 8:
	http://ox-server/servlet/easylogin		http://ox-server/servlet/easylogin

	{{InstallPlugin\|pluginname=open-xchange-easylogin\|sopath=~~unsupported/~~stable~~/extensions~~}}		{{InstallPlugin\|pluginname=open-xchange-easylogin\|sopath=stable}}

	== Configuration ==		== Configuration ==

Mheiland at 13:21, 27 June 2009

2009-06-27T13:21:00Z

← Older revision		Revision as of 13:21, 27 June 2009
Line 66:		Line 66:
	</html>		</html>
	</pre>		</pre>

			[[Category: OX6]]

Choeger at 12:30, 13 May 2009

2009-05-13T12:30:49Z

← Older revision		Revision as of 12:30, 13 May 2009
Line 10:		Line 10:
	{{InstallPlugin\|pluginname=open-xchange-easylogin\|sopath=unsupported/stable/extensions}}		{{InstallPlugin\|pluginname=open-xchange-easylogin\|sopath=unsupported/stable/extensions}}

	=== Configuration ===		== Configuration ==
	Configuration file is:		Configuration file is:
	/opt/open-xchange/etc/groupware/easylogin.properties		/opt/open-xchange/etc/groupware/easylogin.properties
Line 34:		Line 34:
	com.openexchange.easylogin.doGetEnabled = true		com.openexchange.easylogin.doGetEnabled = true

	=== Example HTML form ===		== Example HTML form ==
	The examples below show how an HTML form for a custom login mask looks like. One example is for HTML POST and one for GET (for security reasons we recommend to use POST). When using the example for your own purposes, the ox-server string needs to be replaced by the name of the Open-Xchange server:		The examples below show how an HTML form for a custom login mask looks like. One example is for HTML POST and one for GET (for security reasons we recommend to use POST). When using the example for your own purposes, the ox-server string needs to be replaced by the name of the Open-Xchange server: